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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-codeartifact/types.rb

Overview

Note:

When making an API call, you may pass CopyPackageVersionsRequest data as a hash:

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

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) 


248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/aws-sdk-codeartifact/types.rb', line 248

class CopyPackageVersionsRequest < Struct.new(
  :domain,
  :domain_owner,
  :source_repository,
  :destination_repository,
  :format,
  :namespace,
  :package,
  :versions,
  :version_revisions,
  :allow_overwrite,
  :include_from_upstream)
  SENSITIVE = []
  include Aws::Structure
end

#destination_repository ⇒ String

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

Returns:

  • (String) 


248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/aws-sdk-codeartifact/types.rb', line 248

class CopyPackageVersionsRequest < Struct.new(
  :domain,
  :domain_owner,
  :source_repository,
  :destination_repository,
  :format,
  :namespace,
  :package,
  :versions,
  :version_revisions,
  :allow_overwrite,
  :include_from_upstream)
  SENSITIVE = []
  include Aws::Structure
end

#domain ⇒ String

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

Returns:

  • (String) 


248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/aws-sdk-codeartifact/types.rb', line 248

class CopyPackageVersionsRequest < Struct.new(
  :domain,
  :domain_owner,
  :source_repository,
  :destination_repository,
  :format,
  :namespace,
  :package,
  :versions,
  :version_revisions,
  :allow_overwrite,
  :include_from_upstream)
  SENSITIVE = []
  include Aws::Structure
end

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


248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/aws-sdk-codeartifact/types.rb', line 248

class CopyPackageVersionsRequest < Struct.new(
  :domain,
  :domain_owner,
  :source_repository,
  :destination_repository,
  :format,
  :namespace,
  :package,
  :versions,
  :version_revisions,
  :allow_overwrite,
  :include_from_upstream)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (String) 


248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/aws-sdk-codeartifact/types.rb', line 248

class CopyPackageVersionsRequest < Struct.new(
  :domain,
  :domain_owner,
  :source_repository,
  :destination_repository,
  :format,
  :namespace,
  :package,
  :versions,
  :version_revisions,
  :allow_overwrite,
  :include_from_upstream)
  SENSITIVE = []
  include Aws::Structure
end

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

[1]: docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html

Returns:

  • (Boolean) 


248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/aws-sdk-codeartifact/types.rb', line 248

class CopyPackageVersionsRequest < Struct.new(
  :domain,
  :domain_owner,
  :source_repository,
  :destination_repository,
  :format,
  :namespace,
  :package,
  :versions,
  :version_revisions,
  :allow_overwrite,
  :include_from_upstream)
  SENSITIVE = []
  include Aws::Structure
end

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


248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/aws-sdk-codeartifact/types.rb', line 248

class CopyPackageVersionsRequest < Struct.new(
  :domain,
  :domain_owner,
  :source_repository,
  :destination_repository,
  :format,
  :namespace,
  :package,
  :versions,
  :version_revisions,
  :allow_overwrite,
  :include_from_upstream)
  SENSITIVE = []
  include Aws::Structure
end

#package ⇒ String

The name of the package that is copied.

Returns:

  • (String) 


248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/aws-sdk-codeartifact/types.rb', line 248

class CopyPackageVersionsRequest < Struct.new(
  :domain,
  :domain_owner,
  :source_repository,
  :destination_repository,
  :format,
  :namespace,
  :package,
  :versions,
  :version_revisions,
  :allow_overwrite,
  :include_from_upstream)
  SENSITIVE = []
  include Aws::Structure
end

#source_repository ⇒ String

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

Returns:

  • (String) 


248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/aws-sdk-codeartifact/types.rb', line 248

class CopyPackageVersionsRequest < Struct.new(
  :domain,
  :domain_owner,
  :source_repository,
  :destination_repository,
  :format,
  :namespace,
  :package,
  :versions,
  :version_revisions,
  :allow_overwrite,
  :include_from_upstream)
  SENSITIVE = []
  include Aws::Structure
end

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

<note markdown=“1”> You must specify `versions` or `versionRevisions`. You cannot specify both.

</note>

Returns:

  • (Hash<String,String>) 


248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/aws-sdk-codeartifact/types.rb', line 248

class CopyPackageVersionsRequest < Struct.new(
  :domain,
  :domain_owner,
  :source_repository,
  :destination_repository,
  :format,
  :namespace,
  :package,
  :versions,
  :version_revisions,
  :allow_overwrite,
  :include_from_upstream)
  SENSITIVE = []
  include Aws::Structure
end

#versions ⇒ Array<String>

The versions of the package to copy.

<note markdown=“1”> You must specify `versions` or `versionRevisions`. You cannot specify both.

</note>

Returns:

  • (Array<String>) 


248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/aws-sdk-codeartifact/types.rb', line 248

class CopyPackageVersionsRequest < Struct.new(
  :domain,
  :domain_owner,
  :source_repository,
  :destination_repository,
  :format,
  :namespace,
  :package,
  :versions,
  :version_revisions,
  :allow_overwrite,
  :include_from_upstream)
  SENSITIVE = []
  include Aws::Structure
end