CodeArtifact / Client / publish_package_version

publish_package_version

CodeArtifact.Client.publish_package_version(**kwargs)

Creates a new package version containing one or more assets (or files).

The unfinished flag can be used to keep the package version in the Unfinished state until all of its assets have been uploaded (see Package version status in the CodeArtifact user guide). To set the package version’s status to Published, omit the unfinished flag when uploading the final asset, or set the status using UpdatePackageVersionStatus. Once a package version’s status is set to Published, it cannot change back to Unfinished.

Note

Only generic packages can be published using this API. For more information, see Using generic packages in the CodeArtifact User Guide.

See also: AWS API Documentation

Request Syntax

response = client.publish_package_version(
    domain='string',
    domainOwner='string',
    repository='string',
    format='npm'|'pypi'|'maven'|'nuget'|'generic',
    namespace='string',
    package='string',
    packageVersion='string',
    assetContent=b'bytes'|file,
    assetName='string',
    assetSHA256='string',
    unfinished=True|False
)

Parameters:

• domain (string) –

  [REQUIRED]

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

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

• repository (string) –

  [REQUIRED]

  The name of the repository that the package version will be published to.

• format (string) –

  [REQUIRED]

  A format that specifies the type of the package version with the requested asset file.

  The only supported value is generic.

• namespace (string) – The namespace of the package version to publish.

• package (string) –

  [REQUIRED]

  The name of the package version to publish.

• packageVersion (string) –

  [REQUIRED]

  The package version to publish (for example, 3.5.2).

• assetContent (bytes or seekable file-like object) –

  [REQUIRED]

  The content of the asset to publish.

• assetName (string) –

  [REQUIRED]

  The name of the asset to publish. Asset names can include Unicode letters and numbers, and the following special characters: ~ ! @ ^ & ( ) - ` _ + [ ] { } ; , . `

• assetSHA256 (string) –

  [REQUIRED]

  The SHA256 hash of the assetContent to publish. This value must be calculated by the caller and provided with the request (see Publishing a generic package in the CodeArtifact User Guide).

  This value is used as an integrity check to verify that the assetContent has not changed after it was originally sent.

• unfinished (boolean) –

  Specifies whether the package version should remain in the unfinished state. If omitted, the package version status will be set to Published (see Package version status in the CodeArtifact User Guide).

  Valid values: unfinished

Return type:

dict

Returns:

Response Syntax

{
    'format': 'npm'|'pypi'|'maven'|'nuget'|'generic',
    'namespace': 'string',
    'package': 'string',
    'version': 'string',
    'versionRevision': 'string',
    'status': 'Published'|'Unfinished'|'Unlisted'|'Archived'|'Disposed'|'Deleted',
    'asset': {
        'name': 'string',
        'size': 123,
        'hashes': {
            'string': 'string'
        }
    }
}

Response Structure

• (dict) –

  • format (string) –

    The format of the package version.

  • namespace (string) –

    The namespace of the package version.

  • package (string) –

    The name of the package.

  • version (string) –

    The version of the package.

  • versionRevision (string) –

    The revision of the package version.

  • status (string) –

    A string that contains the status of the package version. For more information, see Package version status in the CodeArtifact User Guide.

  • asset (dict) –

    An AssetSummary for the published asset.

    • name (string) –

      The name of the asset.

    • size (integer) –

      The size of the asset.

    • hashes (dict) –

      The hashes of the asset.

      • (string) –

        • (string) –

Exceptions

• CodeArtifact.Client.exceptions.AccessDeniedException

• CodeArtifact.Client.exceptions.ConflictException

• CodeArtifact.Client.exceptions.InternalServerException

• CodeArtifact.Client.exceptions.ResourceNotFoundException

• CodeArtifact.Client.exceptions.ServiceQuotaExceededException

• CodeArtifact.Client.exceptions.ThrottlingException

• CodeArtifact.Client.exceptions.ValidationException