get_control `async` ¶

get_control(
    control_arn: ControlArn,
    *,
    config_overrides: Optional[AsyncControlCatalogClientConfig] = None,
) -> GetControlResponse

Returns details about a specific control, most notably a list of Amazon Web Services Regions where this control is supported. Input a value for the ControlArn parameter, in ARN form. GetControl accepts controltower or controlcatalog control ARNs as input. Returns a controlcatalog ARN format.

In the API response, controls that have the value GLOBAL in the Scope field do not show the DeployableRegions field, because it does not apply. Controls that have the value REGIONAL in the Scope field return a value for the DeployableRegions field, as shown in the example.

Parameters:

control_arn (ControlArn) –

The Amazon Resource Name (ARN) of the control. It has one of the following formats:

Global format

arn:{PARTITION}:controlcatalog:::control/{CONTROL_CATALOG_OPAQUE_ID}

Or Regional format

arn:{PARTITION}:controltower:{REGION}::control/{CONTROL_TOWER_OPAQUE_ID}

Here is a more general pattern that covers Amazon Web Services Control Tower and Control Catalog ARNs:

^arn:(aws(?:[-a-z]*)?):(controlcatalog|controltower):[a-zA-Z0-9-]*::control/[0-9a-zA-Z_\\-]+$

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.
InternalServerException –

An internal service error occurred during the processing of your request. Try again later.
ResourceNotFoundException –

The requested resource does not exist.
ThrottlingException –

The request was denied due to request throttling.
ValidationException –

The request has invalid or missing parameters.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_controlcatalog/_services/async_control_catalog.py

async def get_control(
    self,
    control_arn: "capo_controlcatalog.types.control_arn.ControlArn",
    *,
    config_overrides: Optional[AsyncControlCatalogClientConfig] = None,
) -> "capo_controlcatalog.types.get_control_response.GetControlResponse":
    r"""<p>Returns details about a specific control, most notably a list of Amazon Web Services Regions where this control is supported. Input a value for the <i>ControlArn</i> parameter, in ARN form. <code>GetControl</code> accepts <i>controltower</i> or <i>controlcatalog</i> control ARNs as input. Returns a <i>controlcatalog</i> ARN format.</p> <p>In the API response, controls that have the value <code>GLOBAL</code> in the <code>Scope</code> field do not show the <code>DeployableRegions</code> field, because it does not apply. Controls that have the value <code>REGIONAL</code> in the <code>Scope</code> field return a value for the <code>DeployableRegions</code> field, as shown in the example.</p>

    Args:
        control_arn: <p>The Amazon Resource Name (ARN) of the control. It has one of the following formats:</p> <p> <i>Global format</i> </p> <p> <code>arn:{PARTITION}:controlcatalog:::control/{CONTROL_CATALOG_OPAQUE_ID}</code> </p> <p> <i>Or Regional format</i> </p> <p> <code>arn:{PARTITION}:controltower:{REGION}::control/{CONTROL_TOWER_OPAQUE_ID}</code> </p> <p>Here is a more general pattern that covers Amazon Web Services Control Tower and Control Catalog ARNs:</p> <p> <code>^arn:(aws(?:[-a-z]*)?):(controlcatalog|controltower):[a-zA-Z0-9-]*::control/[0-9a-zA-Z_\\-]+$</code> </p>

    Raises:
        capo_controlcatalog.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_controlcatalog.errors.internal_server_exception.InternalServerException: <p>An internal service error occurred during the processing of your request. Try again later.</p>
        capo_controlcatalog.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource does not exist.</p>
        capo_controlcatalog.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_controlcatalog.errors.validation_exception.ValidationException: <p>The request has invalid or missing parameters.</p>
        capo_controlcatalog.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_controlcatalog.types.get_control_request.GetControlRequest]",
    ) -> AsyncOperationResponse[
        "capo_controlcatalog.types.get_control_response.GetControlResponse"
    ]:
        import capo_controlcatalog._operations.control_catalog.get_control

        (
            output,
            http_response,
        ) = await capo_controlcatalog._operations.control_catalog.get_control.async_get_control(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetControl")
    )
    input_: capo_controlcatalog.types.get_control_request.GetControlRequest = {
        "control_arn": control_arn
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

get_control async ¶

get_control `async` ¶