Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeHomeRegionControls

This API permits filtering on the ControlId and HomeRegion fields.

Request Syntax


{
   "ControlId": "string",
   "HomeRegion": "string",
   "MaxResults": number,
   "NextToken": "string",
   "Target": { 
      "Id": "string",
      "Type": "string"
   }
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ControlId

The ControlID is a unique identifier string of your HomeRegionControl object.

Type: String

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

Pattern: ^hrc-[a-z0-9]{12}$

Required: No

HomeRegion

The name of the home region you'd like to view.

Type: String

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

Pattern: ^([a-z]+)-([a-z]+)-([0-9]+)$

Required: No

MaxResults

The maximum number of filtering results to display per page.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

If a NextToken was returned by a previous call, more results are available. To retrieve the next page of results, make the call again using the returned token in NextToken.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: ^[a-zA-Z0-9\/\+\=]{0,2048}$

Required: No

Target

The target parameter specifies the identifier to which the home region is applied, which is always of type ACCOUNT. It applies the home region to the current ACCOUNT.

Type: Target object

Required: No

Response Syntax


{
   "HomeRegionControls": [ 
      { 
         "ControlId": "string",
         "HomeRegion": "string",
         "RequestedTime": number,
         "Target": { 
            "Id": "string",
            "Type": "string"
         }
      }
   ],
   "NextToken": "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.

HomeRegionControls

An array that contains your HomeRegionControl objects.

Type: Array of HomeRegionControl objects

Array Members: Maximum number of 100 items.

NextToken

If a NextToken was returned by a previous call, more results are available. To retrieve the next page of results, make the call again using the returned token in NextToken.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: ^[a-zA-Z0-9\/\+\=]{0,2048}$

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400

InternalServerError

Exception raised when an internal, configuration, or dependency error is encountered.

HTTP Status Code: 500

InvalidInputException

Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.

HTTP Status Code: 400

ServiceUnavailableException

Exception raised when a request fails due to temporary unavailability of the service.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400