AWS SDK for PHP 3.x

Service ID: ecr

Version: 2015-09-21

This page describes the parameters and results for the operations of the Amazon EC2 Container Registry (2015-09-21), and shows how to use the Aws\Ecr\EcrClient object to call the described operations. This documentation is specific to the 2015-09-21 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

BatchCheckLayerAvailability ( array $params = [] )
Check the availability of multiple image layers in a specified registry and repository.
BatchDeleteImage ( array $params = [] )
Deletes a list of specified images within a specified repository.
BatchGetImage ( array $params = [] )
Gets detailed information for specified images within a specified repository.
CompleteLayerUpload ( array $params = [] )
Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and upload ID.
CreateRepository ( array $params = [] )
Creates an image repository.
DeleteLifecyclePolicy ( array $params = [] )
Deletes the specified lifecycle policy.
DeleteRepository ( array $params = [] )
Deletes an existing image repository.
DeleteRepositoryPolicy ( array $params = [] )
Deletes the repository policy from a specified repository.
DescribeImages ( array $params = [] )
Returns metadata about the images in a repository, including image size, image tags, and creation date.
DescribeRepositories ( array $params = [] )
Describes image repositories in a registry.
GetAuthorizationToken ( array $params = [] )
Retrieves a token that is valid for a specified registry for 12 hours.
GetDownloadUrlForLayer ( array $params = [] )
Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer.
GetLifecyclePolicy ( array $params = [] )
Retrieves the specified lifecycle policy.
GetLifecyclePolicyPreview ( array $params = [] )
Retrieves the results of the specified lifecycle policy preview request.
GetRepositoryPolicy ( array $params = [] )
Retrieves the repository policy for a specified repository.
InitiateLayerUpload ( array $params = [] )
Notify Amazon ECR that you intend to upload an image layer.
ListImages ( array $params = [] )
Lists all the image IDs for a given repository.
PutImage ( array $params = [] )
Creates or updates the image manifest and tags associated with an image.
PutLifecyclePolicy ( array $params = [] )
Creates or updates a lifecycle policy.
SetRepositoryPolicy ( array $params = [] )
Applies a repository policy on a specified repository to control access permissions.
StartLifecyclePolicyPreview ( array $params = [] )
Starts a preview of the specified lifecycle policy.
UploadLayerPart ( array $params = [] )
Uploads an image layer part to Amazon ECR.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

DescribeImages
DescribeRepositories
ListImages

Operations

BatchCheckLayerAvailability

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

Check the availability of multiple image layers in a specified registry and repository.

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

Parameter Syntax

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

Parameter Details

Members

layerDigests

Required: Yes
Type: Array of strings

The digests of the image layers to check.

registryId

Type: string

The AWS account ID associated with the registry that contains the image layers to check. If you do not specify a registry, the default registry is assumed.

repositoryName

Required: Yes
Type: string

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

Result Syntax

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

Result Details

Members

failures

Type: Array of LayerFailure structures

Any failures associated with the call.

layers

Type: Array of Layer structures

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

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 specified repository. Images are specified with either 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

Members

imageIds

Required: Yes
Type: Array of ImageIdentifier structures

A list of image ID references that correspond to images to delete. The format of the imageIds reference is imageTag=tag or imageDigest=digest.

registryId

Type: string

The AWS account ID associated with the registry that contains the image to delete. If you do not specify a registry, the default registry is assumed.

repositoryName

Required: Yes
Type: string

The repository that contains the image to delete.

Result Syntax

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

Result Details

Members

failures

Type: Array of ImageFailure structures

Any failures associated with the call.

imageIds

Type: Array of ImageIdentifier structures

The image IDs of the deleted images.

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 specified images within a specified repository. Images are specified with either imageTag or imageDigest.

Parameter Syntax

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

Parameter Details

Members

acceptedMediaTypes

Type: Array of strings

The accepted media types for the request.

Valid values: application/vnd.docker.distribution.manifest.v1+json | application/vnd.docker.distribution.manifest.v2+json | application/vnd.oci.image.manifest.v1+json

imageIds

Required: Yes
Type: Array of ImageIdentifier structures

A list of image ID references that correspond to images to describe. The format of the imageIds reference is imageTag=tag or imageDigest=digest.

registryId

Type: string

The AWS account ID associated with the registry that contains the images to describe. If you do not specify a registry, the default registry is assumed.

repositoryName

Required: Yes
Type: string

