Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CodeArtifact.DisposePackageVersions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deletes the assets in package versions and sets the package versions' status to Disposed. A disposed package version cannot be restored in your repository because its assets are deleted.

To view all disposed package versions in a repository, use ListPackageVersions and set the status parameter to Disposed.

To view information about a disposed package version, use DescribePackageVersion.

Synopsis

Creating a Request

data DisposePackageVersions Source #

See: newDisposePackageVersions smart constructor.

Constructors

DisposePackageVersions'

Fields

expectedStatus :: Maybe PackageVersionStatus
The expected status of the package version to dispose. Valid values are:
- ```
Published
```
- ```
Unfinished
```
- ```
Unlisted
```
- ```
Archived
```
- ```
Disposed
```
versionRevisions :: Maybe (HashMap Text Text)
The revisions of the package versions you want to dispose.
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 you want to dispose.
repository :: Text
The name of the repository that contains the package versions you want to dispose.
format :: PackageFormat
A format that specifies the type of package versions you want to dispose. The valid values are:
- ```
npm
```
- ```
pypi
```
- ```
maven
```
package :: Text
The name of the package with the versions you want to dispose.
versions :: [Text]
The versions of the package you want to dispose.

Instances

Instances details

Eq DisposePackageVersions Source #
Instance details Defined in Amazonka.CodeArtifact.DisposePackageVersions Methods (==) :: DisposePackageVersions -> DisposePackageVersions -> Bool # (/=) :: DisposePackageVersions -> DisposePackageVersions -> Bool #
Read DisposePackageVersions Source #
Instance details Defined in Amazonka.CodeArtifact.DisposePackageVersions Methods readsPrec :: Int -> ReadS DisposePackageVersions # readList :: ReadS [DisposePackageVersions] # readPrec :: ReadPrec DisposePackageVersions # readListPrec :: ReadPrec [DisposePackageVersions] #
Show DisposePackageVersions Source #
Instance details Defined in Amazonka.CodeArtifact.DisposePackageVersions Methods showsPrec :: Int -> DisposePackageVersions -> ShowS # show :: DisposePackageVersions -> String # showList :: [DisposePackageVersions] -> ShowS #
Generic DisposePackageVersions Source #
Instance details Defined in Amazonka.CodeArtifact.DisposePackageVersions Associated Types type Rep DisposePackageVersions :: Type -> Type # Methods from :: DisposePackageVersions -> Rep DisposePackageVersions x # to :: Rep DisposePackageVersions x -> DisposePackageVersions #
NFData DisposePackageVersions Source #
Instance details Defined in Amazonka.CodeArtifact.DisposePackageVersions Methods rnf :: DisposePackageVersions -> () #
Hashable DisposePackageVersions Source #
Instance details Defined in Amazonka.CodeArtifact.DisposePackageVersions Methods hashWithSalt :: Int -> DisposePackageVersions -> Int # hash :: DisposePackageVersions -> Int #
ToJSON DisposePackageVersions Source #
Instance details Defined in Amazonka.CodeArtifact.DisposePackageVersions Methods toJSON :: DisposePackageVersions -> Value # toEncoding :: DisposePackageVersions -> Encoding # toJSONList :: [DisposePackageVersions] -> Value # toEncodingList :: [DisposePackageVersions] -> Encoding #
AWSRequest DisposePackageVersions Source #
Instance details Defined in Amazonka.CodeArtifact.DisposePackageVersions Associated Types type AWSResponse DisposePackageVersions # Methods request :: DisposePackageVersions -> Request DisposePackageVersions # response :: MonadResource m => Logger -> Service -> Proxy DisposePackageVersions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DisposePackageVersions))) #
ToHeaders DisposePackageVersions Source #
Instance details Defined in Amazonka.CodeArtifact.DisposePackageVersions Methods toHeaders :: DisposePackageVersions -> [Header] #
ToPath DisposePackageVersions Source #
Instance details Defined in Amazonka.CodeArtifact.DisposePackageVersions Methods toPath :: DisposePackageVersions -> ByteString #
ToQuery DisposePackageVersions Source #
Instance details Defined in Amazonka.CodeArtifact.DisposePackageVersions Methods toQuery :: DisposePackageVersions -> QueryString #
type Rep DisposePackageVersions Source #
Instance details Defined in Amazonka.CodeArtifact.DisposePackageVersions type Rep DisposePackageVersions = D1 ('MetaData "DisposePackageVersions" "Amazonka.CodeArtifact.DisposePackageVersions" "libZSservicesZSamazonka-codeartifactZSamazonka-codeartifact" 'False) (C1 ('MetaCons "DisposePackageVersions'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "expectedStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PackageVersionStatus)) :: S1 ('MetaSel ('Just "versionRevisions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "domainOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe 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]))))))
type AWSResponse DisposePackageVersions Source #
Instance details Defined in Amazonka.CodeArtifact.DisposePackageVersions type AWSResponse DisposePackageVersions = DisposePackageVersionsResponse

newDisposePackageVersions Source #

Arguments

:: Text	`$sel:domain:DisposePackageVersions'`
-> Text	`$sel:repository:DisposePackageVersions'`
-> PackageFormat	`$sel:format:DisposePackageVersions'`
-> Text	`$sel:package:DisposePackageVersions'`
-> DisposePackageVersions

Create a value of DisposePackageVersions 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:DisposePackageVersions', disposePackageVersions_expectedStatus - The expected status of the package version to dispose. Valid values are:

```
Published
```
```
Unfinished
```
```
Unlisted
```
```
Archived
```
```
Disposed
```

$sel:versionRevisions:DisposePackageVersions', disposePackageVersions_versionRevisions - The revisions of the package versions you want to dispose.

$sel:namespace:DisposePackageVersions', disposePackageVersions_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:DisposePackageVersions', disposePackageVersions_domainOwner - The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

$sel:domain:DisposePackageVersions', disposePackageVersions_domain - The name of the domain that contains the repository you want to dispose.

$sel:repository:DisposePackageVersions', disposePackageVersions_repository - The name of the repository that contains the package versions you want to dispose.

$sel:format:DisposePackageVersions', disposePackageVersions_format - A format that specifies the type of package versions you want to dispose. The valid values are:

```
npm
```
```
pypi
```
```
maven
```

$sel:package:DisposePackageVersions', disposePackageVersions_package - The name of the package with the versions you want to dispose.

$sel:versions:DisposePackageVersions', disposePackageVersions_versions - The versions of the package you want to dispose.

Request Lenses

disposePackageVersions_expectedStatus :: Lens' DisposePackageVersions (Maybe PackageVersionStatus) Source #

The expected status of the package version to dispose. Valid values are:

```
Published
```
```
Unfinished
```
```
Unlisted
```
```
Archived
```
```
Disposed
```

disposePackageVersions_versionRevisions :: Lens' DisposePackageVersions (Maybe (HashMap Text Text)) Source #

The revisions of the package versions you want to dispose.

disposePackageVersions_namespace :: Lens' DisposePackageVersions (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.

disposePackageVersions_domainOwner :: Lens' DisposePackageVersions (Maybe Text) Source #

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

disposePackageVersions_domain :: Lens' DisposePackageVersions Text Source #

The name of the domain that contains the repository you want to dispose.

disposePackageVersions_repository :: Lens' DisposePackageVersions Text Source #

The name of the repository that contains the package versions you want to dispose.

disposePackageVersions_format :: Lens' DisposePackageVersions PackageFormat Source #

A format that specifies the type of package versions you want to dispose. The valid values are:

```
npm
```
```
pypi
```
```
maven
```

disposePackageVersions_package :: Lens' DisposePackageVersions Text Source #

The name of the package with the versions you want to dispose.

disposePackageVersions_versions :: Lens' DisposePackageVersions [Text] Source #

The versions of the package you want to dispose.

Destructuring the Response

data DisposePackageVersionsResponse Source #

See: newDisposePackageVersionsResponse smart constructor.

Constructors

DisposePackageVersionsResponse'

Fields

failedVersions :: Maybe (HashMap Text PackageVersionError)
A PackageVersionError object that contains a map of errors codes for the disposed package versions that failed. The possible error codes are:
- ```
ALREADY_EXISTS
```
- ```
MISMATCHED_REVISION
```
- ```
MISMATCHED_STATUS
```
- ```
NOT_ALLOWED
```
- ```
NOT_FOUND
```
- ```
SKIPPED
```
successfulVersions :: Maybe (HashMap Text SuccessfulPackageVersionInfo)
A list of the package versions that were successfully disposed.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DisposePackageVersionsResponse Source #
Instance details Defined in Amazonka.CodeArtifact.DisposePackageVersions Methods (==) :: DisposePackageVersionsResponse -> DisposePackageVersionsResponse -> Bool # (/=) :: DisposePackageVersionsResponse -> DisposePackageVersionsResponse -> Bool #
Read DisposePackageVersionsResponse Source #
Instance details Defined in Amazonka.CodeArtifact.DisposePackageVersions Methods readsPrec :: Int -> ReadS DisposePackageVersionsResponse # readList :: ReadS [DisposePackageVersionsResponse] # readPrec :: ReadPrec DisposePackageVersionsResponse # readListPrec :: ReadPrec [DisposePackageVersionsResponse] #
Show DisposePackageVersionsResponse Source #
Instance details Defined in Amazonka.CodeArtifact.DisposePackageVersions Methods showsPrec :: Int -> DisposePackageVersionsResponse -> ShowS # show :: DisposePackageVersionsResponse -> String # showList :: [DisposePackageVersionsResponse] -> ShowS #
Generic DisposePackageVersionsResponse Source #
Instance details Defined in Amazonka.CodeArtifact.DisposePackageVersions Associated Types type Rep DisposePackageVersionsResponse :: Type -> Type # Methods from :: DisposePackageVersionsResponse -> Rep DisposePackageVersionsResponse x # to :: Rep DisposePackageVersionsResponse x -> DisposePackageVersionsResponse #
NFData DisposePackageVersionsResponse Source #
Instance details Defined in Amazonka.CodeArtifact.DisposePackageVersions Methods rnf :: DisposePackageVersionsResponse -> () #
type Rep DisposePackageVersionsResponse Source #
Instance details Defined in Amazonka.CodeArtifact.DisposePackageVersions type Rep DisposePackageVersionsResponse = D1 ('MetaData "DisposePackageVersionsResponse" "Amazonka.CodeArtifact.DisposePackageVersions" "libZSservicesZSamazonka-codeartifactZSamazonka-codeartifact" 'False) (C1 ('MetaCons "DisposePackageVersionsResponse'" '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))))

newDisposePackageVersionsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DisposePackageVersionsResponse'`
-> DisposePackageVersionsResponse

Create a value of DisposePackageVersionsResponse 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:DisposePackageVersionsResponse', disposePackageVersionsResponse_failedVersions - A PackageVersionError object that contains a map of errors codes for the disposed package versions that failed. The possible error codes are:

```
ALREADY_EXISTS
```
```
MISMATCHED_REVISION
```
```
MISMATCHED_STATUS
```
```
NOT_ALLOWED
```
```
NOT_FOUND
```
```
SKIPPED
```

$sel:successfulVersions:DisposePackageVersionsResponse', disposePackageVersionsResponse_successfulVersions - A list of the package versions that were successfully disposed.

$sel:httpStatus:DisposePackageVersionsResponse', disposePackageVersionsResponse_httpStatus - The response's http status code.

Response Lenses

disposePackageVersionsResponse_failedVersions :: Lens' DisposePackageVersionsResponse (Maybe (HashMap Text PackageVersionError)) Source #

A PackageVersionError object that contains a map of errors codes for the disposed package versions that failed. The possible error codes are:

```
ALREADY_EXISTS
```
```
MISMATCHED_REVISION
```
```
MISMATCHED_STATUS
```
```
NOT_ALLOWED
```
```
NOT_FOUND
```
```
SKIPPED
```

disposePackageVersionsResponse_successfulVersions :: Lens' DisposePackageVersionsResponse (Maybe (HashMap Text SuccessfulPackageVersionInfo)) Source #

A list of the package versions that were successfully disposed.

disposePackageVersionsResponse_httpStatus :: Lens' DisposePackageVersionsResponse Int Source #

The response's http status code.