Copyright	(c) 2013-2021 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

Amazonka.ECR.ListImages

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists all the image IDs for the specified repository.

You can filter images based on whether or not they are tagged by using the tagStatus filter and specifying either TAGGED, UNTAGGED or ANY. 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.

Synopsis

data ListImages = ListImages' {
- registryId :: Maybe Text
- nextToken :: Maybe Text
- filter' :: Maybe ListImagesFilter
- maxResults :: Maybe Natural
- repositoryName :: Text
}
newListImages :: Text -> ListImages
listImages_registryId :: Lens' ListImages (Maybe Text)
listImages_nextToken :: Lens' ListImages (Maybe Text)
listImages_filter :: Lens' ListImages (Maybe ListImagesFilter)
listImages_maxResults :: Lens' ListImages (Maybe Natural)
listImages_repositoryName :: Lens' ListImages Text
data ListImagesResponse = ListImagesResponse' {
- imageIds :: Maybe [ImageIdentifier]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListImagesResponse :: Int -> ListImagesResponse
listImagesResponse_imageIds :: Lens' ListImagesResponse (Maybe [ImageIdentifier])
listImagesResponse_nextToken :: Lens' ListImagesResponse (Maybe Text)
listImagesResponse_httpStatus :: Lens' ListImagesResponse Int

Creating a Request

data ListImages Source #

See: newListImages smart constructor.

Constructors

ListImages'

Fields

registryId :: Maybe Text
The Amazon Web Services 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.
nextToken :: Maybe Text
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.
filter' :: Maybe ListImagesFilter
The filter key and value with which to filter your ListImages results.
maxResults :: Maybe Natural
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 1000. If this parameter is not used, then ListImages returns up to 100 results and a nextToken value, if applicable.
repositoryName :: Text
The repository with image IDs to be listed.

Instances

Instances details

