| 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 |
Network.AWS.ECR.DescribeImages
Description
Returns metadata about the images in a repository, including image size, image tags, and creation date.
This operation returns paginated results.
Synopsis
- 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
Arguments
| :: Text | |
| -> DescribeImages |
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 describe images. If you do not specify a registry, the default registry is assumed.diImageIds- The list of image IDs for the requested repository.diNextToken- ThenextTokenvalue returned from a previous paginatedDescribeImagesrequest wheremaxResultswas used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextTokenvalue. This value isnullwhen there are no more results to return. This option cannot be used when you specify images withimageIds.diFilter- The filter key and value with which to filter yourDescribeImagesresults.diMaxResults- The maximum number of repository results returned byDescribeImagesin paginated output. When this parameter is used,DescribeImagesonly returnsmaxResultsresults in a single page along with anextTokenresponse element. The remaining results of the initial request can be seen by sending anotherDescribeImagesrequest with the returnednextTokenvalue. This value can be between 1 and 100. If this parameter is not used, thenDescribeImagesreturns up to 100 results and anextTokenvalue, if applicable. This option cannot be used when you specify images withimageIds.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.
Instances
Request Lenses
diRegistryId :: Lens' DescribeImages (Maybe Text) Source #
The AWS account ID associated with the registry that contains the repository in which to describe 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. This option cannot be used when you specify images with imageIds .
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. This option cannot be used when you specify images with imageIds .
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 #
Arguments
| :: Int | |
| -> DescribeImagesResponse |
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 ofImageDetailobjects that contain data about the image.dirsNextToken- ThenextTokenvalue to include in a futureDescribeImagesrequest. When the results of aDescribeImagesrequest exceedmaxResults, this value can be used to retrieve the next page of results. This value isnullwhen there are no more results to return.dirsResponseStatus- -- | The response status code.
data DescribeImagesResponse Source #
See: describeImagesResponse smart constructor.
Instances
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.