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 list of PackageSummary objects for packages in a repository that match the request parameters.
This operation returns paginated results.
Synopsis
- data ListPackages = ListPackages' {}
- newListPackages :: Text -> Text -> ListPackages
- listPackages_domainOwner :: Lens' ListPackages (Maybe Text)
- listPackages_format :: Lens' ListPackages (Maybe PackageFormat)
- listPackages_maxResults :: Lens' ListPackages (Maybe Natural)
- listPackages_namespace :: Lens' ListPackages (Maybe Text)
- listPackages_nextToken :: Lens' ListPackages (Maybe Text)
- listPackages_packagePrefix :: Lens' ListPackages (Maybe Text)
- listPackages_publish :: Lens' ListPackages (Maybe AllowPublish)
- listPackages_upstream :: Lens' ListPackages (Maybe AllowUpstream)
- listPackages_domain :: Lens' ListPackages Text
- listPackages_repository :: Lens' ListPackages Text
- data ListPackagesResponse = ListPackagesResponse' {
- nextToken :: Maybe Text
- packages :: Maybe [PackageSummary]
- httpStatus :: Int
- newListPackagesResponse :: Int -> ListPackagesResponse
- listPackagesResponse_nextToken :: Lens' ListPackagesResponse (Maybe Text)
- listPackagesResponse_packages :: Lens' ListPackagesResponse (Maybe [PackageSummary])
- listPackagesResponse_httpStatus :: Lens' ListPackagesResponse Int
Creating a Request
data ListPackages Source #
See: newListPackages
smart constructor.
ListPackages' | |
|
Instances
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.
ListPackagesResponse' | |
|
Instances
newListPackagesResponse Source #
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.