CreateHomeRegionControl
This API sets up the home region for the calling account only.
Request Syntax
{
"DryRun": boolean
,
"HomeRegion": "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.
- DryRun
-
Optional Boolean flag to indicate whether any effect should take place. It tests whether the caller has permission to make the call.
Type: Boolean
Required: No
- HomeRegion
-
The name of the home region of the calling account.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern:
^([a-z]+)-([a-z]+)-([0-9]+)$
Required: Yes
- Target
-
The account for which this command sets up a home region control. The
Target
is always of typeACCOUNT
.Type: Target object
Required: Yes
Response Syntax
{
"HomeRegionControl": {
"ControlId": "string",
"HomeRegion": "string",
"RequestedTime": number,
"Target": {
"Id": "string",
"Type": "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.
- HomeRegionControl
-
This object is the
HomeRegionControl
object that's returned by a successful call toCreateHomeRegionControl
.Type: HomeRegionControl object
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
- DryRunOperation
-
Exception raised to indicate that authorization of an action was successful, when the
DryRun
flag is set to true.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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: