Enumerate Aws Regions

Enumerate Aws Regions

Get the available regions for specified AWS cloud account

Request
URI
POST
https://{api_host}/iaas/api/cloud-accounts-aws/region-enumeration
COPY
Query Parameters
string
apiVersion
Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /iaas/api/about

Request Body

CloudAccount specification

CloudAccountAwsSpecification of type(s) application/json
Required 
{
    "accessKeyId": "ACDC55DB4MFH6ADG75KK",
    "secretAccessKey": "gfsScK345sGGaVdds222dasdfDDSSasdfdsa34fS",
    "createDefaultZones": true,
    "name": "string",
    "description": "string",
    "regionIds": [
        "string"
    ],
    "tags": [
        {
            "value": "string",
            "key": "string"
        }
    ]
}
string
accessKeyId
Required

Aws Access key ID

string
secretAccessKey
Required

Aws Secret Access Key

boolean
createDefaultZones
Optional

Create default cloud zones for the enabled regions.

string
name
Required

A human-friendly name used as an identifier in APIs that support this option.

string
description
Optional

A human-friendly description.

array of string
regionIds
Required

A set of Region names to enable provisioning on. Refer to /iaas/cloud-accounts-aws/region-enumeration..

array of Tag
tags
Optional

A set of tag keys and optional values to set on the Cloud Account

Responses
200

successful operation

Returns CloudAccountRegions of type(s) application/json 
{
    "externalRegionIds": [
        "string"
    ]
}
array of string
externalRegionIds
Required

A set of region ids for the cloud account.


400

Invalid Request - bad data

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

On This Page
Cloud Account Operations
POST
Create Aws Cloud Account
POST
Create Azure Cloud Account
POST
Create Cloud Account
POST
Create Gcp Cloud Account
POST
Create Nsx T Cloud Account
POST
Create Nsx V Cloud Account
POST
Create V Sphere Cloud Account
DELETE
Delete Aws Cloud Account
DELETE
Delete Azure Cloud Account
DELETE
Delete Cloud Account
DELETE
Delete Cloud Account Nsx T
DELETE
Delete Cloud Account Nsx V
DELETE
Delete Gcp Cloud Account
DELETE
Delete V Sphere Cloud Account
POST
Enumerate Aws Regions
POST
Enumerate Azure Regions
POST
Enumerate Gcp Regions
POST
Enumerate Regions
POST
Enumerate V Sphere Regions
GET
Get Aws Cloud Account
GET
Get Aws Cloud Accounts
GET
Get Azure Cloud Account
GET
Get Azure Cloud Accounts
GET
Get Cloud Account
GET
Get Cloud Accounts
GET
Get Gcp Cloud Account
GET
Get Gcp Cloud Accounts
GET
Get Nsx T Cloud Account
GET
Get Nsx T Cloud Accounts
GET
Get Nsx V Cloud Account
GET
Get Nsx V Cloud Accounts
GET
Get V Sphere Cloud Account
GET
Get V Sphere Cloud Accounts
PATCH
Update Aws Cloud Account
PATCH
Update Azure Cloud Account
PATCH
Update Cloud Account
PATCH
Update Gcp Cloud Account
PATCH
Update Nsx T Cloud Account
PATCH
Update Nsx V Cloud Account
PATCH
Update V Sphere Cloud Account