Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.ECR.InitiateLayerUpload

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

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

Eq InitiateLayerUpload Source #
Instance details Defined in Amazonka.ECR.InitiateLayerUpload Methods (==) :: InitiateLayerUpload -> InitiateLayerUpload -> Bool # (/=) :: InitiateLayerUpload -> InitiateLayerUpload -> Bool #
Read InitiateLayerUpload Source #
Instance details Defined in Amazonka.ECR.InitiateLayerUpload Methods readsPrec :: Int -> ReadS InitiateLayerUpload # readList :: ReadS [InitiateLayerUpload] # readPrec :: ReadPrec InitiateLayerUpload # readListPrec :: ReadPrec [InitiateLayerUpload] #
Show InitiateLayerUpload Source #
Instance details Defined in Amazonka.ECR.InitiateLayerUpload Methods showsPrec :: Int -> InitiateLayerUpload -> ShowS # show :: InitiateLayerUpload -> String # showList :: [InitiateLayerUpload] -> ShowS #
Generic InitiateLayerUpload Source #
Instance details Defined in Amazonka.ECR.InitiateLayerUpload Associated Types type Rep InitiateLayerUpload :: Type -> Type # Methods from :: InitiateLayerUpload -> Rep InitiateLayerUpload x # to :: Rep InitiateLayerUpload x -> InitiateLayerUpload #
NFData InitiateLayerUpload Source #
Instance details Defined in Amazonka.ECR.InitiateLayerUpload Methods rnf :: InitiateLayerUpload -> () #
Hashable InitiateLayerUpload Source #
Instance details Defined in Amazonka.ECR.InitiateLayerUpload Methods hashWithSalt :: Int -> InitiateLayerUpload -> Int # hash :: InitiateLayerUpload -> Int #
ToJSON InitiateLayerUpload Source #
Instance details Defined in Amazonka.ECR.InitiateLayerUpload Methods toJSON :: InitiateLayerUpload -> Value # toEncoding :: InitiateLayerUpload -> Encoding # toJSONList :: [InitiateLayerUpload] -> Value # toEncodingList :: [InitiateLayerUpload] -> Encoding #
AWSRequest InitiateLayerUpload Source #
Instance details Defined in Amazonka.ECR.InitiateLayerUpload Associated Types type AWSResponse InitiateLayerUpload # Methods request :: InitiateLayerUpload -> Request InitiateLayerUpload # response :: MonadResource m => Logger -> Service -> Proxy InitiateLayerUpload -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse InitiateLayerUpload))) #
ToHeaders InitiateLayerUpload Source #
Instance details Defined in Amazonka.ECR.InitiateLayerUpload Methods toHeaders :: InitiateLayerUpload -> [Header] #
ToPath InitiateLayerUpload Source #
Instance details Defined in Amazonka.ECR.InitiateLayerUpload Methods toPath :: InitiateLayerUpload -> ByteString #
ToQuery InitiateLayerUpload Source #
Instance details Defined in Amazonka.ECR.InitiateLayerUpload Methods toQuery :: InitiateLayerUpload -> QueryString #
type Rep InitiateLayerUpload Source #
Instance details Defined in Amazonka.ECR.InitiateLayerUpload type Rep InitiateLayerUpload = D1 ('MetaData "InitiateLayerUpload" "Amazonka.ECR.InitiateLayerUpload" "libZSservicesZSamazonka-ecrZSamazonka-ecr" '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)))
type AWSResponse InitiateLayerUpload Source #
Instance details Defined in Amazonka.ECR.InitiateLayerUpload type AWSResponse InitiateLayerUpload = InitiateLayerUploadResponse

newInitiateLayerUpload Source #

Arguments

:: Text	`$sel:repositoryName:InitiateLayerUpload'`
-> InitiateLayerUpload

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:

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

$sel:repositoryName: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

Eq InitiateLayerUploadResponse Source #
Instance details Defined in Amazonka.ECR.InitiateLayerUpload Methods (==) :: InitiateLayerUploadResponse -> InitiateLayerUploadResponse -> Bool # (/=) :: InitiateLayerUploadResponse -> InitiateLayerUploadResponse -> Bool #
Read InitiateLayerUploadResponse Source #
Instance details Defined in Amazonka.ECR.InitiateLayerUpload Methods readsPrec :: Int -> ReadS InitiateLayerUploadResponse # readList :: ReadS [InitiateLayerUploadResponse] # readPrec :: ReadPrec InitiateLayerUploadResponse # readListPrec :: ReadPrec [InitiateLayerUploadResponse] #
Show InitiateLayerUploadResponse Source #
Instance details Defined in Amazonka.ECR.InitiateLayerUpload Methods showsPrec :: Int -> InitiateLayerUploadResponse -> ShowS # show :: InitiateLayerUploadResponse -> String # showList :: [InitiateLayerUploadResponse] -> ShowS #
Generic InitiateLayerUploadResponse Source #
Instance details Defined in Amazonka.ECR.InitiateLayerUpload Associated Types type Rep InitiateLayerUploadResponse :: Type -> Type # Methods from :: InitiateLayerUploadResponse -> Rep InitiateLayerUploadResponse x # to :: Rep InitiateLayerUploadResponse x -> InitiateLayerUploadResponse #
NFData InitiateLayerUploadResponse Source #
Instance details Defined in Amazonka.ECR.InitiateLayerUpload Methods rnf :: InitiateLayerUploadResponse -> () #
type Rep InitiateLayerUploadResponse Source #
Instance details Defined in Amazonka.ECR.InitiateLayerUpload type Rep InitiateLayerUploadResponse = D1 ('MetaData "InitiateLayerUploadResponse" "Amazonka.ECR.InitiateLayerUpload" "libZSservicesZSamazonka-ecrZSamazonka-ecr" '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 #

Arguments

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

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.

initiateLayerUploadResponse_httpStatus :: Lens' InitiateLayerUploadResponse Int Source #

The response's http status code.