Amazonka.CodeArtifact.UpdatePackageVersionsStatus

Updates the status of one or more versions of a package. Using UpdatePackageVersionsStatus, you can update the status of package versions to Archived, Published, or Unlisted. To set the status of a package version to Disposed, use DisposePackageVersions.

Creating a Request

data UpdatePackageVersionsStatus

See: newUpdatePackageVersionsStatus smart constructor.

Constructors

UpdatePackageVersionsStatus'

Fields

• domainOwner :: Maybe Text

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

• expectedStatus :: Maybe PackageVersionStatus

  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.

• namespace :: Maybe Text

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

  • The namespace of a Maven package version is its groupId.
  • The namespace of an npm package version is its scope.
  • Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
• versionRevisions :: Maybe (HashMap Text Text)

  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.

• domain :: Text

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

• repository :: Text

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

• format :: PackageFormat

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

• package :: Text

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

• versions :: [Text]

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

• targetStatus :: PackageVersionStatus

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

Instances

ToJSON UpdatePackageVersionsStatus

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

Methods

toJSON :: UpdatePackageVersionsStatus -> Value

toEncoding :: UpdatePackageVersionsStatus -> Encoding

toJSONList :: [UpdatePackageVersionsStatus] -> Value

toEncodingList :: [UpdatePackageVersionsStatus] -> Encoding

ToHeaders UpdatePackageVersionsStatus

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

Methods

toHeaders :: UpdatePackageVersionsStatus -> [Header]

ToPath UpdatePackageVersionsStatus

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

Methods

toPath :: UpdatePackageVersionsStatus -> ByteString

ToQuery UpdatePackageVersionsStatus

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

Methods

toQuery :: UpdatePackageVersionsStatus -> QueryString

AWSRequest UpdatePackageVersionsStatus

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

Associated Types

type AWSResponse UpdatePackageVersionsStatus

Methods

request :: (Service -> Service) -> UpdatePackageVersionsStatus -> Request UpdatePackageVersionsStatus

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdatePackageVersionsStatus -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdatePackageVersionsStatus)))

Generic UpdatePackageVersionsStatus

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

Associated Types

type Rep UpdatePackageVersionsStatus :: Type -> Type

Methods

from :: UpdatePackageVersionsStatus -> Rep UpdatePackageVersionsStatus x

to :: Rep UpdatePackageVersionsStatus x -> UpdatePackageVersionsStatus

Read UpdatePackageVersionsStatus

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

Methods

readsPrec :: Int -> ReadS UpdatePackageVersionsStatus

readList :: ReadS [UpdatePackageVersionsStatus]

readPrec :: ReadPrec UpdatePackageVersionsStatus

readListPrec :: ReadPrec [UpdatePackageVersionsStatus]

Show UpdatePackageVersionsStatus

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

Methods

showsPrec :: Int -> UpdatePackageVersionsStatus -> ShowS

show :: UpdatePackageVersionsStatus -> String

showList :: [UpdatePackageVersionsStatus] -> ShowS

NFData UpdatePackageVersionsStatus

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

Methods

rnf :: UpdatePackageVersionsStatus -> ()

Eq UpdatePackageVersionsStatus

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

Methods

(==) :: UpdatePackageVersionsStatus -> UpdatePackageVersionsStatus -> Bool

(/=) :: UpdatePackageVersionsStatus -> UpdatePackageVersionsStatus -> Bool

Hashable UpdatePackageVersionsStatus

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

Methods

hashWithSalt :: Int -> UpdatePackageVersionsStatus -> Int

hash :: UpdatePackageVersionsStatus -> Int

type AWSResponse UpdatePackageVersionsStatus

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

type AWSResponse UpdatePackageVersionsStatus = UpdatePackageVersionsStatusResponse

type Rep UpdatePackageVersionsStatus

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

