Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ECR.BatchGetImage

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets detailed information for an image. Images are specified with either an imageTag or imageDigest.

When an image is pulled, the BatchGetImage API is called once to retrieve the image manifest.

Synopsis

data BatchGetImage = BatchGetImage' {
- acceptedMediaTypes :: Maybe (NonEmpty Text)
- registryId :: Maybe Text
- repositoryName :: Text
- imageIds :: [ImageIdentifier]
}
newBatchGetImage :: Text -> BatchGetImage
batchGetImage_acceptedMediaTypes :: Lens' BatchGetImage (Maybe (NonEmpty Text))
batchGetImage_registryId :: Lens' BatchGetImage (Maybe Text)
batchGetImage_repositoryName :: Lens' BatchGetImage Text
batchGetImage_imageIds :: Lens' BatchGetImage [ImageIdentifier]
data BatchGetImageResponse = BatchGetImageResponse' {
- failures :: Maybe [ImageFailure]
- images :: Maybe [Image]
- httpStatus :: Int
}
newBatchGetImageResponse :: Int -> BatchGetImageResponse
batchGetImageResponse_failures :: Lens' BatchGetImageResponse (Maybe [ImageFailure])
batchGetImageResponse_images :: Lens' BatchGetImageResponse (Maybe [Image])
batchGetImageResponse_httpStatus :: Lens' BatchGetImageResponse Int

Creating a Request

data BatchGetImage Source #

See: newBatchGetImage smart constructor.

Constructors

BatchGetImage'

Fields

acceptedMediaTypes :: Maybe (NonEmpty Text)
The accepted media types for the request.
Valid values: application/vnd.docker.distribution.manifest.v1+json | application/vnd.docker.distribution.manifest.v2+json | application/vnd.oci.image.manifest.v1+json
registryId :: Maybe Text
The Amazon Web Services account ID associated with the registry that contains the images to describe. If you do not specify a registry, the default registry is assumed.
repositoryName :: Text
The repository that contains the images to describe.
imageIds :: [ImageIdentifier]
A list of image ID references that correspond to images to describe. The format of the imageIds reference is imageTag=tag or imageDigest=digest.

Instances

Instances details

ToJSON BatchGetImage Source #
Instance details Defined in Amazonka.ECR.BatchGetImage Methods toJSON :: BatchGetImage -> Value # toEncoding :: BatchGetImage -> Encoding # toJSONList :: [BatchGetImage] -> Value # toEncodingList :: [BatchGetImage] -> Encoding #
ToHeaders BatchGetImage Source #
Instance details Defined in Amazonka.ECR.BatchGetImage Methods toHeaders :: BatchGetImage -> [Header] #
ToPath BatchGetImage Source #
Instance details Defined in Amazonka.ECR.BatchGetImage Methods toPath :: BatchGetImage -> ByteString #
ToQuery BatchGetImage Source #
Instance details Defined in Amazonka.ECR.BatchGetImage Methods toQuery :: BatchGetImage -> QueryString #
AWSRequest BatchGetImage Source #
Instance details Defined in Amazonka.ECR.BatchGetImage Associated Types type AWSResponse BatchGetImage # Methods request :: (Service -> Service) -> BatchGetImage -> Request BatchGetImage # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy BatchGetImage -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse BatchGetImage))) #
Generic BatchGetImage Source #
Instance details Defined in Amazonka.ECR.BatchGetImage Associated Types type Rep BatchGetImage :: Type -> Type # Methods from :: BatchGetImage -> Rep BatchGetImage x # to :: Rep BatchGetImage x -> BatchGetImage #
Read BatchGetImage Source #
Instance details Defined in Amazonka.ECR.BatchGetImage Methods readsPrec :: Int -> ReadS BatchGetImage # readList :: ReadS [BatchGetImage] # readPrec :: ReadPrec BatchGetImage # readListPrec :: ReadPrec [BatchGetImage] #
Show BatchGetImage Source #
Instance details Defined in Amazonka.ECR.BatchGetImage Methods showsPrec :: Int -> BatchGetImage -> ShowS # show :: BatchGetImage -> String # showList :: [BatchGetImage] -> ShowS #
NFData BatchGetImage Source #
Instance details Defined in Amazonka.ECR.BatchGetImage Methods rnf :: BatchGetImage -> () #
Eq BatchGetImage Source #
Instance details Defined in Amazonka.ECR.BatchGetImage Methods (==) :: BatchGetImage -> BatchGetImage -> Bool # (/=) :: BatchGetImage -> BatchGetImage -> Bool #
Hashable BatchGetImage Source #
Instance details Defined in Amazonka.ECR.BatchGetImage Methods hashWithSalt :: Int -> BatchGetImage -> Int # hash :: BatchGetImage -> Int #
type AWSResponse BatchGetImage Source #
Instance details Defined in Amazonka.ECR.BatchGetImage type AWSResponse BatchGetImage = BatchGetImageResponse
type Rep BatchGetImage Source #
Instance details Defined in Amazonka.ECR.BatchGetImage type Rep BatchGetImage = D1 ('MetaData "BatchGetImage" "Amazonka.ECR.BatchGetImage" "amazonka-ecr-2.0-BqgZWPod2JCFn2nq69DCrJ" 'False) (C1 ('MetaCons "BatchGetImage'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "acceptedMediaTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :: S1 ('MetaSel ('Just "registryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "repositoryName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "imageIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ImageIdentifier]))))

