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

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

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

Overview

Note:

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

{
  domain: "DomainName", # required
  domain_owner: "AccountId",
  repository: "RepositoryName", # required
  format: "npm", # required, accepts npm, pypi, maven
  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:

Instance Attribute Summary collapse

Instance Attribute Details

#domain ⇒ String

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

Returns:

  • (String) —

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

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

Possible values:

  • Published
  • Unfinished
  • Unlisted
  • Archived
  • Disposed
  • Deleted

Returns:

  • (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. The valid values are:

  • npm

  • pypi

  • maven

    Possible values:

    • npm
    • pypi
    • maven

Returns:

  • (String) —

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

#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 with the version statuses to update.

Returns:

  • (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.

Returns:

  • (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.

Possible values:

  • Published
  • Unfinished
  • Unlisted
  • Archived
  • Disposed
  • Deleted

Returns:

  • (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. 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>) —

    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.

Returns:

  • (Array<String>) —

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