:doc:`CloudFormation <../../cloudformation>` / Client / list_type_versions

******************
list_type_versions
******************



.. py:method:: CloudFormation.Client.list_type_versions(**kwargs)

  

  Returns summary information about the versions of an extension.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListTypeVersions>`_  


  **Request Syntax**
  ::

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

    The kind of the extension.

     

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

    

  
  :type TypeName: string
  :param TypeName: 

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

     

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

    

  
  :type Arn: string
  :param Arn: 

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

    

  
  :type MaxResults: integer
  :param MaxResults: 

    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.

    

  
  :type NextToken: string
  :param NextToken: 

    The token for the next set of items to return. (You received this token from a previous call.)

    

  
  :type DeprecatedStatus: string
  :param DeprecatedStatus: 

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

    

  
  :type PublisherId: string
  :param PublisherId: 

    The publisher ID of the extension publisher.

     

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

    

  
  
  :rtype: 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 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 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-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 <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html#registry-public-enable-auto>`__ 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**
  
  *   :py:class:`CloudFormation.Client.exceptions.CFNRegistryException`

  