Skip to content

DescribeHomeRegionControlsRequest

Source code in docs_src/capo_migrationhub_config/types/describe_home_region_controls_request.py
class DescribeHomeRegionControlsRequest(TypedDict, closed=True):
    control_id: NotRequired["capo_migrationhub_config.types.control_id.ControlId"]
    """<p>The <code>ControlID</code> is a unique identifier string of your <code>HomeRegionControl</code> object.</p>"""
    home_region: NotRequired["capo_migrationhub_config.types.home_region.HomeRegion"]
    """<p>The name of the home region you'd like to view.</p>"""
    target: NotRequired["capo_migrationhub_config.types.target.Target"]
    """<p>The target parameter specifies the identifier to which the home region is applied, which is always of type <code>ACCOUNT</code>. It applies the home region to the current <code>ACCOUNT</code>.</p>"""
    max_results: NotRequired[
        "capo_migrationhub_config.types.describe_home_region_controls_max_results.DescribeHomeRegionControlsMaxResults"
    ]
    """<p>The maximum number of filtering results to display per page. </p>"""
    next_token: NotRequired["capo_migrationhub_config.types.token.Token"]
    """<p>If a <code>NextToken</code> 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 <code>NextToken</code>.</p>"""

control_id instance-attribute

control_id: NotRequired[ControlId]

The ControlID is a unique identifier string of your HomeRegionControl object.

home_region instance-attribute

home_region: NotRequired[HomeRegion]

The name of the home region you'd like to view.

max_results instance-attribute

max_results: NotRequired[DescribeHomeRegionControlsMaxResults]

The maximum number of filtering results to display per page.

next_token instance-attribute

next_token: NotRequired[Token]

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.

target instance-attribute

target: NotRequired[Target]

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.