amazonka-ecr-2.0: Amazon EC2 Container Registry 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.ECR.InitiateLayerUpload

Description

Notifies Amazon ECR that you intend to upload an image layer.

When an image is pushed, the InitiateLayerUpload API is called once per image layer that has not already been uploaded. Whether or not an image layer has been uploaded is determined by the BatchCheckLayerAvailability API action.

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 InitiateLayerUpload Source #

See: newInitiateLayerUpload smart constructor.

Constructors

InitiateLayerUpload' 

Fields

  • registryId :: Maybe Text

    The Amazon Web Services account ID associated with the registry to which you intend to upload layers. If you do not specify a registry, the default registry is assumed.

  • repositoryName :: Text

    The name of the repository to which you intend to upload layers.

Instances

Instances details
ToJSON InitiateLayerUpload Source # 
Instance details

Defined in Amazonka.ECR.InitiateLayerUpload

ToHeaders InitiateLayerUpload Source # 
Instance details

Defined in Amazonka.ECR.InitiateLayerUpload

ToPath InitiateLayerUpload Source # 
Instance details

Defined in Amazonka.ECR.InitiateLayerUpload

ToQuery InitiateLayerUpload Source # 
Instance details

Defined in Amazonka.ECR.InitiateLayerUpload

AWSRequest InitiateLayerUpload Source # 
Instance details

Defined in Amazonka.ECR.InitiateLayerUpload

Associated Types

type AWSResponse InitiateLayerUpload #

Generic InitiateLayerUpload Source # 
Instance details

Defined in Amazonka.ECR.InitiateLayerUpload

Associated Types

type Rep InitiateLayerUpload :: Type -> Type #

Read InitiateLayerUpload Source # 
Instance details

Defined in Amazonka.ECR.InitiateLayerUpload

Show InitiateLayerUpload Source # 
Instance details

Defined in Amazonka.ECR.InitiateLayerUpload

NFData InitiateLayerUpload Source # 
Instance details

Defined in Amazonka.ECR.InitiateLayerUpload

Methods

rnf :: InitiateLayerUpload -> () #

Eq InitiateLayerUpload Source # 
Instance details

Defined in Amazonka.ECR.InitiateLayerUpload

Hashable InitiateLayerUpload Source # 
Instance details

Defined in Amazonka.ECR.InitiateLayerUpload

type AWSResponse InitiateLayerUpload Source # 
Instance details

Defined in Amazonka.ECR.InitiateLayerUpload

type Rep InitiateLayerUpload Source # 
Instance details

Defined in Amazonka.ECR.InitiateLayerUpload

type Rep InitiateLayerUpload = D1 ('MetaData "InitiateLayerUpload" "Amazonka.ECR.InitiateLayerUpload" "amazonka-ecr-2.0-BqgZWPod2JCFn2nq69DCrJ" 'False) (C1 ('MetaCons "InitiateLayerUpload'" 'PrefixI 'True) (S1 ('MetaSel ('Just "registryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "repositoryName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newInitiateLayerUpload Source #

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

InitiateLayerUpload, initiateLayerUpload_registryId - The Amazon Web Services account ID associated with the registry to which you intend to upload layers. If you do not specify a registry, the default registry is assumed.

InitiateLayerUpload, initiateLayerUpload_repositoryName - The name of the repository to which you intend to upload layers.

Request Lenses

initiateLayerUpload_registryId :: Lens' InitiateLayerUpload (Maybe Text) Source #

The Amazon Web Services account ID associated with the registry to which you intend to upload layers. If you do not specify a registry, the default registry is assumed.

initiateLayerUpload_repositoryName :: Lens' InitiateLayerUpload Text Source #

The name of the repository to which you intend to upload layers.

Destructuring the Response

data InitiateLayerUploadResponse Source #

See: newInitiateLayerUploadResponse smart constructor.

Constructors

InitiateLayerUploadResponse' 

Fields

  • partSize :: Maybe Natural

    The size, in bytes, that Amazon ECR expects future layer part uploads to be.

  • uploadId :: Maybe Text

    The upload ID for the layer upload. This parameter is passed to further UploadLayerPart and CompleteLayerUpload operations.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic InitiateLayerUploadResponse Source # 
Instance details

Defined in Amazonka.ECR.InitiateLayerUpload

Associated Types

type Rep InitiateLayerUploadResponse :: Type -> Type #

Read InitiateLayerUploadResponse Source # 
Instance details

Defined in Amazonka.ECR.InitiateLayerUpload

Show InitiateLayerUploadResponse Source # 
Instance details

Defined in Amazonka.ECR.InitiateLayerUpload

NFData InitiateLayerUploadResponse Source # 
Instance details

Defined in Amazonka.ECR.InitiateLayerUpload

Eq InitiateLayerUploadResponse Source # 
Instance details

Defined in Amazonka.ECR.InitiateLayerUpload

type Rep InitiateLayerUploadResponse Source # 
Instance details

Defined in Amazonka.ECR.InitiateLayerUpload

type Rep InitiateLayerUploadResponse = D1 ('MetaData "InitiateLayerUploadResponse" "Amazonka.ECR.InitiateLayerUpload" "amazonka-ecr-2.0-BqgZWPod2JCFn2nq69DCrJ" 'False) (C1 ('MetaCons "InitiateLayerUploadResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "partSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "uploadId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newInitiateLayerUploadResponse Source #

Create a value of InitiateLayerUploadResponse 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:partSize:InitiateLayerUploadResponse', initiateLayerUploadResponse_partSize - The size, in bytes, that Amazon ECR expects future layer part uploads to be.

$sel:uploadId:InitiateLayerUploadResponse', initiateLayerUploadResponse_uploadId - The upload ID for the layer upload. This parameter is passed to further UploadLayerPart and CompleteLayerUpload operations.

$sel:httpStatus:InitiateLayerUploadResponse', initiateLayerUploadResponse_httpStatus - The response's http status code.

Response Lenses

initiateLayerUploadResponse_partSize :: Lens' InitiateLayerUploadResponse (Maybe Natural) Source #

The size, in bytes, that Amazon ECR expects future layer part uploads to be.

initiateLayerUploadResponse_uploadId :: Lens' InitiateLayerUploadResponse (Maybe Text) Source #

The upload ID for the layer upload. This parameter is passed to further UploadLayerPart and CompleteLayerUpload operations.