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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Uploads an image layer part to Amazon ECR.

When an image is pushed, each new image layer is uploaded in parts. The maximum size of each image layer part can be 20971520 bytes (or about 20MB). The UploadLayerPart API is called once per each new image layer part.

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 UploadLayerPart = UploadLayerPart' {
- registryId :: Maybe Text
- repositoryName :: Text
- uploadId :: Text
- partFirstByte :: Natural
- partLastByte :: Natural
- layerPartBlob :: Base64
}
newUploadLayerPart :: Text -> Text -> Natural -> Natural -> ByteString -> UploadLayerPart
uploadLayerPart_registryId :: Lens' UploadLayerPart (Maybe Text)
uploadLayerPart_repositoryName :: Lens' UploadLayerPart Text
uploadLayerPart_uploadId :: Lens' UploadLayerPart Text
uploadLayerPart_partFirstByte :: Lens' UploadLayerPart Natural
uploadLayerPart_partLastByte :: Lens' UploadLayerPart Natural
uploadLayerPart_layerPartBlob :: Lens' UploadLayerPart ByteString
data UploadLayerPartResponse = UploadLayerPartResponse' {
- registryId :: Maybe Text
- lastByteReceived :: Maybe Natural
- repositoryName :: Maybe Text
- uploadId :: Maybe Text
- httpStatus :: Int
}
newUploadLayerPartResponse :: Int -> UploadLayerPartResponse
uploadLayerPartResponse_registryId :: Lens' UploadLayerPartResponse (Maybe Text)
uploadLayerPartResponse_lastByteReceived :: Lens' UploadLayerPartResponse (Maybe Natural)
uploadLayerPartResponse_repositoryName :: Lens' UploadLayerPartResponse (Maybe Text)
uploadLayerPartResponse_uploadId :: Lens' UploadLayerPartResponse (Maybe Text)
uploadLayerPartResponse_httpStatus :: Lens' UploadLayerPartResponse Int

Creating a Request

data UploadLayerPart Source #

See: newUploadLayerPart smart constructor.

Constructors

UploadLayerPart'

Fields

registryId :: Maybe Text
The Amazon Web Services account ID associated with the registry to which you are uploading layer parts. If you do not specify a registry, the default registry is assumed.
repositoryName :: Text
The name of the repository to which you are uploading layer parts.
uploadId :: Text
The upload ID from a previous InitiateLayerUpload operation to associate with the layer part upload.
partFirstByte :: Natural
The position of the first byte of the layer part witin the overall image layer.
partLastByte :: Natural
The position of the last byte of the layer part within the overall image layer.
layerPartBlob :: Base64
The base64-encoded layer part payload.

Instances

Instances details

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

newUploadLayerPart Source #

Arguments

:: Text	`$sel:repositoryName:UploadLayerPart'`
-> Text	`$sel:uploadId:UploadLayerPart'`
-> Natural	`$sel:partFirstByte:UploadLayerPart'`
-> Natural	`$sel:partLastByte:UploadLayerPart'`
-> ByteString	`$sel:layerPartBlob:UploadLayerPart'`
-> UploadLayerPart

Create a value of UploadLayerPart 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:UploadLayerPart', uploadLayerPart_registryId - The Amazon Web Services account ID associated with the registry to which you are uploading layer parts. If you do not specify a registry, the default registry is assumed.

$sel:repositoryName:UploadLayerPart', uploadLayerPart_repositoryName - The name of the repository to which you are uploading layer parts.

$sel:uploadId:UploadLayerPart', uploadLayerPart_uploadId - The upload ID from a previous InitiateLayerUpload operation to associate with the layer part upload.

$sel:partFirstByte:UploadLayerPart', uploadLayerPart_partFirstByte - The position of the first byte of the layer part witin the overall image layer.

$sel:partLastByte:UploadLayerPart', uploadLayerPart_partLastByte - The position of the last byte of the layer part within the overall image layer.

$sel:layerPartBlob:UploadLayerPart', uploadLayerPart_layerPartBlob - The base64-encoded layer part payload.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

Request Lenses

uploadLayerPart_registryId :: Lens' UploadLayerPart (Maybe Text) Source #

The Amazon Web Services account ID associated with the registry to which you are uploading layer parts. If you do not specify a registry, the default registry is assumed.

uploadLayerPart_repositoryName :: Lens' UploadLayerPart Text Source #

The name of the repository to which you are uploading layer parts.

