[ aws . cloudformation ]

list-type-versions

Description

Returns summary information about the versions of a type.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-type-versions
[--type <value>]
[--type-name <value>]
[--arn <value>]
[--max-results <value>]
[--next-token <value>]
[--deprecated-status <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--type (string)

The kind of the type.

Currently the only valid value is RESOURCE .

Conditional: You must specify either TypeName and Type , or Arn .

Possible values:

• RESOURCE

--type-name (string)

The name of the type for which you want version summary information.

Conditional: You must specify either TypeName and Type , or Arn .

--arn (string)

The Amazon Resource Name (ARN) of the type for which you want version summary information.

Conditional: You must specify either TypeName and Type , or Arn .

--max-results (integer)

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

--next-token (string)

If the previous paginated request didn’t return all of the remaining results, the response object’s NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object’s NextToken parameter. If there are no remaining results, the previous response object’s NextToken parameter is set to null .

--deprecated-status (string)

The deprecation status of the type versions that you want to get summary information about.

Valid values include:

• LIVE : The type version is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.

• DEPRECATED : The type version has been deregistered and can no longer be used in CloudFormation operations.

The default is LIVE .

Possible values:

• LIVE

• DEPRECATED

--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.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To list versions of a type

The following list-type-versions example displays summary information of each version of the specified type whose status is LIVE.

aws cloudformation list-type-versions \
    --type RESOURCE \
    --type-name My::Logs::LogGroup \
    --deprecated-status LIVE

Output:

{
    "TypeVersionSummaries": [
        {
            "Description": "Customized resource derived from AWS::Logs::LogGroup",
            "TimeCreated": "2019-12-03T23:29:33.321Z",
            "TypeName": "My::Logs::LogGroup",
            "VersionId": "00000001",
            "Type": "RESOURCE",
            "Arn": "arn:aws:cloudformation:us-west-2:123456789012:type/resource/My-Logs-LogGroup/00000001"
        },
        {
            "Description": "Customized resource derived from AWS::Logs::LogGroup",
            "TimeCreated": "2019-12-04T06:58:14.902Z",
            "TypeName": "My::Logs::LogGroup",
            "VersionId": "00000002",
            "Type": "RESOURCE",
            "Arn": "arn:aws:cloudformation:us-west-2:123456789012:type/resource/My-Logs-LogGroup/00000002"
        }
    ]
}

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

Output

TypeVersionSummaries -> (list)

A list of TypeVersionSummary structures that contain information about the specified type’s versions.

(structure)

Contains summary information about a specific version of a CloudFormation type.

Type -> (string)

The kind of type.

TypeName -> (string)

The name of the type.

VersionId -> (string)

The ID of a specific version of the type. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the type version when it is registered.

IsDefaultVersion -> (boolean)

Whether the specified type version is set as the default version.

Arn -> (string)

The Amazon Resource Name (ARN) of the type version.

TimeCreated -> (timestamp)

When the version was registered.

Description -> (string)

The description of the type version.

NextToken -> (string)

If the request doesn’t return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object’s NextToken parameter. If the request returns all results, NextToken is set to null .