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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of PackageSummary objects for packages in a repository that match the request parameters.

This operation returns paginated results.

Synopsis

data ListPackages = ListPackages' {
- format :: Maybe PackageFormat
- namespace :: Maybe Text
- domainOwner :: Maybe Text
- nextToken :: Maybe Text
- packagePrefix :: Maybe Text
- maxResults :: Maybe Natural
- domain :: Text
- repository :: Text
}
newListPackages :: Text -> Text -> ListPackages
listPackages_format :: Lens' ListPackages (Maybe PackageFormat)
listPackages_namespace :: Lens' ListPackages (Maybe Text)
listPackages_domainOwner :: Lens' ListPackages (Maybe Text)
listPackages_nextToken :: Lens' ListPackages (Maybe Text)
listPackages_packagePrefix :: Lens' ListPackages (Maybe Text)
listPackages_maxResults :: Lens' ListPackages (Maybe Natural)
listPackages_domain :: Lens' ListPackages Text
listPackages_repository :: Lens' ListPackages Text
data ListPackagesResponse = ListPackagesResponse' {
- packages :: Maybe [PackageSummary]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListPackagesResponse :: Int -> ListPackagesResponse
listPackagesResponse_packages :: Lens' ListPackagesResponse (Maybe [PackageSummary])
listPackagesResponse_nextToken :: Lens' ListPackagesResponse (Maybe Text)
listPackagesResponse_httpStatus :: Lens' ListPackagesResponse Int

Creating a Request

data ListPackages Source #

See: newListPackages smart constructor.

Constructors

ListPackages'

Fields

format :: Maybe PackageFormat
The format of the packages. The valid package types are:
- npm: A Node Package Manager (npm) package.
- pypi: A Python Package Index (PyPI) package.
- maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.
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.
nextToken :: Maybe Text
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
packagePrefix :: Maybe Text
A prefix used to filter returned packages. Only packages with names that start with packagePrefix are returned.
maxResults :: Maybe Natural
The maximum number of results to return per page.
domain :: Text
The name of the domain that contains the repository that contains the requested list of packages.
repository :: Text
The name of the repository from which packages are to be listed.

Instances

Instances details

