libZSservicesZSamazonka-ecr-publicZSamazonka-ecr-public
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.ECRPublic.DescribeImages

Description

Returns metadata about the images in a repository in a public registry.

Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by DescribeImages.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeImages Source #

See: newDescribeImages smart constructor.

Constructors

DescribeImages' 

Fields

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

  • imageIds :: Maybe (NonEmpty ImageIdentifier)

    The list of image IDs for the requested repository.

  • nextToken :: Maybe Text

    The nextToken value returned from a previous paginated DescribeImages 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.

  • maxResults :: Maybe Natural

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

  • repositoryName :: Text

    The repository that contains the images to describe.

Instances

Instances details
Eq DescribeImages Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImages

Read DescribeImages Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImages

Show DescribeImages Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImages

Generic DescribeImages Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImages

Associated Types

type Rep DescribeImages :: Type -> Type #

NFData DescribeImages Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImages

Methods

rnf :: DescribeImages -> () #

Hashable DescribeImages Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImages

ToJSON DescribeImages Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImages

AWSPager DescribeImages Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImages

AWSRequest DescribeImages Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImages

Associated Types

type AWSResponse DescribeImages #

ToHeaders DescribeImages Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImages

ToPath DescribeImages Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImages

ToQuery DescribeImages Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImages

type Rep DescribeImages Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImages

type Rep DescribeImages = D1 ('MetaData "DescribeImages" "Amazonka.ECRPublic.DescribeImages" "libZSservicesZSamazonka-ecr-publicZSamazonka-ecr-public" 'False) (C1 ('MetaCons "DescribeImages'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "registryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "imageIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ImageIdentifier)))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "repositoryName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse DescribeImages Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImages

newDescribeImages Source #

Create a value of DescribeImages 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:DescribeImages', describeImages_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.

$sel:imageIds:DescribeImages', describeImages_imageIds - The list of image IDs for the requested repository.

$sel:nextToken:DescribeImages', describeImages_nextToken - The nextToken value returned from a previous paginated DescribeImages 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.

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

$sel:repositoryName:DescribeImages', describeImages_repositoryName - The repository that contains the images to describe.

Request Lenses

describeImages_registryId :: Lens' DescribeImages (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.

describeImages_imageIds :: Lens' DescribeImages (Maybe (NonEmpty ImageIdentifier)) Source #

The list of image IDs for the requested repository.

describeImages_nextToken :: Lens' DescribeImages (Maybe Text) Source #

The nextToken value returned from a previous paginated DescribeImages 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.

describeImages_maxResults :: Lens' DescribeImages (Maybe Natural) Source #

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

describeImages_repositoryName :: Lens' DescribeImages Text Source #

The repository that contains the images to describe.

Destructuring the Response

data DescribeImagesResponse Source #

See: newDescribeImagesResponse smart constructor.

Constructors

DescribeImagesResponse' 

Fields

  • imageDetails :: Maybe [ImageDetail]

    A list of ImageDetail objects that contain data about the image.

  • nextToken :: Maybe Text

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

Defined in Amazonka.ECRPublic.DescribeImages

Read DescribeImagesResponse Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImages

Show DescribeImagesResponse Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImages

Generic DescribeImagesResponse Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImages

Associated Types

type Rep DescribeImagesResponse :: Type -> Type #

NFData DescribeImagesResponse Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImages

Methods

rnf :: DescribeImagesResponse -> () #

type Rep DescribeImagesResponse Source # 
Instance details

Defined in Amazonka.ECRPublic.DescribeImages

type Rep DescribeImagesResponse = D1 ('MetaData "DescribeImagesResponse" "Amazonka.ECRPublic.DescribeImages" "libZSservicesZSamazonka-ecr-publicZSamazonka-ecr-public" 'False) (C1 ('MetaCons "DescribeImagesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "imageDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ImageDetail])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeImagesResponse Source #

Create a value of DescribeImagesResponse 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:imageDetails:DescribeImagesResponse', describeImagesResponse_imageDetails - A list of ImageDetail objects that contain data about the image.

$sel:nextToken:DescribeImages', describeImagesResponse_nextToken - The nextToken value to include in a future DescribeImages request. When the results of a DescribeImages 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:DescribeImagesResponse', describeImagesResponse_httpStatus - The response's http status code.

Response Lenses

describeImagesResponse_imageDetails :: Lens' DescribeImagesResponse (Maybe [ImageDetail]) Source #

A list of ImageDetail objects that contain data about the image.

describeImagesResponse_nextToken :: Lens' DescribeImagesResponse (Maybe Text) Source #

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