Amazon EC2 Container Registry 2015-09-21

BatchCheckLayerAvailability

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

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([/* ... */]);

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',
            '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([/* ... */]);

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',
            'failureReason' => '<string>',
            'imageId' => [
                'imageDigest' => '<string>',
                'imageTag' => '<string>',
            ],
        ],
        // ...
    ],
    'images' => [
        [
            'imageId' => [
                'imageDigest' => '<string>',
                'imageTag' => '<string>',
            ],
            'imageManifest' => '<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.

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',
        ],
    ],
]

CompleteLayerUpload

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

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.

CreateRepository

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

Parameter Syntax

$result = $client->createRepository([
    'imageTagMutability' => 'MUTABLE|IMMUTABLE',
    'repositoryName' => '<string>', // REQUIRED
    'tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'repository' => [
        'createdAt' => <DateTime>,
        '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 Default Service Limits in the Amazon Elastic Container Registry User Guide.

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',
    ],
]

DeleteLifecyclePolicy

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

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.

DeleteRepository

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'repository' => [
        'createdAt' => <DateTime>,
        '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.

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',
    ],
]

DeleteRepositoryPolicy

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

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',
]

DescribeImages

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

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' => [
        [
            'imageDigest' => '<string>',
            'imagePushedAt' => <DateTime>,
            'imageSizeInBytes' => <integer>,
            'imageTags' => ['<string>', ...],
            '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.

DescribeRepositories

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'repositories' => [
        [
            'createdAt' => <DateTime>,
            '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',
        ],
    ],
]

GetAuthorizationToken

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

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' => 'QVdTOkN...',
            'expiresAt' => ,
            'proxyEndpoint' => 'https://012345678901.dkr.ecr.us-west-2.amazonaws.com',
        ],
    ],
]

GetDownloadUrlForLayer

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

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.

GetLifecyclePolicy

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

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.

GetLifecyclePolicyPreview

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

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.

GetRepositoryPolicy

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

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([/* ... */]);

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.

ListImages

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

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([/* ... */]);

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.

PutImage

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'image' => [
        'imageId' => [
            'imageDigest' => '<string>',
            'imageTag' => '<string>',
        ],
        'imageManifest' => '<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.

• LimitExceededException:

  The operation did not succeed because it would have exceeded a service limit for your account. For more information, see Amazon ECR Default Service Limits 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.

PutImageTagMutability

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

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([/* ... */]);

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.

SetRepositoryPolicy

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

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.

StartLifecyclePolicyPreview

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

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. Please try again later.

TagResource

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

Parameter Syntax

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

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([/* ... */]);

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.

UploadLayerPart

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

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 Default Service Limits in the Amazon Elastic Container Registry User Guide.