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

Amazonka.ECR.ListImages

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

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

Read ListImages Source # 
Instance details

Defined in Amazonka.ECR.ListImages

Show ListImages Source # 
Instance details

Defined in Amazonka.ECR.ListImages

Generic ListImages Source # 
Instance details

Defined in Amazonka.ECR.ListImages

Associated Types

type Rep ListImages :: Type -> Type #

NFData ListImages Source # 
Instance details

Defined in Amazonka.ECR.ListImages

Methods

rnf :: ListImages -> () #

Hashable ListImages Source # 
Instance details

Defined in Amazonka.ECR.ListImages

ToJSON ListImages Source # 
Instance details

Defined in Amazonka.ECR.ListImages

AWSPager ListImages Source # 
Instance details

Defined in Amazonka.ECR.ListImages

AWSRequest ListImages Source # 
Instance details

Defined in Amazonka.ECR.ListImages

Associated Types

type 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

ToQuery ListImages Source # 
Instance details

Defined in Amazonka.ECR.ListImages

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

newListImages Source #

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

Read ListImagesResponse Source # 
Instance details

Defined in Amazonka.ECR.ListImages

Show ListImagesResponse Source # 
Instance details

Defined in Amazonka.ECR.ListImages

Generic ListImagesResponse Source # 
Instance details

Defined in Amazonka.ECR.ListImages

Associated Types

type Rep ListImagesResponse :: Type -> Type #

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 #

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.