MigrationHubConfig / Client / describe_home_region_controls

describe_home_region_controls#

MigrationHubConfig.Client.describe_home_region_controls(**kwargs)#

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'
)
Parameters:

  • ControlId (string) – The ControlID is a unique identifier string of your HomeRegionControl object.

  • HomeRegion (string) – The name of the home region you’d like to view.

  • Target (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.)

  • MaxResults (integer) – The maximum number of filtering results to display per page.

  • 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.

Return type:

dict

Returns:

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