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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the readme file or descriptive text for a package version. For packages that do not contain a readme file, CodeArtifact extracts a description from a metadata file. For example, from the <description> element in the pom.xml file of a Maven package.

The returned text might contain formatting. For example, it might contain formatting for Markdown or reStructuredText.

Synopsis

Creating a Request

data GetPackageVersionReadme Source #

See: newGetPackageVersionReadme smart constructor.

Constructors

GetPackageVersionReadme'

Fields

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 version with the requested readme file.
repository :: Text
The repository that contains the package with the requested readme file.
format :: PackageFormat
A format that specifies the type of the package version with the requested readme file. The valid values are:
- ```
npm
```
- ```
pypi
```
- ```
maven
```
package :: Text
The name of the package version that contains the requested readme file.
packageVersion :: Text
A string that contains the package version (for example, 3.5.2).

Instances

Instances details

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

newGetPackageVersionReadme Source #

Arguments

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

Create a value of GetPackageVersionReadme 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:namespace:GetPackageVersionReadme', getPackageVersionReadme_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:GetPackageVersionReadme', getPackageVersionReadme_domainOwner - The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

$sel:domain:GetPackageVersionReadme', getPackageVersionReadme_domain - The name of the domain that contains the repository that contains the package version with the requested readme file.

$sel:repository:GetPackageVersionReadme', getPackageVersionReadme_repository - The repository that contains the package with the requested readme file.

$sel:format:GetPackageVersionReadme', getPackageVersionReadme_format - A format that specifies the type of the package version with the requested readme file. The valid values are:

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

$sel:package:GetPackageVersionReadme', getPackageVersionReadme_package - The name of the package version that contains the requested readme file.

$sel:packageVersion:GetPackageVersionReadme', getPackageVersionReadme_packageVersion - A string that contains the package version (for example, 3.5.2).

Request Lenses

getPackageVersionReadme_namespace :: Lens' GetPackageVersionReadme (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.

getPackageVersionReadme_domainOwner :: Lens' GetPackageVersionReadme (Maybe Text) Source #

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

getPackageVersionReadme_domain :: Lens' GetPackageVersionReadme Text Source #

The name of the domain that contains the repository that contains the package version with the requested readme file.

getPackageVersionReadme_repository :: Lens' GetPackageVersionReadme Text Source #

The repository that contains the package with the requested readme file.

getPackageVersionReadme_format :: Lens' GetPackageVersionReadme PackageFormat Source #

A format that specifies the type of the package version with the requested readme file. The valid values are:

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

getPackageVersionReadme_package :: Lens' GetPackageVersionReadme Text Source #

The name of the package version that contains the requested readme file.

getPackageVersionReadme_packageVersion :: Lens' GetPackageVersionReadme Text Source #

A string that contains the package version (for example, 3.5.2).

Destructuring the Response

data GetPackageVersionReadmeResponse Source #

See: newGetPackageVersionReadmeResponse smart constructor.

Constructors

GetPackageVersionReadmeResponse'

Fields

