Amazonka.CodeArtifact.ListPackages

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

This operation returns paginated results.

Creating a Request

data ListPackages

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

ToJSON ListPackages

Defined in Amazonka.CodeArtifact.ListPackages

Methods

toJSON :: ListPackages -> Value

toEncoding :: ListPackages -> Encoding

toJSONList :: [ListPackages] -> Value

toEncodingList :: [ListPackages] -> Encoding

ToHeaders ListPackages

Defined in Amazonka.CodeArtifact.ListPackages

Methods

toHeaders :: ListPackages -> [Header]

ToPath ListPackages

Defined in Amazonka.CodeArtifact.ListPackages

Methods

toPath :: ListPackages -> ByteString

ToQuery ListPackages

Defined in Amazonka.CodeArtifact.ListPackages

Methods

toQuery :: ListPackages -> QueryString

AWSPager ListPackages

Defined in Amazonka.CodeArtifact.ListPackages

Methods

page :: ListPackages -> AWSResponse ListPackages -> Maybe ListPackages

AWSRequest ListPackages

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

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

Defined in Amazonka.CodeArtifact.ListPackages

Methods

readsPrec :: Int -> ReadS ListPackages

readList :: ReadS [ListPackages]

readPrec :: ReadPrec ListPackages

readListPrec :: ReadPrec [ListPackages]

Show ListPackages

Defined in Amazonka.CodeArtifact.ListPackages

Methods

showsPrec :: Int -> ListPackages -> ShowS

show :: ListPackages -> String

showList :: [ListPackages] -> ShowS

NFData ListPackages

Defined in Amazonka.CodeArtifact.ListPackages

Methods

rnf :: ListPackages -> ()

Eq ListPackages

Defined in Amazonka.CodeArtifact.ListPackages

Methods

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

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

Hashable ListPackages

Defined in Amazonka.CodeArtifact.ListPackages

Methods

hashWithSalt :: Int -> ListPackages -> Int

hash :: ListPackages -> Int

type AWSResponse ListPackages

Defined in Amazonka.CodeArtifact.ListPackages

type AWSResponse ListPackages = ListPackagesResponse

type Rep ListPackages

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

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)

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)

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

listPackages_maxResults :: Lens' ListPackages (Maybe Natural)

The maximum number of results to return per page.

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

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

listPackages_packagePrefix :: Lens' ListPackages (Maybe Text)

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

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

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

listPackages_domain :: Lens' ListPackages Text

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

listPackages_repository :: Lens' ListPackages Text

The name of the repository that contains the requested packages.

Destructuring the Response

data ListPackagesResponse

See: newListPackagesResponse smart constructor.

Constructors

ListPackagesResponse'

Fields

• nextToken :: Maybe Text

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

• packages :: Maybe [PackageSummary]

  The list of returned PackageSummary objects.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListPackagesResponse

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

Defined in Amazonka.CodeArtifact.ListPackages

Methods

readsPrec :: Int -> ReadS ListPackagesResponse

readList :: ReadS [ListPackagesResponse]

readPrec :: ReadPrec ListPackagesResponse

readListPrec :: ReadPrec [ListPackagesResponse]

Show ListPackagesResponse

Defined in Amazonka.CodeArtifact.ListPackages

Methods

showsPrec :: Int -> ListPackagesResponse -> ShowS

show :: ListPackagesResponse -> String

showList :: [ListPackagesResponse] -> ShowS

NFData ListPackagesResponse

Defined in Amazonka.CodeArtifact.ListPackages

Methods

rnf :: ListPackagesResponse -> ()

Eq ListPackagesResponse

Defined in Amazonka.CodeArtifact.ListPackages

Methods

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

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

type Rep ListPackagesResponse

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

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)

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

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

The list of returned PackageSummary objects.

listPackagesResponse_httpStatus :: Lens' ListPackagesResponse Int

The response's http status code.