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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deletes one or more versions of a package. A deleted package version cannot be restored in your repository. If you want to remove a package version from your repository and be able to restore it later, set its status to Archived. Archived packages cannot be downloaded from a repository and don't show up with list package APIs (for example, ListackageVersions), but you can restore them using UpdatePackageVersionsStatus.

Synopsis

Creating a Request

data DeletePackageVersions Source #

See: newDeletePackageVersions smart constructor.

Constructors

DeletePackageVersions'

Fields

expectedStatus :: Maybe PackageVersionStatus
The expected status of the package version to delete. Valid values are:
- ```
Published
```
- ```
Unfinished
```
- ```
Unlisted
```
- ```
Archived
```
- ```
Disposed
```
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 package to delete.
repository :: Text
The name of the repository that contains the package versions to delete.
format :: PackageFormat
The format of the package versions to delete. The valid values are:
- ```
npm
```
- ```
pypi
```
- ```
maven
```
package :: Text
The name of the package with the versions to delete.
versions :: [Text]
An array of strings that specify the versions of the package to delete.

Instances

Instances details

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

newDeletePackageVersions Source #

Arguments

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

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

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

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

$sel:domain:DeletePackageVersions', deletePackageVersions_domain - The name of the domain that contains the package to delete.

$sel:repository:DeletePackageVersions', deletePackageVersions_repository - The name of the repository that contains the package versions to delete.

$sel:format:DeletePackageVersions', deletePackageVersions_format - The format of the package versions to delete. The valid values are:

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

$sel:package:DeletePackageVersions', deletePackageVersions_package - The name of the package with the versions to delete.

$sel:versions:DeletePackageVersions', deletePackageVersions_versions - An array of strings that specify the versions of the package to delete.

Request Lenses

deletePackageVersions_expectedStatus :: Lens' DeletePackageVersions (Maybe PackageVersionStatus) Source #

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

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

deletePackageVersions_namespace :: Lens' DeletePackageVersions (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.

deletePackageVersions_domainOwner :: Lens' DeletePackageVersions (Maybe Text) Source #

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

deletePackageVersions_domain :: Lens' DeletePackageVersions Text Source #

The name of the domain that contains the package to delete.

deletePackageVersions_repository :: Lens' DeletePackageVersions Text Source #

The name of the repository that contains the package versions to delete.

deletePackageVersions_format :: Lens' DeletePackageVersions PackageFormat Source #

The format of the package versions to delete. The valid values are:

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

deletePackageVersions_package :: Lens' DeletePackageVersions Text Source #

The name of the package with the versions to delete.

deletePackageVersions_versions :: Lens' DeletePackageVersions [Text] Source #

An array of strings that specify the versions of the package to delete.

Destructuring the Response

data DeletePackageVersionsResponse Source #

See: newDeletePackageVersionsResponse smart constructor.

Constructors

DeletePackageVersionsResponse'

Fields

failedVersions :: Maybe (HashMap Text PackageVersionError)
A PackageVersionError object that contains a map of errors codes for the deleted package 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 deleted.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newDeletePackageVersionsResponse Source #

Arguments

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

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

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

$sel:successfulVersions:DeletePackageVersionsResponse', deletePackageVersionsResponse_successfulVersions - A list of the package versions that were successfully deleted.

$sel:httpStatus:DeletePackageVersionsResponse', deletePackageVersionsResponse_httpStatus - The response's http status code.

Response Lenses

deletePackageVersionsResponse_failedVersions :: Lens' DeletePackageVersionsResponse (Maybe (HashMap Text PackageVersionError)) Source #

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

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

deletePackageVersionsResponse_successfulVersions :: Lens' DeletePackageVersionsResponse (Maybe (HashMap Text SuccessfulPackageVersionInfo)) Source #

A list of the package versions that were successfully deleted.

deletePackageVersionsResponse_httpStatus :: Lens' DeletePackageVersionsResponse Int Source #

The response's http status code.