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

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

Creating a Request

data PutImage Source #

See: newPutImage smart constructor.

Constructors

PutImage' 

Fields

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

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

  • imageDigest :: Maybe Text

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

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

  • 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
Eq PutImage Source # 
Instance details

Defined in Amazonka.ECR.PutImage

Read PutImage Source # 
Instance details

Defined in Amazonka.ECR.PutImage

Show PutImage Source # 
Instance details

Defined in Amazonka.ECR.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 #

NFData PutImage Source # 
Instance details

Defined in Amazonka.ECR.PutImage

Methods

rnf :: PutImage -> () #

Hashable PutImage Source # 
Instance details

Defined in Amazonka.ECR.PutImage

Methods

hashWithSalt :: Int -> PutImage -> Int #

hash :: PutImage -> Int #

ToJSON PutImage Source # 
Instance details

Defined in Amazonka.ECR.PutImage

AWSRequest PutImage Source # 
Instance details

Defined in Amazonka.ECR.PutImage

Associated Types

type AWSResponse PutImage #

ToHeaders PutImage Source # 
Instance details

Defined in Amazonka.ECR.PutImage

Methods

toHeaders :: PutImage -> [Header] #

ToPath PutImage Source # 
Instance details

Defined in Amazonka.ECR.PutImage

ToQuery PutImage Source # 
Instance details

Defined in Amazonka.ECR.PutImage

type Rep PutImage Source # 
Instance details

Defined in Amazonka.ECR.PutImage

type Rep PutImage = D1 ('MetaData "PutImage" "Amazonka.ECR.PutImage" "libZSservicesZSamazonka-ecrZSamazonka-ecr" 'False) (C1 ('MetaCons "PutImage'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "registryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "imageManifestMediaType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "imageDigest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "imageTag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "repositoryName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "imageManifest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse PutImage Source # 
Instance details

Defined in Amazonka.ECR.PutImage

newPutImage Source #

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:

$sel:registryId: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.

$sel:imageManifestMediaType: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.

$sel:imageDigest:PutImage', putImage_imageDigest - The image digest of the image manifest corresponding to the image.

$sel:imageTag: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.

$sel:repositoryName:PutImage', putImage_repositoryName - The name of the repository in which to put the image.

$sel:imageManifest:PutImage', putImage_imageManifest - The image manifest corresponding to the image to be uploaded.

Request Lenses

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_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_imageDigest :: Lens' PutImage (Maybe Text) Source #

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

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_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

Instances

Instances details
Eq PutImageResponse Source # 
Instance details

Defined in Amazonka.ECR.PutImage

Read PutImageResponse Source # 
Instance details

Defined in Amazonka.ECR.PutImage

Show PutImageResponse Source # 
Instance details

Defined in Amazonka.ECR.PutImage

Generic PutImageResponse Source # 
Instance details

Defined in Amazonka.ECR.PutImage

Associated Types

type Rep PutImageResponse :: Type -> Type #

NFData PutImageResponse Source # 
Instance details

Defined in Amazonka.ECR.PutImage

Methods

rnf :: PutImageResponse -> () #

type Rep PutImageResponse Source # 
Instance details

Defined in Amazonka.ECR.PutImage

type Rep PutImageResponse = D1 ('MetaData "PutImageResponse" "Amazonka.ECR.PutImage" "libZSservicesZSamazonka-ecrZSamazonka-ecr" '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 #

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.