Eq ListPackages Source #
Instance details Defined in Amazonka.CodeArtifact.ListPackages Methods (==) :: ListPackages -> ListPackages -> Bool # (/=) :: ListPackages -> ListPackages -> Bool #
Read ListPackages Source #
Instance details Defined in Amazonka.CodeArtifact.ListPackages Methods readsPrec :: Int -> ReadS ListPackages # readList :: ReadS [ListPackages] # readPrec :: ReadPrec ListPackages # readListPrec :: ReadPrec [ListPackages] #
Show ListPackages Source #
Instance details Defined in Amazonka.CodeArtifact.ListPackages Methods showsPrec :: Int -> ListPackages -> ShowS # show :: ListPackages -> String # showList :: [ListPackages] -> ShowS #
Generic ListPackages Source #
Instance details Defined in Amazonka.CodeArtifact.ListPackages Associated Types type Rep ListPackages :: Type -> Type # Methods from :: ListPackages -> Rep ListPackages x # to :: Rep ListPackages x -> ListPackages #
NFData ListPackages Source #
Instance details Defined in Amazonka.CodeArtifact.ListPackages Methods rnf :: ListPackages -> () #
Hashable ListPackages Source #
Instance details Defined in Amazonka.CodeArtifact.ListPackages Methods hashWithSalt :: Int -> ListPackages -> Int # hash :: ListPackages -> Int #
ToJSON ListPackages Source #
Instance details Defined in Amazonka.CodeArtifact.ListPackages Methods toJSON :: ListPackages -> Value # toEncoding :: ListPackages -> Encoding # toJSONList :: [ListPackages] -> Value # toEncodingList :: [ListPackages] -> Encoding #
AWSPager ListPackages Source #
Instance details Defined in Amazonka.CodeArtifact.ListPackages Methods page :: ListPackages -> AWSResponse ListPackages -> Maybe ListPackages #
AWSRequest ListPackages Source #
Instance details Defined in Amazonka.CodeArtifact.ListPackages Associated Types type AWSResponse ListPackages # Methods request :: ListPackages -> Request ListPackages # response :: MonadResource m => Logger -> Service -> Proxy ListPackages -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListPackages))) #
ToHeaders ListPackages Source #
Instance details Defined in Amazonka.CodeArtifact.ListPackages Methods toHeaders :: ListPackages -> [Header] #
ToPath ListPackages Source #
Instance details Defined in Amazonka.CodeArtifact.ListPackages Methods toPath :: ListPackages -> ByteString #
ToQuery ListPackages Source #
Instance details Defined in Amazonka.CodeArtifact.ListPackages Methods toQuery :: ListPackages -> QueryString #
type Rep ListPackages Source #
Instance details Defined in Amazonka.CodeArtifact.ListPackages type Rep ListPackages = D1 ('MetaData "ListPackages" "Amazonka.CodeArtifact.ListPackages" "libZSservicesZSamazonka-codeartifactZSamazonka-codeartifact" 'False) (C1 ('MetaCons "ListPackages'" '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 "domainOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "packagePrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "repository") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse ListPackages Source #
Instance details Defined in Amazonka.CodeArtifact.ListPackages type AWSResponse ListPackages = ListPackagesResponse

newListPackages Source #

Arguments

:: Text	`$sel:domain:ListPackages'`
-> Text	`$sel:repository:ListPackages'`
-> ListPackages

Create a value of ListPackages 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:format:ListPackages', listPackages_format - The format of the packages. The valid package types are:

npm: A Node Package Manager (npm) package.
pypi: A Python Package Index (PyPI) package.
maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.

$sel:namespace:ListPackages', listPackages_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:ListPackages', listPackages_domainOwner - The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

$sel:nextToken:ListPackages', listPackages_nextToken - The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

$sel:packagePrefix:ListPackages', listPackages_packagePrefix - A prefix used to filter returned packages. Only packages with names that start with packagePrefix are returned.

$sel:maxResults:ListPackages', listPackages_maxResults - The maximum number of results to return per page.

$sel:domain:ListPackages', listPackages_domain - The name of the domain that contains the repository that contains the requested list of packages.

$sel:repository:ListPackages', listPackages_repository - The name of the repository from which packages are to be listed.

Request Lenses

listPackages_format :: Lens' ListPackages (Maybe PackageFormat) Source #

The format of the packages. The valid package types are:

npm: A Node Package Manager (npm) package.
pypi: A Python Package Index (PyPI) package.
maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.

listPackages_namespace :: Lens' ListPackages (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.

listPackages_domainOwner :: Lens' ListPackages (Maybe Text) Source #

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

listPackages_nextToken :: Lens' ListPackages (Maybe Text) Source #

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

listPackages_packagePrefix :: Lens' ListPackages (Maybe Text) Source #

A prefix used to filter returned packages. Only packages with names that start with packagePrefix are returned.

listPackages_maxResults :: Lens' ListPackages (Maybe Natural) Source #

The maximum number of results to return per page.

listPackages_domain :: Lens' ListPackages Text Source #

The name of the domain that contains the repository that contains the requested list of packages.

listPackages_repository :: Lens' ListPackages Text Source #

The name of the repository from which packages are to be listed.

Destructuring the Response

data ListPackagesResponse Source #

See: newListPackagesResponse smart constructor.

Constructors

ListPackagesResponse'
Fields packages :: Maybe [PackageSummary] The list of returned PackageSummary objects. nextToken :: Maybe Text If there are additional results, this is the token for the next set of results. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListPackagesResponse Source #

Arguments

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

Create a value of ListPackagesResponse 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:packages:ListPackagesResponse', listPackagesResponse_packages - The list of returned PackageSummary objects.

$sel:nextToken:ListPackages', listPackagesResponse_nextToken - If there are additional results, this is the token for the next set of results.

$sel:httpStatus:ListPackagesResponse', listPackagesResponse_httpStatus - The response's http status code.

Response Lenses

listPackagesResponse_packages :: Lens' ListPackagesResponse (Maybe [PackageSummary]) Source #

The list of returned PackageSummary objects.

listPackagesResponse_nextToken :: Lens' ListPackagesResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

listPackagesResponse_httpStatus :: Lens' ListPackagesResponse Int Source #

The response's http status code.