Class: Aws::CodeArtifact::Types::UpdatePackageVersionsStatusRequest

Inherits:

Struct

• Object
• Struct
• Aws::CodeArtifact::Types::UpdatePackageVersionsStatusRequest

Includes:

Structure

Defined in:

lib/aws-sdk-codeartifact/types.rb

Overview

Note:

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

{
  domain: "DomainName", # required
  domain_owner: "AccountId",
  repository: "RepositoryName", # required
  format: "npm", # required, accepts npm, pypi, maven, nuget
  namespace: "PackageNamespace",
  package: "PackageName", # required
  versions: ["PackageVersion"], # required
  version_revisions: {
    "PackageVersion" => "PackageVersionRevision",
  },
  expected_status: "Published", # accepts Published, Unfinished, Unlisted, Archived, Disposed, Deleted
  target_status: "Published", # required, accepts Published, Unfinished, Unlisted, Archived, Disposed, Deleted
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #domain ⇒ String

  The name of the domain that contains the repository that contains the package versions with a status to be updated.

• #domain_owner ⇒ String

  The 12-digit account number of the Amazon Web Services account that owns the domain.

• #expected_status ⇒ String

  The package version’s expected status before it is updated.

• #format ⇒ String

  A format that specifies the type of the package with the statuses to update.

• #namespace ⇒ String

  The namespace of the package.

• #package ⇒ String

  The name of the package with the version statuses to update.

• #repository ⇒ String

  The repository that contains the package versions with the status you want to update.

• #target_status ⇒ String

  The status you want to change the package version status to.

• #version_revisions ⇒ Hash<String,String>

  A map of package versions and package version revisions.

• #versions ⇒ Array<String>

  An array of strings that specify the versions of the package with the statuses to update.

Instance Attribute Details

#domain ⇒ String

The name of the domain that contains the repository that contains the package versions with a status to be updated.

Returns:

• (String)

# File 'lib/aws-sdk-codeartifact/types.rb', line 3110

class UpdatePackageVersionsStatusRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package,
  :versions,
  :version_revisions,
  :expected_status,
  :target_status)
  SENSITIVE = []
  include Aws::Structure
end

#domain_owner ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-codeartifact/types.rb', line 3110

class UpdatePackageVersionsStatusRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package,
  :versions,
  :version_revisions,
  :expected_status,
  :target_status)
  SENSITIVE = []
  include Aws::Structure
end

#expected_status ⇒ String

The package version’s expected status before it is updated. If `expectedStatus` is provided, the package version's status is updated only if its status at the time `UpdatePackageVersionsStatus` is called matches `expectedStatus`.

Returns:

• (String)

# File 'lib/aws-sdk-codeartifact/types.rb', line 3110

class UpdatePackageVersionsStatusRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package,
  :versions,
  :version_revisions,
  :expected_status,
  :target_status)
  SENSITIVE = []
  include Aws::Structure
end

#format ⇒ String

A format that specifies the type of the package with the statuses to update.

Returns:

• (String)

# File 'lib/aws-sdk-codeartifact/types.rb', line 3110

class UpdatePackageVersionsStatusRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package,
  :versions,
  :version_revisions,
  :expected_status,
  :target_status)
  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)

# File 'lib/aws-sdk-codeartifact/types.rb', line 3110

class UpdatePackageVersionsStatusRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package,
  :versions,
  :version_revisions,
  :expected_status,
  :target_status)
  SENSITIVE = []
  include Aws::Structure
end

#package ⇒ String

The name of the package with the version statuses to update.

Returns:

• (String)

# File 'lib/aws-sdk-codeartifact/types.rb', line 3110

class UpdatePackageVersionsStatusRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package,
  :versions,
  :version_revisions,
  :expected_status,
  :target_status)
  SENSITIVE = []
  include Aws::Structure
end

#repository ⇒ String

The repository that contains the package versions with the status you want to update.

Returns:

• (String)

# File 'lib/aws-sdk-codeartifact/types.rb', line 3110

class UpdatePackageVersionsStatusRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package,
  :versions,
  :version_revisions,
  :expected_status,
  :target_status)
  SENSITIVE = []
  include Aws::Structure
end

#target_status ⇒ String

The status you want to change the package version status to.

Returns:

• (String)

# File 'lib/aws-sdk-codeartifact/types.rb', line 3110

class UpdatePackageVersionsStatusRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package,
  :versions,
  :version_revisions,
  :expected_status,
  :target_status)
  SENSITIVE = []
  include Aws::Structure
end

#version_revisions ⇒ Hash<String,String>

A map of package versions and package version revisions. The map `key` is the package version (for example, `3.5.2`), and the map `value` is the package version revision.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-codeartifact/types.rb', line 3110

class UpdatePackageVersionsStatusRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package,
  :versions,
  :version_revisions,
  :expected_status,
  :target_status)
  SENSITIVE = []
  include Aws::Structure
end

#versions ⇒ Array<String>

An array of strings that specify the versions of the package with the statuses to update.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-codeartifact/types.rb', line 3110

class UpdatePackageVersionsStatusRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package,
  :versions,
  :version_revisions,
  :expected_status,
  :target_status)
  SENSITIVE = []
  include Aws::Structure
end