:doc:`ElasticBeanstalk <../../elasticbeanstalk>` / Client / describe_application_versions

*****************************
describe_application_versions
*****************************



.. py:method:: ElasticBeanstalk.Client.describe_application_versions(**kwargs)

  

  Retrieve a list of application versions.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DescribeApplicationVersions>`_  


  **Request Syntax**
  ::

    response = client.describe_application_versions(
        ApplicationName='string',
        VersionLabels=[
            'string',
        ],
        MaxRecords=123,
        NextToken='string'
    )
    
  :type ApplicationName: string
  :param ApplicationName: 

    Specify an application name to show only application versions for that application.

    

  
  :type VersionLabels: list
  :param VersionLabels: 

    Specify a version label to show a specific application version.

    

  
    - *(string) --* 

    

  :type MaxRecords: integer
  :param MaxRecords: 

    For a paginated request. Specify a maximum number of application versions to include in each response.

     

    If no ``MaxRecords`` is specified, all available application versions are retrieved in a single response.

    

  
  :type NextToken: string
  :param NextToken: 

    For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.

     

    If no ``NextToken`` is specified, the first page is retrieved.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'ApplicationVersions': [
              {
                  'ApplicationVersionArn': 'string',
                  'ApplicationName': 'string',
                  'Description': 'string',
                  'VersionLabel': 'string',
                  'SourceBuildInformation': {
                      'SourceType': 'Git'|'Zip',
                      'SourceRepository': 'CodeCommit'|'S3',
                      'SourceLocation': 'string'
                  },
                  'BuildArn': 'string',
                  'SourceBundle': {
                      'S3Bucket': 'string',
                      'S3Key': 'string'
                  },
                  'DateCreated': datetime(2015, 1, 1),
                  'DateUpdated': datetime(2015, 1, 1),
                  'Status': 'Processed'|'Unprocessed'|'Failed'|'Processing'|'Building'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Result message wrapping a list of application version descriptions.

      
      

      - **ApplicationVersions** *(list) --* 

        List of ``ApplicationVersionDescription`` objects sorted in order of creation.

        
        

        - *(dict) --* 

          Describes the properties of an application version.

          
          

          - **ApplicationVersionArn** *(string) --* 

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

            
          

          - **ApplicationName** *(string) --* 

            The name of the application to which the application version belongs.

            
          

          - **Description** *(string) --* 

            The description of the application version.

            
          

          - **VersionLabel** *(string) --* 

            A unique identifier for the application version.

            
          

          - **SourceBuildInformation** *(dict) --* 

            If the version's source code was retrieved from AWS CodeCommit, the location of the source code for the application version.

            
            

            - **SourceType** *(string) --* 

              The type of repository.

               

              
              * ``Git``
               
              * ``Zip``
              

              
            

            - **SourceRepository** *(string) --* 

              Location where the repository is stored.

               

              
              * ``CodeCommit``
               
              * ``S3``
              

              
            

            - **SourceLocation** *(string) --* 

              The location of the source code, as a formatted string, depending on the value of ``SourceRepository``

               

              
              * For ``CodeCommit``, the format is the repository name and commit ID, separated by a forward slash. For example, ``my-git-repo/265cfa0cf6af46153527f55d6503ec030551f57a``.
               
              * For ``S3``, the format is the S3 bucket name and object key, separated by a forward slash. For example, ``my-s3-bucket/Folders/my-source-file``.
              

              
        
          

          - **BuildArn** *(string) --* 

            Reference to the artifact from the AWS CodeBuild build.

            
          

          - **SourceBundle** *(dict) --* 

            The storage location of the application version's source bundle in Amazon S3.

            
            

            - **S3Bucket** *(string) --* 

              The Amazon S3 bucket where the data is located.

              
            

            - **S3Key** *(string) --* 

              The Amazon S3 key where the data is located.

              
        
          

          - **DateCreated** *(datetime) --* 

            The creation date of the application version.

            
          

          - **DateUpdated** *(datetime) --* 

            The last modified date of the application version.

            
          

          - **Status** *(string) --* 

            The processing status of the application version. Reflects the state of the application version during its creation. Many of the values are only applicable if you specified ``True`` for the ``Process`` parameter of the ``CreateApplicationVersion`` action. The following list describes the possible values.

             

            
            * ``Unprocessed`` – Application version wasn't pre-processed or validated. Elastic Beanstalk will validate configuration files during deployment of the application version to an environment.
             
            * ``Processing`` – Elastic Beanstalk is currently processing the application version.
             
            * ``Building`` – Application version is currently undergoing an AWS CodeBuild build.
             
            * ``Processed`` – Elastic Beanstalk was successfully pre-processed and validated.
             
            * ``Failed`` – Either the AWS CodeBuild build failed or configuration files didn't pass validation. This application version isn't usable.
            

            
      
    
      

      - **NextToken** *(string) --* 

        In a paginated request, the token that you can pass in a subsequent request to get the next response page.

        
  

  **Examples**

  The following operation retrieves information about an application version labeled v2:
  ::

    response = client.describe_application_versions(
        ApplicationName='my-app',
        VersionLabels=[
            'v2',
        ],
    )
    
    print(response)

  
  Expected Output:
  ::

    {
        'ApplicationVersions': [
            {
                'ApplicationName': 'my-app',
                'DateCreated': datetime(2015, 7, 23, 1, 32, 26, 3, 204, 0),
                'DateUpdated': datetime(2015, 7, 23, 1, 32, 26, 3, 204, 0),
                'Description': 'update cover page',
                'SourceBundle': {
                    'S3Bucket': 'elasticbeanstalk-us-west-2-015321684451',
                    'S3Key': 'my-app/5026-stage-150723_224258.war',
                },
                'VersionLabel': 'v2',
            },
            {
                'ApplicationName': 'my-app',
                'DateCreated': datetime(2015, 7, 23, 22, 26, 10, 3, 204, 0),
                'DateUpdated': datetime(2015, 7, 23, 22, 26, 10, 3, 204, 0),
                'Description': 'initial version',
                'SourceBundle': {
                    'S3Bucket': 'elasticbeanstalk-us-west-2-015321684451',
                    'S3Key': 'my-app/5026-stage-150723_222618.war',
                },
                'VersionLabel': 'v1',
            },
        ],
        'ResponseMetadata': {
            '...': '...',
        },
    }

  