Updates the status of one or more versions of a package¶

Description¶

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

Usage¶

codeartifact_update_package_versions_status(domain, domainOwner,
  repository, format, namespace, package, versions, versionRevisions,
  expectedStatus, targetStatus)

Arguments¶

• domain

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

• domainOwner

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

• repository

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

• format

  [required] A format that specifies the type of the package with the statuses to update.

• 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.

• package

  [required] The name of the package with the version statuses to update.

• versions

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

• 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.

• 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 update_package_versions_status is called matches expectedStatus.

• targetStatus

  [required] The status you want to change the package version status to.

Value¶

A list with the following syntax:

list(
  successfulVersions = list(
    list(
      revision = "string",
      status = "Published"|"Unfinished"|"Unlisted"|"Archived"|"Disposed"|"Deleted"
    )
  ),
  failedVersions = list(
    list(
      errorCode = "ALREADY_EXISTS"|"MISMATCHED_REVISION"|"MISMATCHED_STATUS"|"NOT_ALLOWED"|"NOT_FOUND"|"SKIPPED",
      errorMessage = "string"
    )
  )
)

Request syntax¶

svc$update_package_versions_status(
  domain = "string",
  domainOwner = "string",
  repository = "string",
  format = "npm"|"pypi"|"maven"|"nuget"|"generic"|"ruby"|"swift"|"cargo",
  namespace = "string",
  package = "string",
  versions = list(
    "string"
  ),
  versionRevisions = list(
    "string"
  ),
  expectedStatus = "Published"|"Unfinished"|"Unlisted"|"Archived"|"Disposed"|"Deleted",
  targetStatus = "Published"|"Unfinished"|"Unlisted"|"Archived"|"Disposed"|"Deleted"
)