NSX-T Data Center REST API

AwsAccount (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "CloudAccount
  }, 
  "id": "AwsAccount", 
  "module_id": "CloudAccounts", 
  "properties": {
    "_create_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of resource creation", 
      "readonly": true
    }, 
    "_create_user": {
      "description": "ID of the user who created this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_last_modified_time": {
      "$ref": "EpochMsTimestamp, 
      "can_sort": true, 
      "description": "Timestamp of last modification", 
      "readonly": true
    }, 
    "_last_modified_user": {
      "description": "ID of the user who last modified this resource", 
      "readonly": true, 
      "type": "string"
    }, 
    "_links": {
      "description": "The server will populate this field when returing the resource. Ignored on PUT and POST.", 
      "items": {
        "$ref": "ResourceLink
      }, 
      "readonly": true, 
      "title": "References related to this resource", 
      "type": "array"
    }, 
    "_protection": {
      "description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed             to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed                 to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super                    user and can modify it, but only when providing                    the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this           entity.", 
      "readonly": true, 
      "title": "Indicates protection status of this resource", 
      "type": "string"
    }, 
    "_revision": {
      "description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.", 
      "title": "Generation of this resource config", 
      "type": "int"
    }, 
    "_schema": {
      "readonly": true, 
      "title": "Schema for this resource", 
      "type": "string"
    }, 
    "_self": {
      "$ref": "SelfResourceLink, 
      "readonly": true, 
      "title": "Link to this resource"
    }, 
    "_system_owned": {
      "description": "Indicates system owned resource", 
      "readonly": true, 
      "type": "boolean"
    }, 
    "auth_method": {
      "description": "This property conveys the authorization method to use. Appropriate credentials/parameters will be expected based on this method selection.", 
      "enum": [
        "CREDENTIALS"
      ], 
      "readonly": true, 
      "required": false, 
      "title": "AWS account authorization method", 
      "type": "string"
    }, 
    "auth_users": {
      "description": "List of authorized users.", 
      "items": {
        "$ref": "CloudUserInfo
      }, 
      "readonly": true, 
      "required": false, 
      "title": "Authrized Users", 
      "type": "array"
    }, 
    "cloud_type": {
      "decription": "Name of the cloud vendor.", 
      "enum": [
        "AWS", 
        "AZURE", 
        "GOOGLE", 
        "AZURE_GOV_US", 
        "AWS_GOV_US_EAST", 
        "AWS_GOV_US_WEST"
      ], 
      "readonly": false, 
      "required": true, 
      "title": "Cloud Type", 
      "type": "string"
    }, 
    "credentials": {
      "$ref": "AwsCredentials, 
      "description": "Credentials of AWS Account.", 
      "readonly": true, 
      "required": false, 
      "title": "AWS Credentials"
    }, 
    "description": {
      "can_sort": true, 
      "maxLength": 1024, 
      "title": "Description of this resource", 
      "type": "string"
    }, 
    "display_name": {
      "can_sort": true, 
      "description": "Defaults to ID if not set", 
      "maxLength": 255, 
      "title": "Identifier to use when displaying entity in logs or GUI", 
      "type": "string"
    }, 
    "id": {
      "can_sort": true, 
      "title": "Unique identifier of this resource", 
      "type": "string"
    }, 
    "instance_stats": {
      "$ref": "InstanceStats, 
      "description": "Stores statistics of the number of managed, unmanaged and error virtual machines.", 
      "readonly": true, 
      "required": false, 
      "title": "Instance statistics"
    }, 
    "last_inventory_sync_date": {
      "description": "Time when last inventory syncing completed.", 
      "readonly": true, 
      "required": false, 
      "title": "Last inventory sync date", 
      "type": "integer"
    }, 
    "regions_config": {
      "$ref": "RegionListConfig, 
      "description": "Configured list of regions to be used for the cloud account.", 
      "readonly": false, 
      "required": false, 
      "title": "List of regions configuration for the cloud account"
    }, 
    "regions_count": {
      "description": "Count of the AWS regions which have atleast one VPC created.", 
      "readonly": true, 
      "required": false, 
      "title": "AWS Regions Count", 
      "type": "integer"
    }, 
    "resource_type": {
      "description": "The type of this resource.", 
      "readonly": false, 
      "type": "string"
    }, 
    "status": {
      "$ref": "AwsAccountStatus, 
      "readonly": true, 
      "required": false, 
      "title": "Status of the account"
    }, 
    "tags": {
      "items": {
        "$ref": "Tag
      }, 
      "maxItems": 30, 
      "title": "Opaque identifiers meaningful to the API user", 
      "type": "array"
    }, 
    "tenant_id": {
      "description": "Tenant ID of the cloud account.", 
      "readonly": true, 
      "required": false, 
      "title": "Tenant ID", 
      "type": "string"
    }, 
    "vpc_stats": {
      "$ref": "VpcStats, 
      "readonly": true, 
      "required": false, 
      "title": "VPC statistics"
    }
  }, 
  "title": "AWS account", 
  "type": "object"
}