You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CodeArtifact::Types::CopyPackageVersionsRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CopyPackageVersionsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  domain: "DomainName", # required
  domain_owner: "AccountId",
  source_repository: "RepositoryName", # required
  destination_repository: "RepositoryName", # required
  format: "npm", # required, accepts npm, pypi, maven
  namespace: "PackageNamespace",
  package: "PackageName", # required
  versions: ["PackageVersion"],
  version_revisions: {
    "PackageVersion" => "PackageVersionRevision",
  },
  allow_overwrite: false,
  include_from_upstream: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#allow_overwrite ⇒ Boolean

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.

Returns:

  • (Boolean) —

    Set to true to overwrite a package version that already exists in the destination repository.

#destination_repository ⇒ String

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

Returns:

  • (String) —

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

#domain ⇒ String

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

Returns:

  • (String) —

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

#domain_owner ⇒ String

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

Returns:

  • (String) —

    The 12-digit account number of the AWS account that owns the domain.

#format ⇒ String

The format of the package that is copied. The valid package types are:

  • npm: A Node Package Manager (npm) package.

  • pypi: A Python Package Index (PyPI) package.

  • maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.

    Possible values:

    • npm
    • pypi
    • maven

Returns:

  • (String) —

    The format of the package that is copied.

#include_from_upstream ⇒ Boolean

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.

Returns:

  • (Boolean) —

    Set to true to copy packages from repositories that are upstream from the source repository to the destination repository.

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

  • A Python package does not contain a corresponding component, so Python packages do not have a namespace.

Returns:

  • (String) —

    The namespace of the package.

#package ⇒ String

The name of the package that is copied.

Returns:

  • (String) —

    The name of the package that is copied.

#source_repository ⇒ String

The name of the repository that contains the package versions to copy.

Returns:

  • (String) —

    The name of the repository that contains the package versions to copy.

#version_revisions ⇒ Hash<String,String>

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.

Returns:

  • (Hash<String,String>) —

    A list of key-value pairs.

#versions ⇒ Array<String>

The versions of the package to copy.

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

Returns:

  • (Array<String>) —

    The versions of the package to copy.