Skip to content

CopyPackageVersionsRequest

Source code in docs_src/capo_codeartifact/types/copy_package_versions_request.py
class CopyPackageVersionsRequest(TypedDict, closed=True):
    domain: "capo_codeartifact.types.domain_name.DomainName"
    """<p> The name of the domain that contains the source and destination repositories. </p>"""
    domain_owner: NotRequired["capo_codeartifact.types.account_id.AccountId"]
    """<p> The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. </p>"""
    source_repository: "capo_codeartifact.types.repository_name.RepositoryName"
    """<p> The name of the repository that contains the package versions to be copied. </p>"""
    destination_repository: "capo_codeartifact.types.repository_name.RepositoryName"
    """<p> The name of the repository into which package versions are copied. </p>"""
    format: "capo_codeartifact.types.package_format.PackageFormat"
    """<p> The format of the package versions to be copied. </p>"""
    namespace: NotRequired["capo_codeartifact.types.package_namespace.PackageNamespace"]
    """<p>The namespace of the package versions to be copied. The package component that specifies its namespace depends on its type. For example:</p> <note> <p>The namespace is required when copying package versions of the following formats:</p> <ul> <li> <p>Maven</p> </li> <li> <p>Swift</p> </li> <li> <p>generic</p> </li> </ul> </note> <ul> <li> <p> The namespace of a Maven package version is its <code>groupId</code>. </p> </li> <li> <p> The namespace of an npm or Swift package version is its <code>scope</code>. </p> </li> <li> <p>The namespace of a generic package is its <code>namespace</code>.</p> </li> <li> <p> Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace. </p> </li> </ul>"""
    package: "capo_codeartifact.types.package_name.PackageName"
    """<p> The name of the package that contains the versions to be copied. </p>"""
    versions: NotRequired[
        "capo_codeartifact.types.package_version_list.PackageVersionList"
    ]
    """<p> The versions of the package to be copied. </p> <note> <p> You must specify <code>versions</code> or <code>versionRevisions</code>. You cannot specify both. </p> </note>"""
    version_revisions: NotRequired[
        "capo_codeartifact.types.package_version_revision_map.PackageVersionRevisionMap"
    ]
    """<p> A list of key-value pairs. The keys are package versions and the values are package version revisions. A <code>CopyPackageVersion</code> operation succeeds if the specified versions in the source repository match the specified package version revision. </p> <note> <p> You must specify <code>versions</code> or <code>versionRevisions</code>. You cannot specify both. </p> </note>"""
    allow_overwrite: NotRequired[
        "capo_codeartifact.types.boolean_optional.BooleanOptional"
    ]
    """<p> Set to true to overwrite a package version that already exists in the destination repository. If set to false and the package version already exists in the destination repository, the package version is returned in the <code>failedVersions</code> field of the response with an <code>ALREADY_EXISTS</code> error code. </p>"""
    include_from_upstream: NotRequired[
        "capo_codeartifact.types.boolean_optional.BooleanOptional"
    ]
    """<p> Set to true to copy packages from repositories that are upstream from the source repository to the destination repository. The default setting is false. For more information, see <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html">Working with upstream repositories</a>. </p>"""

allow_overwrite instance-attribute

allow_overwrite: NotRequired[BooleanOptional]

Set to true to overwrite a package version that already exists in the destination repository. If set to false and the package version already exists in the destination repository, the package version is returned in the failedVersions field of the response with an ALREADY_EXISTS error code.

destination_repository instance-attribute

destination_repository: RepositoryName

The name of the repository into which package versions are copied.

domain instance-attribute

domain: DomainName

The name of the domain that contains the source and destination repositories.

domain_owner instance-attribute

domain_owner: NotRequired[AccountId]

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

format instance-attribute

format: PackageFormat

The format of the package versions to be copied.

include_from_upstream instance-attribute

include_from_upstream: NotRequired[BooleanOptional]

Set to true to copy packages from repositories that are upstream from the source repository to the destination repository. The default setting is false. For more information, see Working with upstream repositories.

namespace instance-attribute

namespace: NotRequired[PackageNamespace]

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

The namespace is required when copying 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 instance-attribute

package: PackageName

The name of the package that contains the versions to be copied.

source_repository instance-attribute

source_repository: RepositoryName

The name of the repository that contains the package versions to be copied.

version_revisions instance-attribute

version_revisions: NotRequired[PackageVersionRevisionMap]

A list of key-value pairs. The keys are package versions and the values are package version revisions. A CopyPackageVersion operation succeeds if the specified versions in the source repository match the specified package version revision.

You must specify versions or versionRevisions. You cannot specify both.

versions instance-attribute

versions: NotRequired[PackageVersionList]

The versions of the package to be copied.

You must specify versions or versionRevisions. You cannot specify both.