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 |
Returns a PackageDescription object that contains information about the requested package.
Synopsis
- data DescribePackage = DescribePackage' {
- domainOwner :: Maybe Text
- namespace :: Maybe Text
- domain :: Text
- repository :: Text
- format :: PackageFormat
- package :: Text
- newDescribePackage :: Text -> Text -> PackageFormat -> Text -> DescribePackage
- describePackage_domainOwner :: Lens' DescribePackage (Maybe Text)
- describePackage_namespace :: Lens' DescribePackage (Maybe Text)
- describePackage_domain :: Lens' DescribePackage Text
- describePackage_repository :: Lens' DescribePackage Text
- describePackage_format :: Lens' DescribePackage PackageFormat
- describePackage_package :: Lens' DescribePackage Text
- data DescribePackageResponse = DescribePackageResponse' {}
- newDescribePackageResponse :: Int -> PackageDescription -> DescribePackageResponse
- describePackageResponse_httpStatus :: Lens' DescribePackageResponse Int
- describePackageResponse_package :: Lens' DescribePackageResponse PackageDescription
Creating a Request
data DescribePackage Source #
See: newDescribePackage
smart constructor.
DescribePackage' | |
|
Instances
:: Text | |
-> Text | |
-> PackageFormat | |
-> Text | |
-> DescribePackage |
Create a value of DescribePackage
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:
DescribePackage
, describePackage_domainOwner
- The 12-digit account number of the Amazon Web Services account that owns
the domain. It does not include dashes or spaces.
DescribePackage
, describePackage_namespace
- The namespace of the requested 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 is required when requesting Maven packages. - The namespace of an npm package is its
scope
. - Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.
$sel:domain:DescribePackage'
, describePackage_domain
- The name of the domain that contains the repository that contains the
package.
$sel:repository:DescribePackage'
, describePackage_repository
- The name of the repository that contains the requested package.
DescribePackage
, describePackage_format
- A format that specifies the type of the requested package.
DescribePackage
, describePackage_package
- The name of the requested package.
Request Lenses
describePackage_domainOwner :: Lens' DescribePackage (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.
describePackage_namespace :: Lens' DescribePackage (Maybe Text) Source #
The namespace of the requested 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 is required when requesting Maven packages. - The namespace of an npm package is its
scope
. - Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.
describePackage_domain :: Lens' DescribePackage Text Source #
The name of the domain that contains the repository that contains the package.
describePackage_repository :: Lens' DescribePackage Text Source #
The name of the repository that contains the requested package.
describePackage_format :: Lens' DescribePackage PackageFormat Source #
A format that specifies the type of the requested package.
describePackage_package :: Lens' DescribePackage Text Source #
The name of the requested package.
Destructuring the Response
data DescribePackageResponse Source #
See: newDescribePackageResponse
smart constructor.
DescribePackageResponse' | |
|
Instances
newDescribePackageResponse Source #
Create a value of DescribePackageResponse
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:httpStatus:DescribePackageResponse'
, describePackageResponse_httpStatus
- The response's http status code.
DescribePackage
, describePackageResponse_package
- A
PackageDescription
object that contains information about the requested package.
Response Lenses
describePackageResponse_httpStatus :: Lens' DescribePackageResponse Int Source #
The response's http status code.
describePackageResponse_package :: Lens' DescribePackageResponse PackageDescription Source #
A PackageDescription object that contains information about the requested package.