Retrieve an AWS account
Retrieves an AWS account using the public ID. Use this to access details about the specified account for management or integration purposes.
HTTP method and endpoint
GET /accounts/aws/{cloudProviderAccountId}
|
|
This operation is deprecated. |
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
cloudProviderAccountId |
string |
path |
True |
Error
Status: Default, Default response
| Name | Type | Required | Description |
|---|---|---|---|
accessKey |
string |
False |
|
accountId |
string |
False |
|
accountName |
string |
False |
|
accountType |
string |
False |
|
assumeRole |
False |
||
occmRole |
string |
False |
|
publicId |
string |
True |
|
subscriptionId |
string |
False |
|
vsaList |
True |
Example error response
{
"accessKey": "string",
"accountId": "string",
"accountName": "string",
"accountType": "string",
"assumeRole": {
"accountId": "string",
"roleName": "string"
},
"occmRole": "string",
"publicId": "string",
"subscriptionId": "string",
"vsaList": [
{
"name": "string",
"publicId": "string",
"workingEnvironmentType": "string"
}
]
}
Definitions
See Definitions
AssumeRole
| Name | Type | Required | Description |
|---|---|---|---|
accountId |
string |
False |
|
isGov |
boolean |
False |
|
roleName |
string |
False |
AccountWorkingEnvironmentResponse
| Name | Type | Required | Description |
|---|---|---|---|
name |
string |
False |
|
publicId |
string |
False |
|
workingEnvironmentType |
string |
False |