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 |
Lists all the image IDs for a given repository.
You can filter images based on whether or not they are tagged by setting the tagStatus
parameter to TAGGED
or UNTAGGED
. For example, you can filter your results to return only UNTAGGED
images and then pipe that result to a BatchDeleteImage operation to delete them. Or, you can filter your results to return only TAGGED
images to list all of the tags in your repository.
This operation returns paginated results.
- listImages :: Text -> ListImages
- data ListImages
- liRegistryId :: Lens' ListImages (Maybe Text)
- liNextToken :: Lens' ListImages (Maybe Text)
- liFilter :: Lens' ListImages (Maybe ListImagesFilter)
- liMaxResults :: Lens' ListImages (Maybe Natural)
- liRepositoryName :: Lens' ListImages Text
- listImagesResponse :: Int -> ListImagesResponse
- data ListImagesResponse
- lirsImageIds :: Lens' ListImagesResponse [ImageIdentifier]
- lirsNextToken :: Lens' ListImagesResponse (Maybe Text)
- lirsResponseStatus :: Lens' ListImagesResponse Int
Creating a Request
Creates a value of ListImages
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ListImages Source #
See: listImages
smart constructor.
Request Lenses
liRegistryId :: Lens' ListImages (Maybe Text) Source #
The AWS account ID associated with the registry that contains the repository to list images in. If you do not specify a registry, the default registry is assumed.
liNextToken :: Lens' ListImages (Maybe Text) Source #
The nextToken
value returned from a previous paginated ListImages
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.
liFilter :: Lens' ListImages (Maybe ListImagesFilter) Source #
The filter key and value with which to filter your ListImages
results.
liMaxResults :: Lens' ListImages (Maybe Natural) Source #
The maximum number of image results returned by ListImages
in paginated output. When this parameter is used, ListImages
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 ListImages
request with the returned nextToken
value. This value can be between 1 and 100. If this parameter is not used, then ListImages
returns up to 100 results and a nextToken
value, if applicable.
liRepositoryName :: Lens' ListImages Text Source #
The repository whose image IDs are to be listed.
Destructuring the Response
Creates a value of ListImagesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ListImagesResponse Source #
See: listImagesResponse
smart constructor.
Response Lenses
lirsImageIds :: Lens' ListImagesResponse [ImageIdentifier] Source #
The list of image IDs for the requested repository.
lirsNextToken :: Lens' ListImagesResponse (Maybe Text) Source #
The nextToken
value to include in a future ListImages
request. When the results of a ListImages
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.
lirsResponseStatus :: Lens' ListImagesResponse Int Source #
The response status code.