CloudFormation / Client / describe_type_registration

describe_type_registration#

CloudFormation.Client.describe_type_registration(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_type_registration(
    RegistrationToken='string'
)
Parameters:

RegistrationToken (string) –

[REQUIRED]

The identifier for this registration request.

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

Return type:

dict

Returns:

Response Syntax

{
    'ProgressStatus': 'COMPLETE'|'IN_PROGRESS'|'FAILED',
    'Description': 'string',
    'TypeArn': 'string',
    'TypeVersionArn': 'string'
}

Response Structure

  • (dict) –

    • ProgressStatus (string) –

      The current status of the extension registration request.

    • Description (string) –

      The description of the extension registration request.

    • TypeArn (string) –

      The Amazon Resource Name (ARN) of the extension being registered.

      For registration requests with a ProgressStatus of other than COMPLETE , this will be null .

    • TypeVersionArn (string) –

      The Amazon Resource Name (ARN) of this specific version of the extension being registered.

      For registration requests with a ProgressStatus of other than COMPLETE , this will be null .

Exceptions

  • CloudFormation.Client.exceptions.CFNRegistryException