ECR / Client / batch_check_layer_availability

batch_check_layer_availability

ECR.Client.batch_check_layer_availability(**kwargs)

Checks the availability of one or more image layers in a repository.

When an image is pushed to a repository, each image layer is checked to verify if it has been uploaded before. If it has been uploaded, then the image layer is skipped.

Note

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.

See also: AWS API Documentation

Request Syntax

response = client.batch_check_layer_availability(
    registryId='string',
    repositoryName='string',
    layerDigests=[
        'string',
    ]
)

Parameters:

• registryId (string) – The Amazon Web Services account ID associated with the registry that contains the image layers to check. If you do not specify a registry, the default registry is assumed.

• repositoryName (string) –

  [REQUIRED]

  The name of the repository that is associated with the image layers to check.

• layerDigests (list) –

  [REQUIRED]

  The digests of the image layers to check.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'layers': [
        {
            'layerDigest': 'string',
            'layerAvailability': 'AVAILABLE'|'UNAVAILABLE',
            'layerSize': 123,
            'mediaType': 'string'
        },
    ],
    'failures': [
        {
            'layerDigest': 'string',
            'failureCode': 'InvalidLayerDigest'|'MissingLayerDigest',
            'failureReason': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • layers (list) –

    A list of image layer objects corresponding to the image layer references in the request.

    • (dict) –

      An object representing an Amazon ECR image layer.

      • layerDigest (string) –

        The sha256 digest of the image layer.

      • layerAvailability (string) –

        The availability status of the image layer.

      • layerSize (integer) –

        The size, in bytes, of the image layer.

      • mediaType (string) –

        The media type of the layer, such as application/vnd.docker.image.rootfs.diff.tar.gzip or application/vnd.oci.image.layer.v1.tar+gzip.

  • failures (list) –

    Any failures associated with the call.

    • (dict) –

      An object representing an Amazon ECR image layer failure.

      • layerDigest (string) –

        The layer digest associated with the failure.

      • failureCode (string) –

        The failure code associated with the failure.

      • failureReason (string) –

        The reason for the failure.

Exceptions

• ECR.Client.exceptions.RepositoryNotFoundException

• ECR.Client.exceptions.InvalidParameterException

• ECR.Client.exceptions.ServerException