libZSservicesZSamazonka-codeartifactZSamazonka-codeartifact
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CodeArtifact.UpdatePackageVersionsStatus

Description

Updates the status of one or more versions of a package.

Synopsis

Creating a Request

data UpdatePackageVersionsStatus Source #

See: newUpdatePackageVersionsStatus smart constructor.

Constructors

UpdatePackageVersionsStatus' 

Fields

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

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

  • namespace :: Maybe Text

    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.
  • domainOwner :: Maybe Text

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

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

    • npm
    • pypi
    • maven
  • 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

Instances details
Eq UpdatePackageVersionsStatus Source # 
Instance details

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

Read UpdatePackageVersionsStatus Source # 
Instance details

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

Show UpdatePackageVersionsStatus Source # 
Instance details

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

Generic UpdatePackageVersionsStatus Source # 
Instance details

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

Associated Types

type Rep UpdatePackageVersionsStatus :: Type -> Type #

NFData UpdatePackageVersionsStatus Source # 
Instance details

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

Hashable UpdatePackageVersionsStatus Source # 
Instance details

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

ToJSON UpdatePackageVersionsStatus Source # 
Instance details

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

AWSRequest UpdatePackageVersionsStatus Source # 
Instance details

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

ToHeaders UpdatePackageVersionsStatus Source # 
Instance details

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

ToPath UpdatePackageVersionsStatus Source # 
Instance details

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

ToQuery UpdatePackageVersionsStatus Source # 
Instance details

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

type Rep UpdatePackageVersionsStatus Source # 
Instance details

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

type AWSResponse UpdatePackageVersionsStatus Source # 
Instance details

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

newUpdatePackageVersionsStatus Source #

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:

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

$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:namespace:UpdatePackageVersionsStatus', updatePackageVersionsStatus_namespace - 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.

$sel:domainOwner:UpdatePackageVersionsStatus', updatePackageVersionsStatus_domainOwner - The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

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

$sel:format:UpdatePackageVersionsStatus', updatePackageVersionsStatus_format - A format that specifies the type of the package with the statuses to update. The valid values are:

  • npm
  • pypi
  • maven

$sel:package: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_expectedStatus :: Lens' UpdatePackageVersionsStatus (Maybe PackageVersionStatus) Source #

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_versionRevisions :: Lens' UpdatePackageVersionsStatus (Maybe (HashMap Text Text)) Source #

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_namespace :: Lens' UpdatePackageVersionsStatus (Maybe Text) Source #

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.

updatePackageVersionsStatus_domainOwner :: Lens' UpdatePackageVersionsStatus (Maybe Text) Source #

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

updatePackageVersionsStatus_domain :: Lens' UpdatePackageVersionsStatus Text Source #

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

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

updatePackageVersionsStatus_format :: Lens' UpdatePackageVersionsStatus PackageFormat Source #

A format that specifies the type of the package with the statuses to update. The valid values are:

  • npm
  • pypi
  • maven

updatePackageVersionsStatus_package :: Lens' UpdatePackageVersionsStatus Text Source #

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

updatePackageVersionsStatus_versions :: Lens' UpdatePackageVersionsStatus [Text] Source #

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

updatePackageVersionsStatus_targetStatus :: Lens' UpdatePackageVersionsStatus PackageVersionStatus Source #

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

Destructuring the Response

data UpdatePackageVersionsStatusResponse Source #

Constructors

UpdatePackageVersionsStatusResponse' 

Fields

Instances

Instances details
Eq UpdatePackageVersionsStatusResponse Source # 
Instance details

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

Read UpdatePackageVersionsStatusResponse Source # 
Instance details

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

Show UpdatePackageVersionsStatusResponse Source # 
Instance details

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

Generic UpdatePackageVersionsStatusResponse Source # 
Instance details

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

NFData UpdatePackageVersionsStatusResponse Source # 
Instance details

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

type Rep UpdatePackageVersionsStatusResponse Source # 
Instance details

Defined in Amazonka.CodeArtifact.UpdatePackageVersionsStatus

type Rep UpdatePackageVersionsStatusResponse = D1 ('MetaData "UpdatePackageVersionsStatusResponse" "Amazonka.CodeArtifact.UpdatePackageVersionsStatus" "libZSservicesZSamazonka-codeartifactZSamazonka-codeartifact" '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 Source #

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

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

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

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