BatchCheckLayerAvailability

$result = $client->batchCheckLayerAvailability([/* ... */]);
$promise = $client->batchCheckLayerAvailabilityAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->batchCheckLayerAvailability([
    'layerDigests' => ['<string>', ...], // REQUIRED
    'registryId' => '<string>',
    'repositoryName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'failures' => [
        [
            'failureCode' => 'InvalidLayerDigest|MissingLayerDigest',
            'failureReason' => '<string>',
            'layerDigest' => '<string>',
        ],
        // ...
    ],
    'layers' => [
        [
            'layerAvailability' => 'AVAILABLE|UNAVAILABLE',
            'layerDigest' => '<string>',
            'layerSize' => <integer>,
            'mediaType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

RepositoryNotFoundException:

The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ServerException:

These errors are usually caused by a server-side issue.

BatchDeleteImage

$result = $client->batchDeleteImage([/* ... */]);
$promise = $client->batchDeleteImageAsync([/* ... */]);

Deletes a list of specified images within a repository. Images are specified with either an imageTag or imageDigest.

You can remove a tag from an image by specifying the image's tag in your request. When you remove the last tag from an image, the image is deleted from your repository.

You can completely delete an image (and all of its tags) by specifying the image's digest in your request.

Parameter Syntax

$result = $client->batchDeleteImage([
    'imageIds' => [ // REQUIRED
        [
            'imageDigest' => '<string>',
            'imageTag' => '<string>',
        ],
        // ...
    ],
    'registryId' => '<string>',
    'repositoryName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'failures' => [
        [
            'failureCode' => 'InvalidImageDigest|InvalidImageTag|ImageTagDoesNotMatchDigest|ImageNotFound|MissingDigestAndTag|ImageReferencedByManifestList|KmsError|UpstreamAccessDenied|UpstreamTooManyRequests|UpstreamUnavailable',
            'failureReason' => '<string>',
            'imageId' => [
                'imageDigest' => '<string>',
                'imageTag' => '<string>',
            ],
        ],
        // ...
    ],
    'imageIds' => [
        [
            'imageDigest' => '<string>',
            'imageTag' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException:

The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

Examples

Example 1: To delete multiple images

This example deletes images with the tags precise and trusty in a repository called ubuntu in the default registry for an account.

$result = $client->batchDeleteImage([
    'imageIds' => [
        [
            'imageTag' => 'precise',
        ],
    ],
    'repositoryName' => 'ubuntu',
]);

Result syntax:

[
    'failures' => [
    ],
    'imageIds' => [
        [
            'imageDigest' => 'sha256:examplee6d1e504117a17000003d3753086354a38375961f2e665416ef4b1b2f',
            'imageTag' => 'precise',
        ],
    ],
]

BatchGetImage

$result = $client->batchGetImage([/* ... */]);
$promise = $client->batchGetImageAsync([/* ... */]);

Gets detailed information for an image. Images are specified with either an imageTag or imageDigest.

When an image is pulled, the BatchGetImage API is called once to retrieve the image manifest.

Parameter Syntax

$result = $client->batchGetImage([
    'acceptedMediaTypes' => ['<string>', ...],
    'imageIds' => [ // REQUIRED
        [
            'imageDigest' => '<string>',
            'imageTag' => '<string>',
        ],
        // ...
    ],
    'registryId' => '<string>',
    'repositoryName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'failures' => [
        [
            'failureCode' => 'InvalidImageDigest|InvalidImageTag|ImageTagDoesNotMatchDigest|ImageNotFound|MissingDigestAndTag|ImageReferencedByManifestList|KmsError|UpstreamAccessDenied|UpstreamTooManyRequests|UpstreamUnavailable',
            'failureReason' => '<string>',
            'imageId' => [
                'imageDigest' => '<string>',
                'imageTag' => '<string>',
            ],
        ],
        // ...
    ],
    'images' => [
        [
            'imageId' => [
                'imageDigest' => '<string>',
                'imageTag' => '<string>',
            ],
            'imageManifest' => '<string>',
            'imageManifestMediaType' => '<string>',
            'registryId' => '<string>',
            'repositoryName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException:

The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

LimitExceededException:

The operation did not succeed because it would have exceeded a service limit for your account. For more information, see Amazon ECR service quotas in the Amazon Elastic Container Registry User Guide.

UnableToGetUpstreamImageException:

The image or images were unable to be pulled using the pull through cache rule. This is usually caused because of an issue with the Secrets Manager secret containing the credentials for the upstream registry.

Examples

Example 1: To obtain multiple images in a single request

This example obtains information for an image with a specified image digest ID from the repository named ubuntu in the current account.

$result = $client->batchGetImage([
    'imageIds' => [
        [
            'imageTag' => 'precise',
        ],
    ],
    'repositoryName' => 'ubuntu',
]);

Result syntax:

[
    'failures' => [
    ],
    'images' => [
        [
            'imageId' => [
                'imageDigest' => 'sha256:example76bdff6d83a09ba2a818f0d00000063724a9ac3ba5019c56f74ebf42a',
                'imageTag' => 'precise',
            ],
            'imageManifest' => '{ "schemaVersion": 1, "name": "ubuntu", "tag": "precise",...',
            'registryId' => '244698725403',
            'repositoryName' => 'ubuntu',
        ],
    ],
]

BatchGetRepositoryScanningConfiguration

$result = $client->batchGetRepositoryScanningConfiguration([/* ... */]);
$promise = $client->batchGetRepositoryScanningConfigurationAsync([/* ... */]);

Gets the scanning configuration for one or more repositories.

Parameter Syntax

$result = $client->batchGetRepositoryScanningConfiguration([
    'repositoryNames' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'failures' => [
        [
            'failureCode' => 'REPOSITORY_NOT_FOUND',
            'failureReason' => '<string>',
            'repositoryName' => '<string>',
        ],
        // ...
    ],
    'scanningConfigurations' => [
        [
            'appliedScanFilters' => [
                [
                    'filter' => '<string>',
                    'filterType' => 'WILDCARD',
                ],
                // ...
            ],
            'repositoryArn' => '<string>',
            'repositoryName' => '<string>',
            'scanFrequency' => 'SCAN_ON_PUSH|CONTINUOUS_SCAN|MANUAL',
            'scanOnPush' => true || false,
        ],
        // ...
    ],
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException:

The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

ValidationException:

There was an exception validating this request.

CompleteLayerUpload

$result = $client->completeLayerUpload([/* ... */]);
$promise = $client->completeLayerUploadAsync([/* ... */]);

Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and upload ID. You can optionally provide a sha256 digest of the image layer for data validation purposes.

When an image is pushed, the CompleteLayerUpload API is called once per each new image layer to verify that the upload has completed.

Parameter Syntax

$result = $client->completeLayerUpload([
    'layerDigests' => ['<string>', ...], // REQUIRED
    'registryId' => '<string>',
    'repositoryName' => '<string>', // REQUIRED
    'uploadId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'layerDigest' => '<string>',
    'registryId' => '<string>',
    'repositoryName' => '<string>',
    'uploadId' => '<string>',
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException:

The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

UploadNotFoundException:

The upload could not be found, or the specified upload ID is not valid for this repository.

InvalidLayerException:

The layer digest calculation performed by Amazon ECR upon receipt of the image layer does not match the digest specified.

LayerPartTooSmallException:

Layer parts must be at least 5 MiB in size.

LayerAlreadyExistsException:

The image layer already exists in the associated repository.

EmptyUploadException:

The specified layer upload does not contain any layer parts.

KmsException:

The operation failed due to a KMS exception.

CreatePullThroughCacheRule

$result = $client->createPullThroughCacheRule([/* ... */]);
$promise = $client->createPullThroughCacheRuleAsync([/* ... */]);

Creates a pull through cache rule. A pull through cache rule provides a way to cache images from an upstream registry source in your Amazon ECR private registry. For more information, see Using pull through cache rules in the Amazon Elastic Container Registry User Guide.

Parameter Syntax

$result = $client->createPullThroughCacheRule([
    'credentialArn' => '<string>',
    'customRoleArn' => '<string>',
    'ecrRepositoryPrefix' => '<string>', // REQUIRED
    'registryId' => '<string>',
    'upstreamRegistry' => 'ecr|ecr-public|quay|k8s|docker-hub|github-container-registry|azure-container-registry|gitlab-container-registry',
    'upstreamRegistryUrl' => '<string>', // REQUIRED
    'upstreamRepositoryPrefix' => '<string>',
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'credentialArn' => '<string>',
    'customRoleArn' => '<string>',
    'ecrRepositoryPrefix' => '<string>',
    'registryId' => '<string>',
    'upstreamRegistry' => 'ecr|ecr-public|quay|k8s|docker-hub|github-container-registry|azure-container-registry|gitlab-container-registry',
    'upstreamRegistryUrl' => '<string>',
    'upstreamRepositoryPrefix' => '<string>',
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ValidationException:

There was an exception validating this request.

PullThroughCacheRuleAlreadyExistsException:

A pull through cache rule with these settings already exists for the private registry.

UnsupportedUpstreamRegistryException:

The specified upstream registry isn't supported.

LimitExceededException:

The operation did not succeed because it would have exceeded a service limit for your account. For more information, see Amazon ECR service quotas in the Amazon Elastic Container Registry User Guide.

UnableToAccessSecretException:

The secret is unable to be accessed. Verify the resource permissions for the secret and try again.

SecretNotFoundException:

The ARN of the secret specified in the pull through cache rule was not found. Update the pull through cache rule with a valid secret ARN and try again.

UnableToDecryptSecretValueException:

The secret is accessible but is unable to be decrypted. Verify the resource permisisons and try again.

CreateRepository

$result = $client->createRepository([/* ... */]);
$promise = $client->createRepositoryAsync([/* ... */]);

Creates a repository. For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide.

Parameter Syntax

$result = $client->createRepository([
    'encryptionConfiguration' => [
        'encryptionType' => 'AES256|KMS|KMS_DSSE', // REQUIRED
        'kmsKey' => '<string>',
    ],
    'imageScanningConfiguration' => [
        'scanOnPush' => true || false,
    ],
    'imageTagMutability' => 'MUTABLE|IMMUTABLE',
    'registryId' => '<string>',
    'repositoryName' => '<string>', // REQUIRED
    'tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'repository' => [
        'createdAt' => <DateTime>,
        'encryptionConfiguration' => [
            'encryptionType' => 'AES256|KMS|KMS_DSSE',
            'kmsKey' => '<string>',
        ],
        'imageScanningConfiguration' => [
            'scanOnPush' => true || false,
        ],
        'imageTagMutability' => 'MUTABLE|IMMUTABLE',
        'registryId' => '<string>',
        'repositoryArn' => '<string>',
        'repositoryName' => '<string>',
        'repositoryUri' => '<string>',
    ],
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

InvalidTagParameterException:

An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

TooManyTagsException:

The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a repository is 50.

RepositoryAlreadyExistsException:

The specified repository already exists in the specified registry.

LimitExceededException:

The operation did not succeed because it would have exceeded a service limit for your account. For more information, see Amazon ECR service quotas in the Amazon Elastic Container Registry User Guide.

KmsException:

The operation failed due to a KMS exception.

Examples

Example 1: To create a new repository

This example creates a repository called nginx-web-app inside the project-a namespace in the default registry for an account.

$result = $client->createRepository([
    'repositoryName' => 'project-a/nginx-web-app',
]);

Result syntax:

[
    'repository' => [
        'registryId' => '012345678901',
        'repositoryArn' => 'arn:aws:ecr:us-west-2:012345678901:repository/project-a/nginx-web-app',
        'repositoryName' => 'project-a/nginx-web-app',
    ],
]

CreateRepositoryCreationTemplate

$result = $client->createRepositoryCreationTemplate([/* ... */]);
$promise = $client->createRepositoryCreationTemplateAsync([/* ... */]);

Creates a repository creation template. This template is used to define the settings for repositories created by Amazon ECR on your behalf. For example, repositories created through pull through cache actions. For more information, see Private repository creation templates in the Amazon Elastic Container Registry User Guide.

Parameter Syntax

$result = $client->createRepositoryCreationTemplate([
    'appliedFor' => ['<string>', ...], // REQUIRED
    'customRoleArn' => '<string>',
    'description' => '<string>',
    'encryptionConfiguration' => [
        'encryptionType' => 'AES256|KMS|KMS_DSSE', // REQUIRED
        'kmsKey' => '<string>',
    ],
    'imageTagMutability' => 'MUTABLE|IMMUTABLE',
    'lifecyclePolicy' => '<string>',
    'prefix' => '<string>', // REQUIRED
    'repositoryPolicy' => '<string>',
    'resourceTags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'registryId' => '<string>',
    'repositoryCreationTemplate' => [
        'appliedFor' => ['<string>', ...],
        'createdAt' => <DateTime>,
        'customRoleArn' => '<string>',
        'description' => '<string>',
        'encryptionConfiguration' => [
            'encryptionType' => 'AES256|KMS|KMS_DSSE',
            'kmsKey' => '<string>',
        ],
        'imageTagMutability' => 'MUTABLE|IMMUTABLE',
        'lifecyclePolicy' => '<string>',
        'prefix' => '<string>',
        'repositoryPolicy' => '<string>',
        'resourceTags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

ValidationException:

There was an exception validating this request.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

LimitExceededException:

The operation did not succeed because it would have exceeded a service limit for your account. For more information, see Amazon ECR service quotas in the Amazon Elastic Container Registry User Guide.

TemplateAlreadyExistsException:

The repository creation template already exists. Specify a unique prefix and try again.

Examples

Example 1: Create a new repository creation template

This example creates a repository creation template.

$result = $client->createRepositoryCreationTemplate([
    'appliedFor' => [
        'REPLICATION',
        'PULL_THROUGH_CACHE',
    ],
    'description' => 'Repos for testing images',
    'encryptionConfiguration' => [
        'encryptionType' => 'AES256',
    ],
    'imageTagMutability' => 'MUTABLE',
    'lifecyclePolicy' => '{ "rules": [ { "rulePriority": 1, "description": "Expire images older than 14 days", "selection": { "tagStatus": "untagged", "countType": "sinceImagePushed", "countUnit": "days", "countNumber": 14 }, "action": { "type": "expire" } } ]}',
    'prefix' => 'eng/test',
    'repositoryPolicy' => '{ "Version": "2012-10-17", "Statement": [ { "Sid": "LambdaECRPullPolicy", "Effect": "Allow", "Principal": { "Service": "lambda.amazonaws.com" }, "Action": "ecr:BatchGetImage" } ]}',
    'resourceTags' => [
        [
            'Key' => 'environment',
            'Value' => 'test',
        ],
    ],
]);

Result syntax:

[
    'registryId' => '012345678901',
    'repositoryCreationTemplate' => [
        'appliedFor' => [
            'REPLICATION',
            'PULL_THROUGH_CACHE',
        ],
        'createdAt' => ,
        'description' => 'Repos for testing images',
        'encryptionConfiguration' => [
            'encryptionType' => 'AES256',
        ],
        'imageTagMutability' => 'MUTABLE',
        'lifecyclePolicy' => '{ "rules": [ { "rulePriority": 1, "description": "Expire images older than 14 days", "selection": { "tagStatus": "untagged", "countType": "sinceImagePushed", "countUnit": "days", "countNumber": 14 }, "action": { "type": "expire" } } ]}',
        'prefix' => 'eng/test',
        'repositoryPolicy' => '{ "Version" : "2012-10-17", "Statement" : [ { "Sid" : "LambdaECRPullPolicy", "Effect" : "Allow", "Principal" : { "Service" : "lambda.amazonaws.com" }, "Action" : "ecr:BatchGetImage" } ]}',
        'resourceTags' => [
            [
                'Key' => 'environment',
                'Value' => 'test',
            ],
        ],
        'updatedAt' => ,
    ],
]

DeleteLifecyclePolicy

$result = $client->deleteLifecyclePolicy([/* ... */]);
$promise = $client->deleteLifecyclePolicyAsync([/* ... */]);

Deletes the lifecycle policy associated with the specified repository.

Parameter Syntax

$result = $client->deleteLifecyclePolicy([
    'registryId' => '<string>',
    'repositoryName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'lastEvaluatedAt' => <DateTime>,
    'lifecyclePolicyText' => '<string>',
    'registryId' => '<string>',
    'repositoryName' => '<string>',
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException:

The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

LifecyclePolicyNotFoundException:

The lifecycle policy could not be found, and no policy is set to the repository.

ValidationException:

There was an exception validating this request.

DeletePullThroughCacheRule

$result = $client->deletePullThroughCacheRule([/* ... */]);
$promise = $client->deletePullThroughCacheRuleAsync([/* ... */]);

Deletes a pull through cache rule.

Parameter Syntax

$result = $client->deletePullThroughCacheRule([
    'ecrRepositoryPrefix' => '<string>', // REQUIRED
    'registryId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'credentialArn' => '<string>',
    'customRoleArn' => '<string>',
    'ecrRepositoryPrefix' => '<string>',
    'registryId' => '<string>',
    'upstreamRegistryUrl' => '<string>',
    'upstreamRepositoryPrefix' => '<string>',
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ValidationException:

There was an exception validating this request.

PullThroughCacheRuleNotFoundException:

The pull through cache rule was not found. Specify a valid pull through cache rule and try again.

DeleteRegistryPolicy

$result = $client->deleteRegistryPolicy([/* ... */]);
$promise = $client->deleteRegistryPolicyAsync([/* ... */]);

Deletes the registry permissions policy.

Parameter Syntax

$result = $client->deleteRegistryPolicy([
]);

Parameter Details

Result Syntax

[
    'policyText' => '<string>',
    'registryId' => '<string>',
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

RegistryPolicyNotFoundException:

The registry doesn't have an associated registry policy.

ValidationException:

There was an exception validating this request.

DeleteRepository

$result = $client->deleteRepository([/* ... */]);
$promise = $client->deleteRepositoryAsync([/* ... */]);

Deletes a repository. If the repository isn't empty, you must either delete the contents of the repository or use the force option to delete the repository and have Amazon ECR delete all of its contents on your behalf.

Parameter Syntax

$result = $client->deleteRepository([
    'force' => true || false,
    'registryId' => '<string>',
    'repositoryName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'repository' => [
        'createdAt' => <DateTime>,
        'encryptionConfiguration' => [
            'encryptionType' => 'AES256|KMS|KMS_DSSE',
            'kmsKey' => '<string>',
        ],
        'imageScanningConfiguration' => [
            'scanOnPush' => true || false,
        ],
        'imageTagMutability' => 'MUTABLE|IMMUTABLE',
        'registryId' => '<string>',
        'repositoryArn' => '<string>',
        'repositoryName' => '<string>',
        'repositoryUri' => '<string>',
    ],
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException:

The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

RepositoryNotEmptyException:

The specified repository contains images. To delete a repository that contains images, you must force the deletion with the force parameter.

KmsException:

The operation failed due to a KMS exception.

Examples

Example 1: To force delete a repository

This example force deletes a repository named ubuntu in the default registry for an account. The force parameter is required if the repository contains images.

$result = $client->deleteRepository([
    'force' => 1,
    'repositoryName' => 'ubuntu',
]);

Result syntax:

[
    'repository' => [
        'registryId' => '012345678901',
        'repositoryArn' => 'arn:aws:ecr:us-west-2:012345678901:repository/ubuntu',
        'repositoryName' => 'ubuntu',
    ],
]

DeleteRepositoryCreationTemplate

$result = $client->deleteRepositoryCreationTemplate([/* ... */]);
$promise = $client->deleteRepositoryCreationTemplateAsync([/* ... */]);

Deletes a repository creation template.

Parameter Syntax

$result = $client->deleteRepositoryCreationTemplate([
    'prefix' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'registryId' => '<string>',
    'repositoryCreationTemplate' => [
        'appliedFor' => ['<string>', ...],
        'createdAt' => <DateTime>,
        'customRoleArn' => '<string>',
        'description' => '<string>',
        'encryptionConfiguration' => [
            'encryptionType' => 'AES256|KMS|KMS_DSSE',
            'kmsKey' => '<string>',
        ],
        'imageTagMutability' => 'MUTABLE|IMMUTABLE',
        'lifecyclePolicy' => '<string>',
        'prefix' => '<string>',
        'repositoryPolicy' => '<string>',
        'resourceTags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

ValidationException:

There was an exception validating this request.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

TemplateNotFoundException:

The specified repository creation template can't be found. Verify the registry ID and prefix and try again.

Examples

Example 1: Delete a repository creation template

This example deletes a repository creation template.

$result = $client->deleteRepositoryCreationTemplate([
    'prefix' => 'eng',
]);

Result syntax:

[
    'registryId' => '012345678901',
    'repositoryCreationTemplate' => [
        'createdAt' => ,
        'encryptionConfiguration' => [
            'encryptionType' => 'AES256',
        ],
        'imageTagMutability' => 'MUTABLE',
        'prefix' => 'eng',
        'updatedAt' => ,
    ],
]

DeleteRepositoryPolicy

$result = $client->deleteRepositoryPolicy([/* ... */]);
$promise = $client->deleteRepositoryPolicyAsync([/* ... */]);

Deletes the repository policy associated with the specified repository.

Parameter Syntax

$result = $client->deleteRepositoryPolicy([
    'registryId' => '<string>',
    'repositoryName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'policyText' => '<string>',
    'registryId' => '<string>',
    'repositoryName' => '<string>',
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException:

The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

RepositoryPolicyNotFoundException:

The specified repository and registry combination does not have an associated repository policy.

Examples

Example 1: To delete the policy associated with a repository

This example deletes the policy associated with the repository named ubuntu in the current account.

$result = $client->deleteRepositoryPolicy([
    'repositoryName' => 'ubuntu',
]);

Result syntax:

[
    'policyText' => '{ ... }',
    'registryId' => '012345678901',
    'repositoryName' => 'ubuntu',
]

DescribeImageReplicationStatus

$result = $client->describeImageReplicationStatus([/* ... */]);
$promise = $client->describeImageReplicationStatusAsync([/* ... */]);

Returns the replication status for a specified image.

Parameter Syntax

$result = $client->describeImageReplicationStatus([
    'imageId' => [ // REQUIRED
        'imageDigest' => '<string>',
        'imageTag' => '<string>',
    ],
    'registryId' => '<string>',
    'repositoryName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'imageId' => [
        'imageDigest' => '<string>',
        'imageTag' => '<string>',
    ],
    'replicationStatuses' => [
        [
            'failureCode' => '<string>',
            'region' => '<string>',
            'registryId' => '<string>',
            'status' => 'IN_PROGRESS|COMPLETE|FAILED',
        ],
        // ...
    ],
    'repositoryName' => '<string>',
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ImageNotFoundException:

The image requested does not exist in the specified repository.

RepositoryNotFoundException:

The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

ValidationException:

There was an exception validating this request.

DescribeImageScanFindings

$result = $client->describeImageScanFindings([/* ... */]);
$promise = $client->describeImageScanFindingsAsync([/* ... */]);

Returns the scan findings for the specified image.

Parameter Syntax

$result = $client->describeImageScanFindings([
    'imageId' => [ // REQUIRED
        'imageDigest' => '<string>',
        'imageTag' => '<string>',
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'registryId' => '<string>',
    'repositoryName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'imageId' => [
        'imageDigest' => '<string>',
        'imageTag' => '<string>',
    ],
    'imageScanFindings' => [
        'enhancedFindings' => [
            [
                'awsAccountId' => '<string>',
                'description' => '<string>',
                'exploitAvailable' => '<string>',
                'findingArn' => '<string>',
                'firstObservedAt' => <DateTime>,
                'fixAvailable' => '<string>',
                'lastObservedAt' => <DateTime>,
                'packageVulnerabilityDetails' => [
                    'cvss' => [
                        [
                            'baseScore' => <float>,
                            'scoringVector' => '<string>',
                            'source' => '<string>',
                            'version' => '<string>',
                        ],
                        // ...
                    ],
                    'referenceUrls' => ['<string>', ...],
                    'relatedVulnerabilities' => ['<string>', ...],
                    'source' => '<string>',
                    'sourceUrl' => '<string>',
                    'vendorCreatedAt' => <DateTime>,
                    'vendorSeverity' => '<string>',
                    'vendorUpdatedAt' => <DateTime>,
                    'vulnerabilityId' => '<string>',
                    'vulnerablePackages' => [
                        [
                            'arch' => '<string>',
                            'epoch' => <integer>,
                            'filePath' => '<string>',
                            'fixedInVersion' => '<string>',
                            'name' => '<string>',
                            'packageManager' => '<string>',
                            'release' => '<string>',
                            'sourceLayerHash' => '<string>',
                            'version' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'remediation' => [
                    'recommendation' => [
                        'text' => '<string>',
                        'url' => '<string>',
                    ],
                ],
                'resources' => [
                    [
                        'details' => [
                            'awsEcrContainerImage' => [
                                'architecture' => '<string>',
                                'author' => '<string>',
                                'imageHash' => '<string>',
                                'imageTags' => ['<string>', ...],
                                'platform' => '<string>',
                                'pushedAt' => <DateTime>,
                                'registry' => '<string>',
                                'repositoryName' => '<string>',
                            ],
                        ],
                        'id' => '<string>',
                        'tags' => ['<string>', ...],
                        'type' => '<string>',
                    ],
                    // ...
                ],
                'score' => <float>,
                'scoreDetails' => [
                    'cvss' => [
                        'adjustments' => [
                            [
                                'metric' => '<string>',
                                'reason' => '<string>',
                            ],
                            // ...
                        ],
                        'score' => <float>,
                        'scoreSource' => '<string>',
                        'scoringVector' => '<string>',
                        'version' => '<string>',
                    ],
                ],
                'severity' => '<string>',
                'status' => '<string>',
                'title' => '<string>',
                'type' => '<string>',
                'updatedAt' => <DateTime>,
            ],
            // ...
        ],
        'findingSeverityCounts' => [<integer>, ...],
        'findings' => [
            [
                'attributes' => [
                    [
                        'key' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'description' => '<string>',
                'name' => '<string>',
                'severity' => 'INFORMATIONAL|LOW|MEDIUM|HIGH|CRITICAL|UNDEFINED',
                'uri' => '<string>',
            ],
            // ...
        ],
        'imageScanCompletedAt' => <DateTime>,
        'vulnerabilitySourceUpdatedAt' => <DateTime>,
    ],
    'imageScanStatus' => [
        'description' => '<string>',
        'status' => 'IN_PROGRESS|COMPLETE|FAILED|UNSUPPORTED_IMAGE|ACTIVE|PENDING|SCAN_ELIGIBILITY_EXPIRED|FINDINGS_UNAVAILABLE|LIMIT_EXCEEDED',
    ],
    'nextToken' => '<string>',
    'registryId' => '<string>',
    'repositoryName' => '<string>',
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException:

The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

ImageNotFoundException:

The image requested does not exist in the specified repository.

ScanNotFoundException:

The specified image scan could not be found. Ensure that image scanning is enabled on the repository and try again.

ValidationException:

There was an exception validating this request.

DescribeImages

$result = $client->describeImages([/* ... */]);
$promise = $client->describeImagesAsync([/* ... */]);

Returns metadata about the images in a repository.

Parameter Syntax

$result = $client->describeImages([
    'filter' => [
        'tagStatus' => 'TAGGED|UNTAGGED|ANY',
    ],
    'imageIds' => [
        [
            'imageDigest' => '<string>',
            'imageTag' => '<string>',
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'registryId' => '<string>',
    'repositoryName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'imageDetails' => [
        [
            'artifactMediaType' => '<string>',
            'imageDigest' => '<string>',
            'imageManifestMediaType' => '<string>',
            'imagePushedAt' => <DateTime>,
            'imageScanFindingsSummary' => [
                'findingSeverityCounts' => [<integer>, ...],
                'imageScanCompletedAt' => <DateTime>,
                'vulnerabilitySourceUpdatedAt' => <DateTime>,
            ],
            'imageScanStatus' => [
                'description' => '<string>',
                'status' => 'IN_PROGRESS|COMPLETE|FAILED|UNSUPPORTED_IMAGE|ACTIVE|PENDING|SCAN_ELIGIBILITY_EXPIRED|FINDINGS_UNAVAILABLE|LIMIT_EXCEEDED',
            ],
            'imageSizeInBytes' => <integer>,
            'imageTags' => ['<string>', ...],
            'lastRecordedPullTime' => <DateTime>,
            'registryId' => '<string>',
            'repositoryName' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException:

The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

ImageNotFoundException:

The image requested does not exist in the specified repository.

DescribePullThroughCacheRules

$result = $client->describePullThroughCacheRules([/* ... */]);
$promise = $client->describePullThroughCacheRulesAsync([/* ... */]);

Returns the pull through cache rules for a registry.

Parameter Syntax

$result = $client->describePullThroughCacheRules([
    'ecrRepositoryPrefixes' => ['<string>', ...],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'registryId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'pullThroughCacheRules' => [
        [
            'createdAt' => <DateTime>,
            'credentialArn' => '<string>',
            'customRoleArn' => '<string>',
            'ecrRepositoryPrefix' => '<string>',
            'registryId' => '<string>',
            'updatedAt' => <DateTime>,
            'upstreamRegistry' => 'ecr|ecr-public|quay|k8s|docker-hub|github-container-registry|azure-container-registry|gitlab-container-registry',
            'upstreamRegistryUrl' => '<string>',
            'upstreamRepositoryPrefix' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ValidationException:

There was an exception validating this request.

PullThroughCacheRuleNotFoundException:

The pull through cache rule was not found. Specify a valid pull through cache rule and try again.

DescribeRegistry

$result = $client->describeRegistry([/* ... */]);
$promise = $client->describeRegistryAsync([/* ... */]);

Describes the settings for a registry. The replication configuration for a repository can be created or updated with the PutReplicationConfiguration API action.

Parameter Syntax

$result = $client->describeRegistry([
]);

Parameter Details

Result Syntax

[
    'registryId' => '<string>',
    'replicationConfiguration' => [
        'rules' => [
            [
                'destinations' => [
                    [
                        'region' => '<string>',
                        'registryId' => '<string>',
                    ],
                    // ...
                ],
                'repositoryFilters' => [
                    [
                        'filter' => '<string>',
                        'filterType' => 'PREFIX_MATCH',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ValidationException:

There was an exception validating this request.

DescribeRepositories

$result = $client->describeRepositories([/* ... */]);
$promise = $client->describeRepositoriesAsync([/* ... */]);

Describes image repositories in a registry.

Parameter Syntax

$result = $client->describeRepositories([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'registryId' => '<string>',
    'repositoryNames' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'repositories' => [
        [
            'createdAt' => <DateTime>,
            'encryptionConfiguration' => [
                'encryptionType' => 'AES256|KMS|KMS_DSSE',
                'kmsKey' => '<string>',
            ],
            'imageScanningConfiguration' => [
                'scanOnPush' => true || false,
            ],
            'imageTagMutability' => 'MUTABLE|IMMUTABLE',
            'registryId' => '<string>',
            'repositoryArn' => '<string>',
            'repositoryName' => '<string>',
            'repositoryUri' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException:

The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

Examples

Example 1: To describe all repositories in the current account

The following example obtains a list and description of all repositories in the default registry to which the current user has access.

$result = $client->describeRepositories([
]);

Result syntax:

[
    'repositories' => [
        [
            'registryId' => '012345678910',
            'repositoryArn' => 'arn:aws:ecr:us-west-2:012345678910:repository/ubuntu',
            'repositoryName' => 'ubuntu',
        ],
        [
            'registryId' => '012345678910',
            'repositoryArn' => 'arn:aws:ecr:us-west-2:012345678910:repository/test',
            'repositoryName' => 'test',
        ],
    ],
]

DescribeRepositoryCreationTemplates

$result = $client->describeRepositoryCreationTemplates([/* ... */]);
$promise = $client->describeRepositoryCreationTemplatesAsync([/* ... */]);

Returns details about the repository creation templates in a registry. The prefixes request parameter can be used to return the details for a specific repository creation template.

Parameter Syntax

$result = $client->describeRepositoryCreationTemplates([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'prefixes' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'registryId' => '<string>',
    'repositoryCreationTemplates' => [
        [
            'appliedFor' => ['<string>', ...],
            'createdAt' => <DateTime>,
            'customRoleArn' => '<string>',
            'description' => '<string>',
            'encryptionConfiguration' => [
                'encryptionType' => 'AES256|KMS|KMS_DSSE',
                'kmsKey' => '<string>',
            ],
            'imageTagMutability' => 'MUTABLE|IMMUTABLE',
            'lifecyclePolicy' => '<string>',
            'prefix' => '<string>',
            'repositoryPolicy' => '<string>',
            'resourceTags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

ValidationException:

There was an exception validating this request.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

Examples

Example 1: Describe a repository creation template

This example describes the contents of a repository creation template.

$result = $client->describeRepositoryCreationTemplates([
    'maxResults' => 123,
    'nextToken' => '',
    'prefixes' => [
        'eng',
    ],
]);

Result syntax:

[
    'nextToken' => '',
    'registryId' => '012345678901',
    'repositoryCreationTemplates' => [
        [
            'appliedFor' => [
                'PULL_THROUGH_CACHE',
                'REPLICATION',
            ],
            'createdAt' => ,
            'encryptionConfiguration' => [
                'encryptionType' => 'AES256',
            ],
            'imageTagMutability' => 'MUTABLE',
            'prefix' => 'eng/test',
            'updatedAt' => ,
        ],
        [
            'appliedFor' => [
                'REPLICATION',
            ],
            'createdAt' => ,
            'encryptionConfiguration' => [
                'encryptionType' => 'AES256',
            ],
            'imageTagMutability' => 'IMMUTABLE',
            'prefix' => 'eng/replication-test',
            'updatedAt' => ,
        ],
    ],
]

GetAccountSetting

$result = $client->getAccountSetting([/* ... */]);
$promise = $client->getAccountSettingAsync([/* ... */]);

Retrieves the account setting value for the specified setting name.

Parameter Syntax

$result = $client->getAccountSetting([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'name' => '<string>',
    'value' => '<string>',
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

ValidationException:

There was an exception validating this request.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

GetAuthorizationToken

$result = $client->getAuthorizationToken([/* ... */]);
$promise = $client->getAuthorizationTokenAsync([/* ... */]);

Retrieves an authorization token. An authorization token represents your IAM authentication credentials and can be used to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid for 12 hours.

The authorizationToken returned is a base64 encoded string that can be decoded and used in a docker login command to authenticate to a registry. The CLI offers an get-login-password command that simplifies the login process. For more information, see Registry authentication in the Amazon Elastic Container Registry User Guide.

Parameter Syntax

$result = $client->getAuthorizationToken([
    'registryIds' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'authorizationData' => [
        [
            'authorizationToken' => '<string>',
            'expiresAt' => <DateTime>,
            'proxyEndpoint' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

Examples

Example 1: To obtain an authorization token

This example gets an authorization token for your default registry.

$result = $client->getAuthorizationToken([
]);

Result syntax:

[
    'authorizationData' => [
        [
            'authorizationToken' => 'QVdTOkNEXAMPLE',
            'expiresAt' => ,
            'proxyEndpoint' => 'https://012345678901.dkr.ecr.us-west-2.amazonaws.com',
        ],
    ],
]

GetDownloadUrlForLayer

$result = $client->getDownloadUrlForLayer([/* ... */]);
$promise = $client->getDownloadUrlForLayerAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getDownloadUrlForLayer([
    'layerDigest' => '<string>', // REQUIRED
    'registryId' => '<string>',
    'repositoryName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'downloadUrl' => '<string>',
    'layerDigest' => '<string>',
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

LayersNotFoundException:

The specified layers could not be found, or the specified layer is not valid for this repository.

LayerInaccessibleException:

The specified layer is not available because it is not associated with an image. Unassociated image layers may be cleaned up at any time.

RepositoryNotFoundException:

The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

UnableToGetUpstreamLayerException:

There was an issue getting the upstream layer matching the pull through cache rule.

GetLifecyclePolicy

$result = $client->getLifecyclePolicy([/* ... */]);
$promise = $client->getLifecyclePolicyAsync([/* ... */]);

Retrieves the lifecycle policy for the specified repository.

Parameter Syntax

$result = $client->getLifecyclePolicy([
    'registryId' => '<string>',
    'repositoryName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'lastEvaluatedAt' => <DateTime>,
    'lifecyclePolicyText' => '<string>',
    'registryId' => '<string>',
    'repositoryName' => '<string>',
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException:

The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

LifecyclePolicyNotFoundException:

The lifecycle policy could not be found, and no policy is set to the repository.

ValidationException:

There was an exception validating this request.

GetLifecyclePolicyPreview

$result = $client->getLifecyclePolicyPreview([/* ... */]);
$promise = $client->getLifecyclePolicyPreviewAsync([/* ... */]);

Retrieves the results of the lifecycle policy preview request for the specified repository.

Parameter Syntax

$result = $client->getLifecyclePolicyPreview([
    'filter' => [
        'tagStatus' => 'TAGGED|UNTAGGED|ANY',
    ],
    'imageIds' => [
        [
            'imageDigest' => '<string>',
            'imageTag' => '<string>',
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'registryId' => '<string>',
    'repositoryName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'lifecyclePolicyText' => '<string>',
    'nextToken' => '<string>',
    'previewResults' => [
        [
            'action' => [
                'type' => 'EXPIRE',
            ],
            'appliedRulePriority' => <integer>,
            'imageDigest' => '<string>',
            'imagePushedAt' => <DateTime>,
            'imageTags' => ['<string>', ...],
        ],
        // ...
    ],
    'registryId' => '<string>',
    'repositoryName' => '<string>',
    'status' => 'IN_PROGRESS|COMPLETE|EXPIRED|FAILED',
    'summary' => [
        'expiringImageTotalCount' => <integer>,
    ],
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException:

The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

LifecyclePolicyPreviewNotFoundException:

There is no dry run for this repository.

ValidationException:

There was an exception validating this request.

GetRegistryPolicy

$result = $client->getRegistryPolicy([/* ... */]);
$promise = $client->getRegistryPolicyAsync([/* ... */]);

Retrieves the permissions policy for a registry.

Parameter Syntax

$result = $client->getRegistryPolicy([
]);

Parameter Details

Result Syntax

[
    'policyText' => '<string>',
    'registryId' => '<string>',
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

RegistryPolicyNotFoundException:

The registry doesn't have an associated registry policy.

ValidationException:

There was an exception validating this request.

GetRegistryScanningConfiguration

$result = $client->getRegistryScanningConfiguration([/* ... */]);
$promise = $client->getRegistryScanningConfigurationAsync([/* ... */]);

Retrieves the scanning configuration for a registry.

Parameter Syntax

$result = $client->getRegistryScanningConfiguration([
]);

Parameter Details

Result Syntax

[
    'registryId' => '<string>',
    'scanningConfiguration' => [
        'rules' => [
            [
                'repositoryFilters' => [
                    [
                        'filter' => '<string>',
                        'filterType' => 'WILDCARD',
                    ],
                    // ...
                ],
                'scanFrequency' => 'SCAN_ON_PUSH|CONTINUOUS_SCAN|MANUAL',
            ],
            // ...
        ],
        'scanType' => 'BASIC|ENHANCED',
    ],
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ValidationException:

There was an exception validating this request.

GetRepositoryPolicy

$result = $client->getRepositoryPolicy([/* ... */]);
$promise = $client->getRepositoryPolicyAsync([/* ... */]);

Retrieves the repository policy for the specified repository.

Parameter Syntax

$result = $client->getRepositoryPolicy([
    'registryId' => '<string>',
    'repositoryName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'policyText' => '<string>',
    'registryId' => '<string>',
    'repositoryName' => '<string>',
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException:

The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

RepositoryPolicyNotFoundException:

The specified repository and registry combination does not have an associated repository policy.

Examples

Example 1: To get the current policy for a repository

This example obtains the repository policy for the repository named ubuntu.

$result = $client->getRepositoryPolicy([
    'repositoryName' => 'ubuntu',
]);

Result syntax:

[
    'policyText' => '{ "Version" : "2008-10-17", "Statement" : [ { "Sid" : "new statement", "Effect" : "Allow", "Principal" : { "AWS" : "arn:aws:iam::012345678901:role/CodeDeployDemo" },"Action" : [ "ecr:GetDownloadUrlForLayer", "ecr:BatchGetImage", "ecr:BatchCheckLayerAvailability" ] } ]}',
    'registryId' => '012345678901',
    'repositoryName' => 'ubuntu',
]

InitiateLayerUpload

$result = $client->initiateLayerUpload([/* ... */]);
$promise = $client->initiateLayerUploadAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->initiateLayerUpload([
    'registryId' => '<string>',
    'repositoryName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'partSize' => <integer>,
    'uploadId' => '<string>',
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException:

The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

KmsException:

The operation failed due to a KMS exception.

ListImages

$result = $client->listImages([/* ... */]);
$promise = $client->listImagesAsync([/* ... */]);

Lists all the image IDs for the specified repository.

You can filter images based on whether or not they are tagged by using the tagStatus filter and specifying either TAGGED, UNTAGGED or ANY. For example, you can filter your results to return only UNTAGGED images and then pipe that result to a BatchDeleteImage operation to delete them. Or, you can filter your results to return only TAGGED images to list all of the tags in your repository.

Parameter Syntax

$result = $client->listImages([
    'filter' => [
        'tagStatus' => 'TAGGED|UNTAGGED|ANY',
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'registryId' => '<string>',
    'repositoryName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'imageIds' => [
        [
            'imageDigest' => '<string>',
            'imageTag' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException:

The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

Examples

Example 1: To list all images in a repository

This example lists all of the images in the repository named ubuntu in the default registry in the current account.

$result = $client->listImages([
    'repositoryName' => 'ubuntu',
]);

Result syntax:

[
    'imageIds' => [
        [
            'imageDigest' => 'sha256:764f63476bdff6d83a09ba2a818f0d35757063724a9ac3ba5019c56f74ebf42a',
            'imageTag' => 'precise',
        ],
    ],
]

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

List the tags for an Amazon ECR resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException:

The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

ServerException:

These errors are usually caused by a server-side issue.

PutAccountSetting

$result = $client->putAccountSetting([/* ... */]);
$promise = $client->putAccountSettingAsync([/* ... */]);

Allows you to change the basic scan type version or registry policy scope.

Parameter Syntax

$result = $client->putAccountSetting([
    'name' => '<string>', // REQUIRED
    'value' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'name' => '<string>',
    'value' => '<string>',
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

ValidationException:

There was an exception validating this request.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

LimitExceededException:

The operation did not succeed because it would have exceeded a service limit for your account. For more information, see Amazon ECR service quotas in the Amazon Elastic Container Registry User Guide.

PutImage

$result = $client->putImage([/* ... */]);
$promise = $client->putImageAsync([/* ... */]);

Creates or updates the image manifest and tags associated with an image.

When an image is pushed and all new image layers have been uploaded, the PutImage API is called once to create or update the image manifest and the tags associated with the image.

Parameter Syntax

$result = $client->putImage([
    'imageDigest' => '<string>',
    'imageManifest' => '<string>', // REQUIRED
    'imageManifestMediaType' => '<string>',
    'imageTag' => '<string>',
    'registryId' => '<string>',
    'repositoryName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'image' => [
        'imageId' => [
            'imageDigest' => '<string>',
            'imageTag' => '<string>',
        ],
        'imageManifest' => '<string>',
        'imageManifestMediaType' => '<string>',
        'registryId' => '<string>',
        'repositoryName' => '<string>',
    ],
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException:

The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

ImageAlreadyExistsException:

The specified image has already been pushed, and there were no changes to the manifest or image tag after the last push.

LayersNotFoundException:

The specified layers could not be found, or the specified layer is not valid for this repository.

ReferencedImagesNotFoundException:

The manifest list is referencing an image that does not exist.

LimitExceededException:

The operation did not succeed because it would have exceeded a service limit for your account. For more information, see Amazon ECR service quotas in the Amazon Elastic Container Registry User Guide.

ImageTagAlreadyExistsException:

The specified image is tagged with a tag that already exists. The repository is configured for tag immutability.

ImageDigestDoesNotMatchException:

The specified image digest does not match the digest that Amazon ECR calculated for the image.

KmsException:

The operation failed due to a KMS exception.

PutImageScanningConfiguration

$result = $client->putImageScanningConfiguration([/* ... */]);
$promise = $client->putImageScanningConfigurationAsync([/* ... */]);

The PutImageScanningConfiguration API is being deprecated, in favor of specifying the image scanning configuration at the registry level. For more information, see PutRegistryScanningConfiguration.

Updates the image scanning configuration for the specified repository.

Parameter Syntax

$result = $client->putImageScanningConfiguration([
    'imageScanningConfiguration' => [ // REQUIRED
        'scanOnPush' => true || false,
    ],
    'registryId' => '<string>',
    'repositoryName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'imageScanningConfiguration' => [
        'scanOnPush' => true || false,
    ],
    'registryId' => '<string>',
    'repositoryName' => '<string>',
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException:

The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

ValidationException:

There was an exception validating this request.

PutImageTagMutability

$result = $client->putImageTagMutability([/* ... */]);
$promise = $client->putImageTagMutabilityAsync([/* ... */]);

Updates the image tag mutability settings for the specified repository. For more information, see Image tag mutability in the Amazon Elastic Container Registry User Guide.

Parameter Syntax

$result = $client->putImageTagMutability([
    'imageTagMutability' => 'MUTABLE|IMMUTABLE', // REQUIRED
    'registryId' => '<string>',
    'repositoryName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'imageTagMutability' => 'MUTABLE|IMMUTABLE',
    'registryId' => '<string>',
    'repositoryName' => '<string>',
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException:

The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

PutLifecyclePolicy

$result = $client->putLifecyclePolicy([/* ... */]);
$promise = $client->putLifecyclePolicyAsync([/* ... */]);

Creates or updates the lifecycle policy for the specified repository. For more information, see Lifecycle policy template.

Parameter Syntax

$result = $client->putLifecyclePolicy([
    'lifecyclePolicyText' => '<string>', // REQUIRED
    'registryId' => '<string>',
    'repositoryName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'lifecyclePolicyText' => '<string>',
    'registryId' => '<string>',
    'repositoryName' => '<string>',
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException:

The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

ValidationException:

There was an exception validating this request.

PutRegistryPolicy

$result = $client->putRegistryPolicy([/* ... */]);
$promise = $client->putRegistryPolicyAsync([/* ... */]);

Creates or updates the permissions policy for your registry.

A registry policy is used to specify permissions for another Amazon Web Services account and is used when configuring cross-account replication. For more information, see Registry permissions in the Amazon Elastic Container Registry User Guide.

Parameter Syntax

$result = $client->putRegistryPolicy([
    'policyText' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'policyText' => '<string>',
    'registryId' => '<string>',
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ValidationException:

There was an exception validating this request.

PutRegistryScanningConfiguration

$result = $client->putRegistryScanningConfiguration([/* ... */]);
$promise = $client->putRegistryScanningConfigurationAsync([/* ... */]);

Creates or updates the scanning configuration for your private registry.

Parameter Syntax

$result = $client->putRegistryScanningConfiguration([
    'rules' => [
        [
            'repositoryFilters' => [ // REQUIRED
                [
                    'filter' => '<string>', // REQUIRED
                    'filterType' => 'WILDCARD', // REQUIRED
                ],
                // ...
            ],
            'scanFrequency' => 'SCAN_ON_PUSH|CONTINUOUS_SCAN|MANUAL', // REQUIRED
        ],
        // ...
    ],
    'scanType' => 'BASIC|ENHANCED',
]);

Parameter Details

Result Syntax

[
    'registryScanningConfiguration' => [
        'rules' => [
            [
                'repositoryFilters' => [
                    [
                        'filter' => '<string>',
                        'filterType' => 'WILDCARD',
                    ],
                    // ...
                ],
                'scanFrequency' => 'SCAN_ON_PUSH|CONTINUOUS_SCAN|MANUAL',
            ],
            // ...
        ],
        'scanType' => 'BASIC|ENHANCED',
    ],
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ValidationException:

There was an exception validating this request.

PutReplicationConfiguration

$result = $client->putReplicationConfiguration([/* ... */]);
$promise = $client->putReplicationConfigurationAsync([/* ... */]);

Creates or updates the replication configuration for a registry. The existing replication configuration for a repository can be retrieved with the DescribeRegistry API action. The first time the PutReplicationConfiguration API is called, a service-linked IAM role is created in your account for the replication process. For more information, see Using service-linked roles for Amazon ECR in the Amazon Elastic Container Registry User Guide. For more information on the custom role for replication, see Creating an IAM role for replication.

Parameter Syntax

$result = $client->putReplicationConfiguration([
    'replicationConfiguration' => [ // REQUIRED
        'rules' => [ // REQUIRED
            [
                'destinations' => [ // REQUIRED
                    [
                        'region' => '<string>', // REQUIRED
                        'registryId' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
                'repositoryFilters' => [
                    [
                        'filter' => '<string>', // REQUIRED
                        'filterType' => 'PREFIX_MATCH', // REQUIRED
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'replicationConfiguration' => [
        'rules' => [
            [
                'destinations' => [
                    [
                        'region' => '<string>',
                        'registryId' => '<string>',
                    ],
                    // ...
                ],
                'repositoryFilters' => [
                    [
                        'filter' => '<string>',
                        'filterType' => 'PREFIX_MATCH',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ValidationException:

There was an exception validating this request.

SetRepositoryPolicy

$result = $client->setRepositoryPolicy([/* ... */]);
$promise = $client->setRepositoryPolicyAsync([/* ... */]);

Applies a repository policy to the specified repository to control access permissions. For more information, see Amazon ECR Repository policies in the Amazon Elastic Container Registry User Guide.

Parameter Syntax

$result = $client->setRepositoryPolicy([
    'force' => true || false,
    'policyText' => '<string>', // REQUIRED
    'registryId' => '<string>',
    'repositoryName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'policyText' => '<string>',
    'registryId' => '<string>',
    'repositoryName' => '<string>',
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException:

The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

StartImageScan

$result = $client->startImageScan([/* ... */]);
$promise = $client->startImageScanAsync([/* ... */]);

Starts a basic image vulnerability scan.

A basic image scan can only be started once per 24 hours on an individual image. This limit includes if an image was scanned on initial push. You can start up to 100,000 basic scans per 24 hours. This limit includes both scans on initial push and scans initiated by the StartImageScan API. For more information, see Basic scanning in the Amazon Elastic Container Registry User Guide.

Parameter Syntax

$result = $client->startImageScan([
    'imageId' => [ // REQUIRED
        'imageDigest' => '<string>',
        'imageTag' => '<string>',
    ],
    'registryId' => '<string>',
    'repositoryName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'imageId' => [
        'imageDigest' => '<string>',
        'imageTag' => '<string>',
    ],
    'imageScanStatus' => [
        'description' => '<string>',
        'status' => 'IN_PROGRESS|COMPLETE|FAILED|UNSUPPORTED_IMAGE|ACTIVE|PENDING|SCAN_ELIGIBILITY_EXPIRED|FINDINGS_UNAVAILABLE|LIMIT_EXCEEDED',
    ],
    'registryId' => '<string>',
    'repositoryName' => '<string>',
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

UnsupportedImageTypeException:

The image is of a type that cannot be scanned.

LimitExceededException:

The operation did not succeed because it would have exceeded a service limit for your account. For more information, see Amazon ECR service quotas in the Amazon Elastic Container Registry User Guide.

RepositoryNotFoundException:

The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

ImageNotFoundException:

The image requested does not exist in the specified repository.

ValidationException:

There was an exception validating this request.

StartLifecyclePolicyPreview

$result = $client->startLifecyclePolicyPreview([/* ... */]);
$promise = $client->startLifecyclePolicyPreviewAsync([/* ... */]);

Starts a preview of a lifecycle policy for the specified repository. This allows you to see the results before associating the lifecycle policy with the repository.

Parameter Syntax

$result = $client->startLifecyclePolicyPreview([
    'lifecyclePolicyText' => '<string>',
    'registryId' => '<string>',
    'repositoryName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'lifecyclePolicyText' => '<string>',
    'registryId' => '<string>',
    'repositoryName' => '<string>',
    'status' => 'IN_PROGRESS|COMPLETE|EXPIRED|FAILED',
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException:

The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

LifecyclePolicyNotFoundException:

The lifecycle policy could not be found, and no policy is set to the repository.

LifecyclePolicyPreviewInProgressException:

The previous lifecycle policy preview request has not completed. Wait and try again.

ValidationException:

There was an exception validating this request.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds specified tags to a resource with the specified ARN. Existing tags on a resource are not changed if they are not specified in the request parameters.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

InvalidTagParameterException:

An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

TooManyTagsException:

The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a repository is 50.

RepositoryNotFoundException:

The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

ServerException:

These errors are usually caused by a server-side issue.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Deletes specified tags from a resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

InvalidTagParameterException:

An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

TooManyTagsException:

The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a repository is 50.

RepositoryNotFoundException:

The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

ServerException:

These errors are usually caused by a server-side issue.

UpdatePullThroughCacheRule

$result = $client->updatePullThroughCacheRule([/* ... */]);
$promise = $client->updatePullThroughCacheRuleAsync([/* ... */]);

Updates an existing pull through cache rule.

Parameter Syntax

$result = $client->updatePullThroughCacheRule([
    'credentialArn' => '<string>',
    'customRoleArn' => '<string>',
    'ecrRepositoryPrefix' => '<string>', // REQUIRED
    'registryId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'credentialArn' => '<string>',
    'customRoleArn' => '<string>',
    'ecrRepositoryPrefix' => '<string>',
    'registryId' => '<string>',
    'updatedAt' => <DateTime>,
    'upstreamRepositoryPrefix' => '<string>',
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ValidationException:

There was an exception validating this request.

UnableToAccessSecretException:

The secret is unable to be accessed. Verify the resource permissions for the secret and try again.

PullThroughCacheRuleNotFoundException:

The pull through cache rule was not found. Specify a valid pull through cache rule and try again.

SecretNotFoundException:

The ARN of the secret specified in the pull through cache rule was not found. Update the pull through cache rule with a valid secret ARN and try again.

UnableToDecryptSecretValueException:

The secret is accessible but is unable to be decrypted. Verify the resource permisisons and try again.

UpdateRepositoryCreationTemplate

$result = $client->updateRepositoryCreationTemplate([/* ... */]);
$promise = $client->updateRepositoryCreationTemplateAsync([/* ... */]);

Updates an existing repository creation template.

Parameter Syntax

$result = $client->updateRepositoryCreationTemplate([
    'appliedFor' => ['<string>', ...],
    'customRoleArn' => '<string>',
    'description' => '<string>',
    'encryptionConfiguration' => [
        'encryptionType' => 'AES256|KMS|KMS_DSSE', // REQUIRED
        'kmsKey' => '<string>',
    ],
    'imageTagMutability' => 'MUTABLE|IMMUTABLE',
    'lifecyclePolicy' => '<string>',
    'prefix' => '<string>', // REQUIRED
    'repositoryPolicy' => '<string>',
    'resourceTags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'registryId' => '<string>',
    'repositoryCreationTemplate' => [
        'appliedFor' => ['<string>', ...],
        'createdAt' => <DateTime>,
        'customRoleArn' => '<string>',
        'description' => '<string>',
        'encryptionConfiguration' => [
            'encryptionType' => 'AES256|KMS|KMS_DSSE',
            'kmsKey' => '<string>',
        ],
        'imageTagMutability' => 'MUTABLE|IMMUTABLE',
        'lifecyclePolicy' => '<string>',
        'prefix' => '<string>',
        'repositoryPolicy' => '<string>',
        'resourceTags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

ValidationException:

There was an exception validating this request.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

TemplateNotFoundException:

The specified repository creation template can't be found. Verify the registry ID and prefix and try again.

Examples

Example 1: Update a repository creation template

This example updates a repository creation template.

$result = $client->updateRepositoryCreationTemplate([
    'appliedFor' => [
        'REPLICATION',
    ],
    'prefix' => 'eng/test',
    'resourceTags' => [
        [
            'Key' => 'environment',
            'Value' => 'test',
        ],
    ],
]);

Result syntax:

[
    'registryId' => '012345678901',
    'repositoryCreationTemplate' => [
        'appliedFor' => [
            'REPLICATION',
        ],
        'createdAt' => ,
        'description' => 'Repos for testing images',
        'encryptionConfiguration' => [
            'encryptionType' => 'AES256',
        ],
        'imageTagMutability' => 'MUTABLE',
        'lifecyclePolicy' => '{ "rules": [ { "rulePriority": 1, "description": "Expire images older than 14 days", "selection": { "tagStatus": "untagged", "countType": "sinceImagePushed", "countUnit": "days", "countNumber": 14 }, "action": { "type": "expire" } } ]}',
        'prefix' => 'eng/test',
        'repositoryPolicy' => '{ "Version" : "2012-10-17", "Statement" : [ { "Sid" : "LambdaECRPullPolicy", "Effect" : "Allow", "Principal" : { "Service" : "lambda.amazonaws.com" }, "Action" : "ecr:BatchGetImage" } ]}',
        'resourceTags' => [
            [
                'Key' => 'environment',
                'Value' => 'test',
            ],
        ],
        'updatedAt' => ,
    ],
]

UploadLayerPart

$result = $client->uploadLayerPart([/* ... */]);
$promise = $client->uploadLayerPartAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->uploadLayerPart([
    'layerPartBlob' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'partFirstByte' => <integer>, // REQUIRED
    'partLastByte' => <integer>, // REQUIRED
    'registryId' => '<string>',
    'repositoryName' => '<string>', // REQUIRED
    'uploadId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'lastByteReceived' => <integer>,
    'registryId' => '<string>',
    'repositoryName' => '<string>',
    'uploadId' => '<string>',
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

InvalidLayerPartException:

The layer part size is not valid, or the first byte specified is not consecutive to the last byte of a previous layer part upload.

RepositoryNotFoundException:

The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

UploadNotFoundException:

The upload could not be found, or the specified upload ID is not valid for this repository.

LimitExceededException:

The operation did not succeed because it would have exceeded a service limit for your account. For more information, see Amazon ECR service quotas in the Amazon Elastic Container Registry User Guide.

KmsException:

The operation failed due to a KMS exception.

ValidatePullThroughCacheRule

$result = $client->validatePullThroughCacheRule([/* ... */]);
$promise = $client->validatePullThroughCacheRuleAsync([/* ... */]);

Validates an existing pull through cache rule for an upstream registry that requires authentication. This will retrieve the contents of the Amazon Web Services Secrets Manager secret, verify the syntax, and then validate that authentication to the upstream registry is successful.

Parameter Syntax

$result = $client->validatePullThroughCacheRule([
    'ecrRepositoryPrefix' => '<string>', // REQUIRED
    'registryId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'credentialArn' => '<string>',
    'customRoleArn' => '<string>',
    'ecrRepositoryPrefix' => '<string>',
    'failure' => '<string>',
    'isValid' => true || false,
    'registryId' => '<string>',
    'upstreamRegistryUrl' => '<string>',
    'upstreamRepositoryPrefix' => '<string>',
]

Result Details

Errors

ServerException:

These errors are usually caused by a server-side issue.

InvalidParameterException:

The specified parameter is invalid. Review the available parameters for the API request.

ValidationException:

There was an exception validating this request.

PullThroughCacheRuleNotFoundException:

The pull through cache rule was not found. Specify a valid pull through cache rule and try again.