readme :: Maybe Text
The text of the returned readme file.
format :: Maybe PackageFormat
The format of the package with the requested readme file. Valid format types are:
- ```
npm
```
- ```
pypi
```
- ```
maven
```
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.
versionRevision :: Maybe Text
The current revision associated with the package version.
version :: Maybe Text
The version of the package with the requested readme file.
package :: Maybe Text
The name of the package that contains the returned readme file.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq GetPackageVersionReadmeResponse Source #
Instance details Defined in Amazonka.CodeArtifact.GetPackageVersionReadme Methods (==) :: GetPackageVersionReadmeResponse -> GetPackageVersionReadmeResponse -> Bool # (/=) :: GetPackageVersionReadmeResponse -> GetPackageVersionReadmeResponse -> Bool #
Read GetPackageVersionReadmeResponse Source #
Instance details Defined in Amazonka.CodeArtifact.GetPackageVersionReadme Methods readsPrec :: Int -> ReadS GetPackageVersionReadmeResponse # readList :: ReadS [GetPackageVersionReadmeResponse] # readPrec :: ReadPrec GetPackageVersionReadmeResponse # readListPrec :: ReadPrec [GetPackageVersionReadmeResponse] #
Show GetPackageVersionReadmeResponse Source #
Instance details Defined in Amazonka.CodeArtifact.GetPackageVersionReadme Methods showsPrec :: Int -> GetPackageVersionReadmeResponse -> ShowS # show :: GetPackageVersionReadmeResponse -> String # showList :: [GetPackageVersionReadmeResponse] -> ShowS #
Generic GetPackageVersionReadmeResponse Source #
Instance details Defined in Amazonka.CodeArtifact.GetPackageVersionReadme Associated Types type Rep GetPackageVersionReadmeResponse :: Type -> Type # Methods from :: GetPackageVersionReadmeResponse -> Rep GetPackageVersionReadmeResponse x # to :: Rep GetPackageVersionReadmeResponse x -> GetPackageVersionReadmeResponse #
NFData GetPackageVersionReadmeResponse Source #
Instance details Defined in Amazonka.CodeArtifact.GetPackageVersionReadme Methods rnf :: GetPackageVersionReadmeResponse -> () #
type Rep GetPackageVersionReadmeResponse Source #
Instance details Defined in Amazonka.CodeArtifact.GetPackageVersionReadme type Rep GetPackageVersionReadmeResponse = D1 ('MetaData "GetPackageVersionReadmeResponse" "Amazonka.CodeArtifact.GetPackageVersionReadme" "libZSservicesZSamazonka-codeartifactZSamazonka-codeartifact" 'False) (C1 ('MetaCons "GetPackageVersionReadmeResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "readme") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PackageFormat)) :: S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "versionRevision") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "package") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetPackageVersionReadmeResponse Source #

Arguments

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

Create a value of GetPackageVersionReadmeResponse 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:readme:GetPackageVersionReadmeResponse', getPackageVersionReadmeResponse_readme - The text of the returned readme file.

$sel:format:GetPackageVersionReadme', getPackageVersionReadmeResponse_format - The format of the package with the requested readme file. Valid format types are:

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

$sel:namespace:GetPackageVersionReadme', getPackageVersionReadmeResponse_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:versionRevision:GetPackageVersionReadmeResponse', getPackageVersionReadmeResponse_versionRevision - The current revision associated with the package version.

$sel:version:GetPackageVersionReadmeResponse', getPackageVersionReadmeResponse_version - The version of the package with the requested readme file.

$sel:package:GetPackageVersionReadme', getPackageVersionReadmeResponse_package - The name of the package that contains the returned readme file.

$sel:httpStatus:GetPackageVersionReadmeResponse', getPackageVersionReadmeResponse_httpStatus - The response's http status code.

Response Lenses

getPackageVersionReadmeResponse_readme :: Lens' GetPackageVersionReadmeResponse (Maybe Text) Source #

The text of the returned readme file.

getPackageVersionReadmeResponse_format :: Lens' GetPackageVersionReadmeResponse (Maybe PackageFormat) Source #

The format of the package with the requested readme file. Valid format types are:

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

getPackageVersionReadmeResponse_namespace :: Lens' GetPackageVersionReadmeResponse (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.

getPackageVersionReadmeResponse_versionRevision :: Lens' GetPackageVersionReadmeResponse (Maybe Text) Source #

The current revision associated with the package version.

getPackageVersionReadmeResponse_version :: Lens' GetPackageVersionReadmeResponse (Maybe Text) Source #

The version of the package with the requested readme file.

getPackageVersionReadmeResponse_package :: Lens' GetPackageVersionReadmeResponse (Maybe Text) Source #

The name of the package that contains the returned readme file.

getPackageVersionReadmeResponse_httpStatus :: Lens' GetPackageVersionReadmeResponse Int Source #

The response's http status code.