Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

PublishPackageVersion

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 AWS CodeArtifact User Guide.

Request Syntax


POST /v1/package/version/publish?asset=assetName&domain=domain&domain-owner=domainOwner&format=format&namespace=namespace&package=package&repository=repository&unfinished=unfinished&version=packageVersion HTTP/1.1
x-amz-content-sha256: assetSHA256

assetContent

URI Request Parameters

The request uses the following URI parameters.

assetName

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

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: \P{C}+

Required: Yes

assetSHA256

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 AWS CodeArtifact User Guide).

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

Length Constraints: Fixed length of 64.

Pattern: [0-9a-f]+

Required: Yes

domain

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

Length Constraints: Minimum length of 2. Maximum length of 50.

Pattern: [a-z][a-z0-9\-]{0,48}[a-z0-9]

Required: Yes

domainOwner

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

Length Constraints: Fixed length of 12.

Pattern: [0-9]{12}

format

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

Valid Values: generic

Required: Yes

namespace

The namespace of the package version to publish.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [^#/\s]+

package

The name of the package version to publish.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [^#/\s]+

Required: Yes

packageVersion

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

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [^#/\s]+

Required: Yes

repository

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

Length Constraints: Minimum length of 2. Maximum length of 100.

Pattern: [A-Za-z0-9][A-Za-z0-9._\-]{1,99}

Required: Yes

unfinished

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

Request Body

The request accepts the following binary data.

assetContent

The content of the asset to publish.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "asset": { 
      "hashes": { 
         "string" : "string" 
      },
      "name": "string",
      "size": number
   },
   "format": "string",
   "namespace": "string",
   "package": "string",
   "status": "string",
   "version": "string",
   "versionRevision": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

asset

An AssetSummary for the published asset.

Type: AssetSummary object

format

The format of the package version.

Type: String

Valid Values: generic

namespace

The namespace of the package version.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [^#/\s]+

package

The name of the package.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [^#/\s]+

status

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

Type: String

version

The version of the package.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [^#/\s]+

versionRevision

The revision of the package version.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50.

Pattern: \S+

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The operation did not succeed because of an unauthorized access attempt.

HTTP Status Code: 403

ConflictException

The operation did not succeed because prerequisites are not met.

HTTP Status Code: 409

InternalServerException

The operation did not succeed because of an error that occurred inside AWS CodeArtifact.

HTTP Status Code: 500

ResourceNotFoundException

The operation did not succeed because the resource requested is not found in the service.

HTTP Status Code: 404

ServiceQuotaExceededException

The operation did not succeed because it would have exceeded a service limit for your account.

HTTP Status Code: 402

ThrottlingException

The operation did not succeed because too many requests are sent to the service.

HTTP Status Code: 429

ValidationException

The operation did not succeed because a parameter in the request was sent with an invalid value.

HTTP Status Code: 400