uploadLayerPart_uploadId :: Lens' UploadLayerPart Text Source #

The upload ID from a previous InitiateLayerUpload operation to associate with the layer part upload.

uploadLayerPart_partFirstByte :: Lens' UploadLayerPart Natural Source #

The position of the first byte of the layer part witin the overall image layer.

uploadLayerPart_partLastByte :: Lens' UploadLayerPart Natural Source #

The position of the last byte of the layer part within the overall image layer.

uploadLayerPart_layerPartBlob :: Lens' UploadLayerPart ByteString Source #

The base64-encoded layer part payload.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

Destructuring the Response

data UploadLayerPartResponse Source #

See: newUploadLayerPartResponse smart constructor.

Constructors

UploadLayerPartResponse'
Fields registryId :: Maybe Text The registry ID associated with the request. lastByteReceived :: Maybe Natural The integer value of the last byte received in the request. repositoryName :: Maybe Text The repository name associated with the request. uploadId :: Maybe Text The upload ID associated with the request. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq UploadLayerPartResponse Source #
Instance details Defined in Amazonka.ECR.UploadLayerPart Methods (==) :: UploadLayerPartResponse -> UploadLayerPartResponse -> Bool # (/=) :: UploadLayerPartResponse -> UploadLayerPartResponse -> Bool #
Read UploadLayerPartResponse Source #
Instance details Defined in Amazonka.ECR.UploadLayerPart Methods readsPrec :: Int -> ReadS UploadLayerPartResponse # readList :: ReadS [UploadLayerPartResponse] # readPrec :: ReadPrec UploadLayerPartResponse # readListPrec :: ReadPrec [UploadLayerPartResponse] #
Show UploadLayerPartResponse Source #
Instance details Defined in Amazonka.ECR.UploadLayerPart Methods showsPrec :: Int -> UploadLayerPartResponse -> ShowS # show :: UploadLayerPartResponse -> String # showList :: [UploadLayerPartResponse] -> ShowS #
Generic UploadLayerPartResponse Source #
Instance details Defined in Amazonka.ECR.UploadLayerPart Associated Types type Rep UploadLayerPartResponse :: Type -> Type # Methods from :: UploadLayerPartResponse -> Rep UploadLayerPartResponse x # to :: Rep UploadLayerPartResponse x -> UploadLayerPartResponse #
NFData UploadLayerPartResponse Source #
Instance details Defined in Amazonka.ECR.UploadLayerPart Methods rnf :: UploadLayerPartResponse -> () #
type Rep UploadLayerPartResponse Source #
Instance details Defined in Amazonka.ECR.UploadLayerPart type Rep UploadLayerPartResponse = D1 ('MetaData "UploadLayerPartResponse" "Amazonka.ECR.UploadLayerPart" "libZSservicesZSamazonka-ecrZSamazonka-ecr" 'False) (C1 ('MetaCons "UploadLayerPartResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "registryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "lastByteReceived") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "repositoryName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "uploadId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newUploadLayerPartResponse Source #

Arguments

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

Create a value of UploadLayerPartResponse 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:UploadLayerPart', uploadLayerPartResponse_registryId - The registry ID associated with the request.

$sel:lastByteReceived:UploadLayerPartResponse', uploadLayerPartResponse_lastByteReceived - The integer value of the last byte received in the request.

$sel:repositoryName:UploadLayerPart', uploadLayerPartResponse_repositoryName - The repository name associated with the request.

$sel:uploadId:UploadLayerPart', uploadLayerPartResponse_uploadId - The upload ID associated with the request.

$sel:httpStatus:UploadLayerPartResponse', uploadLayerPartResponse_httpStatus - The response's http status code.

Response Lenses

uploadLayerPartResponse_registryId :: Lens' UploadLayerPartResponse (Maybe Text) Source #

The registry ID associated with the request.

uploadLayerPartResponse_lastByteReceived :: Lens' UploadLayerPartResponse (Maybe Natural) Source #

The integer value of the last byte received in the request.

uploadLayerPartResponse_repositoryName :: Lens' UploadLayerPartResponse (Maybe Text) Source #

The repository name associated with the request.

uploadLayerPartResponse_uploadId :: Lens' UploadLayerPartResponse (Maybe Text) Source #

The upload ID associated with the request.

uploadLayerPartResponse_httpStatus :: Lens' UploadLayerPartResponse Int Source #

The response's http status code.