home_regions
Creates, updates, deletes, gets or lists a home_regions resource.
Overview
| Name | home_regions |
| Type | Resource |
| Id | aws.migrationhub_config.home_regions |
Fields
The following fields are returned by SELECT queries:
- get_home_region
| Name | Datatype | Description |
|---|---|---|
home_region | string | The name of the home region of the calling account. (pattern: <code>^([a-z]+)-([a-z]+)-([0-9]+)$</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_home_region | select | region | 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. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_home_region
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.
SELECT
home_region
FROM aws.migrationhub_config.home_regions
WHERE region = '{{ region }}' -- required
;