type Rep UpdatePackageVersionsStatus = D1 ('MetaData "UpdatePackageVersionsStatus" "Amazonka.CodeArtifact.UpdatePackageVersionsStatus" "amazonka-codeartifact-2.0-CskMABZQLQJDgej73fXQxp" 'False) (C1 ('MetaCons "UpdatePackageVersionsStatus'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "domainOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "expectedStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PackageVersionStatus))) :*: (S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "versionRevisions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) :*: ((S1 ('MetaSel ('Just "repository") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PackageFormat)) :*: (S1 ('MetaSel ('Just "package") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "versions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :*: S1 ('MetaSel ('Just "targetStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PackageVersionStatus))))))

newUpdatePackageVersionsStatus

Arguments

:: Text

$sel:domain:UpdatePackageVersionsStatus'

-> Text

$sel:repository:UpdatePackageVersionsStatus'

-> PackageFormat

UpdatePackageVersionsStatus

-> Text

UpdatePackageVersionsStatus

-> PackageVersionStatus

$sel:targetStatus:UpdatePackageVersionsStatus'

-> UpdatePackageVersionsStatus

Create a value of UpdatePackageVersionsStatus with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

$sel:expectedStatus:UpdatePackageVersionsStatus', updatePackageVersionsStatus_expectedStatus - 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.

UpdatePackageVersionsStatus, updatePackageVersionsStatus_namespace - The namespace of the package version to be updated. The package version component that specifies its namespace depends on its type. For example:

• The namespace of a Maven package version is its groupId.
• The namespace of an npm package version is its scope.
• Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

$sel:versionRevisions:UpdatePackageVersionsStatus', updatePackageVersionsStatus_versionRevisions - 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.

$sel:domain:UpdatePackageVersionsStatus', updatePackageVersionsStatus_domain - The name of the domain that contains the repository that contains the package versions with a status to be updated.

$sel:repository:UpdatePackageVersionsStatus', updatePackageVersionsStatus_repository - The repository that contains the package versions with the status you want to update.

UpdatePackageVersionsStatus, updatePackageVersionsStatus_format - A format that specifies the type of the package with the statuses to update.

UpdatePackageVersionsStatus, updatePackageVersionsStatus_package - The name of the package with the version statuses to update.

$sel:versions:UpdatePackageVersionsStatus', updatePackageVersionsStatus_versions - An array of strings that specify the versions of the package with the statuses to update.

$sel:targetStatus:UpdatePackageVersionsStatus', updatePackageVersionsStatus_targetStatus - The status you want to change the package version status to.

Request Lenses

updatePackageVersionsStatus_domainOwner :: Lens' UpdatePackageVersionsStatus (Maybe Text)

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

updatePackageVersionsStatus_expectedStatus :: Lens' UpdatePackageVersionsStatus (Maybe PackageVersionStatus)

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.

updatePackageVersionsStatus_namespace :: Lens' UpdatePackageVersionsStatus (Maybe Text)

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

• The namespace of a Maven package version is its groupId.
• The namespace of an npm package version is its scope.
• Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

updatePackageVersionsStatus_versionRevisions :: Lens' UpdatePackageVersionsStatus (Maybe (HashMap Text Text))

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.

updatePackageVersionsStatus_domain :: Lens' UpdatePackageVersionsStatus Text

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

updatePackageVersionsStatus_repository :: Lens' UpdatePackageVersionsStatus Text

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

updatePackageVersionsStatus_format :: Lens' UpdatePackageVersionsStatus PackageFormat

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

updatePackageVersionsStatus_package :: Lens' UpdatePackageVersionsStatus Text

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

updatePackageVersionsStatus_versions :: Lens' UpdatePackageVersionsStatus [Text]

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

updatePackageVersionsStatus_targetStatus :: Lens' UpdatePackageVersionsStatus PackageVersionStatus

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

Destructuring the Response

data UpdatePackageVersionsStatusResponse

See: newUpdatePackageVersionsStatusResponse smart constructor.

Constructors

UpdatePackageVersionsStatusResponse'

Fields

• failedVersions :: Maybe (HashMap Text PackageVersionError)

  A list of SuccessfulPackageVersionInfo objects, one for each package version with a status that successfully updated.

• successfulVersions :: Maybe (HashMap Text SuccessfulPackageVersionInfo)

  A list of PackageVersionError objects, one for each package version with a status that failed to update.

• httpStatus :: Int

  The response's http status code.

Instances

Generic UpdatePackageVersionsStatusResponse

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

Associated Types

type Rep UpdatePackageVersionsStatusResponse :: Type -> Type

Methods

from :: UpdatePackageVersionsStatusResponse -> Rep UpdatePackageVersionsStatusResponse x

to :: Rep UpdatePackageVersionsStatusResponse x -> UpdatePackageVersionsStatusResponse

Read UpdatePackageVersionsStatusResponse

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

Methods

readsPrec :: Int -> ReadS UpdatePackageVersionsStatusResponse

readList :: ReadS [UpdatePackageVersionsStatusResponse]

readPrec :: ReadPrec UpdatePackageVersionsStatusResponse

readListPrec :: ReadPrec [UpdatePackageVersionsStatusResponse]

Show UpdatePackageVersionsStatusResponse

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

Methods

showsPrec :: Int -> UpdatePackageVersionsStatusResponse -> ShowS

show :: UpdatePackageVersionsStatusResponse -> String

showList :: [UpdatePackageVersionsStatusResponse] -> ShowS

NFData UpdatePackageVersionsStatusResponse

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

Methods

rnf :: UpdatePackageVersionsStatusResponse -> ()

Eq UpdatePackageVersionsStatusResponse

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

Methods

(==) :: UpdatePackageVersionsStatusResponse -> UpdatePackageVersionsStatusResponse -> Bool

(/=) :: UpdatePackageVersionsStatusResponse -> UpdatePackageVersionsStatusResponse -> Bool

type Rep UpdatePackageVersionsStatusResponse

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

type Rep UpdatePackageVersionsStatusResponse = D1 ('MetaData "UpdatePackageVersionsStatusResponse" "Amazonka.CodeArtifact.UpdatePackageVersionsStatus" "amazonka-codeartifact-2.0-CskMABZQLQJDgej73fXQxp" 'False) (C1 ('MetaCons "UpdatePackageVersionsStatusResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "failedVersions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text PackageVersionError))) :*: (S1 ('MetaSel ('Just "successfulVersions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text SuccessfulPackageVersionInfo))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newUpdatePackageVersionsStatusResponse

Arguments

:: Int

$sel:httpStatus:UpdatePackageVersionsStatusResponse'

-> UpdatePackageVersionsStatusResponse

Create a value of UpdatePackageVersionsStatusResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:failedVersions:UpdatePackageVersionsStatusResponse', updatePackageVersionsStatusResponse_failedVersions - A list of SuccessfulPackageVersionInfo objects, one for each package version with a status that successfully updated.

$sel:successfulVersions:UpdatePackageVersionsStatusResponse', updatePackageVersionsStatusResponse_successfulVersions - A list of PackageVersionError objects, one for each package version with a status that failed to update.

$sel:httpStatus:UpdatePackageVersionsStatusResponse', updatePackageVersionsStatusResponse_httpStatus - The response's http status code.

Response Lenses

updatePackageVersionsStatusResponse_failedVersions :: Lens' UpdatePackageVersionsStatusResponse (Maybe (HashMap Text PackageVersionError))

A list of SuccessfulPackageVersionInfo objects, one for each package version with a status that successfully updated.

updatePackageVersionsStatusResponse_successfulVersions :: Lens' UpdatePackageVersionsStatusResponse (Maybe (HashMap Text SuccessfulPackageVersionInfo))

A list of PackageVersionError objects, one for each package version with a status that failed to update.

updatePackageVersionsStatusResponse_httpStatus :: Lens' UpdatePackageVersionsStatusResponse Int

The response's http status code.