CodeArtifact

Deletes a package and all associated package versions. A deleted package cannot be restored. To delete one or more package versions, use the DeletePackageVersions API.

See also: AWS API Documentation

Request Syntax

client.delete_package(
    domain='string',
    domainOwner='string',
    repository='string',
    format='npm'|'pypi'|'maven'|'nuget',
    namespace='string',
    package='string'
)

type domain

string

param domain

[REQUIRED]

The name of the domain that contains the package to delete.

type domainOwner

string

param domainOwner

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

type repository

string

param repository

[REQUIRED]

The name of the repository that contains the package to delete.

type format

string

param format

[REQUIRED]

The format of the requested package to delete.

type namespace

string

param namespace

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

• The namespace of a Maven package is its groupId . The namespace is required when deleting Maven package versions.

• The namespace of an npm package is its scope .

• Python and NuGet packages do not contain corresponding components, packages of those formats do not have a namespace.

type package

string

param package

[REQUIRED]

The name of the package to delete.

rtype

dict

returns

Response Syntax

{
    'deletedPackage': {
        'format': 'npm'|'pypi'|'maven'|'nuget',
        'namespace': 'string',
        'package': 'string',
        'originConfiguration': {
            'restrictions': {
                'publish': 'ALLOW'|'BLOCK',
                'upstream': 'ALLOW'|'BLOCK'
            }
        }
    }
}

Response Structure

• (dict) --

  • deletedPackage (dict) --

    Details about a package, including its format, namespace, and name.

    • format (string) --

      The format of the package.

    • namespace (string) --

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

      • The namespace of a Maven package is its groupId .

      • The namespace of an npm package is its scope .

      • Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.

    • package (string) --

      The name of the package.

    • originConfiguration (dict) --

      A PackageOriginConfiguration object that contains a PackageOriginRestrictions object that contains information about the upstream and publish package origin restrictions.

      • restrictions (dict) --

        A PackageOriginRestrictions object that contains information about the upstream and publish package origin configuration for the package.

        • publish (string) --

          The package origin configuration that determines if new versions of the package can be published directly to the repository.

        • upstream (string) --

          The package origin configuration that determines if new versions of the package can be added to the repository from an external connection or upstream source.