describe_package_version

CodeArtifact.Client.describe_package_version(**kwargs)

Returns a PackageVersionDescription object that contains information about the requested package version.

See also: AWS API Documentation

Request Syntax

response = client.describe_package_version(
    domain='string',
    domainOwner='string',
    repository='string',
    format='npm'|'pypi'|'maven'|'nuget'|'generic',
    namespace='string',
    package='string',
    packageVersion='string'
)

Parameters

• domain (string) --

  [REQUIRED]

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

• domainOwner (string) -- The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
• repository (string) --

  [REQUIRED]

  The name of the repository that contains the package version.

• format (string) --

  [REQUIRED]

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

• namespace (string) --

  The namespace of the requested package version. The package version 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 package version is its scope .
  • Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
  • The namespace of a generic package is it’s namespace .
• package (string) --

  [REQUIRED]

  The name of the requested package version.

• packageVersion (string) --

  [REQUIRED]

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

Return type

dict

Returns

Response Syntax

{
    'packageVersion': {
        'format': 'npm'|'pypi'|'maven'|'nuget'|'generic',
        '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 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 version 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 package version is its scope .
      • Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
      • The namespace of a generic package is it’s 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 object that contains information about how the package version was added to the repository.

      • domainEntryPoint (dict) --

        A DomainEntryPoint 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

• CodeArtifact.Client.exceptions.AccessDeniedException
• CodeArtifact.Client.exceptions.ConflictException
• CodeArtifact.Client.exceptions.InternalServerException
• CodeArtifact.Client.exceptions.ResourceNotFoundException
• CodeArtifact.Client.exceptions.ThrottlingException
• CodeArtifact.Client.exceptions.ValidationException