amazonka-ecr-public-2.0: Amazon Elastic Container Registry Public SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.ECRPublic.DescribeImageTags

Description

Returns the image tag details for a repository in a public registry.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeImageTags Source #

See: newDescribeImageTags smart constructor.

Constructors

DescribeImageTags' 

Fields

  • maxResults :: Maybe Natural

    The maximum number of repository results returned by DescribeImageTags in paginated output. When this parameter is used, DescribeImageTags 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 DescribeImageTags request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeImageTags returns up to 100 results and a nextToken value, if applicable. This option cannot be used when you specify images with imageIds.

  • nextToken :: Maybe Text

    The nextToken value returned from a previous paginated DescribeImageTags 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 option cannot be used when you specify images with imageIds.

  • registryId :: Maybe Text

    The AWS account ID associated with the public registry that contains the repository in which to describe images. If you do not specify a registry, the default public registry is assumed.

  • repositoryName :: Text

    The name of the repository that contains the image tag details to describe.

Instances

Instances details
ToJSON DescribeImageTags Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImageTags

ToHeaders DescribeImageTags Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImageTags

ToPath DescribeImageTags Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImageTags

ToQuery DescribeImageTags Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImageTags

AWSPager DescribeImageTags Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImageTags

AWSRequest DescribeImageTags Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImageTags

Associated Types

type AWSResponse DescribeImageTags #

Generic DescribeImageTags Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImageTags

Associated Types

type Rep DescribeImageTags :: Type -> Type #

Read DescribeImageTags Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImageTags

Show DescribeImageTags Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImageTags

NFData DescribeImageTags Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImageTags

Methods

rnf :: DescribeImageTags -> () #

Eq DescribeImageTags Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImageTags

Hashable DescribeImageTags Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImageTags

type AWSResponse DescribeImageTags Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImageTags

type Rep DescribeImageTags Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImageTags

type Rep DescribeImageTags = D1 ('MetaData "DescribeImageTags" "Amazonka.ECRPublic.DescribeImageTags" "amazonka-ecr-public-2.0-37SU5CHdiHw3VhMeSkOlop" 'False) (C1 ('MetaCons "DescribeImageTags'" 'PrefixI 'True) ((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))))

newDescribeImageTags Source #

Create a value of DescribeImageTags 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:maxResults:DescribeImageTags', describeImageTags_maxResults - The maximum number of repository results returned by DescribeImageTags in paginated output. When this parameter is used, DescribeImageTags 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 DescribeImageTags request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeImageTags returns up to 100 results and a nextToken value, if applicable. This option cannot be used when you specify images with imageIds.

DescribeImageTags, describeImageTags_nextToken - The nextToken value returned from a previous paginated DescribeImageTags 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 option cannot be used when you specify images with imageIds.

DescribeImageTags, describeImageTags_registryId - The AWS account ID associated with the public registry that contains the repository in which to describe images. If you do not specify a registry, the default public registry is assumed.

DescribeImageTags, describeImageTags_repositoryName - The name of the repository that contains the image tag details to describe.

Request Lenses

describeImageTags_maxResults :: Lens' DescribeImageTags (Maybe Natural) Source #

The maximum number of repository results returned by DescribeImageTags in paginated output. When this parameter is used, DescribeImageTags 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 DescribeImageTags request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeImageTags returns up to 100 results and a nextToken value, if applicable. This option cannot be used when you specify images with imageIds.

describeImageTags_nextToken :: Lens' DescribeImageTags (Maybe Text) Source #

The nextToken value returned from a previous paginated DescribeImageTags 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 option cannot be used when you specify images with imageIds.

describeImageTags_registryId :: Lens' DescribeImageTags (Maybe Text) Source #

The AWS account ID associated with the public registry that contains the repository in which to describe images. If you do not specify a registry, the default public registry is assumed.

describeImageTags_repositoryName :: Lens' DescribeImageTags Text Source #

The name of the repository that contains the image tag details to describe.

Destructuring the Response

data DescribeImageTagsResponse Source #

See: newDescribeImageTagsResponse smart constructor.

Constructors

DescribeImageTagsResponse' 

Fields

  • imageTagDetails :: Maybe [ImageTagDetail]

    The image tag details for the images in the requested repository.

  • nextToken :: Maybe Text

    The nextToken value to include in a future DescribeImageTags request. When the results of a DescribeImageTags 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
Generic DescribeImageTagsResponse Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImageTags

Associated Types

type Rep DescribeImageTagsResponse :: Type -> Type #

Read DescribeImageTagsResponse Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImageTags

Show DescribeImageTagsResponse Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImageTags

NFData DescribeImageTagsResponse Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImageTags

Eq DescribeImageTagsResponse Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImageTags

type Rep DescribeImageTagsResponse Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImageTags

type Rep DescribeImageTagsResponse = D1 ('MetaData "DescribeImageTagsResponse" "Amazonka.ECRPublic.DescribeImageTags" "amazonka-ecr-public-2.0-37SU5CHdiHw3VhMeSkOlop" 'False) (C1 ('MetaCons "DescribeImageTagsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "imageTagDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ImageTagDetail])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeImageTagsResponse Source #

Create a value of DescribeImageTagsResponse 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:imageTagDetails:DescribeImageTagsResponse', describeImageTagsResponse_imageTagDetails - The image tag details for the images in the requested repository.

DescribeImageTags, describeImageTagsResponse_nextToken - The nextToken value to include in a future DescribeImageTags request. When the results of a DescribeImageTags 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:DescribeImageTagsResponse', describeImageTagsResponse_httpStatus - The response's http status code.

Response Lenses

describeImageTagsResponse_imageTagDetails :: Lens' DescribeImageTagsResponse (Maybe [ImageTagDetail]) Source #

The image tag details for the images in the requested repository.

describeImageTagsResponse_nextToken :: Lens' DescribeImageTagsResponse (Maybe Text) Source #

The nextToken value to include in a future DescribeImageTags request. When the results of a DescribeImageTags 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.