2019/11/20 - AWS Migration Hub Config - 3 new api methods
Changes AWS Migration Hub Config Service allows you to get and set the Migration Hub home region for use with AWS Migration Hub and Application Discovery Service
This API sets up the home region for the calling account only.
See also: AWS API Documentation
Request Syntax
client.create_home_region_control(
HomeRegion='string',
Target={
'Type': 'ACCOUNT',
'Id': 'string'
},
DryRun=True|False
)
string
[REQUIRED]
The name of the home region of the calling account.
dict
[REQUIRED]
The account for which this command sets up a home region control. The Target is always of type ACCOUNT .
Type (string) -- [REQUIRED]
The target type is always an ACCOUNT .
Id (string) --
The TargetID is a 12-character identifier of the ACCOUNT for which the control was created. (This must be the current account.)
boolean
Optional Boolean flag to indicate whether any effect should take place. It tests whether the caller has permission to make the call.
dict
Response Syntax
{
'HomeRegionControl': {
'ControlId': 'string',
'HomeRegion': 'string',
'Target': {
'Type': 'ACCOUNT',
'Id': 'string'
},
'RequestedTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
HomeRegionControl (dict) --
This object is the HomeRegionControl object that's returned by a successful call to CreateHomeRegionControl .
ControlId (string) --
A unique identifier that's generated for each home region control. It's always a string that begins with "hrc-" followed by 12 lowercase letters and numbers.
HomeRegion (string) --
The AWS Region that's been set as home region. For example, "us-west-2" or "eu-central-1" are valid home regions.
Target (dict) --
The target parameter specifies the identifier to which the home region is applied, which is always an ACCOUNT . It applies the home region to the current ACCOUNT .
Type (string) --
The target type is always an ACCOUNT .
Id (string) --
The TargetID is a 12-character identifier of the ACCOUNT for which the control was created. (This must be the current account.)
RequestedTime (datetime) --
A timestamp representing the time when the customer called CreateHomeregionControl and set the home region for the account.
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.
See also: AWS API Documentation
Request Syntax
client.get_home_region()
dict
Response Syntax
{
'HomeRegion': 'string'
}
Response Structure
(dict) --
HomeRegion (string) --
The name of the home region of the calling account.
This API permits filtering on the ControlId , HomeRegion , and RegionControlScope fields.
See also: AWS API Documentation
Request Syntax
client.describe_home_region_controls(
ControlId='string',
HomeRegion='string',
Target={
'Type': 'ACCOUNT',
'Id': 'string'
},
MaxResults=123,
NextToken='string'
)
string
The ControlID is a unique identifier string of your HomeRegionControl object.
string
The name of the home region you'd like to view.
dict
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 (string) -- [REQUIRED]
The target type is always an ACCOUNT .
Id (string) --
The TargetID is a 12-character identifier of the ACCOUNT for which the control was created. (This must be the current account.)
integer
The maximum number of filtering results to display per page.
string
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 .
dict
Response Syntax
{
'HomeRegionControls': [
{
'ControlId': 'string',
'HomeRegion': 'string',
'Target': {
'Type': 'ACCOUNT',
'Id': 'string'
},
'RequestedTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
HomeRegionControls (list) --
An array that contains your HomeRegionControl objects.
(dict) --
A home region control is an object that specifies the home region for an account, with some additional information. It contains a target (always of type ACCOUNT ), an ID, and a time at which the home region was set.
ControlId (string) --
A unique identifier that's generated for each home region control. It's always a string that begins with "hrc-" followed by 12 lowercase letters and numbers.
HomeRegion (string) --
The AWS Region that's been set as home region. For example, "us-west-2" or "eu-central-1" are valid home regions.
Target (dict) --
The target parameter specifies the identifier to which the home region is applied, which is always an ACCOUNT . It applies the home region to the current ACCOUNT .
Type (string) --
The target type is always an ACCOUNT .
Id (string) --
The TargetID is a 12-character identifier of the ACCOUNT for which the control was created. (This must be the current account.)
RequestedTime (datetime) --
A timestamp representing the time when the customer called CreateHomeregionControl and set the home region for the account.
NextToken (string) --
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 .