GetHomeRegion
Returns the calling account’s home region, if configured. This API is used by other AWS
services to determine the regional endpoint for calling AWS Application Discovery Service and
Migration Hub. You must call GetHomeRegion
at least once before you call any
other AWS Application Discovery Service and AWS Migration Hub APIs, to obtain the account's
Migration Hub home region.
Response Syntax
{
"HomeRegion": "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.
- 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]+)$
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: