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 |
Describes repositories in a public registry.
This operation returns paginated results.
Synopsis
- data DescribeRepositories = DescribeRepositories' {
- registryId :: Maybe Text
- repositoryNames :: Maybe (NonEmpty Text)
- nextToken :: Maybe Text
- maxResults :: Maybe Natural
- newDescribeRepositories :: DescribeRepositories
- describeRepositories_registryId :: Lens' DescribeRepositories (Maybe Text)
- describeRepositories_repositoryNames :: Lens' DescribeRepositories (Maybe (NonEmpty Text))
- describeRepositories_nextToken :: Lens' DescribeRepositories (Maybe Text)
- describeRepositories_maxResults :: Lens' DescribeRepositories (Maybe Natural)
- data DescribeRepositoriesResponse = DescribeRepositoriesResponse' {
- repositories :: Maybe [Repository]
- nextToken :: Maybe Text
- httpStatus :: Int
- newDescribeRepositoriesResponse :: Int -> DescribeRepositoriesResponse
- describeRepositoriesResponse_repositories :: Lens' DescribeRepositoriesResponse (Maybe [Repository])
- describeRepositoriesResponse_nextToken :: Lens' DescribeRepositoriesResponse (Maybe Text)
- describeRepositoriesResponse_httpStatus :: Lens' DescribeRepositoriesResponse Int
Creating a Request
data DescribeRepositories Source #
See: newDescribeRepositories
smart constructor.
DescribeRepositories' | |
|
Instances
newDescribeRepositories :: DescribeRepositories Source #
Create a value of DescribeRepositories
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:registryId:DescribeRepositories'
, describeRepositories_registryId
- The AWS account ID associated with the registry that contains the
repositories to be described. If you do not specify a registry, the
default public registry is assumed.
$sel:repositoryNames:DescribeRepositories'
, describeRepositories_repositoryNames
- A list of repositories to describe. If this parameter is omitted, then
all repositories in a registry are described.
$sel:nextToken:DescribeRepositories'
, describeRepositories_nextToken
- The nextToken
value returned from a previous paginated
DescribeRepositories
request where maxResults
was used and the
results exceeded the value of that parameter. Pagination continues from
the end of the previous results that returned the nextToken
value.
This value is null
when there are no more results to return. This
option cannot be used when you specify repositories with
repositoryNames
.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
$sel:maxResults:DescribeRepositories'
, describeRepositories_maxResults
- The maximum number of repository results returned by
DescribeRepositories
in paginated output. When this parameter is used,
DescribeRepositories
only returns maxResults
results in a single
page along with a nextToken
response element. The remaining results of
the initial request can be seen by sending another
DescribeRepositories
request with the returned nextToken
value. This
value can be between 1 and 1000. If this parameter is not used, then
DescribeRepositories
returns up to 100 results and a nextToken
value, if applicable. This option cannot be used when you specify
repositories with repositoryNames
.
Request Lenses
describeRepositories_registryId :: Lens' DescribeRepositories (Maybe Text) Source #
The AWS account ID associated with the registry that contains the repositories to be described. If you do not specify a registry, the default public registry is assumed.
describeRepositories_repositoryNames :: Lens' DescribeRepositories (Maybe (NonEmpty Text)) Source #
A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.
describeRepositories_nextToken :: Lens' DescribeRepositories (Maybe Text) Source #
The nextToken
value returned from a previous paginated
DescribeRepositories
request where maxResults
was used and the
results exceeded the value of that parameter. Pagination continues from
the end of the previous results that returned the nextToken
value.
This value is null
when there are no more results to return. This
option cannot be used when you specify repositories with
repositoryNames
.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
describeRepositories_maxResults :: Lens' DescribeRepositories (Maybe Natural) Source #
The maximum number of repository results returned by
DescribeRepositories
in paginated output. When this parameter is used,
DescribeRepositories
only returns maxResults
results in a single
page along with a nextToken
response element. The remaining results of
the initial request can be seen by sending another
DescribeRepositories
request with the returned nextToken
value. This
value can be between 1 and 1000. If this parameter is not used, then
DescribeRepositories
returns up to 100 results and a nextToken
value, if applicable. This option cannot be used when you specify
repositories with repositoryNames
.
Destructuring the Response
data DescribeRepositoriesResponse Source #
See: newDescribeRepositoriesResponse
smart constructor.
DescribeRepositoriesResponse' | |
|
Instances
newDescribeRepositoriesResponse Source #
Create a value of DescribeRepositoriesResponse
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:repositories:DescribeRepositoriesResponse'
, describeRepositoriesResponse_repositories
- A list of repository objects corresponding to valid repositories.
$sel:nextToken:DescribeRepositories'
, describeRepositoriesResponse_nextToken
- The nextToken
value to include in a future DescribeRepositories
request. When the results of a DescribeRepositories
request exceed
maxResults
, this value can be used to retrieve the next page of
results. This value is null
when there are no more results to return.
$sel:httpStatus:DescribeRepositoriesResponse'
, describeRepositoriesResponse_httpStatus
- The response's http status code.
Response Lenses
describeRepositoriesResponse_repositories :: Lens' DescribeRepositoriesResponse (Maybe [Repository]) Source #
A list of repository objects corresponding to valid repositories.
describeRepositoriesResponse_nextToken :: Lens' DescribeRepositoriesResponse (Maybe Text) Source #
The nextToken
value to include in a future DescribeRepositories
request. When the results of a DescribeRepositories
request exceed
maxResults
, this value can be used to retrieve the next page of
results. This value is null
when there are no more results to return.
describeRepositoriesResponse_httpStatus :: Lens' DescribeRepositoriesResponse Int Source #
The response's http status code.