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

UpdatePackageVersionsStatus

Updates the status of one or more versions of a package. Using UpdatePackageVersionsStatus, you can update the status of package versions to Archived, Published, or Unlisted. To set the status of a package version to Disposed, use DisposePackageVersions.

Request Syntax


POST /v1/package/versions/update_status?domain=domain&domain-owner=domainOwner&format=format&namespace=namespace&package=package&repository=repository HTTP/1.1
Content-type: application/json

{
   "expectedStatus": "string",
   "targetStatus": "string",
   "versionRevisions": { 
      "string" : "string" 
   },
   "versions": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

domain

The name of the domain that contains the repository that contains the package versions with a status to be updated.

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 with the statuses to update.

Required: Yes

namespace

The namespace of the package version to be updated. 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.

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

Pattern: [^#/\s]+

package

The name of the package with the version statuses to update.

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

Pattern: [^#/\s]+

Required: Yes

repository

The repository that contains the package versions with the status you want to update.

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

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

expectedStatus

The package version’s expected status before it is updated. If expectedStatus is provided, the package version's status is updated only if its status at the time UpdatePackageVersionsStatus is called matches expectedStatus.

Type: String

Valid Values: Archived | Published | Unlisted | Unfinished

Required: No

targetStatus

The status you want to change the package version status to.

Type: String

Valid Values: Archived | Published | Unlisted

Required: Yes

versionRevisions

A map of package versions and package version revisions. The map key is the package version (for example, 3.5.2), and the map value is the package version revision.

Type: String to string map

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

Key Pattern: [^#/\s]+

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

Value Pattern: \S+

Required: No

versions

An array of strings that specify the versions of the package with the statuses to update.

Type: Array of strings

Array Members: Maximum number of 100 items.

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

Pattern: [^#/\s]+

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "failedVersions": { 
      "string" : { 
         "errorCode": "string",
         "errorMessage": "string"
      }
   },
   "successfulVersions": { 
      "string" : { 
         "revision": "string",
         "status": "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.

failedVersions

A list of SuccessfulPackageVersionInfo objects, one for each package version with a status that successfully updated.

Type: String to PackageVersionError object map

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

Key Pattern: [^#/\s]+

successfulVersions

A list of PackageVersionError objects, one for each package version with a status that failed to update.

Type: String to SuccessfulPackageVersionInfo object map

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

Key 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

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