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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates or updates the image manifest and tags associated with an image.

When an image is pushed and all new image layers have been uploaded, the PutImage API is called once to create or update the image manifest and the tags associated with the image.

This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

Synopsis

data PutImage = PutImage' {
- imageDigest :: Maybe Text
- imageManifestMediaType :: Maybe Text
- imageTag :: Maybe Text
- registryId :: Maybe Text
- repositoryName :: Text
- imageManifest :: Text
}
newPutImage :: Text -> Text -> PutImage
putImage_imageDigest :: Lens' PutImage (Maybe Text)
putImage_imageManifestMediaType :: Lens' PutImage (Maybe Text)
putImage_imageTag :: Lens' PutImage (Maybe Text)
putImage_registryId :: Lens' PutImage (Maybe Text)
putImage_repositoryName :: Lens' PutImage Text
putImage_imageManifest :: Lens' PutImage Text
data PutImageResponse = PutImageResponse' {
- image :: Maybe Image
- httpStatus :: Int
}
newPutImageResponse :: Int -> PutImageResponse
putImageResponse_image :: Lens' PutImageResponse (Maybe Image)
putImageResponse_httpStatus :: Lens' PutImageResponse Int

Creating a Request

data PutImage Source #

See: newPutImage smart constructor.

Constructors

PutImage'

Fields

imageDigest :: Maybe Text
The image digest of the image manifest corresponding to the image.
imageManifestMediaType :: Maybe Text
The media type of the image manifest. If you push an image manifest that does not contain the mediaType field, you must specify the imageManifestMediaType in the request.
imageTag :: Maybe Text
The tag to associate with the image. This parameter is required for images that use the Docker Image Manifest V2 Schema 2 or Open Container Initiative (OCI) formats.
registryId :: Maybe Text
The Amazon Web Services account ID associated with the registry that contains the repository in which to put the image. If you do not specify a registry, the default registry is assumed.
repositoryName :: Text
The name of the repository in which to put the image.
imageManifest :: Text
The image manifest corresponding to the image to be uploaded.

Instances

Instances details

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

newPutImage Source #

Arguments

:: Text	`PutImage`
-> Text	`PutImage`
-> PutImage

Create a value of PutImage 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:

PutImage, putImage_imageDigest - The image digest of the image manifest corresponding to the image.

PutImage, putImage_imageManifestMediaType - The media type of the image manifest. If you push an image manifest that does not contain the mediaType field, you must specify the imageManifestMediaType in the request.

PutImage, putImage_imageTag - The tag to associate with the image. This parameter is required for images that use the Docker Image Manifest V2 Schema 2 or Open Container Initiative (OCI) formats.

PutImage, putImage_registryId - The Amazon Web Services account ID associated with the registry that contains the repository in which to put the image. If you do not specify a registry, the default registry is assumed.

PutImage, putImage_repositoryName - The name of the repository in which to put the image.

PutImage, putImage_imageManifest - The image manifest corresponding to the image to be uploaded.

Request Lenses

putImage_imageDigest :: Lens' PutImage (Maybe Text) Source #

The image digest of the image manifest corresponding to the image.

putImage_imageManifestMediaType :: Lens' PutImage (Maybe Text) Source #

The media type of the image manifest. If you push an image manifest that does not contain the mediaType field, you must specify the imageManifestMediaType in the request.

putImage_imageTag :: Lens' PutImage (Maybe Text) Source #

The tag to associate with the image. This parameter is required for images that use the Docker Image Manifest V2 Schema 2 or Open Container Initiative (OCI) formats.

putImage_registryId :: Lens' PutImage (Maybe Text) Source #

The Amazon Web Services account ID associated with the registry that contains the repository in which to put the image. If you do not specify a registry, the default registry is assumed.

putImage_repositoryName :: Lens' PutImage Text Source #

The name of the repository in which to put the image.

putImage_imageManifest :: Lens' PutImage Text Source #

The image manifest corresponding to the image to be uploaded.

Destructuring the Response

data PutImageResponse Source #

See: newPutImageResponse smart constructor.

Constructors

PutImageResponse'
Fields image :: Maybe Image Details of the image uploaded. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newPutImageResponse Source #

Arguments

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

Create a value of PutImageResponse 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:image:PutImageResponse', putImageResponse_image - Details of the image uploaded.

$sel:httpStatus:PutImageResponse', putImageResponse_httpStatus - The response's http status code.

Response Lenses

putImageResponse_image :: Lens' PutImageResponse (Maybe Image) Source #

Details of the image uploaded.

putImageResponse_httpStatus :: Lens' PutImageResponse Int Source #

The response's http status code.