CloudFormation / Client / list_type_versions

list_type_versions

CloudFormation.Client.list_type_versions(**kwargs)

Returns summary information about the versions of an extension.

See also: AWS API Documentation

Request Syntax

response = client.list_type_versions(
    Type='RESOURCE'|'MODULE'|'HOOK',
    TypeName='string',
    Arn='string',
    MaxResults=123,
    NextToken='string',
    DeprecatedStatus='LIVE'|'DEPRECATED',
    PublisherId='string'
)

Parameters:

• Type (string) –

  The kind of the extension.

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

• TypeName (string) –

  The name of the extension 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 extension for which you want version summary information.

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

• MaxResults (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.

• NextToken (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.

• DeprecatedStatus (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.

• PublisherId (string) –

  The publisher ID of the extension publisher.

  Extensions published by Amazon aren’t assigned a publisher ID.

Return type:

dict

Returns:

Response Syntax

{
    'TypeVersionSummaries': [
        {
            'Type': 'RESOURCE'|'MODULE'|'HOOK',
            'TypeName': 'string',
            'VersionId': 'string',
            'IsDefaultVersion': True|False,
            'Arn': 'string',
            'TimeCreated': datetime(2015, 1, 1),
            'Description': 'string',
            'PublicVersionNumber': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • TypeVersionSummaries (list) –

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

    • (dict) –

      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 (datetime) –

        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-arty 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 Setting CloudFormation to 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’s NextToken parameter. If the request returns all results, NextToken is set to null.

Exceptions

• CloudFormation.Client.exceptions.CFNRegistryException