Skip to content

describe_type_registration

describe_type_registration(
    *,
    config_overrides: Optional[CloudFormationClientConfig] = None,
    registration_token: Optional[RegistrationToken] = None,
) -> DescribeTypeRegistrationOutput

Returns information about an extension's registration, including its current status and type and version identifiers.

When you initiate a registration request using RegisterType, you can then use DescribeTypeRegistration to monitor the progress of that registration request.

Once the registration request has completed, use DescribeType to return detailed information about an extension.

Parameters:

  • registration_token (Optional[RegistrationToken], default: None ) –

    The identifier for this registration request.

    This registration token is generated by CloudFormation when you initiate a registration request using RegisterType.

Raises:

Source code in docs_src/capo_cloudformation/_services/cloud_formation.py
def describe_type_registration(
    self,
    *,
    config_overrides: Optional[CloudFormationClientConfig] = None,
    registration_token: Optional[
        "capo_cloudformation.types.registration_token.RegistrationToken"
    ] = None,
) -> "capo_cloudformation.types.describe_type_registration_output.DescribeTypeRegistrationOutput":
    """<p>Returns information about an extension's registration, including its current status and type and version identifiers.</p> <p>When you initiate a registration request using <a>RegisterType</a>, you can then use <a>DescribeTypeRegistration</a> to monitor the progress of that registration request.</p> <p>Once the registration request has completed, use <a>DescribeType</a> to return detailed information about an extension.</p>

    Args:
        registration_token: <p>The identifier for this registration request.</p> <p>This registration token is generated by CloudFormation when you initiate a registration request using <a>RegisterType</a>.</p>

    Raises:
        capo_cloudformation.errors.cfn_registry_exception.CFNRegistryException: <p>An error occurred during a CloudFormation registry operation.</p>
        capo_cloudformation.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_cloudformation.types.describe_type_registration_input.DescribeTypeRegistrationInput]",
    ) -> OperationResponse[
        "capo_cloudformation.types.describe_type_registration_output.DescribeTypeRegistrationOutput"
    ]:
        import capo_cloudformation._operations.cloud_formation.describe_type_registration

        output, http_response = (
            capo_cloudformation._operations.cloud_formation.describe_type_registration.describe_type_registration(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeTypeRegistration")
    )
    input_: capo_cloudformation.types.describe_type_registration_input.DescribeTypeRegistrationInput = {}
    if registration_token is not None:
        input_["registration_token"] = registration_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output