Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

GetGovCloudAccountInformation

Retrieves information about the GovCloud account linked to the specified standard account (if it exists) including the GovCloud account ID and state. To use this API, an IAM user or role must have the account:GetGovCloudAccountInformation IAM permission.

Request Syntax


POST /getGovCloudAccountInformation HTTP/1.1
Content-type: application/json

{
   "StandardAccountId": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

StandardAccountId

Specifies the 12 digit account ID number of the AWS account that you want to access or modify with this operation.

If you do not specify this parameter, it defaults to the AWS account of the identity used to call the operation.

To use this parameter, the caller must be an identity in the organization's management account or a delegated administrator account, and the specified account ID must be a member account in the same organization. The organization must have all features enabled, and the organization must have trusted access enabled for the Account Management service, and optionally a delegated administrator account assigned.

Note

The management account can't specify its own AccountId; it must call the operation in standalone context by not including the AccountId parameter.

To call this operation on an account that is not a member of an organization, then don't specify this parameter, and call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.

Type: String

Pattern: \d{12}

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "AccountState": "string",
   "GovCloudAccountId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AccountState

The account state of the linked GovCloud account.

Type: String

Valid Values: PENDING_ACTIVATION | ACTIVE | SUSPENDED | CLOSED

GovCloudAccountId

The 12-digit account ID number of the linked GovCloud account.

Type: String

Pattern: \d{12}

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The operation failed because the calling identity doesn't have the minimum required permissions.

errorType: The value populated to the x-amzn-ErrorType response header by API Gateway.

HTTP Status Code: 403

InternalServerException

The operation failed because of an error internal to AWS. Try your operation again later.

errorType: The value populated to the x-amzn-ErrorType response header by API Gateway.

HTTP Status Code: 500

ResourceNotFoundException

The operation failed because it specified a resource that can't be found.

errorType: The value populated to the x-amzn-ErrorType response header by API Gateway.

HTTP Status Code: 404

ResourceUnavailableException

The operation failed because it specified a resource that is not currently available.

errorType: The value populated to the x-amzn-ErrorType response header by API Gateway.

HTTP Status Code: 424

TooManyRequestsException

The operation failed because it was called too frequently and exceeded a throttle limit.

errorType: The value populated to the x-amzn-ErrorType response header by API Gateway.

HTTP Status Code: 429

ValidationException

The operation failed because one of the input parameters was invalid.

fieldList: The field where the invalid entry was detected.
message: The message that informs you about what was invalid about the request.
reason: The reason that validation failed.

HTTP Status Code: 400

Examples

Example 1

The following example retrieves the linked GovCloud account information for the account whose credentials are used to call the operation.

Sample Request


POST / HTTP/1.1
X-Amz-Target: AWSAccountV20210201.GetGovCloudAccountInformation
                    
{}

Sample Response


HTTP/1.1 200 OK
Content-Type: application/json
                    
{
   "GovCloudAccountId": "123456789012",
   "AccountState": "ACTIVE"
}

Example 2

The following example retrieves the linked GovCloud account information for the specified member account in an organization. You must use credentials from either the organization's management account or from the Account Management service's delegated admin account.

Sample Request


POST / HTTP/1.1
X-Amz-Target: AWSAccountV20210201.GetGovCloudAccountInformation
                    
{
   "StandardAccountId": "111111111111" 
}

Sample Response


HTTP/1.1 200 OK
Content-Type: application/json
                    
{
   "GovCloudAccountId": "123456789012",
   "AccountState": "ACTIVE"
}

Example 3

The following example attempts to retrieve the linked GovCloud account information for a standard account that is not linked to a GovCloud account.

Sample Request


POST / HTTP/1.1
X-Amz-Target: AWSAccountV20210201.GetGovCloudAccountInformation
                    
{
   "StandardAccountId": "222222222222" 
}

Sample Response


HTTP/1.1 404
Content-Type: application/json
                    
{
   "message":"GovCloud Account ID not found for Standard Account - 222222222222."
}