Eq ListImages Source #
Instance details Defined in Amazonka.ECR.ListImages Methods (==) :: ListImages -> ListImages -> Bool # (/=) :: ListImages -> ListImages -> Bool #
Read ListImages Source #
Instance details Defined in Amazonka.ECR.ListImages Methods readsPrec :: Int -> ReadS ListImages # readList :: ReadS [ListImages] # readPrec :: ReadPrec ListImages # readListPrec :: ReadPrec [ListImages] #
Show ListImages Source #
Instance details Defined in Amazonka.ECR.ListImages Methods showsPrec :: Int -> ListImages -> ShowS # show :: ListImages -> String # showList :: [ListImages] -> ShowS #
Generic ListImages Source #
Instance details Defined in Amazonka.ECR.ListImages Associated Types type Rep ListImages :: Type -> Type # Methods from :: ListImages -> Rep ListImages x # to :: Rep ListImages x -> ListImages #
NFData ListImages Source #
Instance details Defined in Amazonka.ECR.ListImages Methods rnf :: ListImages -> () #
Hashable ListImages Source #
Instance details Defined in Amazonka.ECR.ListImages Methods hashWithSalt :: Int -> ListImages -> Int # hash :: ListImages -> Int #
ToJSON ListImages Source #
Instance details Defined in Amazonka.ECR.ListImages Methods toJSON :: ListImages -> Value # toEncoding :: ListImages -> Encoding # toJSONList :: [ListImages] -> Value # toEncodingList :: [ListImages] -> Encoding #
AWSPager ListImages Source #
Instance details Defined in Amazonka.ECR.ListImages Methods page :: ListImages -> AWSResponse ListImages -> Maybe ListImages #
AWSRequest ListImages Source #
Instance details Defined in Amazonka.ECR.ListImages Associated Types type AWSResponse ListImages # Methods request :: ListImages -> Request ListImages # response :: MonadResource m => Logger -> Service -> Proxy ListImages -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListImages))) #
ToHeaders ListImages Source #
Instance details Defined in Amazonka.ECR.ListImages Methods toHeaders :: ListImages -> [Header] #
ToPath ListImages Source #
Instance details Defined in Amazonka.ECR.ListImages Methods toPath :: ListImages -> ByteString #
ToQuery ListImages Source #
Instance details Defined in Amazonka.ECR.ListImages Methods toQuery :: ListImages -> QueryString #
type Rep ListImages Source #
Instance details Defined in Amazonka.ECR.ListImages type Rep ListImages = D1 ('MetaData "ListImages" "Amazonka.ECR.ListImages" "libZSservicesZSamazonka-ecrZSamazonka-ecr" 'False) (C1 ('MetaCons "ListImages'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "registryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ListImagesFilter)) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "repositoryName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse ListImages Source #
Instance details Defined in Amazonka.ECR.ListImages type AWSResponse ListImages = ListImagesResponse

newListImages Source #

Arguments

:: Text	`$sel:repositoryName:ListImages'`
-> ListImages

Create a value of ListImages 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:registryId:ListImages', listImages_registryId - The Amazon Web Services 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.

$sel:nextToken:ListImages', listImages_nextToken - 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.

$sel:filter':ListImages', listImages_filter - The filter key and value with which to filter your ListImages results.

$sel:maxResults:ListImages', listImages_maxResults - 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 1000. If this parameter is not used, then ListImages returns up to 100 results and a nextToken value, if applicable.

$sel:repositoryName:ListImages', listImages_repositoryName - The repository with image IDs to be listed.

Request Lenses

listImages_registryId :: Lens' ListImages (Maybe Text) Source #

The Amazon Web Services 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.

listImages_nextToken :: 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.

listImages_filter :: Lens' ListImages (Maybe ListImagesFilter) Source #

The filter key and value with which to filter your ListImages results.

listImages_maxResults :: 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 1000. If this parameter is not used, then ListImages returns up to 100 results and a nextToken value, if applicable.

listImages_repositoryName :: Lens' ListImages Text Source #

The repository with image IDs to be listed.

Destructuring the Response

data ListImagesResponse Source #

See: newListImagesResponse smart constructor.

Constructors

ListImagesResponse'

Fields

imageIds :: Maybe [ImageIdentifier]
The list of image IDs for the requested repository.
nextToken :: Maybe Text
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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq ListImagesResponse Source #
Instance details Defined in Amazonka.ECR.ListImages Methods (==) :: ListImagesResponse -> ListImagesResponse -> Bool # (/=) :: ListImagesResponse -> ListImagesResponse -> Bool #
Read ListImagesResponse Source #
Instance details Defined in Amazonka.ECR.ListImages Methods readsPrec :: Int -> ReadS ListImagesResponse # readList :: ReadS [ListImagesResponse] # readPrec :: ReadPrec ListImagesResponse # readListPrec :: ReadPrec [ListImagesResponse] #
Show ListImagesResponse Source #
Instance details Defined in Amazonka.ECR.ListImages Methods showsPrec :: Int -> ListImagesResponse -> ShowS # show :: ListImagesResponse -> String # showList :: [ListImagesResponse] -> ShowS #
Generic ListImagesResponse Source #
Instance details Defined in Amazonka.ECR.ListImages Associated Types type Rep ListImagesResponse :: Type -> Type # Methods from :: ListImagesResponse -> Rep ListImagesResponse x # to :: Rep ListImagesResponse x -> ListImagesResponse #
NFData ListImagesResponse Source #
Instance details Defined in Amazonka.ECR.ListImages Methods rnf :: ListImagesResponse -> () #
type Rep ListImagesResponse Source #
Instance details Defined in Amazonka.ECR.ListImages type Rep ListImagesResponse = D1 ('MetaData "ListImagesResponse" "Amazonka.ECR.ListImages" "libZSservicesZSamazonka-ecrZSamazonka-ecr" 'False) (C1 ('MetaCons "ListImagesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "imageIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ImageIdentifier])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListImagesResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListImagesResponse'`
-> ListImagesResponse

Create a value of ListImagesResponse 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:imageIds:ListImagesResponse', listImagesResponse_imageIds - The list of image IDs for the requested repository.

$sel:nextToken:ListImages', listImagesResponse_nextToken - 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.

$sel:httpStatus:ListImagesResponse', listImagesResponse_httpStatus - The response's http status code.

Response Lenses

listImagesResponse_imageIds :: Lens' ListImagesResponse (Maybe [ImageIdentifier]) Source #

The list of image IDs for the requested repository.

listImagesResponse_nextToken :: 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.

listImagesResponse_httpStatus :: Lens' ListImagesResponse Int Source #

The response's http status code.