Amazonka.CodeArtifact.GetPackageVersionReadme

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.

Creating a Request

data GetPackageVersionReadme

See: newGetPackageVersionReadme smart constructor.

Constructors

GetPackageVersionReadme'

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.

• namespace :: Maybe Text

  The namespace of the package version with the requested readme file. 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.
• 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.

• 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

ToHeaders GetPackageVersionReadme

Defined in Amazonka.CodeArtifact.GetPackageVersionReadme

Methods

toHeaders :: GetPackageVersionReadme -> [Header]

ToPath GetPackageVersionReadme

Defined in Amazonka.CodeArtifact.GetPackageVersionReadme

Methods

toPath :: GetPackageVersionReadme -> ByteString

ToQuery GetPackageVersionReadme

Defined in Amazonka.CodeArtifact.GetPackageVersionReadme

Methods

toQuery :: GetPackageVersionReadme -> QueryString

AWSRequest GetPackageVersionReadme

Defined in Amazonka.CodeArtifact.GetPackageVersionReadme

Associated Types

type AWSResponse GetPackageVersionReadme

Methods

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

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

Generic GetPackageVersionReadme

Defined in Amazonka.CodeArtifact.GetPackageVersionReadme

Associated Types

type Rep GetPackageVersionReadme :: Type -> Type

Methods

from :: GetPackageVersionReadme -> Rep GetPackageVersionReadme x

to :: Rep GetPackageVersionReadme x -> GetPackageVersionReadme

Read GetPackageVersionReadme

Defined in Amazonka.CodeArtifact.GetPackageVersionReadme

Methods

readsPrec :: Int -> ReadS GetPackageVersionReadme

readList :: ReadS [GetPackageVersionReadme]

readPrec :: ReadPrec GetPackageVersionReadme

readListPrec :: ReadPrec [GetPackageVersionReadme]

Show GetPackageVersionReadme

Defined in Amazonka.CodeArtifact.GetPackageVersionReadme

Methods

showsPrec :: Int -> GetPackageVersionReadme -> ShowS

show :: GetPackageVersionReadme -> String

showList :: [GetPackageVersionReadme] -> ShowS

NFData GetPackageVersionReadme

Defined in Amazonka.CodeArtifact.GetPackageVersionReadme

Methods

rnf :: GetPackageVersionReadme -> ()

Eq GetPackageVersionReadme

Defined in Amazonka.CodeArtifact.GetPackageVersionReadme

Methods

(==) :: GetPackageVersionReadme -> GetPackageVersionReadme -> Bool

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

Hashable GetPackageVersionReadme

Defined in Amazonka.CodeArtifact.GetPackageVersionReadme

Methods

hashWithSalt :: Int -> GetPackageVersionReadme -> Int

hash :: GetPackageVersionReadme -> Int

type AWSResponse GetPackageVersionReadme

Defined in Amazonka.CodeArtifact.GetPackageVersionReadme

type AWSResponse GetPackageVersionReadme = GetPackageVersionReadmeResponse

type Rep GetPackageVersionReadme

Defined in Amazonka.CodeArtifact.GetPackageVersionReadme