newBatchGetImage Source #

Arguments

:: Text	`BatchGetImage`
-> BatchGetImage

Create a value of BatchGetImage 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:acceptedMediaTypes:BatchGetImage', batchGetImage_acceptedMediaTypes - The accepted media types for the request.

Valid values: application/vnd.docker.distribution.manifest.v1+json | application/vnd.docker.distribution.manifest.v2+json | application/vnd.oci.image.manifest.v1+json

BatchGetImage, batchGetImage_registryId - The Amazon Web Services account ID associated with the registry that contains the images to describe. If you do not specify a registry, the default registry is assumed.

BatchGetImage, batchGetImage_repositoryName - The repository that contains the images to describe.

$sel:imageIds:BatchGetImage', batchGetImage_imageIds - A list of image ID references that correspond to images to describe. The format of the imageIds reference is imageTag=tag or imageDigest=digest.

Request Lenses

batchGetImage_acceptedMediaTypes :: Lens' BatchGetImage (Maybe (NonEmpty Text)) Source #

The accepted media types for the request.

Valid values: application/vnd.docker.distribution.manifest.v1+json | application/vnd.docker.distribution.manifest.v2+json | application/vnd.oci.image.manifest.v1+json

batchGetImage_registryId :: Lens' BatchGetImage (Maybe Text) Source #

The Amazon Web Services account ID associated with the registry that contains the images to describe. If you do not specify a registry, the default registry is assumed.

batchGetImage_repositoryName :: Lens' BatchGetImage Text Source #

The repository that contains the images to describe.

batchGetImage_imageIds :: Lens' BatchGetImage [ImageIdentifier] Source #

A list of image ID references that correspond to images to describe. The format of the imageIds reference is imageTag=tag or imageDigest=digest.

Destructuring the Response

data BatchGetImageResponse Source #

See: newBatchGetImageResponse smart constructor.

Constructors

BatchGetImageResponse'
Fields failures :: Maybe [ImageFailure] Any failures associated with the call. images :: Maybe [Image] A list of image objects corresponding to the image references in the request. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic BatchGetImageResponse Source #
Instance details Defined in Amazonka.ECR.BatchGetImage Associated Types type Rep BatchGetImageResponse :: Type -> Type # Methods from :: BatchGetImageResponse -> Rep BatchGetImageResponse x # to :: Rep BatchGetImageResponse x -> BatchGetImageResponse #
Read BatchGetImageResponse Source #
Instance details Defined in Amazonka.ECR.BatchGetImage Methods readsPrec :: Int -> ReadS BatchGetImageResponse # readList :: ReadS [BatchGetImageResponse] # readPrec :: ReadPrec BatchGetImageResponse # readListPrec :: ReadPrec [BatchGetImageResponse] #
Show BatchGetImageResponse Source #
Instance details Defined in Amazonka.ECR.BatchGetImage Methods showsPrec :: Int -> BatchGetImageResponse -> ShowS # show :: BatchGetImageResponse -> String # showList :: [BatchGetImageResponse] -> ShowS #
NFData BatchGetImageResponse Source #
Instance details Defined in Amazonka.ECR.BatchGetImage Methods rnf :: BatchGetImageResponse -> () #
Eq BatchGetImageResponse Source #
Instance details Defined in Amazonka.ECR.BatchGetImage Methods (==) :: BatchGetImageResponse -> BatchGetImageResponse -> Bool # (/=) :: BatchGetImageResponse -> BatchGetImageResponse -> Bool #
type Rep BatchGetImageResponse Source #
Instance details Defined in Amazonka.ECR.BatchGetImage type Rep BatchGetImageResponse = D1 ('MetaData "BatchGetImageResponse" "Amazonka.ECR.BatchGetImage" "amazonka-ecr-2.0-BqgZWPod2JCFn2nq69DCrJ" 'False) (C1 ('MetaCons "BatchGetImageResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "failures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ImageFailure])) :: (S1 ('MetaSel ('Just "images") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Image])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newBatchGetImageResponse Source #

Arguments

:: Int	`$sel:httpStatus:BatchGetImageResponse'`
-> BatchGetImageResponse

Create a value of BatchGetImageResponse 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:failures:BatchGetImageResponse', batchGetImageResponse_failures - Any failures associated with the call.

$sel:images:BatchGetImageResponse', batchGetImageResponse_images - A list of image objects corresponding to the image references in the request.

$sel:httpStatus:BatchGetImageResponse', batchGetImageResponse_httpStatus - The response's http status code.

Response Lenses

batchGetImageResponse_failures :: Lens' BatchGetImageResponse (Maybe [ImageFailure]) Source #

Any failures associated with the call.

batchGetImageResponse_images :: Lens' BatchGetImageResponse (Maybe [Image]) Source #

A list of image objects corresponding to the image references in the request.

batchGetImageResponse_httpStatus :: Lens' BatchGetImageResponse Int Source #

The response's http status code.