Create Aws Cloud Account

Create Aws Cloud Account

Create an AWS cloud account in the current organization

Request
URI
POST
https://{api_host}/iaas/api/cloud-accounts-aws
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

CloudAccountAws 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
201

successful operation

Returns CloudAccountAws of type(s) application/json
{
    "owner": "[email protected]",
    "accessKeyId": "KLIKJ7EA4PPDZR7T7Z6K",
    "enabledRegionIds": [
        "string"
    ],
    "description": "my-description",
    "orgId": "9e49",
    "tags": [
        {
            "value": "string",
            "key": "string"
        }
    ],
    "organizationId": "deprecated",
    "createdAt": "2012-09-27",
    "name": "my-name",
    "id": "9e49",
    "updatedAt": "2012-09-27"
}
string
owner
Optional

Email of the user that owns the entity.

string
accessKeyId
Required

Access key id for Aws.

array of string
enabledRegionIds
Optional

A set of region names that are enabled for this cloud account.

object
_links
Required

HATEOAS of the entity

string
description
Optional

A human-friendly description.

string
orgId
Optional

The id of the organization this entity belongs to.

array of Tag
tags
Optional

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

string
organizationId
Optional

This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.

string
createdAt
Optional

Date when the entity was created. The date is in ISO 6801 and UTC.

object
customProperties
Optional

Additional properties that may be used to extend the base type.

string
name
Optional

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

string
id
Required

The id of this resource instance

string
updatedAt
Optional

Date when the entity was last updated. The date is ISO 8601 and UTC.


400

Invalid Request - bad data

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure