List Aws Accounts | NSX-T Data Center REST API

List Aws Accounts

Return a list of all AWS accounts

Request

URI

GET

https://nsxmanager.your.domain/api/v1/csm/aws-accounts

COPY

Query Parameters

string

cursor

Optional

Opaque cursor to be used for getting next page of records (supplied by current result page)

string

included_fields

Optional

Comma separated list of fields that should be included to result of query

integer

page_size

Optional

Maximum number of results to return in this page (server may return fewer)

string

region_id

Optional

Identifier for region based on which accounts statistics will be aggregated. Using this request parameter will return only all_accounts_vpc_stats and all_accounts_instance_stats properties.

boolean

sort_ascending

Optional

sort_ascending

string

sort_by

Optional

Field by which records are sorted

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Success

Returns AwsAccountsListResult of type(s) application/json

This response body class contains all of the following: ListResult , InlineAwsAccountsListResult1

{
    "_self": {
        "rel": "string"
    },
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "cursor": "string",
    "sort_ascending": false,
    "sort_by": "string",
    "result_count": 0,
    "all_accounts_vpc_stats": {
        "unmanaged": 0,
        "managed": 0
    },
    "all_accounts_instance_stats": {
        "unmanaged": 0,
        "vcpus": 0,
        "managed": 0,
        "error": 0
    },
    "results": [
        {
            "_self": {
                "rel": "string"
            },
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "_revision": 0,
            "_create_time": 0,
            "_system_owned": false,
            "display_name": "string",
            "description": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "_last_modified_time": 0,
            "_create_user": "string",
            "_last_modified_user": "string",
            "id": "string",
            "resource_type": "string",
            "tenant_id": "string",
            "instance_stats": {
                "unmanaged": 0,
                "vcpus": 0,
                "managed": 0,
                "error": 0
            },
            "cloud_type": "string",
            "auth_users": [
                {
                    "display_name": "string",
                    "id": "string"
                }
            ],
            "status": {
                "inventory_sync_state": "string",
                "inventory_sync_status": "string",
                "credentials_status": "string"
            },
            "access_key": "string",
            "regions_count": 0,
            "auth_mechanism_iam": false,
            "gateway_role_name": "string",
            "vpc_stats": {
                "unmanaged": 0,
                "managed": 0
            },
            "has_managed_vpc": "string",
            "secret_key": "string",
            "external_id": "string",
            "iam_role_arn": "string"
        }
    ]
}

400

Returns BadRequest of type(s) application/json

Operation doesn't return any data structure

403

Returns Forbidden of type(s) application/json

Operation doesn't return any data structure

404

Returns NotFound of type(s) application/json

Operation doesn't return any data structure

412

Returns PreconditionFailed of type(s) application/json

Operation doesn't return any data structure