Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Returns metadata about the images in a repository, including image size and creation date.
This operation returns paginated results.
- describeImages :: Text -> DescribeImages
- data DescribeImages
- diRegistryId :: Lens' DescribeImages (Maybe Text)
- diImageIds :: Lens' DescribeImages [ImageIdentifier]
- diNextToken :: Lens' DescribeImages (Maybe Text)
- diFilter :: Lens' DescribeImages (Maybe DescribeImagesFilter)
- diMaxResults :: Lens' DescribeImages (Maybe Natural)
- diRepositoryName :: Lens' DescribeImages Text
- describeImagesResponse :: Int -> DescribeImagesResponse
- data DescribeImagesResponse
- dirsImageDetails :: Lens' DescribeImagesResponse [ImageDetail]
- dirsNextToken :: Lens' DescribeImagesResponse (Maybe Text)
- dirsResponseStatus :: Lens' DescribeImagesResponse Int
Creating a Request
Creates a value of DescribeImages
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
diRegistryId
- The AWS account ID associated with the registry that contains the repository in which to list images. If you do not specify a registry, the default registry is assumed.diImageIds
- The list of image IDs for the requested repository.diNextToken
- ThenextToken
value returned from a previous paginatedDescribeImages
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.diFilter
- The filter key and value with which to filter yourDescribeImages
results.diMaxResults
- The maximum number of repository results returned byDescribeImages
in paginated output. When this parameter is used,DescribeImages
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherDescribeImages
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenDescribeImages
returns up to 100 results and anextToken
value, if applicable.diRepositoryName
- A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.
data DescribeImages Source #
See: describeImages
smart constructor.
Request Lenses
diRegistryId :: Lens' DescribeImages (Maybe Text) Source #
The AWS account ID associated with the registry that contains the repository in which to list images. If you do not specify a registry, the default registry is assumed.
diImageIds :: Lens' DescribeImages [ImageIdentifier] Source #
The list of image IDs for the requested repository.
diNextToken :: Lens' DescribeImages (Maybe Text) Source #
The nextToken
value returned from a previous paginated DescribeImages
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.
diFilter :: Lens' DescribeImages (Maybe DescribeImagesFilter) Source #
The filter key and value with which to filter your DescribeImages
results.
diMaxResults :: Lens' DescribeImages (Maybe Natural) Source #
The maximum number of repository results returned by DescribeImages
in paginated output. When this parameter is used, DescribeImages
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 DescribeImages
request with the returned nextToken
value. This value can be between 1 and 100. If this parameter is not used, then DescribeImages
returns up to 100 results and a nextToken
value, if applicable.
diRepositoryName :: Lens' DescribeImages Text Source #
A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.
Destructuring the Response
describeImagesResponse Source #
Creates a value of DescribeImagesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dirsImageDetails
- A list ofImageDetail
objects that contain data about the image.dirsNextToken
- ThenextToken
value to include in a futureDescribeImages
request. When the results of aDescribeImages
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.dirsResponseStatus
- -- | The response status code.
data DescribeImagesResponse Source #
See: describeImagesResponse
smart constructor.
Response Lenses
dirsImageDetails :: Lens' DescribeImagesResponse [ImageDetail] Source #
A list of ImageDetail
objects that contain data about the image.
dirsNextToken :: Lens' DescribeImagesResponse (Maybe Text) Source #
The nextToken
value to include in a future DescribeImages
request. When the results of a DescribeImages
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.
dirsResponseStatus :: Lens' DescribeImagesResponse Int Source #
- - | The response status code.