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

Amazonka.CodeArtifact.DescribePackage

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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' {
- httpStatus :: Int
- package :: PackageDescription
}
newDescribePackageResponse :: Int -> PackageDescription -> DescribePackageResponse
describePackageResponse_httpStatus :: Lens' DescribePackageResponse Int
describePackageResponse_package :: Lens' DescribePackageResponse PackageDescription

Creating a Request

data DescribePackage Source #

See: newDescribePackage smart constructor.

Constructors

DescribePackage'

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 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.
domain :: Text
The name of the domain that contains the repository that contains the package.
repository :: Text
The name of the repository that contains the requested package.
format :: PackageFormat
A format that specifies the type of the requested package.
package :: Text
The name of the requested package.

Instances

Instances details

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

newDescribePackage Source #

Arguments

:: Text	`$sel:domain:DescribePackage'`
-> Text	`$sel:repository:DescribePackage'`
-> PackageFormat	`DescribePackage`
-> Text	`DescribePackage`
-> 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.

Constructors

DescribePackageResponse'
Fields httpStatus :: Int The response's http status code. package :: PackageDescription A PackageDescription object that contains information about the requested package.

Instances

Instances details

Generic DescribePackageResponse Source #
Instance details Defined in Amazonka.CodeArtifact.DescribePackage Associated Types type Rep DescribePackageResponse :: Type -> Type # Methods from :: DescribePackageResponse -> Rep DescribePackageResponse x # to :: Rep DescribePackageResponse x -> DescribePackageResponse #
Read DescribePackageResponse Source #
Instance details Defined in Amazonka.CodeArtifact.DescribePackage Methods readsPrec :: Int -> ReadS DescribePackageResponse # readList :: ReadS [DescribePackageResponse] # readPrec :: ReadPrec DescribePackageResponse # readListPrec :: ReadPrec [DescribePackageResponse] #
Show DescribePackageResponse Source #
Instance details Defined in Amazonka.CodeArtifact.DescribePackage Methods showsPrec :: Int -> DescribePackageResponse -> ShowS # show :: DescribePackageResponse -> String # showList :: [DescribePackageResponse] -> ShowS #
NFData DescribePackageResponse Source #
Instance details Defined in Amazonka.CodeArtifact.DescribePackage Methods rnf :: DescribePackageResponse -> () #
Eq DescribePackageResponse Source #
Instance details Defined in Amazonka.CodeArtifact.DescribePackage Methods (==) :: DescribePackageResponse -> DescribePackageResponse -> Bool # (/=) :: DescribePackageResponse -> DescribePackageResponse -> Bool #
type Rep DescribePackageResponse Source #
Instance details Defined in Amazonka.CodeArtifact.DescribePackage type Rep DescribePackageResponse = D1 ('MetaData "DescribePackageResponse" "Amazonka.CodeArtifact.DescribePackage" "amazonka-codeartifact-2.0-CskMABZQLQJDgej73fXQxp" 'False) (C1 ('MetaCons "DescribePackageResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "package") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PackageDescription)))

newDescribePackageResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribePackageResponse'`
-> PackageDescription	`DescribePackage`
-> DescribePackageResponse

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.