:doc:`CodeArtifact <../../codeartifact>` / Client / describe_package_version

************************
describe_package_version
************************



.. py:method:: CodeArtifact.Client.describe_package_version(**kwargs)

  

  Returns a `PackageVersionDescription <https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html>`__ object that contains information about the requested package version.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/DescribePackageVersion>`_  


  **Request Syntax**
  ::

    response = client.describe_package_version(
        domain='string',
        domainOwner='string',
        repository='string',
        format='npm'|'pypi'|'maven'|'nuget'|'generic'|'ruby'|'swift'|'cargo',
        namespace='string',
        package='string',
        packageVersion='string'
    )
    
  :type domain: string
  :param domain: **[REQUIRED]** 

    The name of the domain that contains the repository that contains the package version.

    

  
  :type domainOwner: string
  :param domainOwner: 

    The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

    

  
  :type repository: string
  :param repository: **[REQUIRED]** 

    The name of the repository that contains the package version.

    

  
  :type format: string
  :param format: **[REQUIRED]** 

    A format that specifies the type of the requested package version.

    

  
  :type namespace: string
  :param namespace: 

    The namespace of the requested package version. The package component that specifies its namespace depends on its type. For example:

     

    .. note::

      

      The namespace is required when requesting package versions of the following formats:

       

      
      * Maven
       
      * Swift
       
      * generic
      

      

     

    
    * The namespace of a Maven package version is its ``groupId``.
     
    * The namespace of an npm or Swift package version is its ``scope``.
     
    * The namespace of a generic package is its ``namespace``.
     
    * Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
    

    

  
  :type package: string
  :param package: **[REQUIRED]** 

    The name of the requested package version.

    

  
  :type packageVersion: string
  :param packageVersion: **[REQUIRED]** 

    A string that contains the package version (for example, ``3.5.2``).

    

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

    
    ::

      {
          'packageVersion': {
              'format': 'npm'|'pypi'|'maven'|'nuget'|'generic'|'ruby'|'swift'|'cargo',
              'namespace': 'string',
              'packageName': 'string',
              'displayName': 'string',
              'version': 'string',
              'summary': 'string',
              'homePage': 'string',
              'sourceCodeRepository': 'string',
              'publishedTime': datetime(2015, 1, 1),
              'licenses': [
                  {
                      'name': 'string',
                      'url': 'string'
                  },
              ],
              'revision': 'string',
              'status': 'Published'|'Unfinished'|'Unlisted'|'Archived'|'Disposed'|'Deleted',
              'origin': {
                  'domainEntryPoint': {
                      'repositoryName': 'string',
                      'externalConnectionName': 'string'
                  },
                  'originType': 'INTERNAL'|'EXTERNAL'|'UNKNOWN'
              }
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **packageVersion** *(dict) --* 

        A `PackageVersionDescription <https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html>`__ object that contains information about the requested package version.

        
        

        - **format** *(string) --* 

          The format of the package version.

          
        

        - **namespace** *(string) --* 

          The namespace of the package version. The package component that specifies its namespace depends on its type. For example:

           

          
          * The namespace of a Maven package version is its ``groupId``.
           
          * The namespace of an npm or Swift package version is its ``scope``.
           
          * The namespace of a generic package is its ``namespace``.
           
          * Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
          

          
        

        - **packageName** *(string) --* 

          The name of the requested package.

          
        

        - **displayName** *(string) --* 

          The name of the package that is displayed. The ``displayName`` varies depending on the package version's format. For example, if an npm package is named ``ui``, is in the namespace ``vue``, and has the format ``npm``, then the ``displayName`` is ``@vue/ui``.

          
        

        - **version** *(string) --* 

          The version of the package.

          
        

        - **summary** *(string) --* 

          A summary of the package version. The summary is extracted from the package. The information in and detail level of the summary depends on the package version's format.

          
        

        - **homePage** *(string) --* 

          The homepage associated with the package.

          
        

        - **sourceCodeRepository** *(string) --* 

          The repository for the source code in the package version, or the source code used to build it.

          
        

        - **publishedTime** *(datetime) --* 

          A timestamp that contains the date and time the package version was published.

          
        

        - **licenses** *(list) --* 

          Information about licenses associated with the package version.

          
          

          - *(dict) --* 

            Details of the license data.

            
            

            - **name** *(string) --* 

              Name of the license.

              
            

            - **url** *(string) --* 

              The URL for license data.

              
        
      
        

        - **revision** *(string) --* 

          The revision of the package version.

          
        

        - **status** *(string) --* 

          A string that contains the status of the package version.

          
        

        - **origin** *(dict) --* 

          A `PackageVersionOrigin <https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionOrigin.html>`__ object that contains information about how the package version was added to the repository.

          
          

          - **domainEntryPoint** *(dict) --* 

            A `DomainEntryPoint <https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DomainEntryPoint.html>`__ object that contains information about from which repository or external connection the package version was added to the domain.

            
            

            - **repositoryName** *(string) --* 

              The name of the repository that a package was originally published to.

              
            

            - **externalConnectionName** *(string) --* 

              The name of the external connection that a package was ingested from.

              
        
          

          - **originType** *(string) --* 

            Describes how the package version was originally added to the domain. An ``INTERNAL`` origin type means the package version was published directly to a repository in the domain. An ``EXTERNAL`` origin type means the package version was ingested from an external connection.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`CodeArtifact.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`CodeArtifact.Client.exceptions.ConflictException`

  
  *   :py:class:`CodeArtifact.Client.exceptions.InternalServerException`

  
  *   :py:class:`CodeArtifact.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`CodeArtifact.Client.exceptions.ThrottlingException`

  
  *   :py:class:`CodeArtifact.Client.exceptions.ValidationException`

  