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

Description

Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can only get URLs for image layers that are referenced in an image.

When an image is pulled, the GetDownloadUrlForLayer API is called once per image layer that is not already cached.

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

See: newGetDownloadUrlForLayer smart constructor.

Constructors

GetDownloadUrlForLayer' 

Fields

  • registryId :: Maybe Text

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

  • repositoryName :: Text

    The name of the repository that is associated with the image layer to download.

  • layerDigest :: Text

    The digest of the image layer to download.

Instances

Instances details
ToJSON GetDownloadUrlForLayer Source # 
Instance details

Defined in Amazonka.ECR.GetDownloadUrlForLayer

ToHeaders GetDownloadUrlForLayer Source # 
Instance details

Defined in Amazonka.ECR.GetDownloadUrlForLayer

ToPath GetDownloadUrlForLayer Source # 
Instance details

Defined in Amazonka.ECR.GetDownloadUrlForLayer

ToQuery GetDownloadUrlForLayer Source # 
Instance details

Defined in Amazonka.ECR.GetDownloadUrlForLayer

AWSRequest GetDownloadUrlForLayer Source # 
Instance details

Defined in Amazonka.ECR.GetDownloadUrlForLayer

Associated Types

type AWSResponse GetDownloadUrlForLayer #

Generic GetDownloadUrlForLayer Source # 
Instance details

Defined in Amazonka.ECR.GetDownloadUrlForLayer

Associated Types

type Rep GetDownloadUrlForLayer :: Type -> Type #

Read GetDownloadUrlForLayer Source # 
Instance details

Defined in Amazonka.ECR.GetDownloadUrlForLayer

Show GetDownloadUrlForLayer Source # 
Instance details

Defined in Amazonka.ECR.GetDownloadUrlForLayer

NFData GetDownloadUrlForLayer Source # 
Instance details

Defined in Amazonka.ECR.GetDownloadUrlForLayer

Methods

rnf :: GetDownloadUrlForLayer -> () #

Eq GetDownloadUrlForLayer Source # 
Instance details

Defined in Amazonka.ECR.GetDownloadUrlForLayer

Hashable GetDownloadUrlForLayer Source # 
Instance details

Defined in Amazonka.ECR.GetDownloadUrlForLayer

type AWSResponse GetDownloadUrlForLayer Source # 
Instance details

Defined in Amazonka.ECR.GetDownloadUrlForLayer

type Rep GetDownloadUrlForLayer Source # 
Instance details

Defined in Amazonka.ECR.GetDownloadUrlForLayer

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

newGetDownloadUrlForLayer Source #

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

GetDownloadUrlForLayer, getDownloadUrlForLayer_registryId - The Amazon Web Services account ID associated with the registry that contains the image layer to download. If you do not specify a registry, the default registry is assumed.

GetDownloadUrlForLayer, getDownloadUrlForLayer_repositoryName - The name of the repository that is associated with the image layer to download.

GetDownloadUrlForLayer, getDownloadUrlForLayer_layerDigest - The digest of the image layer to download.

Request Lenses

getDownloadUrlForLayer_registryId :: Lens' GetDownloadUrlForLayer (Maybe Text) Source #

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

getDownloadUrlForLayer_repositoryName :: Lens' GetDownloadUrlForLayer Text Source #

The name of the repository that is associated with the image layer to download.

getDownloadUrlForLayer_layerDigest :: Lens' GetDownloadUrlForLayer Text Source #

The digest of the image layer to download.

Destructuring the Response

data GetDownloadUrlForLayerResponse Source #

See: newGetDownloadUrlForLayerResponse smart constructor.

Constructors

GetDownloadUrlForLayerResponse' 

Fields

Instances

Instances details
Generic GetDownloadUrlForLayerResponse Source # 
Instance details

Defined in Amazonka.ECR.GetDownloadUrlForLayer

Associated Types

type Rep GetDownloadUrlForLayerResponse :: Type -> Type #

Read GetDownloadUrlForLayerResponse Source # 
Instance details

Defined in Amazonka.ECR.GetDownloadUrlForLayer

Show GetDownloadUrlForLayerResponse Source # 
Instance details

Defined in Amazonka.ECR.GetDownloadUrlForLayer

NFData GetDownloadUrlForLayerResponse Source # 
Instance details

Defined in Amazonka.ECR.GetDownloadUrlForLayer

Eq GetDownloadUrlForLayerResponse Source # 
Instance details

Defined in Amazonka.ECR.GetDownloadUrlForLayer

type Rep GetDownloadUrlForLayerResponse Source # 
Instance details

Defined in Amazonka.ECR.GetDownloadUrlForLayer

type Rep GetDownloadUrlForLayerResponse = D1 ('MetaData "GetDownloadUrlForLayerResponse" "Amazonka.ECR.GetDownloadUrlForLayer" "amazonka-ecr-2.0-BqgZWPod2JCFn2nq69DCrJ" 'False) (C1 ('MetaCons "GetDownloadUrlForLayerResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "downloadUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "layerDigest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetDownloadUrlForLayerResponse Source #

Create a value of GetDownloadUrlForLayerResponse 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:downloadUrl:GetDownloadUrlForLayerResponse', getDownloadUrlForLayerResponse_downloadUrl - The pre-signed Amazon S3 download URL for the requested layer.

GetDownloadUrlForLayer, getDownloadUrlForLayerResponse_layerDigest - The digest of the image layer to download.

$sel:httpStatus:GetDownloadUrlForLayerResponse', getDownloadUrlForLayerResponse_httpStatus - The response's http status code.

Response Lenses

getDownloadUrlForLayerResponse_downloadUrl :: Lens' GetDownloadUrlForLayerResponse (Maybe Text) Source #

The pre-signed Amazon S3 download URL for the requested layer.