amazonka-ecr-1.4.5: Amazon EC2 Container Registry SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.ECR.ListImages

Contents

Description

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.

Synopsis

Creating a Request

listImages #

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:

  • liRegistryId - 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 - 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.
  • liFilter - The filter key and value with which to filter your ListImages results.
  • liMaxResults - 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 - The repository whose image IDs are to be listed.

data ListImages #

See: listImages smart constructor.

Instances

Eq ListImages # 
Data ListImages # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListImages -> c ListImages #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListImages #

toConstr :: ListImages -> Constr #

dataTypeOf :: ListImages -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListImages) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListImages) #

gmapT :: (forall b. Data b => b -> b) -> ListImages -> ListImages #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListImages -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListImages -> r #

gmapQ :: (forall d. Data d => d -> u) -> ListImages -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListImages -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListImages -> m ListImages #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListImages -> m ListImages #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListImages -> m ListImages #

Read ListImages # 
Show ListImages # 
Generic ListImages # 

Associated Types

type Rep ListImages :: * -> * #

Hashable ListImages # 
ToJSON ListImages # 
NFData ListImages # 

Methods

rnf :: ListImages -> () #

AWSPager ListImages # 
AWSRequest ListImages # 
ToQuery ListImages # 
ToPath ListImages # 
ToHeaders ListImages # 

Methods

toHeaders :: ListImages -> [Header] #

type Rep ListImages # 
type Rep ListImages = D1 (MetaData "ListImages" "Network.AWS.ECR.ListImages" "amazonka-ecr-1.4.5-5nGSxfFcP6f5SQqSnAVfxz" False) (C1 (MetaCons "ListImages'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_liRegistryId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_liNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_liFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ListImagesFilter))) ((:*:) (S1 (MetaSel (Just Symbol "_liMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_liRepositoryName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))
type Rs ListImages # 

Request Lenses

liRegistryId :: Lens' ListImages (Maybe Text) #

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) #

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.

liFilter :: Lens' ListImages (Maybe ListImagesFilter) #

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

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

liRepositoryName :: Lens' ListImages Text #

The repository whose image IDs are to be listed.

Destructuring the Response

listImagesResponse #

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:

  • lirsImageIds - The list of image IDs for the requested repository.
  • lirsNextToken - 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 - -- | The response status code.

data ListImagesResponse #

See: listImagesResponse smart constructor.

Instances

Eq ListImagesResponse # 
Data ListImagesResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListImagesResponse -> c ListImagesResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListImagesResponse #

toConstr :: ListImagesResponse -> Constr #

dataTypeOf :: ListImagesResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListImagesResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListImagesResponse) #

gmapT :: (forall b. Data b => b -> b) -> ListImagesResponse -> ListImagesResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListImagesResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListImagesResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> ListImagesResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListImagesResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListImagesResponse -> m ListImagesResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListImagesResponse -> m ListImagesResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListImagesResponse -> m ListImagesResponse #

Read ListImagesResponse # 
Show ListImagesResponse # 
Generic ListImagesResponse # 
NFData ListImagesResponse # 

Methods

rnf :: ListImagesResponse -> () #

type Rep ListImagesResponse # 
type Rep ListImagesResponse = D1 (MetaData "ListImagesResponse" "Network.AWS.ECR.ListImages" "amazonka-ecr-1.4.5-5nGSxfFcP6f5SQqSnAVfxz" False) (C1 (MetaCons "ListImagesResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_lirsImageIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ImageIdentifier]))) ((:*:) (S1 (MetaSel (Just Symbol "_lirsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_lirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

lirsImageIds :: Lens' ListImagesResponse [ImageIdentifier] #

The list of image IDs for the requested repository.

lirsNextToken :: Lens' ListImagesResponse (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.

lirsResponseStatus :: Lens' ListImagesResponse Int #

  • - | The response status code.