Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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
- data GetPackageVersionReadme = GetPackageVersionReadme' {
- domainOwner :: Maybe Text
- namespace :: Maybe Text
- domain :: Text
- repository :: Text
- format :: PackageFormat
- package :: Text
- packageVersion :: Text
- newGetPackageVersionReadme :: Text -> Text -> PackageFormat -> Text -> Text -> GetPackageVersionReadme
- getPackageVersionReadme_domainOwner :: Lens' GetPackageVersionReadme (Maybe Text)
- getPackageVersionReadme_namespace :: Lens' GetPackageVersionReadme (Maybe Text)
- getPackageVersionReadme_domain :: Lens' GetPackageVersionReadme Text
- getPackageVersionReadme_repository :: Lens' GetPackageVersionReadme Text
- getPackageVersionReadme_format :: Lens' GetPackageVersionReadme PackageFormat
- getPackageVersionReadme_package :: Lens' GetPackageVersionReadme Text
- getPackageVersionReadme_packageVersion :: Lens' GetPackageVersionReadme Text
- data GetPackageVersionReadmeResponse = GetPackageVersionReadmeResponse' {}
- newGetPackageVersionReadmeResponse :: Int -> GetPackageVersionReadmeResponse
- getPackageVersionReadmeResponse_format :: Lens' GetPackageVersionReadmeResponse (Maybe PackageFormat)
- getPackageVersionReadmeResponse_namespace :: Lens' GetPackageVersionReadmeResponse (Maybe Text)
- getPackageVersionReadmeResponse_package :: Lens' GetPackageVersionReadmeResponse (Maybe Text)
- getPackageVersionReadmeResponse_readme :: Lens' GetPackageVersionReadmeResponse (Maybe Text)
- getPackageVersionReadmeResponse_version :: Lens' GetPackageVersionReadmeResponse (Maybe Text)
- getPackageVersionReadmeResponse_versionRevision :: Lens' GetPackageVersionReadmeResponse (Maybe Text)
- getPackageVersionReadmeResponse_httpStatus :: Lens' GetPackageVersionReadmeResponse Int
Creating a Request
data GetPackageVersionReadme Source #
See: newGetPackageVersionReadme
smart constructor.
GetPackageVersionReadme' | |
|
Instances
newGetPackageVersionReadme Source #
:: Text | |
-> Text | |
-> PackageFormat | |
-> Text | |
-> Text | |
-> 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) Source #
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) Source #
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 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.
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.
GetPackageVersionReadmeResponse' | |
|
Instances
newGetPackageVersionReadmeResponse Source #
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) Source #
The format of the package with the requested readme file.
getPackageVersionReadmeResponse_namespace :: Lens' GetPackageVersionReadmeResponse (Maybe Text) Source #
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) Source #
The name of the package that contains the returned readme file.
getPackageVersionReadmeResponse_readme :: Lens' GetPackageVersionReadmeResponse (Maybe Text) Source #
The text of the returned readme file.
getPackageVersionReadmeResponse_version :: Lens' GetPackageVersionReadmeResponse (Maybe Text) Source #
The version of the package with the requested readme file.
getPackageVersionReadmeResponse_versionRevision :: Lens' GetPackageVersionReadmeResponse (Maybe Text) Source #
The current revision associated with the package version.
getPackageVersionReadmeResponse_httpStatus :: Lens' GetPackageVersionReadmeResponse Int Source #
The response's http status code.