get_region_opt_status¶

Account.Client.get_region_opt_status(**kwargs)¶

Retrieves the opt-in status of a particular Region.

Request Syntax

response = client.get_region_opt_status(
    AccountId='string',
    RegionName='string'
)

Parameters

AccountId (string) --
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 don't 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. The specified account ID must also 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 admin 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, don't specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.
RegionName (string) --
[REQUIRED]

Specifies the Region-code for a given Region name (for example, af-south-1 ). This function will return the status of whatever Region you pass into this parameter.

Return type

dict

Returns

Response Syntax

{
    'RegionName': 'string',
    'RegionOptStatus': 'ENABLED'|'ENABLING'|'DISABLING'|'DISABLED'|'ENABLED_BY_DEFAULT'
}

Response Structure

Exceptions

Table Of Contents