type Rep GetPackageVersionReadme = D1 ('MetaData "GetPackageVersionReadme" "Amazonka.CodeArtifact.GetPackageVersionReadme" "amazonka-codeartifact-2.0-CskMABZQLQJDgej73fXQxp" 'False) (C1 ('MetaCons "GetPackageVersionReadme'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "domainOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "namespace") '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)))))

newGetPackageVersionReadme

Arguments

:: Text

$sel:domain:GetPackageVersionReadme'

-> Text

$sel:repository:GetPackageVersionReadme'

-> PackageFormat

GetPackageVersionReadme

-> Text

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:

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

GetPackageVersionReadme, getPackageVersionReadme_namespace - The namespace of the package version with the requested readme file. 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: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.

GetPackageVersionReadme, getPackageVersionReadme_format - A format that specifies the type of the package version with the requested readme file.

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_domainOwner :: Lens' GetPackageVersionReadme (Maybe Text)

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

getPackageVersionReadme_namespace :: Lens' GetPackageVersionReadme (Maybe Text)

The namespace of the package version with the requested readme file. 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.

getPackageVersionReadme_domain :: Lens' GetPackageVersionReadme Text

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

getPackageVersionReadme_repository :: Lens' GetPackageVersionReadme Text

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

getPackageVersionReadme_format :: Lens' GetPackageVersionReadme PackageFormat

A format that specifies the type of the package version with the requested readme file.

getPackageVersionReadme_package :: Lens' GetPackageVersionReadme Text

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

getPackageVersionReadme_packageVersion :: Lens' GetPackageVersionReadme Text

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

Destructuring the Response

data GetPackageVersionReadmeResponse

See: newGetPackageVersionReadmeResponse smart constructor.

Constructors

GetPackageVersionReadmeResponse'

Fields

• format :: Maybe PackageFormat

  The format of the package with the requested readme file.

• namespace :: Maybe Text

  The namespace of the package version with the requested readme file. 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.
• package :: Maybe Text

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

• readme :: Maybe Text

  The text of the returned readme file.

• version :: Maybe Text

  The version of the package with the requested readme file.

• versionRevision :: Maybe Text

  The current revision associated with the package version.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetPackageVersionReadmeResponse

Defined in Amazonka.CodeArtifact.GetPackageVersionReadme

Associated Types

type Rep GetPackageVersionReadmeResponse :: Type -> Type

Methods

from :: GetPackageVersionReadmeResponse -> Rep GetPackageVersionReadmeResponse x

to :: Rep GetPackageVersionReadmeResponse x -> GetPackageVersionReadmeResponse

Read GetPackageVersionReadmeResponse

Defined in Amazonka.CodeArtifact.GetPackageVersionReadme

Methods

readsPrec :: Int -> ReadS GetPackageVersionReadmeResponse

readList :: ReadS [GetPackageVersionReadmeResponse]

readPrec :: ReadPrec GetPackageVersionReadmeResponse

readListPrec :: ReadPrec [GetPackageVersionReadmeResponse]

Show GetPackageVersionReadmeResponse

Defined in Amazonka.CodeArtifact.GetPackageVersionReadme

Methods

showsPrec :: Int -> GetPackageVersionReadmeResponse -> ShowS

show :: GetPackageVersionReadmeResponse -> String

showList :: [GetPackageVersionReadmeResponse] -> ShowS

NFData GetPackageVersionReadmeResponse

Defined in Amazonka.CodeArtifact.GetPackageVersionReadme

Methods

rnf :: GetPackageVersionReadmeResponse -> ()

Eq GetPackageVersionReadmeResponse

Defined in Amazonka.CodeArtifact.GetPackageVersionReadme

Methods

(==) :: GetPackageVersionReadmeResponse -> GetPackageVersionReadmeResponse -> Bool

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

type Rep GetPackageVersionReadmeResponse

Defined in Amazonka.CodeArtifact.GetPackageVersionReadme

type Rep GetPackageVersionReadmeResponse = D1 ('MetaData "GetPackageVersionReadmeResponse" "Amazonka.CodeArtifact.GetPackageVersionReadme" "amazonka-codeartifact-2.0-CskMABZQLQJDgej73fXQxp" 'False) (C1 ('MetaCons "GetPackageVersionReadmeResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PackageFormat)) :*: (S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "package") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "readme") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "versionRevision") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetPackageVersionReadmeResponse

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:

GetPackageVersionReadme, getPackageVersionReadmeResponse_format - The format of the package with the requested readme file.

GetPackageVersionReadme, getPackageVersionReadmeResponse_namespace - The namespace of the package version with the requested readme file. 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.

GetPackageVersionReadme, getPackageVersionReadmeResponse_package - The name of the package that contains the returned readme file.

$sel:readme:GetPackageVersionReadmeResponse', getPackageVersionReadmeResponse_readme - The text of the returned readme file.

GetPackageVersionReadmeResponse, getPackageVersionReadmeResponse_version - The version of the package with the requested readme file.

$sel:versionRevision:GetPackageVersionReadmeResponse', getPackageVersionReadmeResponse_versionRevision - The current revision associated with the package version.

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

Response Lenses

getPackageVersionReadmeResponse_format :: Lens' GetPackageVersionReadmeResponse (Maybe PackageFormat)

The format of the package with the requested readme file.

getPackageVersionReadmeResponse_namespace :: Lens' GetPackageVersionReadmeResponse (Maybe Text)

The namespace of the package version with the requested readme file. 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.

getPackageVersionReadmeResponse_package :: Lens' GetPackageVersionReadmeResponse (Maybe Text)

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

getPackageVersionReadmeResponse_readme :: Lens' GetPackageVersionReadmeResponse (Maybe Text)

The text of the returned readme file.

getPackageVersionReadmeResponse_version :: Lens' GetPackageVersionReadmeResponse (Maybe Text)

The version of the package with the requested readme file.

getPackageVersionReadmeResponse_versionRevision :: Lens' GetPackageVersionReadmeResponse (Maybe Text)

The current revision associated with the package version.

getPackageVersionReadmeResponse_httpStatus :: Lens' GetPackageVersionReadmeResponse Int

The response's http status code.