The repository that contains the images to describe.

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

Members

failures

Type: Array of ImageFailure structures

Any failures associated with the call.

images

Type: Array of Image structures

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

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

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.

Parameter Syntax

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

Parameter Details

Members

layerDigests

Required: Yes
Type: Array of strings

The sha256 digest of the image layer.

registryId

Type: string

The AWS account ID associated with the registry to which to upload layers. If you do not specify a registry, the default registry is assumed.

repositoryName

Required: Yes
Type: string

The name of the repository to associate with the image layer.

uploadId

Required: Yes
Type: string

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

Result Syntax

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

Result Details

Members

layerDigest

Type: string

The sha256 digest of the image layer.

registryId

Type: string

The registry ID associated with the request.

repositoryName

Type: string

The repository name associated with the request.

uploadId

Type: string

The upload ID associated with the layer.

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

Creates an image repository.

Parameter Syntax

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

Parameter Details

Members

repositoryName

Required: Yes
Type: string

The name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app).

Result Syntax

[
    'repository' => [
        'createdAt' => <DateTime>,
        'registryId' => '<string>',
        'repositoryArn' => '<string>',
        'repositoryName' => '<string>',
        'repositoryUri' => '<string>',
    ],
]

Result Details

Members

repository

Type: Repository structure

The repository that was created.

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

Deletes the specified lifecycle policy.

Parameter Syntax

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

Parameter Details

Members

registryId

Type: string

The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.

repositoryName

Required: Yes
Type: string

The name of the repository.

Result Syntax

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

Result Details

Members

lastEvaluatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time stamp of the last time that the lifecycle policy was run.

lifecyclePolicyText

Type: string

The JSON lifecycle policy text.

registryId

Type: string

The registry ID associated with the request.

repositoryName

Type: string

The repository name associated with the request.

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

Deletes an existing image repository. If a repository contains images, you must use the force option to delete it.

Parameter Syntax

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

Parameter Details

Members

force

Type: boolean

If a repository contains images, forces the deletion.

registryId

Type: string

The AWS account ID associated with the registry that contains the repository to delete. If you do not specify a registry, the default registry is assumed.

repositoryName

Required: Yes
Type: string

The name of the repository to delete.

Result Syntax

[
    'repository' => [
        'createdAt' => <DateTime>,
        'registryId' => '<string>',
        'repositoryArn' => '<string>',
        'repositoryName' => '<string>',
        'repositoryUri' => '<string>',
    ],
]

Result Details

Members

repository

Type: Repository structure

The repository that was deleted.

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

Deletes the repository policy from a specified repository.

Parameter Syntax

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

Parameter Details

Members

registryId

Type: string

The AWS account ID associated with the registry that contains the repository policy to delete. If you do not specify a registry, the default registry is assumed.

repositoryName

Required: Yes
Type: string

The name of the repository that is associated with the repository policy to delete.

Result Syntax

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

Result Details

Members

policyText

Type: string

The JSON repository policy that was deleted from the repository.

registryId

Type: string

The registry ID associated with the request.

repositoryName

Type: string

The repository name associated with the request.

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

Returns metadata about the images in a repository, including image size, image tags, and creation date.

Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by DescribeImages.

Parameter Syntax

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

Parameter Details

Members

filter

Type: DescribeImagesFilter structure

The filter key and value with which to filter your DescribeImages results.

imageIds

Type: Array of ImageIdentifier structures

The list of image IDs for the requested repository.

maxResults

Type: int

The maximum number of repository results returned by DescribeImages in paginated output. When this parameter is used, DescribeImages only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeImages request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then DescribeImages returns up to 100 results and a nextToken value, if applicable. This option cannot be used when you specify images with imageIds.

nextToken

Type: string

The nextToken value returned from a previous paginated DescribeImages request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return. This option cannot be used when you specify images with imageIds.

registryId

Type: string

The AWS account ID associated with the registry that contains the repository in which to describe images. If you do not specify a registry, the default registry is assumed.

repositoryName

Required: Yes
Type: string

A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.

Result Syntax

