Deletes the assets in package versions and sets the package versions' status to Disposed¶

Description¶

Deletes the assets in package versions and sets the package versions' status to Disposed. A disposed package version cannot be restored in your repository because its assets are deleted.

To view all disposed package versions in a repository, use list_package_versions and set the status parameter to Disposed.

To view information about a disposed package version, use describe_package_version.

Usage¶

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

Arguments¶

• domain

  [required] The name of the domain that contains the repository you want to dispose.

• 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 name of the repository that contains the package versions you want to dispose.

• format

  [required] A format that specifies the type of package versions you want to dispose.

• namespace

  The namespace of the package versions to be disposed. The package component that specifies its namespace depends on its type. For example:

  The namespace is required when disposing package versions of the following formats:

  • Maven
  • Swift
  • generic
  • 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 versions you want to dispose.

• versions

  [required] The versions of the package you want to dispose.

• versionRevisions

  The revisions of the package versions you want to dispose.

• expectedStatus

  The expected status of the package version to dispose.

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$dispose_package_versions(
  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"
)