[ aws . cloudformation ]
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
See ‘aws help’ for descriptions of global parameters.
describe-type-registration
--registration-token <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--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
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml
.
--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
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. 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.
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.
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 thanCOMPLETE
, this will benull
.
TypeVersionArn -> (string)
The Amazon Resource Name (ARN) of this specific version of the extension being registered.
For registration requests with a
ProgressStatus
of other thanCOMPLETE
, this will benull
.