Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
Describes image repositories in a registry.
This operation returns paginated results.
Synopsis
- describeRepositories :: DescribeRepositories
- data DescribeRepositories
- drRegistryId :: Lens' DescribeRepositories (Maybe Text)
- drRepositoryNames :: Lens' DescribeRepositories (Maybe (NonEmpty Text))
- drNextToken :: Lens' DescribeRepositories (Maybe Text)
- drMaxResults :: Lens' DescribeRepositories (Maybe Natural)
- describeRepositoriesResponse :: Int -> DescribeRepositoriesResponse
- data DescribeRepositoriesResponse
- drrsRepositories :: Lens' DescribeRepositoriesResponse [Repository]
- drrsNextToken :: Lens' DescribeRepositoriesResponse (Maybe Text)
- drrsResponseStatus :: Lens' DescribeRepositoriesResponse Int
Creating a Request
describeRepositories :: DescribeRepositories Source #
Creates a value of DescribeRepositories
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
drRegistryId
- The AWS account ID associated with the registry that contains the repositories to be described. If you do not specify a registry, the default registry is assumed.drRepositoryNames
- A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.drNextToken
- ThenextToken
value returned from a previous paginatedDescribeRepositories
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value. This value isnull
when there are no more results to return. This option cannot be used when you specify repositories withrepositoryNames
.drMaxResults
- The maximum number of repository results returned byDescribeRepositories
in paginated output. When this parameter is used,DescribeRepositories
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherDescribeRepositories
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenDescribeRepositories
returns up to 100 results and anextToken
value, if applicable. This option cannot be used when you specify repositories withrepositoryNames
.
data DescribeRepositories Source #
See: describeRepositories
smart constructor.
Instances
Request Lenses
drRegistryId :: 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 registry is assumed.
drRepositoryNames :: 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.
drNextToken :: 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
.
drMaxResults :: 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 100. 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
describeRepositoriesResponse Source #
Creates a value of DescribeRepositoriesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
drrsRepositories
- A list of repository objects corresponding to valid repositories.drrsNextToken
- ThenextToken
value to include in a futureDescribeRepositories
request. When the results of aDescribeRepositories
request exceedmaxResults
, this value can be used to retrieve the next page of results. This value isnull
when there are no more results to return.drrsResponseStatus
- -- | The response status code.
data DescribeRepositoriesResponse Source #
See: describeRepositoriesResponse
smart constructor.
Instances
Response Lenses
drrsRepositories :: Lens' DescribeRepositoriesResponse [Repository] Source #
A list of repository objects corresponding to valid repositories.
drrsNextToken :: 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.
drrsResponseStatus :: Lens' DescribeRepositoriesResponse Int Source #
- - | The response status code.