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

GetRegionOptStatus

Retrieves the opt-in status of a particular Region.

Request Syntax


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

{
   "AccountId": "string",
   "RegionName": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

AccountId

Specifies the 12-digit account ID number of the AWS account that you want to access or modify with this operation. If you don't 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. 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.

Type: String

Pattern: ^\d{12}$

Required: No

RegionName

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "RegionName": "string",
   "RegionOptStatus": "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.

RegionName

The Region code that was passed in.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50.

RegionOptStatus

One of the potential statuses a Region can undergo (Enabled, Enabling, Disabled, Disabling, Enabled_By_Default).

Type: String

Valid Values: ENABLED | ENABLING | DISABLING | DISABLED | ENABLED_BY_DEFAULT

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.

HTTP Status Code: 403

InternalServerException

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

HTTP Status Code: 500

TooManyRequestsException

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

HTTP Status Code: 429

ValidationException

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

HTTP Status Code: 400