amazonka-codeartifact-2.0: Amazon CodeArtifact SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CodeArtifact.ListPackages

Description

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

This operation returns paginated results.

Synopsis

Creating a Request

data ListPackages Source #

See: newListPackages smart constructor.

Constructors

ListPackages' 

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.

  • format :: Maybe PackageFormat

    The format used to filter requested packages. Only packages from the provided format will be returned.

  • maxResults :: Maybe Natural

    The maximum number of results to return per page.

  • namespace :: Maybe Text

    The namespace used to filter requested packages. Only packages with the provided namespace will be returned. 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.
    • Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.
  • 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 requested packages. Only packages with names that start with packagePrefix are returned.

  • publish :: Maybe AllowPublish

    The value of the Publish package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.

  • upstream :: Maybe AllowUpstream

    The value of the Upstream package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.

  • domain :: Text

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

  • repository :: Text

    The name of the repository that contains the requested packages.

Instances

Instances details
ToJSON ListPackages Source # 
Instance details

Defined in Amazonka.CodeArtifact.ListPackages

Methods

toJSON :: ListPackages -> Value #

toEncoding :: ListPackages -> Encoding #

toJSONList :: [ListPackages] -> Value #

toEncodingList :: [ListPackages] -> Encoding #

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 #

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 :: (Service -> Service) -> ListPackages -> Request ListPackages #

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

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 #

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 #

NFData ListPackages Source # 
Instance details

Defined in Amazonka.CodeArtifact.ListPackages

Methods

rnf :: ListPackages -> () #

Eq ListPackages Source # 
Instance details

Defined in Amazonka.CodeArtifact.ListPackages

Methods

(==) :: ListPackages -> ListPackages -> Bool #

(/=) :: ListPackages -> ListPackages -> Bool #

Hashable ListPackages Source # 
Instance details

Defined in Amazonka.CodeArtifact.ListPackages

Methods

hashWithSalt :: Int -> ListPackages -> Int #

hash :: ListPackages -> Int #

type AWSResponse ListPackages Source # 
Instance details

Defined in Amazonka.CodeArtifact.ListPackages

type AWSResponse ListPackages = ListPackagesResponse
type Rep ListPackages Source # 
Instance details

Defined in Amazonka.CodeArtifact.ListPackages

type Rep ListPackages = D1 ('MetaData "ListPackages" "Amazonka.CodeArtifact.ListPackages" "amazonka-codeartifact-2.0-CskMABZQLQJDgej73fXQxp" 'False) (C1 ('MetaCons "ListPackages'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "domainOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PackageFormat))) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "namespace") '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 "publish") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AllowPublish))) :*: (S1 ('MetaSel ('Just "upstream") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AllowUpstream)) :*: (S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "repository") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

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:

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

ListPackages, listPackages_format - The format used to filter requested packages. Only packages from the provided format will be returned.

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

ListPackages, listPackages_namespace - The namespace used to filter requested packages. Only packages with the provided namespace will be returned. 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.
  • Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.

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 requested packages. Only packages with names that start with packagePrefix are returned.

ListPackages, listPackages_publish - The value of the Publish package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.

ListPackages, listPackages_upstream - The value of the Upstream package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.

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

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

Request Lenses

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

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

The format used to filter requested packages. Only packages from the provided format will be returned.

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

The maximum number of results to return per page.

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

The namespace used to filter requested packages. Only packages with the provided namespace will be returned. 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.
  • Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.

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 requested packages. Only packages with names that start with packagePrefix are returned.

listPackages_publish :: Lens' ListPackages (Maybe AllowPublish) Source #

The value of the Publish package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.

listPackages_upstream :: Lens' ListPackages (Maybe AllowUpstream) Source #

The value of the Upstream package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.

listPackages_domain :: Lens' ListPackages Text Source #

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

listPackages_repository :: Lens' ListPackages Text Source #

The name of the repository that contains the requested packages.

Destructuring the Response

data ListPackagesResponse Source #

See: newListPackagesResponse smart constructor.

Constructors

ListPackagesResponse' 

Fields

Instances

Instances details
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 #

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 #

NFData ListPackagesResponse Source # 
Instance details

Defined in Amazonka.CodeArtifact.ListPackages

Methods

rnf :: ListPackagesResponse -> () #

Eq ListPackagesResponse Source # 
Instance details

Defined in Amazonka.CodeArtifact.ListPackages

Methods

(==) :: ListPackagesResponse -> ListPackagesResponse -> Bool #

(/=) :: ListPackagesResponse -> ListPackagesResponse -> Bool #

type Rep ListPackagesResponse Source # 
Instance details

Defined in Amazonka.CodeArtifact.ListPackages

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

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

$sel:packages:ListPackagesResponse', listPackagesResponse_packages - The list of returned PackageSummary objects.

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

Response Lenses

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

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

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

The list of returned PackageSummary objects.

listPackagesResponse_httpStatus :: Lens' ListPackagesResponse Int Source #

The response's http status code.