Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . cloudformation ]

describe-type-registration

Description

Returns information about a type'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 informaiton about a type.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-type-registration
--registration-token <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--registration-token (string)

The identifier for this registration request.

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To display type registration information

The following describe-type-registration example displays information about the specified type registration, including the type's current status, type, and version.

aws cloudformation describe-type-registration \
    --registration-token a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Output:

{
    "ProgressStatus": "COMPLETE",
    "TypeArn": "arn:aws:cloudformation:us-west-2:123456789012:type/resource/My-Logs-LogGroup",
    "Description": "Deployment is currently in DEPLOY_STAGE of status COMPLETED; ",
    "TypeVersionArn": "arn:aws:cloudformation:us-west-2:123456789012:type/resource/My-Logs-LogGroup/00000001"
}

For more information, see Using the CloudFormation Registry in the AWS CloudFormation Users Guide.

Output

ProgressStatus -> (string)

The current status of the type registration request.

Description -> (string)

The description of the type registration request.

TypeArn -> (string)

The Amazon Resource Name (ARN) of the type 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 type being registered.

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