[
    'imageDetails' => [
        [
            'imageDigest' => '<string>',
            'imagePushedAt' => <DateTime>,
            'imageSizeInBytes' => <integer>,
            'imageTags' => ['<string>', ...],
            'registryId' => '<string>',
            'repositoryName' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

imageDetails

Type: Array of ImageDetail structures

A list of ImageDetail objects that contain data about the image.

nextToken

Type: string

The nextToken value to include in a future DescribeImages request. When the results of a DescribeImages request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

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

Describes image repositories in a registry.

Parameter Syntax

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

Parameter Details

Members

maxResults

Type: int

The maximum number of repository results returned by DescribeRepositories in paginated output. When this parameter is used, DescribeRepositories only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeRepositories request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then DescribeRepositories returns up to 100 results and a nextToken value, if applicable. This option cannot be used when you specify repositories with repositoryNames.

nextToken

Type: string

The nextToken value returned from a previous paginated DescribeRepositories request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return. This option cannot be used when you specify repositories with repositoryNames.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

registryId

Type: string

The AWS account ID associated with the registry that contains the repositories to be described. If you do not specify a registry, the default registry is assumed.

repositoryNames

Type: Array of strings

A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.

Result Syntax

[
    'nextToken' => '<string>',
    'repositories' => [
        [
            'createdAt' => <DateTime>,
            'registryId' => '<string>',
            'repositoryArn' => '<string>',
            'repositoryName' => '<string>',
            'repositoryUri' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

nextToken

Type: string

The nextToken value to include in a future DescribeRepositories request. When the results of a DescribeRepositories request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

repositories

Type: Array of Repository structures

A list of repository objects corresponding to valid repositories.

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

Retrieves a token that is valid for a specified registry for 12 hours. This command allows you to use the docker CLI to push and pull images with Amazon ECR. If you do not specify a registry, the default registry is assumed.

The authorizationToken returned for each registry specified is a base64 encoded string that can be decoded and used in a docker login command to authenticate to a registry. The AWS CLI offers an aws ecr get-login command that simplifies the login process.

Parameter Syntax

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

Parameter Details

Members

registryIds

Type: Array of strings

A list of AWS account IDs that are associated with the registries for which to get authorization tokens. If you do not specify a registry, the default registry is assumed.

Result Syntax

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

Result Details

Members

authorizationData

Type: Array of AuthorizationData structures

A list of authorization token data objects that correspond to the registryIds values in the request.

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

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.

Parameter Syntax

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

Parameter Details

Members

layerDigest

Required: Yes
Type: string

The digest of the image layer to download.

registryId

Type: string

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

repositoryName

Required: Yes
Type: string

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

Result Syntax

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

Result Details

Members

downloadUrl

Type: string

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

layerDigest

Type: string

The digest of the image layer to download.

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

Retrieves the specified lifecycle policy.

Parameter Syntax

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

Parameter Details

Members

registryId

Type: string

The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.

repositoryName

Required: Yes
Type: string

The name of the repository.

Result Syntax

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

Result Details

Members

lastEvaluatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time stamp of the last time that the lifecycle policy was run.

lifecyclePolicyText

Type: string

The JSON lifecycle policy text.

registryId

Type: string

The registry ID associated with the request.

repositoryName

Type: string

The repository name associated with the request.

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

Retrieves the results of the specified lifecycle policy preview request.

Parameter Syntax

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

Parameter Details

Members

filter

Type: LifecyclePolicyPreviewFilter structure

An optional parameter that filters results based on image tag status and all tags, if tagged.

imageIds

Type: Array of ImageIdentifier structures

The list of imageIDs to be included.

maxResults

Type: int

The maximum number of repository results returned by GetLifecyclePolicyPreviewRequest in  paginated output. When this parameter is used, GetLifecyclePolicyPreviewRequest only returns  maxResults results in a single page along with a nextToken  response element. The remaining results of the initial request can be seen by sending  another GetLifecyclePolicyPreviewRequest request with the returned nextToken  value. This value can be between 1 and 100. If this  parameter is not used, then GetLifecyclePolicyPreviewRequest returns up to  100 results and a nextToken value, if  applicable. This option cannot be used when you specify images with imageIds.

nextToken

Type: string

The nextToken value returned from a previous paginated  GetLifecyclePolicyPreviewRequest request where maxResults was used and the  results exceeded the value of that parameter. Pagination continues from the end of the  previous results that returned the nextToken value. This value is  null when there are no more results to return. This option cannot be used when you specify images with imageIds.

registryId

Type: string

The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.

repositoryName

Required: Yes
Type: string

The name of the repository.

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

Members

lifecyclePolicyText

Type: string

The JSON lifecycle policy text.

nextToken

Type: string

The nextToken value to include in a future GetLifecyclePolicyPreview request. When the results of a GetLifecyclePolicyPreview request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

previewResults

Type: Array of LifecyclePolicyPreviewResult structures

The results of the lifecycle policy preview request.

registryId

Type: string

The registry ID associated with the request.

repositoryName

Type: string

The repository name associated with the request.

status

Type: string

The status of the lifecycle policy preview request.

summary

Type: LifecyclePolicyPreviewSummary structure

The list of images that is returned as a result of the action.

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

Retrieves the repository policy for a specified repository.

Parameter Syntax

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

Parameter Details

Members

registryId

Type: string

The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.

repositoryName

Required: Yes
Type: string

The name of the repository with the policy to retrieve.

Result Syntax

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

Result Details

Members

policyText

Type: string

The JSON repository policy text associated with the repository.

registryId

Type: string

The registry ID associated with the request.

repositoryName

Type: string

The repository name associated with the request.

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

Notify Amazon ECR that you intend to upload an image layer.

Parameter Syntax

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

Parameter Details

Members

registryId

Type: string

The AWS account ID associated with the registry to which you intend to upload layers. If you do not specify a registry, the default registry is assumed.

repositoryName

Required: Yes
Type: string

The name of the repository to which you intend to upload layers.

Result Syntax

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

Result Details

Members

partSize

Type: long (int|float)

The size, in bytes, that Amazon ECR expects future layer part uploads to be.

uploadId

Type: string

The upload ID for the layer upload. This parameter is passed to further UploadLayerPart and CompleteLayerUpload operations.

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

Lists all the image IDs for a given repository.

You can filter images based on whether or not they are tagged by setting the tagStatus parameter to TAGGED or UNTAGGED. 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',
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'registryId' => '<string>',
    'repositoryName' => '<string>', // REQUIRED
]);

Parameter Details

Members

filter

Type: ListImagesFilter structure

The filter key and value with which to filter your ListImages results.

maxResults

Type: int

The maximum number of image results returned by ListImages in paginated output. When this parameter is used, ListImages only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListImages request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListImages returns up to 100 results and a nextToken value, if applicable.

nextToken

Type: string

The nextToken value returned from a previous paginated ListImages request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

registryId

Type: string

The AWS account ID associated with the registry that contains the repository in which to list images. If you do not specify a registry, the default registry is assumed.

repositoryName

Required: Yes
Type: string

The repository with image IDs to be listed.

Result Syntax

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

Result Details

Members

imageIds

Type: Array of ImageIdentifier structures

The list of image IDs for the requested repository.

nextToken

Type: string

The nextToken value to include in a future ListImages request. When the results of a ListImages request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

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

PutImage

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

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

Parameter Syntax

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

Parameter Details

Members

imageManifest

Required: Yes
Type: string

The image manifest corresponding to the image to be uploaded.

imageTag

Type: string

The tag to associate with the image. This parameter is required for images that use the Docker Image Manifest V2 Schema 2 or OCI formats.

registryId

Type: string

The AWS account ID associated with the registry that contains the repository in which to put the image. If you do not specify a registry, the default registry is assumed.

repositoryName

Required: Yes
Type: string

The name of the repository in which to put the image.

Result Syntax

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

Result Details

Members

image

Type: Image structure

Details of the image uploaded.

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.

PutLifecyclePolicy

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

Creates or updates a lifecycle policy. For information about lifecycle policy syntax, see Lifecycle Policy Template.

Parameter Syntax

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

Parameter Details

Members

lifecyclePolicyText

Required: Yes
Type: string

The JSON repository policy text to apply to the repository.

registryId

Type: string

The AWS account ID associated with the registry that contains the repository. If you do  not specify a registry, the default registry is assumed.

repositoryName

Required: Yes
Type: string

The name of the repository to receive the policy.

Result Syntax

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

Result Details

Members

lifecyclePolicyText

Type: string

The JSON repository policy text.

registryId

Type: string

The registry ID associated with the request.

repositoryName

Type: string

The repository name associated with the request.

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

Applies a repository policy on a specified repository to control access permissions.

Parameter Syntax

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

Parameter Details

Members

force

Type: boolean

If the policy you are attempting to set on a repository policy would prevent you from setting another policy in the future, you must force the SetRepositoryPolicy operation. This is intended to prevent accidental repository lock outs.

policyText

Required: Yes
Type: string

The JSON repository policy text to apply to the repository.

registryId

Type: string

The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.

repositoryName

Required: Yes
Type: string

The name of the repository to receive the policy.

Result Syntax

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

Result Details

Members

policyText

Type: string

The JSON repository policy text applied to the repository.

registryId

Type: string

The registry ID associated with the request.

repositoryName

Type: string

The repository name associated with the request.

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

Starts a preview of the specified lifecycle policy. This allows you to see the results before creating the lifecycle policy.

Parameter Syntax

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

Parameter Details

Members

lifecyclePolicyText

Type: string

The policy to be evaluated against. If you do not specify a policy, the current policy for the repository is used.

registryId

Type: string

The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.

repositoryName

Required: Yes
Type: string

The name of the repository to be evaluated.

Result Syntax

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

Result Details

Members

lifecyclePolicyText

Type: string

The JSON repository policy text.

registryId

Type: string

The registry ID associated with the request.

repositoryName

Type: string

The repository name associated with the request.

status

Type: string

The status of the lifecycle policy preview request.

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.

UploadLayerPart

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

Uploads an image layer part to Amazon ECR.

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

Members

layerPartBlob

Required: Yes
Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The base64-encoded layer part payload.

partFirstByte

Required: Yes
Type: long (int|float)

The integer value of the first byte of the layer part.

partLastByte

Required: Yes
Type: long (int|float)

The integer value of the last byte of the layer part.

registryId

Type: string

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

repositoryName

Required: Yes
Type: string

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

uploadId

Required: Yes
Type: string

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

Result Syntax

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

Result Details

Members

lastByteReceived

Type: long (int|float)

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

registryId

Type: string

The registry ID associated with the request.

repositoryName

Type: string

The repository name associated with the request.

uploadId

Type: string

The upload ID associated with the request.

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.

Shapes

AuthorizationData

Description

An object representing authorization data for an Amazon ECR registry.

Members

authorizationToken

Type: string

A base64-encoded string that contains authorization data for the specified Amazon ECR registry. When the string is decoded, it is presented in the format user:password for private registry authentication using docker login.

expiresAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The Unix time in seconds and milliseconds when the authorization token expires. Authorization tokens are valid for 12 hours.

proxyEndpoint

Type: string

The registry URL to use for this authorization token in a docker login command. The Amazon ECR registry URL format is https://aws_account_id.dkr.ecr.region.amazonaws.com. For example, https://012345678910.dkr.ecr.us-east-1.amazonaws.com..

DescribeImagesFilter

Description

An object representing a filter on a DescribeImages operation.

Members

tagStatus

Type: string

The tag status with which to filter your DescribeImages results. You can filter results based on whether they are TAGGED or UNTAGGED.

EmptyUploadException

Description

The specified layer upload does not contain any layer parts.

Members

message

Type: string

The error message associated with the exception.

Image

Description

An object representing an Amazon ECR image.

Members

imageId

Type: ImageIdentifier structure

An object containing the image tag and image digest associated with an image.

imageManifest

Type: string

The image manifest associated with the image.

registryId

Type: string

The AWS account ID associated with the registry containing the image.

repositoryName

Type: string

The name of the repository associated with the image.

ImageAlreadyExistsException

Description

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

Members

message

Type: string

The error message associated with the exception.

ImageDetail

Description

An object that describes an image returned by a DescribeImages operation.

Members

imageDigest

Type: string

The sha256 digest of the image manifest.

imagePushedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository.

imageSizeInBytes

Type: long (int|float)

The size, in bytes, of the image in the repository.

imageTags

Type: Array of strings

The list of tags associated with this image.

registryId

Type: string

The AWS account ID associated with the registry to which this image belongs.

repositoryName

Type: string

The name of the repository to which this image belongs.

ImageFailure

Description

An object representing an Amazon ECR image failure.

Members

failureCode

Type: string

The code associated with the failure.

failureReason

Type: string

The reason for the failure.

imageId

Type: ImageIdentifier structure

The image ID associated with the failure.

ImageIdentifier

Description

An object with identifying information for an Amazon ECR image.

Members

imageDigest

Type: string

The sha256 digest of the image manifest.

imageTag

Type: string

The tag used for the image.

ImageNotFoundException

Description

The image requested does not exist in the specified repository.

Members

message

Type: string

InvalidLayerException

Description

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

Members

message

Type: string

The error message associated with the exception.

InvalidLayerPartException

Description

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.

Members

lastValidByteReceived

Type: long (int|float)

The last valid byte received from the layer part upload that is associated with the exception.

message

Type: string

The error message associated with the exception.

registryId

Type: string

The registry ID associated with the exception.

repositoryName

Type: string

The repository name associated with the exception.

uploadId

Type: string

The upload ID associated with the exception.

InvalidParameterException

Description

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

Members

message

Type: string

The error message associated with the exception.

Layer

Description

An object representing an Amazon ECR image layer.

Members

layerAvailability

Type: string

The availability status of the image layer.

layerDigest

Type: string

The sha256 digest of the image layer.

layerSize

Type: long (int|float)

The size, in bytes, of the image layer.

mediaType

Type: string

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

LayerAlreadyExistsException

Description

The image layer already exists in the associated repository.

Members

message

Type: string

The error message associated with the exception.

LayerFailure

Description

An object representing an Amazon ECR image layer failure.

Members

failureCode

Type: string

The failure code associated with the failure.

failureReason

Type: string

The reason for the failure.

layerDigest

Type: string

The layer digest associated with the failure.

LayerInaccessibleException

Description

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

Members

message

Type: string

The error message associated with the exception.

LayerPartTooSmallException

Description

Layer parts must be at least 5 MiB in size.

Members

message

Type: string

The error message associated with the exception.

LayersNotFoundException

Description

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

Members

message

Type: string

The error message associated with the exception.

LifecyclePolicyNotFoundException

Description

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

Members

message

Type: string

LifecyclePolicyPreviewFilter

Description

The filter for the lifecycle policy preview.

Members

tagStatus

Type: string

The tag status of the image.

LifecyclePolicyPreviewInProgressException

Description

The previous lifecycle policy preview request has not completed. Please try again later.

Members

message

Type: string

LifecyclePolicyPreviewNotFoundException

Description

There is no dry run for this repository.

Members

message

Type: string

LifecyclePolicyPreviewResult

Description

The result of the lifecycle policy preview.

Members

action

Type: LifecyclePolicyRuleAction structure

The type of action to be taken.

appliedRulePriority

Type: int

The priority of the applied rule.

imageDigest

Type: string

The sha256 digest of the image manifest.

imagePushedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository.

imageTags

Type: Array of strings

The list of tags associated with this image.

LifecyclePolicyPreviewSummary

Description

The summary of the lifecycle policy preview request.

Members

expiringImageTotalCount

Type: int

The number of expiring images.

LifecyclePolicyRuleAction

Description

The type of action to be taken.

Members

type

Type: string

The type of action to be taken.

LimitExceededException

Description

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.

Members

message

Type: string

The error message associated with the exception.

ListImagesFilter

Description

An object representing a filter on a ListImages operation.

Members

tagStatus

Type: string

The tag status with which to filter your ListImages results. You can filter results based on whether they are TAGGED or UNTAGGED.

Repository

Description

An object representing a repository.

Members

createdAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time, in JavaScript date format, when the repository was created.

registryId

Type: string

The AWS account ID associated with the registry that contains the repository.

repositoryArn

Type: string

The Amazon Resource Name (ARN) that identifies the repository. The ARN contains the arn:aws:ecr namespace, followed by the region of the repository, AWS account ID of the repository owner, repository namespace, and repository name. For example, arn:aws:ecr:region:012345678910:repository/test.

repositoryName

Type: string

The name of the repository.

repositoryUri

Type: string

The URI for the repository. You can use this URI for Docker push or pull operations.

RepositoryAlreadyExistsException

Description

The specified repository already exists in the specified registry.

Members

message

Type: string

The error message associated with the exception.

RepositoryNotEmptyException

Description

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

Members

message

Type: string

The error message associated with the exception.

RepositoryNotFoundException

Description

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.

Members

message

Type: string

The error message associated with the exception.

RepositoryPolicyNotFoundException

Description

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

Members

message

Type: string

The error message associated with the exception.

ServerException

Description

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

Members

message

Type: string

The error message associated with the exception.

UploadNotFoundException

Description

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

Members

message

Type: string

The error message associated with the exception.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Amazon EC2 Container Registry 2015-09-21

Operation Summary

Paginators

Operations

BatchCheckLayerAvailability

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

BatchDeleteImage

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To delete multiple images

BatchGetImage

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To obtain multiple images in a single request

CompleteLayerUpload

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateRepository

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To create a new repository

DeleteLifecyclePolicy

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteRepository

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To force delete a repository

DeleteRepositoryPolicy

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details