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 details for a public registry.
This operation returns paginated results.
Synopsis
- data DescribeRegistries = DescribeRegistries' {}
- newDescribeRegistries :: DescribeRegistries
- describeRegistries_maxResults :: Lens' DescribeRegistries (Maybe Natural)
- describeRegistries_nextToken :: Lens' DescribeRegistries (Maybe Text)
- data DescribeRegistriesResponse = DescribeRegistriesResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- registries :: [Registry]
- newDescribeRegistriesResponse :: Int -> DescribeRegistriesResponse
- describeRegistriesResponse_nextToken :: Lens' DescribeRegistriesResponse (Maybe Text)
- describeRegistriesResponse_httpStatus :: Lens' DescribeRegistriesResponse Int
- describeRegistriesResponse_registries :: Lens' DescribeRegistriesResponse [Registry]
Creating a Request
data DescribeRegistries Source #
See: newDescribeRegistries
smart constructor.
DescribeRegistries' | |
|
Instances
newDescribeRegistries :: DescribeRegistries Source #
Create a value of DescribeRegistries
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:maxResults:DescribeRegistries'
, describeRegistries_maxResults
- The maximum number of repository results returned by
DescribeRegistries
in paginated output. When this parameter is used,
DescribeRegistries
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 DescribeRegistries
request with the returned nextToken
value. This value can be between 1
and 1000. If this parameter is not used, then DescribeRegistries
returns up to 100 results and a nextToken
value, if applicable.
DescribeRegistries
, describeRegistries_nextToken
- The nextToken
value returned from a previous paginated
DescribeRegistries
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 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.
Request Lenses
describeRegistries_maxResults :: Lens' DescribeRegistries (Maybe Natural) Source #
The maximum number of repository results returned by
DescribeRegistries
in paginated output. When this parameter is used,
DescribeRegistries
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 DescribeRegistries
request with the returned nextToken
value. This value can be between 1
and 1000. If this parameter is not used, then DescribeRegistries
returns up to 100 results and a nextToken
value, if applicable.
describeRegistries_nextToken :: Lens' DescribeRegistries (Maybe Text) Source #
The nextToken
value returned from a previous paginated
DescribeRegistries
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 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.
Destructuring the Response
data DescribeRegistriesResponse Source #
See: newDescribeRegistriesResponse
smart constructor.
DescribeRegistriesResponse' | |
|
Instances
newDescribeRegistriesResponse Source #
Create a value of DescribeRegistriesResponse
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:
DescribeRegistries
, describeRegistriesResponse_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:DescribeRegistriesResponse'
, describeRegistriesResponse_httpStatus
- The response's http status code.
$sel:registries:DescribeRegistriesResponse'
, describeRegistriesResponse_registries
- An object containing the details for a public registry.
Response Lenses
describeRegistriesResponse_nextToken :: Lens' DescribeRegistriesResponse (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.
describeRegistriesResponse_httpStatus :: Lens' DescribeRegistriesResponse Int Source #
The response's http status code.
describeRegistriesResponse_registries :: Lens' DescribeRegistriesResponse [Registry] Source #
An object containing the details for a public registry.