Amazonka.ECR.ListImages

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.

Creating a Request

data ListImages

See: newListImages smart constructor.

Constructors

ListImages'

Fields

• 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.

• 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.

• 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.

• repositoryName :: Text

  The repository with image IDs to be listed.

Instances

ToJSON ListImages

Defined in Amazonka.ECR.ListImages

Methods

toJSON :: ListImages -> Value

toEncoding :: ListImages -> Encoding

toJSONList :: [ListImages] -> Value

toEncodingList :: [ListImages] -> Encoding

ToHeaders ListImages

Defined in Amazonka.ECR.ListImages

Methods

toHeaders :: ListImages -> [Header]

ToPath ListImages

Defined in Amazonka.ECR.ListImages

Methods

toPath :: ListImages -> ByteString

ToQuery ListImages

Defined in Amazonka.ECR.ListImages

Methods

toQuery :: ListImages -> QueryString

AWSPager ListImages

Defined in Amazonka.ECR.ListImages

Methods

page :: ListImages -> AWSResponse ListImages -> Maybe ListImages

AWSRequest ListImages

Defined in Amazonka.ECR.ListImages

Associated Types

type AWSResponse ListImages

Methods

request :: (Service -> Service) -> ListImages -> Request ListImages

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListImages -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListImages)))

Generic ListImages

Defined in Amazonka.ECR.ListImages

Associated Types

type Rep ListImages :: Type -> Type

Methods

from :: ListImages -> Rep ListImages x

to :: Rep ListImages x -> ListImages

Read ListImages

Defined in Amazonka.ECR.ListImages

Methods

readsPrec :: Int -> ReadS ListImages

readList :: ReadS [ListImages]

readPrec :: ReadPrec ListImages

readListPrec :: ReadPrec [ListImages]

Show ListImages

Defined in Amazonka.ECR.ListImages

Methods

showsPrec :: Int -> ListImages -> ShowS

show :: ListImages -> String

showList :: [ListImages] -> ShowS

NFData ListImages

Defined in Amazonka.ECR.ListImages

Methods

rnf :: ListImages -> ()

Eq ListImages

Defined in Amazonka.ECR.ListImages

Methods

(==) :: ListImages -> ListImages -> Bool

(/=) :: ListImages -> ListImages -> Bool

Hashable ListImages

Defined in Amazonka.ECR.ListImages

Methods

hashWithSalt :: Int -> ListImages -> Int

hash :: ListImages -> Int

type AWSResponse ListImages

Defined in Amazonka.ECR.ListImages

type AWSResponse ListImages = ListImagesResponse

type Rep ListImages

Defined in Amazonka.ECR.ListImages

type Rep ListImages = D1 ('MetaData "ListImages" "Amazonka.ECR.ListImages" "amazonka-ecr-2.0-BqgZWPod2JCFn2nq69DCrJ" 'False) (C1 ('MetaCons "ListImages'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ListImagesFilter)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "registryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "repositoryName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListImages

Arguments

:: Text

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:

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.

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.

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.

ListImages, listImages_repositoryName - The repository with image IDs to be listed.

Request Lenses

listImages_filter :: Lens' ListImages (Maybe ListImagesFilter)

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

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

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

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_registryId :: Lens' ListImages (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.

listImages_repositoryName :: Lens' ListImages Text

The repository with image IDs to be listed.

Destructuring the Response

data ListImagesResponse

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

Generic ListImagesResponse

Defined in Amazonka.ECR.ListImages

Associated Types

type Rep ListImagesResponse :: Type -> Type

Methods

from :: ListImagesResponse -> Rep ListImagesResponse x

to :: Rep ListImagesResponse x -> ListImagesResponse

Read ListImagesResponse

Defined in Amazonka.ECR.ListImages

Methods

readsPrec :: Int -> ReadS ListImagesResponse

readList :: ReadS [ListImagesResponse]

readPrec :: ReadPrec ListImagesResponse

readListPrec :: ReadPrec [ListImagesResponse]

Show ListImagesResponse

Defined in Amazonka.ECR.ListImages

Methods

showsPrec :: Int -> ListImagesResponse -> ShowS

show :: ListImagesResponse -> String

showList :: [ListImagesResponse] -> ShowS

NFData ListImagesResponse

Defined in Amazonka.ECR.ListImages

Methods

rnf :: ListImagesResponse -> ()

Eq ListImagesResponse

Defined in Amazonka.ECR.ListImages

Methods

(==) :: ListImagesResponse -> ListImagesResponse -> Bool

(/=) :: ListImagesResponse -> ListImagesResponse -> Bool

type Rep ListImagesResponse

Defined in Amazonka.ECR.ListImages

type Rep ListImagesResponse = D1 ('MetaData "ListImagesResponse" "Amazonka.ECR.ListImages" "amazonka-ecr-2.0-BqgZWPod2JCFn2nq69DCrJ" '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

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.

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

The list of image IDs for the requested repository.

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

listImagesResponse_httpStatus :: Lens' ListImagesResponse Int

The response's http status code.