BatchCheckLayerAvailability

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

Checks the availability of one or more image layers that are within a repository in a public registry. When an image is pushed to a repository, each image layer is checked to verify if it has been uploaded before. If it has been uploaded, then the image layer is skipped.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

RepositoryNotFoundException:

The specified repository can't be found. Check the spelling of the specified repository and ensure that you're 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.

RegistryNotFoundException:

The registry doesn't exist.

UnsupportedCommandException:

The action isn't supported in this Region.

BatchDeleteImage

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

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

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'failures' => [
        [
            'failureCode' => 'InvalidImageDigest|InvalidImageTag|ImageTagDoesNotMatchDigest|ImageNotFound|MissingDigestAndTag|ImageReferencedByManifestList|KmsError',
            '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 can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.

UnsupportedCommandException:

The action isn't supported in this Region.

CompleteLayerUpload

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

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

When an image is pushed, the CompleteLayerUpload API is called once for each new image layer to verify that the upload is complete.

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 can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.

UploadNotFoundException:

The upload can't be found, or the specified upload ID isn't valid for this repository.

InvalidLayerException:

The layer digest calculation performed by Amazon ECR when the image layer doesn't 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 doesn't contain any layer parts.

RegistryNotFoundException:

The registry doesn't exist.

UnsupportedCommandException:

The action isn't supported in this Region.

CreateRepository

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

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

Parameter Syntax

$result = $client->createRepository([
    'catalogData' => [
        'aboutText' => '<string>',
        'architectures' => ['<string>', ...],
        'description' => '<string>',
        'logoImageBlob' => <string || resource || Psr\Http\Message\StreamInterface>,
        'operatingSystems' => ['<string>', ...],
        'usageText' => '<string>',
    ],
    'repositoryName' => '<string>', // REQUIRED
    'tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'catalogData' => [
        'aboutText' => '<string>',
        'architectures' => ['<string>', ...],
        'description' => '<string>',
        'logoUrl' => '<string>',
        'marketplaceCertified' => true || false,
        'operatingSystems' => ['<string>', ...],
        'usageText' => '<string>',
    ],
    'repository' => [
        'createdAt' => <DateTime>,
        '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 didn't succeed because it would have exceeded a service limit for your account. For more information, see Amazon ECR Service Quotas in the Amazon Elastic Container Registry User Guide.

UnsupportedCommandException:

The action isn't supported in this Region.

DeleteRepository

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

Deletes a repository in a public registry. If the repository contains images, you must either manually delete all images in the repository or use the force option. This option deletes all images on your behalf before deleting the repository.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'repository' => [
        'createdAt' => <DateTime>,
        '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 can't be found. Check the spelling of the specified repository and ensure that you're 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.

UnsupportedCommandException:

The action isn't supported in this Region.

DeleteRepositoryPolicy

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

Deletes the repository policy that's associated with the specified repository.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ServerException:

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

InvalidParameterException:

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

RepositoryNotFoundException:

The specified repository can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.

RepositoryPolicyNotFoundException:

The specified repository and registry combination doesn't have an associated repository policy.

UnsupportedCommandException:

The action isn't supported in this Region.

DescribeImageTags

$result = $client->describeImageTags([/* ... */]);
$promise = $client->describeImageTagsAsync([/* ... */]);

Returns the image tag details for a repository in a public registry.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'imageTagDetails' => [
        [
            'createdAt' => <DateTime>,
            'imageDetail' => [
                'artifactMediaType' => '<string>',
                'imageDigest' => '<string>',
                'imageManifestMediaType' => '<string>',
                'imagePushedAt' => <DateTime>,
                'imageSizeInBytes' => <integer>,
            ],
            '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 can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.

UnsupportedCommandException:

The action isn't supported in this Region.

DescribeImages

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

Returns metadata that's related to the images in a repository in a public registry.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'imageDetails' => [
        [
            'artifactMediaType' => '<string>',
            'imageDigest' => '<string>',
            'imageManifestMediaType' => '<string>',
            'imagePushedAt' => <DateTime>,
            '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 can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.

ImageNotFoundException:

The image requested doesn't exist in the specified repository.

UnsupportedCommandException:

The action isn't supported in this Region.

DescribeRegistries

$result = $client->describeRegistries([/* ... */]);
$promise = $client->describeRegistriesAsync([/* ... */]);

Returns details for a public registry.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'registries' => [
        [
            'aliases' => [
                [
                    'defaultRegistryAlias' => true || false,
                    'name' => '<string>',
                    'primaryRegistryAlias' => true || false,
                    'status' => 'ACTIVE|PENDING|REJECTED',
                ],
                // ...
            ],
            'registryArn' => '<string>',
            'registryId' => '<string>',
            'registryUri' => '<string>',
            'verified' => true || false,
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterException:

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

UnsupportedCommandException:

The action isn't supported in this Region.

ServerException:

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

DescribeRepositories

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

Describes repositories that are in a public registry.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'repositories' => [
        [
            'createdAt' => <DateTime>,
            '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 can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.

UnsupportedCommandException:

The action isn't supported in this Region.

GetAuthorizationToken

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

Retrieves an authorization token. An authorization token represents your IAM authentication credentials. You can use it to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid for 12 hours. This API requires the ecr-public:GetAuthorizationToken and sts:GetServiceBearerToken permissions.

Parameter Syntax

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

Parameter Details

Result Syntax

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

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.

UnsupportedCommandException:

The action isn't supported in this Region.

GetRegistryCatalogData

$result = $client->getRegistryCatalogData([/* ... */]);
$promise = $client->getRegistryCatalogDataAsync([/* ... */]);

Retrieves catalog metadata for a public registry.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'registryCatalogData' => [
        'displayName' => '<string>',
    ],
]

Result Details

Errors

ServerException:

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

UnsupportedCommandException:

The action isn't supported in this Region.

GetRepositoryCatalogData

$result = $client->getRepositoryCatalogData([/* ... */]);
$promise = $client->getRepositoryCatalogDataAsync([/* ... */]);

Retrieve catalog metadata for a repository in a public registry. This metadata is displayed publicly in the Amazon ECR Public Gallery.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'catalogData' => [
        'aboutText' => '<string>',
        'architectures' => ['<string>', ...],
        'description' => '<string>',
        'logoUrl' => '<string>',
        'marketplaceCertified' => true || false,
        'operatingSystems' => ['<string>', ...],
        'usageText' => '<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.

RepositoryCatalogDataNotFoundException:

The repository catalog data doesn't exist.

RepositoryNotFoundException:

The specified repository can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.

UnsupportedCommandException:

The action isn't supported in this Region.

GetRepositoryPolicy

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

Retrieves the repository policy for the specified repository.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ServerException:

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

InvalidParameterException:

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

RepositoryNotFoundException:

The specified repository can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.

RepositoryPolicyNotFoundException:

The specified repository and registry combination doesn't have an associated repository policy.

UnsupportedCommandException:

The action isn't supported in this Region.

InitiateLayerUpload

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

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

When an image is pushed, the InitiateLayerUpload API is called once for each image layer that hasn't already been uploaded. Whether an image layer uploads is determined by the BatchCheckLayerAvailability API action.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ServerException:

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

InvalidParameterException:

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

RepositoryNotFoundException:

The specified repository can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.

RegistryNotFoundException:

The registry doesn't exist.

UnsupportedCommandException:

The action isn't supported in this Region.

ListTagsForResource

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

List the tags for an Amazon ECR Public resource.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidParameterException:

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

RepositoryNotFoundException:

The specified repository can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.

UnsupportedCommandException:

The action isn't supported in this Region.

ServerException:

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

PutImage

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

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ServerException:

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

InvalidParameterException:

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

RepositoryNotFoundException:

The specified repository can't be found. Check the spelling of the specified repository and ensure that you're 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 can't be found, or the specified layer isn't valid for this repository.

ReferencedImagesNotFoundException:

The manifest list is referencing an image that doesn't exist.

LimitExceededException:

The operation didn't succeed because it would have exceeded a service limit for your account. For more information, see Amazon ECR Service Quotas in the Amazon Elastic Container Registry User Guide.

ImageTagAlreadyExistsException:

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

ImageDigestDoesNotMatchException:

The specified image digest doesn't match the digest that Amazon ECR calculated for the image.

RegistryNotFoundException:

The registry doesn't exist.

UnsupportedCommandException:

The action isn't supported in this Region.

PutRegistryCatalogData

$result = $client->putRegistryCatalogData([/* ... */]);
$promise = $client->putRegistryCatalogDataAsync([/* ... */]);

Create or update the catalog data for a public registry.

Parameter Syntax

$result = $client->putRegistryCatalogData([
    'displayName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'registryCatalogData' => [
        'displayName' => '<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.

UnsupportedCommandException:

The action isn't supported in this Region.

PutRepositoryCatalogData

$result = $client->putRepositoryCatalogData([/* ... */]);
$promise = $client->putRepositoryCatalogDataAsync([/* ... */]);

Creates or updates the catalog data for a repository in a public registry.

Parameter Syntax

$result = $client->putRepositoryCatalogData([
    'catalogData' => [ // REQUIRED
        'aboutText' => '<string>',
        'architectures' => ['<string>', ...],
        'description' => '<string>',
        'logoImageBlob' => <string || resource || Psr\Http\Message\StreamInterface>,
        'operatingSystems' => ['<string>', ...],
        'usageText' => '<string>',
    ],
    'registryId' => '<string>',
    'repositoryName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'catalogData' => [
        'aboutText' => '<string>',
        'architectures' => ['<string>', ...],
        'description' => '<string>',
        'logoUrl' => '<string>',
        'marketplaceCertified' => true || false,
        'operatingSystems' => ['<string>', ...],
        'usageText' => '<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 can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.

UnsupportedCommandException:

The action isn't supported in this Region.

SetRepositoryPolicy

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ServerException:

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

InvalidParameterException:

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

RepositoryNotFoundException:

The specified repository can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.

UnsupportedCommandException:

The action isn't supported in this Region.

TagResource

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

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted.

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 can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.

UnsupportedCommandException:

The action isn't supported in this Region.

ServerException:

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

UntagResource

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

Deletes specified tags from a resource.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

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

InvalidTagParameterException:

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

TooManyTagsException:

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

RepositoryNotFoundException:

The specified repository can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.

UnsupportedCommandException:

The action isn't supported in this Region.

ServerException:

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

UploadLayerPart

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

Uploads an image layer part to Amazon ECR.

When an image is pushed, each new image layer is uploaded in parts. The maximum size of each image layer part can be 20971520 bytes (about 20MB). The UploadLayerPart API is called once for each new image layer part.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ServerException:

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

InvalidParameterException:

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

InvalidLayerPartException:

The layer part size isn't valid, or the first byte specified isn't consecutive to the last byte of a previous layer part upload.

RepositoryNotFoundException:

The specified repository can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.

UploadNotFoundException:

The upload can't be found, or the specified upload ID isn't valid for this repository.

LimitExceededException:

The operation didn't succeed because it would have exceeded a service limit for your account. For more information, see Amazon ECR Service Quotas in the Amazon Elastic Container Registry User Guide.

RegistryNotFoundException:

The registry doesn't exist.

UnsupportedCommandException:

The action isn't supported in this Region.