Get Gov Cloud Account Information

account_get_gov_cloud_account_information

R Documentation

Retrieves information about the GovCloud account linked to the specified standard account (if it exists) including the GovCloud account ID and state

Description

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.

Usage

account_get_gov_cloud_account_information(StandardAccountId)

Arguments

StandardAccountId

Specifies the 12 digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you do not specify this parameter, it defaults to the Amazon Web Services 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. 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.

Value

A list with the following syntax:

list(
  GovCloudAccountId = "string",
  AccountState = "PENDING_ACTIVATION"|"ACTIVE"|"SUSPENDED"|"CLOSED"
)

Request syntax

svc$get_gov_cloud_account_information(
  StandardAccountId = "string"
)