Amazon Elastic Container Registry Public 2020-10-30
- Client: Aws\ECRPublic\ECRPublicClient
- Service ID: ecr-public
- Version: 2020-10-30
This page describes the parameters and results for the operations of the Amazon Elastic Container Registry Public (2020-10-30), and shows how to use the Aws\ECRPublic\ECRPublicClient object to call the described operations. This documentation is specific to the 2020-10-30 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 = [] )
Checks the availability of one or more image layers within a repository in a public registry.
- BatchDeleteImage ( array $params = [] )
Deletes a list of specified images within a repository in a public registry.
- CompleteLayerUpload ( array $params = [] )
Informs Amazon ECR that the image layer upload has completed for a specified public registry, repository name, and upload ID.
- CreateRepository ( array $params = [] )
Creates a repository in a public registry.
- DeleteRepository ( array $params = [] )
Deletes a repository in a public registry.
- DeleteRepositoryPolicy ( array $params = [] )
Deletes the repository policy associated with the specified repository.
- DescribeImageTags ( array $params = [] )
Returns the image tag details for a repository in a public registry.
- DescribeImages ( array $params = [] )
Returns metadata about the images in a repository in a public registry.
- DescribeRegistries ( array $params = [] )
Returns details for a public registry.
- DescribeRepositories ( array $params = [] )
Describes repositories in a public registry.
- GetAuthorizationToken ( array $params = [] )
Retrieves an authorization token.
- GetRegistryCatalogData ( array $params = [] )
Retrieves catalog metadata for a public registry.
- GetRepositoryCatalogData ( array $params = [] )
Retrieve catalog metadata for a repository in a public registry.
- GetRepositoryPolicy ( array $params = [] )
Retrieves the repository policy for the specified repository.
- InitiateLayerUpload ( array $params = [] )
Notifies Amazon ECR that you intend to upload an image layer.
- ListTagsForResource ( array $params = [] )
List the tags for an Amazon ECR Public resource.
- PutImage ( array $params = [] )
Creates or updates the image manifest and tags associated with an image.
- PutRegistryCatalogData ( array $params = [] )
Create or updates the catalog data for a public registry.
- PutRepositoryCatalogData ( array $params = [] )
Creates or updates the catalog data for a repository in a public registry.
- SetRepositoryPolicy ( array $params = [] )
Applies a repository policy to the specified public repository to control access permissions.
- TagResource ( array $params = [] )
Associates the specified tags to a resource with the specified resourceArn.
- UntagResource ( array $params = [] )
Deletes specified tags from a resource.
- 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:
Operations
BatchCheckLayerAvailability
$result = $client->batchCheckLayerAvailability
([/* ... */]); $promise = $client->batchCheckLayerAvailabilityAsync
([/* ... */]);
Checks the availability of one or more image layers 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.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker
CLI to pull, tag, and push images.
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 public registry that contains the image layers to check. If you do not specify a registry, the default public 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
-
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.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
These errors are usually caused by a server-side issue.
-
The registry does not exist.
BatchDeleteImage
$result = $client->batchDeleteImage
([/* ... */]); $promise = $client->batchDeleteImageAsync
([/* ... */]);
Deletes a list of specified images 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 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 isimageTag=tag
orimageDigest=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 public registry is assumed.
- repositoryName
-
- Required: Yes
- Type: string
The repository in a public registry that contains the image to delete.
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
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
-
These errors are usually caused by a server-side issue.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
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.
CompleteLayerUpload
$result = $client->completeLayerUpload
([/* ... */]); $promise = $client->completeLayerUploadAsync
([/* ... */]);
Informs Amazon ECR that the image layer upload has completed 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 per each new image layer to verify that the upload has completed.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker
CLI to pull, tag, and push images.
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 public registry is assumed.
- repositoryName
-
- Required: Yes
- Type: string
The name of the repository in a public registry 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
Errors
-
These errors are usually caused by a server-side issue.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
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.
-
The upload could not be found, or the specified upload ID is not valid for this repository.
-
The layer digest calculation performed by Amazon ECR upon receipt of the image layer does not match the digest specified.
-
Layer parts must be at least 5 MiB in size.
-
The image layer already exists in the associated repository.
-
The specified layer upload does not contain any layer parts.
-
The registry does not exist.
-
The action is not 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
Members
- catalogData
-
- Type: RepositoryCatalogDataInput structure
The details about the repository that are publicly visible in the Amazon ECR Public Gallery.
- repositoryName
-
- Required: Yes
- Type: string
The name to use for the repository. This appears publicly in the Amazon ECR Public Gallery. 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 asproject-a/nginx-web-app
). - tags
-
- Type: Array of Tag structures
The metadata that you apply to the repository to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
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
Members
- catalogData
-
- Type: RepositoryCatalogData structure
The catalog data for a repository. This data is publicly visible in the Amazon ECR Public Gallery.
- repository
-
- Type: Repository structure
The repository that was created.
Errors
-
These errors are usually caused by a server-side issue.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
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.
-
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.
-
The operation did not succeed because it would have exceeded a service limit for your account. For more information, see Amazon ECR Service Quotas in the Amazon Elastic Container Registry User Guide.
DeleteRepository
$result = $client->deleteRepository
([/* ... */]); $promise = $client->deleteRepositoryAsync
([/* ... */]);
Deletes a repository in a public registry. If the repository contains images, you must either delete all images in the repository or use the force
option which 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
Members
- force
-
- Type: boolean
If a repository contains images, forces the deletion.
- registryId
-
- Type: string
The AWS account ID associated with the public registry that contains the repository to delete. If you do not specify a registry, the default public 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
-
These errors are usually caused by a server-side issue.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
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.
-
The specified repository contains images. To delete a repository that contains images, you must force the deletion with the
force
parameter.
DeleteRepositoryPolicy
$result = $client->deleteRepositoryPolicy
([/* ... */]); $promise = $client->deleteRepositoryPolicyAsync
([/* ... */]);
Deletes the repository policy associated with the specified repository.
Parameter Syntax
$result = $client->deleteRepositoryPolicy([ 'registryId' => '<string>', 'repositoryName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- registryId
-
- Type: string
The AWS account ID associated with the public registry that contains the repository policy to delete. If you do not specify a registry, the default public 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
Errors
-
These errors are usually caused by a server-side issue.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
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.
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
Members
- maxResults
-
- Type: int
The maximum number of repository results returned by
DescribeImageTags
in paginated output. When this parameter is used,DescribeImageTags
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherDescribeImageTags
request with the returnednextToken
value. This value can be between 1 and 1000. If this parameter is not used, thenDescribeImageTags
returns up to 100 results and anextToken
value, if applicable. This option cannot be used when you specify images withimageIds
. - nextToken
-
- Type: string
The
nextToken
value returned from a previous paginatedDescribeImageTags
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value. This value isnull
when there are no more results to return. This option cannot be used when you specify images withimageIds
. - registryId
-
- Type: string
The AWS account ID associated with the public registry that contains the repository in which to describe images. If you do not specify a registry, the default public registry is assumed.
- repositoryName
-
- Required: Yes
- Type: string
The name of the repository that contains the image tag details to describe.
Result Syntax
[ 'imageTagDetails' => [ [ 'createdAt' => <DateTime>, 'imageDetail' => [ 'artifactMediaType' => '<string>', 'imageDigest' => '<string>', 'imageManifestMediaType' => '<string>', 'imagePushedAt' => <DateTime>, 'imageSizeInBytes' => <integer>, ], 'imageTag' => '<string>', ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- imageTagDetails
-
- Type: Array of ImageTagDetail structures
The image tag details for the images in the requested repository.
- nextToken
-
- Type: string
The
nextToken
value to include in a futureDescribeImageTags
request. When the results of aDescribeImageTags
request exceedmaxResults
, this value can be used to retrieve the next page of results. This value isnull
when there are no more results to return.
Errors
-
These errors are usually caused by a server-side issue.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
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.
DescribeImages
$result = $client->describeImages
([/* ... */]); $promise = $client->describeImagesAsync
([/* ... */]);
Returns metadata about the images in a repository in a public registry.
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([ 'imageIds' => [ [ 'imageDigest' => '<string>', 'imageTag' => '<string>', ], // ... ], 'maxResults' => <integer>, 'nextToken' => '<string>', 'registryId' => '<string>', 'repositoryName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- 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 returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherDescribeImages
request with the returnednextToken
value. This value can be between 1 and 1000. If this parameter is not used, thenDescribeImages
returns up to 100 results and anextToken
value, if applicable. This option cannot be used when you specify images withimageIds
. - nextToken
-
- Type: string
The
nextToken
value returned from a previous paginatedDescribeImages
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value. This value isnull
when there are no more results to return. This option cannot be used when you specify images withimageIds
. - registryId
-
- Type: string
The AWS account ID associated with the public registry that contains the repository in which to describe images. If you do not specify a registry, the default public registry is assumed.
- repositoryName
-
- Required: Yes
- Type: string
The repository that contains the images to describe.
Result Syntax
[ 'imageDetails' => [ [ 'artifactMediaType' => '<string>', 'imageDigest' => '<string>', 'imageManifestMediaType' => '<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 futureDescribeImages
request. When the results of aDescribeImages
request exceedmaxResults
, this value can be used to retrieve the next page of results. This value isnull
when there are no more results to return.
Errors
-
These errors are usually caused by a server-side issue.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
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.
-
The image requested does not exist in the specified repository.
DescribeRegistries
$result = $client->describeRegistries
([/* ... */]); $promise = $client->describeRegistriesAsync
([/* ... */]);
Returns details for a public registry.
Parameter Syntax
$result = $client->describeRegistries([ 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of repository results returned by
DescribeRegistries
in paginated output. When this parameter is used,DescribeRegistries
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherDescribeRegistries
request with the returnednextToken
value. This value can be between 1 and 1000. If this parameter is not used, thenDescribeRegistries
returns up to 100 results and anextToken
value, if applicable. - nextToken
-
- Type: string
The
nextToken
value returned from a previous paginatedDescribeRegistries
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value. This value isnull
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.
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
Members
- nextToken
-
- Type: string
The
nextToken
value to include in a futureDescribeRepositories
request. When the results of aDescribeRepositories
request exceedmaxResults
, this value can be used to retrieve the next page of results. This value isnull
when there are no more results to return. - registries
-
- Required: Yes
- Type: Array of Registry structures
An object containing the details for a public registry.
Errors
-
The specified parameter is invalid. Review the available parameters for the API request.
-
The action is not supported in this Region.
-
These errors are usually caused by a server-side issue.
DescribeRepositories
$result = $client->describeRepositories
([/* ... */]); $promise = $client->describeRepositoriesAsync
([/* ... */]);
Describes repositories in a public 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 returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherDescribeRepositories
request with the returnednextToken
value. This value can be between 1 and 1000. If this parameter is not used, thenDescribeRepositories
returns up to 100 results and anextToken
value, if applicable. This option cannot be used when you specify repositories withrepositoryNames
. - nextToken
-
- Type: string
The
nextToken
value returned from a previous paginatedDescribeRepositories
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value. This value isnull
when there are no more results to return. This option cannot be used when you specify repositories withrepositoryNames
.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 public 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 futureDescribeRepositories
request. When the results of aDescribeRepositories
request exceedmaxResults
, this value can be used to retrieve the next page of results. This value isnull
when there are no more results to return. - repositories
-
- Type: Array of Repository structures
A list of repository objects corresponding to valid repositories.
Errors
-
These errors are usually caused by a server-side issue.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
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.
GetAuthorizationToken
$result = $client->getAuthorizationToken
([/* ... */]); $promise = $client->getAuthorizationTokenAsync
([/* ... */]);
Retrieves an authorization token. An authorization token represents your IAM authentication credentials and can be used to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid for 12 hours. This API requires the ecr-public:GetAuthorizationToken
and sts:GetServiceBearerToken
permissions.
Parameter Syntax
$result = $client->getAuthorizationToken([ ]);
Parameter Details
Members
Result Syntax
[ 'authorizationData' => [ 'authorizationToken' => '<string>', 'expiresAt' => <DateTime>, ], ]
Result Details
Members
- authorizationData
-
- Type: AuthorizationData structure
An authorization token data object that corresponds to a public registry.
Errors
-
These errors are usually caused by a server-side issue.
-
The specified parameter is invalid. Review the available parameters for the API request.
GetRegistryCatalogData
$result = $client->getRegistryCatalogData
([/* ... */]); $promise = $client->getRegistryCatalogDataAsync
([/* ... */]);
Retrieves catalog metadata for a public registry.
Parameter Syntax
$result = $client->getRegistryCatalogData([ ]);
Parameter Details
Members
Result Syntax
[ 'registryCatalogData' => [ 'displayName' => '<string>', ], ]
Result Details
Members
- registryCatalogData
-
- Required: Yes
- Type: RegistryCatalogData structure
The catalog metadata for the public registry.
Errors
-
These errors are usually caused by a server-side issue.
-
The action is not 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
Members
- 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 public registry is assumed.
- repositoryName
-
- Required: Yes
- Type: string
The name of the repository to retrieve the catalog metadata for.
Result Syntax
[ 'catalogData' => [ 'aboutText' => '<string>', 'architectures' => ['<string>', ...], 'description' => '<string>', 'logoUrl' => '<string>', 'marketplaceCertified' => true || false, 'operatingSystems' => ['<string>', ...], 'usageText' => '<string>', ], ]
Result Details
Members
- catalogData
-
- Type: RepositoryCatalogData structure
The catalog metadata for the repository.
Errors
-
These errors are usually caused by a server-side issue.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
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.
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
Members
Result Syntax
[ 'policyText' => '<string>', 'registryId' => '<string>', 'repositoryName' => '<string>', ]
Result Details
Members
Errors
-
These errors are usually caused by a server-side issue.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
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.
InitiateLayerUpload
$result = $client->initiateLayerUpload
([/* ... */]); $promise = $client->initiateLayerUploadAsync
([/* ... */]);
Notifies Amazon ECR that you intend to upload an image layer.
When an image is pushed, the InitiateLayerUpload API is called once per image layer that has not already been uploaded. Whether or not an image layer has been uploaded is determined by the BatchCheckLayerAvailability API action.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker
CLI to pull, tag, and push images.
Parameter Syntax
$result = $client->initiateLayerUpload([ 'registryId' => '<string>', 'repositoryName' => '<string>', // REQUIRED ]);
Parameter Details
Members
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
-
These errors are usually caused by a server-side issue.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
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.
-
The registry does not exist.
-
The action is not 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
Members
Result Syntax
[ 'tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]
Result Details
Members
- tags
-
- Type: Array of Tag structures
The tags for the resource.
Errors
-
The specified parameter is invalid. Review the available parameters for the API request.
-
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.
-
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 associated with an image.
When an image is pushed and all new image layers have been uploaded, the PutImage API is called once to create or update the image manifest and the tags associated with the image.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker
CLI to pull, tag, and push images.
Parameter Syntax
$result = $client->putImage([ 'imageDigest' => '<string>', 'imageManifest' => '<string>', // REQUIRED 'imageManifestMediaType' => '<string>', 'imageTag' => '<string>', 'registryId' => '<string>', 'repositoryName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- imageDigest
-
- Type: string
The image digest of the image manifest corresponding to the image.
- imageManifest
-
- Required: Yes
- Type: string
The image manifest corresponding to the image to be uploaded.
- imageManifestMediaType
-
- Type: string
The media type of the image manifest. If you push an image manifest that does not contain the
mediaType
field, you must specify theimageManifestMediaType
in the request. - 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 Open Container Initiative (OCI) formats.
- registryId
-
- Type: string
The AWS account ID associated with the public registry that contains the repository in which to put the image. If you do not specify a registry, the default public 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>', 'imageManifestMediaType' => '<string>', 'registryId' => '<string>', 'repositoryName' => '<string>', ], ]
Result Details
Members
- image
-
- Type: Image structure
Details of the image uploaded.
Errors
-
These errors are usually caused by a server-side issue.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
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.
-
The specified image has already been pushed, and there were no changes to the manifest or image tag after the last push.
-
The specified layers could not be found, or the specified layer is not valid for this repository.
-
ReferencedImagesNotFoundException:
The manifest list is referencing an image that does not exist.
-
The operation did not succeed because it would have exceeded a service limit for your account. For more information, see Amazon ECR Service Quotas in the Amazon Elastic Container Registry User Guide.
-
ImageTagAlreadyExistsException:
The specified image is tagged with a tag that already exists. The repository is configured for tag immutability.
-
ImageDigestDoesNotMatchException:
The specified image digest does not match the digest that Amazon ECR calculated for the image.
-
The registry does not exist.
-
The action is not supported in this Region.
PutRegistryCatalogData
$result = $client->putRegistryCatalogData
([/* ... */]); $promise = $client->putRegistryCatalogDataAsync
([/* ... */]);
Create or updates the catalog data for a public registry.
Parameter Syntax
$result = $client->putRegistryCatalogData([ 'displayName' => '<string>', ]);
Parameter Details
Members
Result Syntax
[ 'registryCatalogData' => [ 'displayName' => '<string>', ], ]
Result Details
Members
- registryCatalogData
-
- Required: Yes
- Type: RegistryCatalogData structure
The catalog data for the public registry.
Errors
-
These errors are usually caused by a server-side issue.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
The action is not 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
Members
- catalogData
-
- Required: Yes
- Type: RepositoryCatalogDataInput structure
An object containing the catalog data for a repository. This data is publicly visible in the Amazon ECR Public Gallery.
- registryId
-
- Type: string
The AWS account ID associated with the public registry the repository is in. If you do not specify a registry, the default public registry is assumed.
- repositoryName
-
- Required: Yes
- Type: string
The name of the repository to create or update the catalog data for.
Result Syntax
[ 'catalogData' => [ 'aboutText' => '<string>', 'architectures' => ['<string>', ...], 'description' => '<string>', 'logoUrl' => '<string>', 'marketplaceCertified' => true || false, 'operatingSystems' => ['<string>', ...], 'usageText' => '<string>', ], ]
Result Details
Members
- catalogData
-
- Type: RepositoryCatalogData structure
The catalog data for the repository.
Errors
-
These errors are usually caused by a server-side issue.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
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 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
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. For more information, see Amazon ECR Repository Policies in the Amazon Elastic Container Registry User Guide.
- registryId
-
- Type: string
The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default public 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
Errors
-
These errors are usually caused by a server-side issue.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
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.
TagResource
$result = $client->tagResource
([/* ... */]); $promise = $client->tagResourceAsync
([/* ... */]);
Associates the specified tags to a resource with the specified resourceArn
. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well.
Parameter Syntax
$result = $client->tagResource([ 'resourceArn' => '<string>', // REQUIRED 'tags' => [ // REQUIRED [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, the supported resource is an Amazon ECR Public repository.
- tags
-
- Required: Yes
- Type: Array of Tag structures
The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
Result Syntax
[]
Result Details
Errors
-
The specified parameter is invalid. Review the available parameters for the API request.
-
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.
-
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.
-
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.
-
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
Members
Result Syntax
[]
Result Details
Errors
-
The specified parameter is invalid. Review the available parameters for the API request.
-
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.
-
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.
-
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.
-
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 (or about 20MB). The UploadLayerPart API is called once per each new image layer part.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker
CLI to pull, tag, and push images.
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 position of the first byte of the layer part witin the overall image layer.
- partLastByte
-
- Required: Yes
- Type: long (int|float)
The position of the last byte of the layer part within the overall image layer.
- 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 public 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
-
These errors are usually caused by a server-side issue.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
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.
-
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.
-
The upload could not be found, or the specified upload ID is not valid for this repository.
-
The operation did not succeed because it would have exceeded a service limit for your account. For more information, see Amazon ECR Service Quotas in the Amazon Elastic Container Registry User Guide.
-
The registry does not exist.
-
The action is not supported in this Region.
Shapes
AuthorizationData
Description
An authorization token data object that corresponds to a public registry.
Members
- authorizationToken
-
- Type: string
A base64-encoded string that contains authorization data for a public Amazon ECR registry. When the string is decoded, it is presented in the format
user:password
for public registry authentication usingdocker 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.
EmptyUploadException
Description
The specified layer upload does not contain any layer parts.
Members
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.
- imageManifestMediaType
-
- Type: string
The manifest media type of 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
ImageDetail
Description
An object that describes an image returned by a DescribeImages operation.
Members
- artifactMediaType
-
- Type: string
The artifact media type of the image.
- imageDigest
-
- Type: string
The
sha256
digest of the image manifest. - imageManifestMediaType
-
- Type: string
The media type 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.
If the image is a manifest list, this will be the max size of all manifests in the list.
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. - imageTags
-
- Type: Array of strings
The list of tags associated with this image.
- registryId
-
- Type: string
The AWS account ID associated with the public registry to which this image belongs.
- repositoryName
-
- Type: string
The name of the repository to which this image belongs.
ImageDigestDoesNotMatchException
Description
The specified image digest does not match the digest that Amazon ECR calculated for the image.
Members
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
ImageNotFoundException
Description
The image requested does not exist in the specified repository.
Members
ImageTagAlreadyExistsException
Description
The specified image is tagged with a tag that already exists. The repository is configured for tag immutability.
Members
ImageTagDetail
Description
An object representing the image tag details for an image.
Members
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time stamp indicating when the image tag was created.
- imageDetail
-
- Type: ReferencedImageDetail structure
An object that describes the details of an image.
- imageTag
-
- Type: string
The tag associated with the image.
InvalidLayerException
Description
The layer digest calculation performed by Amazon ECR upon receipt of the image layer does not match the digest specified.
Members
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 position of the last byte of the layer part.
- message
-
- Type: string
- registryId
-
- Type: string
The AWS account ID associated with the layer part.
- repositoryName
-
- Type: string
The name of the repository.
- uploadId
-
- Type: string
The upload ID associated with the layer part.
InvalidParameterException
Description
The specified parameter is invalid. Review the available parameters for the API request.
Members
InvalidTagParameterException
Description
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.
Members
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
orapplication/vnd.oci.image.layer.v1.tar+gzip
.
LayerAlreadyExistsException
Description
The image layer already exists in the associated repository.
Members
LayerFailure
Description
An object representing an Amazon ECR image layer failure.
Members
LayerPartTooSmallException
LayersNotFoundException
Description
The specified layers could not be found, or the specified layer is not valid for this repository.
Members
LimitExceededException
Description
The operation did not succeed because it would have exceeded a service limit for your account. For more information, see Amazon ECR Service Quotas in the Amazon Elastic Container Registry User Guide.
Members
ReferencedImageDetail
Description
An object that describes the image tag details returned by a DescribeImageTags action.
Members
- artifactMediaType
-
- Type: string
The artifact media type of the image.
- imageDigest
-
- Type: string
The
sha256
digest of the image manifest. - imageManifestMediaType
-
- Type: string
The media type 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 tag was pushed to the repository.
- imageSizeInBytes
-
- Type: long (int|float)
The size, in bytes, of the image in the repository.
If the image is a manifest list, this will be the max size of all manifests in the list.
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.
ReferencedImagesNotFoundException
Description
The manifest list is referencing an image that does not exist.
Members
Registry
Description
The details of a public registry.
Members
- aliases
-
- Required: Yes
- Type: Array of RegistryAlias structures
An array of objects representing the aliases for a public registry.
- registryArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the public registry.
- registryId
-
- Required: Yes
- Type: string
The AWS account ID associated with the registry. If you do not specify a registry, the default public registry is assumed.
- registryUri
-
- Required: Yes
- Type: string
The URI of a public registry. The URI contains a universal prefix and the registry alias.
- verified
-
- Required: Yes
- Type: boolean
Whether the account is verified. This indicates whether the account is an AWS Marketplace vendor. If an account is verified, each public repository will received a verified account badge on the Amazon ECR Public Gallery.
RegistryAlias
Description
An object representing the aliases for a public registry. A public registry is given an alias upon creation but a custom alias can be set using the Amazon ECR console. For more information, see Registries in the Amazon Elastic Container Registry User Guide.
Members
- defaultRegistryAlias
-
- Required: Yes
- Type: boolean
Whether or not the registry alias is the default alias for the registry. When the first public repository is created, your public registry is assigned a default registry alias.
- name
-
- Required: Yes
- Type: string
The name of the registry alias.
- primaryRegistryAlias
-
- Required: Yes
- Type: boolean
Whether or not the registry alias is the primary alias for the registry. If true, the alias is the primary registry alias and is displayed in both the repository URL and the image URI used in the
docker pull
commands on the Amazon ECR Public Gallery.A registry alias that is not the primary registry alias can be used in the repository URI in a
docker pull
command. - status
-
- Required: Yes
- Type: string
The status of the registry alias.
RegistryCatalogData
Description
The metadata for a public registry.
Members
RegistryNotFoundException
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 public 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 container image
push
andpull
operations.
RepositoryAlreadyExistsException
Description
The specified repository already exists in the specified registry.
Members
RepositoryCatalogData
Description
The catalog data for a repository. This data is publicly visible in the Amazon ECR Public Gallery.
Members
- aboutText
-
- Type: string
The longform description of the contents of the repository. This text appears in the repository details on the Amazon ECR Public Gallery.
- architectures
-
- Type: Array of strings
The architecture tags that are associated with the repository.
Only supported operating system tags appear publicly in the Amazon ECR Public Gallery. For more information, see RepositoryCatalogDataInput.
- description
-
- Type: string
The short description of the repository.
- logoUrl
-
- Type: string
The URL containing the logo associated with the repository.
- marketplaceCertified
-
- Type: boolean
Whether or not the repository is certified by AWS Marketplace.
- operatingSystems
-
- Type: Array of strings
The operating system tags that are associated with the repository.
Only supported operating system tags appear publicly in the Amazon ECR Public Gallery. For more information, see RepositoryCatalogDataInput.
- usageText
-
- Type: string
The longform usage details of the contents of the repository. The usage text provides context for users of the repository.
RepositoryCatalogDataInput
Description
An object containing the catalog data for a repository. This data is publicly visible in the Amazon ECR Public Gallery.
Members
- aboutText
-
- Type: string
A detailed description of the contents of the repository. It is publicly visible in the Amazon ECR Public Gallery. The text must be in markdown format.
- architectures
-
- Type: Array of strings
The system architecture that the images in the repository are compatible with. On the Amazon ECR Public Gallery, the following supported architectures will appear as badges on the repository and are used as search filters.
-
Linux
-
Windows
If an unsupported tag is added to your repository catalog data, it will be associated with the repository and can be retrieved using the API but will not be discoverable in the Amazon ECR Public Gallery.
- description
-
- Type: string
A short description of the contents of the repository. This text appears in both the image details and also when searching for repositories on the Amazon ECR Public Gallery.
- logoImageBlob
-
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The base64-encoded repository logo payload.
The repository logo is only publicly visible in the Amazon ECR Public Gallery for verified accounts.
- operatingSystems
-
- Type: Array of strings
The operating systems that the images in the repository are compatible with. On the Amazon ECR Public Gallery, the following supported operating systems will appear as badges on the repository and are used as search filters.
-
ARM
-
ARM 64
-
x86
-
x86-64
If an unsupported tag is added to your repository catalog data, it will be associated with the repository and can be retrieved using the API but will not be discoverable in the Amazon ECR Public Gallery.
- usageText
-
- Type: string
Detailed information on how to use the contents of the repository. It is publicly visible in the Amazon ECR Public Gallery. The usage text provides context, support information, and additional usage details for users of the repository. The text must be in markdown format.
RepositoryNotEmptyException
Description
The specified repository contains images. To delete a repository that contains images, you must force the deletion with the force
parameter.
Members
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
RepositoryPolicyNotFoundException
Description
The specified repository and registry combination does not have an associated repository policy.
Members
ServerException
Tag
Description
The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
Members
TooManyTagsException
Description
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.