[ aws . cloudformation ]
Returns summary information about the versions of an extension.
See also: AWS API Documentation
list-type-versions
[--type <value>]
[--type-name <value>]
[--arn <value>]
[--max-results <value>]
[--next-token <value>]
[--deprecated-status <value>]
[--publisher-id <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
--type
(string)
The kind of the extension.
Conditional: You must specify either
TypeName
andType
, orArn
.Possible values:
RESOURCE
MODULE
HOOK
--type-name
(string)
The name of the extension for which you want version summary information.
Conditional: You must specify either
TypeName
andType
, orArn
.
--arn
(string)
The Amazon Resource Name (ARN) of the extension for which you want version summary information.
Conditional: You must specify either
TypeName
andType
, orArn
.
--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 aNextToken
value that you can assign to theNextToken
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’sNextToken
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’sNextToken
parameter. If there are no remaining results, the previous response object’sNextToken
parameter is set tonull
.
--deprecated-status
(string)
The deprecation status of the extension versions that you want to get summary information about.
Valid values include:
LIVE
: The extension version is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.DEPRECATED
: The extension version has been deregistered and can no longer be used in CloudFormation operations.The default is
LIVE
.Possible values:
LIVE
DEPRECATED
--publisher-id
(string)
The publisher ID of the extension publisher.
Extensions published by Amazon aren’t assigned a publisher ID.
--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command’s default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format
(string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb://
will always be treated as binary and use the file contents directly regardless of the cli-binary-format
setting. When using file://
the file contents will need to properly formatted for the configured cli-binary-format
.
--no-cli-pager
(boolean)
Disable cli pager for output.
--cli-auto-prompt
(boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt
(boolean)
Disable automatically prompt for CLI input parameters.
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To list an extension’s version
The following list-type-versions
example returns summary information about the versions of an extension.
aws cloudformation list-type-versions \
--endpoint https://example.com \
--region us-west-2 \
--type RESOURCE \
--type-name My::Resource::Example \
--publisher-id 123456789012
This command produces no output.
For more information, see Using the AWS CloudFormation registry in the AWS CloudFormation User Guide.
TypeVersionSummaries -> (list)
A list of
TypeVersionSummary
structures that contain information about the specified extension’s versions.(structure)
Contains summary information about a specific version of a CloudFormation extension.
Type -> (string)
The kind of extension.TypeName -> (string)
The name of the extension.VersionId -> (string)
The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it’s registered.IsDefaultVersion -> (boolean)
Whether the specified extension version is set as the default version.
This applies only to private extensions you have registered in your account, and extensions published by Amazon. For public third-party extensions, CloudFormation returns
null
.Arn -> (string)
The Amazon Resource Name (ARN) of the extension version.TimeCreated -> (timestamp)
When the version was registered.Description -> (string)
The description of the extension version.PublicVersionNumber -> (string)
For public extensions that have been activated for this account and Region, the version of the public extension to be used for CloudFormation operations in this account and Region. For any extensions other than activated third-party extensions, CloudFormation returns
null
.How you specified
AutoUpdate
when enabling the extension affects whether CloudFormation automatically updates the extension in this account and Region when a new version is released. For more information, see Automatically use new versions of extensions in the CloudFormation User Guide .
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’sNextToken
parameter. If the request returns all results,NextToken
is set tonull
.