Table of Contents
A low-level client representing AWS Migration Hub Config
The AWS Migration Hub home region APIs are available specifically for working with your Migration Hub home region. You can use these APIs to determine a home region, as well as to create and work with controls that describe the home region.
For specific API usage, see the sections that follow in this AWS Migration Hub Home Region API reference.
client = session.create_client('migrationhub-config')
These are the available methods:
Check if an operation can be paginated.
This API sets up the home region for the calling account only.
See also: AWS API Documentation
Request Syntax
response = client.create_home_region_control(
HomeRegion='string',
Target={
'Type': 'ACCOUNT',
'Id': 'string'
},
DryRun=True|False
)
[REQUIRED]
The name of the home region of the calling account.
[REQUIRED]
The account for which this command sets up a home region control. The Target is always of type ACCOUNT .
The target type is always an ACCOUNT .
The TargetID is a 12-character identifier of the ACCOUNT for which the control was created. (This must be the current account.)
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.
Exceptions
This API permits filtering on the ControlId and HomeRegion fields.
See also: AWS API Documentation
Request Syntax
response = client.describe_home_region_controls(
ControlId='string',
HomeRegion='string',
Target={
'Type': 'ACCOUNT',
'Id': 'string'
},
MaxResults=123,
NextToken='string'
)
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 .
The target type is always an ACCOUNT .
The TargetID is a 12-character identifier of the ACCOUNT for which the control was created. (This must be the current account.)
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 .
Exceptions
Generate a presigned url given a client, its method, and arguments
The presigned url
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
response = client.get_home_region()
{
'HomeRegion': 'string'
}
Response Structure
The name of the home region of the calling account.
Exceptions
Create a paginator for an operation.
Returns an object that can wait for some condition.
Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
You do not have sufficient access to perform this action.
Example
try:
...
except client.exceptions.AccessDeniedException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
You do not have sufficient access to perform this action.
Exception raised to indicate that authorization of an action was successful, when the DryRun flag is set to true.
Example
try:
...
except client.exceptions.DryRunOperation as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
Exception raised to indicate that authorization of an action was successful, when the DryRun flag is set to true.
Exception raised when an internal, configuration, or dependency error is encountered.
Example
try:
...
except client.exceptions.InternalServerError as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
Exception raised when an internal, configuration, or dependency error is encountered.
Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
Example
try:
...
except client.exceptions.InvalidInputException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
Exception raised when a request fails due to temporary unavailability of the service.
Example
try:
...
except client.exceptions.ServiceUnavailableException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
Exception raised when a request fails due to temporary unavailability of the service.
The request was denied due to request throttling.
Example
try:
...
except client.exceptions.ThrottlingException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'RetryAfterSeconds': 123,
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
The request was denied due to request throttling.
Message (string) --
RetryAfterSeconds (integer) --
The number of seconds the caller should wait before retrying.
Error (dict) -- Normalized access to common exception attributes.
The available paginators are: