# Actions The following actions are supported: + [BatchCheckLayerAvailability](API_BatchCheckLayerAvailability.md) + [BatchDeleteImage](API_BatchDeleteImage.md) + [CompleteLayerUpload](API_CompleteLayerUpload.md) + [CreateRepository](API_CreateRepository.md) + [DeleteRepository](API_DeleteRepository.md) + [DeleteRepositoryPolicy](API_DeleteRepositoryPolicy.md) + [DescribeImages](API_DescribeImages.md) + [DescribeImageTags](API_DescribeImageTags.md) + [DescribeRegistries](API_DescribeRegistries.md) + [DescribeRepositories](API_DescribeRepositories.md) + [GetAuthorizationToken](API_GetAuthorizationToken.md) + [GetRegistryCatalogData](API_GetRegistryCatalogData.md) + [GetRepositoryCatalogData](API_GetRepositoryCatalogData.md) + [GetRepositoryPolicy](API_GetRepositoryPolicy.md) + [InitiateLayerUpload](API_InitiateLayerUpload.md) + [ListTagsForResource](API_ListTagsForResource.md) + [PutImage](API_PutImage.md) + [PutRegistryCatalogData](API_PutRegistryCatalogData.md) + [PutRepositoryCatalogData](API_PutRepositoryCatalogData.md) + [SetRepositoryPolicy](API_SetRepositoryPolicy.md) + [TagResource](API_TagResource.md) + [UntagResource](API_UntagResource.md) + [UploadLayerPart](API_UploadLayerPart.md) # BatchCheckLayerAvailability 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. **Note** 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. ## Request Syntax ``` { "layerDigests": [ "string" ], "registryId": "string", "repositoryName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [layerDigests](#API_BatchCheckLayerAvailability_RequestSyntax) ** The digests of the image layers to check. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 100 items. Length Constraints: Minimum length of 0. Maximum length of 1000. Required: Yes ** [registryId](#API_BatchCheckLayerAvailability_RequestSyntax) ** The AWS account ID, or registry alias, 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. Type: String Length Constraints: Minimum length of 2. Maximum length of 50. Required: No ** [repositoryName](#API_BatchCheckLayerAvailability_RequestSyntax) ** The name of the repository that's associated with the image layers to check. Type: String Length Constraints: Minimum length of 2. Maximum length of 205. Pattern: `(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*` Required: Yes ## Response Syntax ``` { "failures": [ { "failureCode": "string", "failureReason": "string", "layerDigest": "string" } ], "layers": [ { "layerAvailability": "string", "layerDigest": "string", "layerSize": number, "mediaType": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [failures](#API_BatchCheckLayerAvailability_ResponseSyntax) ** Any failures associated with the call. Type: Array of [LayerFailure](API_LayerFailure.md) objects ** [layers](#API_BatchCheckLayerAvailability_ResponseSyntax) ** A list of image layer objects that correspond to the image layer references in the request. Type: Array of [Layer](API_Layer.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. HTTP Status Code: 400 ** RegistryNotFoundException ** The registry doesn't exist. HTTP Status Code: 400 ** 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. HTTP Status Code: 400 ** ServerException ** These errors are usually caused by a server-side issue. HTTP Status Code: 500 ** UnsupportedCommandException ** The action isn't supported in this Region. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ecr-public-2020-10-30/BatchCheckLayerAvailability) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ecr-public-2020-10-30/BatchCheckLayerAvailability) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ecr-public-2020-10-30/BatchCheckLayerAvailability) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ecr-public-2020-10-30/BatchCheckLayerAvailability) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ecr-public-2020-10-30/BatchCheckLayerAvailability) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ecr-public-2020-10-30/BatchCheckLayerAvailability) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ecr-public-2020-10-30/BatchCheckLayerAvailability) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ecr-public-2020-10-30/BatchCheckLayerAvailability) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ecr-public-2020-10-30/BatchCheckLayerAvailability) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ecr-public-2020-10-30/BatchCheckLayerAvailability) # BatchDeleteImage 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. ## Request Syntax ``` { "imageIds": [ { "imageDigest": "string", "imageTag": "string" } ], "registryId": "string", "repositoryName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [imageIds](#API_BatchDeleteImage_RequestSyntax) ** A list of image ID references that correspond to images to delete. The format of the `imageIds` reference is `imageTag=tag` or `imageDigest=digest`. Type: Array of [ImageIdentifier](API_ImageIdentifier.md) objects Array Members: Minimum number of 1 item. Maximum number of 100 items. Required: Yes ** [registryId](#API_BatchDeleteImage_RequestSyntax) ** The AWS account ID, or registry alias, that's associated with the registry that contains the image to delete. If you do not specify a registry, the default public registry is assumed. Type: String Length Constraints: Minimum length of 2. Maximum length of 50. Required: No ** [repositoryName](#API_BatchDeleteImage_RequestSyntax) ** The repository in a public registry that contains the image to delete. Type: String Length Constraints: Minimum length of 2. Maximum length of 205. Pattern: `(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*` Required: Yes ## Response Syntax ``` { "failures": [ { "failureCode": "string", "failureReason": "string", "imageId": { "imageDigest": "string", "imageTag": "string" } } ], "imageIds": [ { "imageDigest": "string", "imageTag": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [failures](#API_BatchDeleteImage_ResponseSyntax) ** Any failures associated with the call. Type: Array of [ImageFailure](API_ImageFailure.md) objects ** [imageIds](#API_BatchDeleteImage_ResponseSyntax) ** The image IDs of the deleted images. Type: Array of [ImageIdentifier](API_ImageIdentifier.md) objects Array Members: Minimum number of 1 item. Maximum number of 100 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. HTTP Status Code: 400 ** 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. HTTP Status Code: 400 ** ServerException ** These errors are usually caused by a server-side issue. HTTP Status Code: 500 ** UnsupportedCommandException ** The action isn't supported in this Region. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ecr-public-2020-10-30/BatchDeleteImage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ecr-public-2020-10-30/BatchDeleteImage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ecr-public-2020-10-30/BatchDeleteImage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ecr-public-2020-10-30/BatchDeleteImage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ecr-public-2020-10-30/BatchDeleteImage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ecr-public-2020-10-30/BatchDeleteImage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ecr-public-2020-10-30/BatchDeleteImage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ecr-public-2020-10-30/BatchDeleteImage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ecr-public-2020-10-30/BatchDeleteImage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ecr-public-2020-10-30/BatchDeleteImage) # CompleteLayerUpload 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. **Note** 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. ## Request Syntax ``` { "layerDigests": [ "string" ], "registryId": "string", "repositoryName": "string", "uploadId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [layerDigests](#API_CompleteLayerUpload_RequestSyntax) ** The `sha256` digest of the image layer. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 100 items. Pattern: `[a-zA-Z0-9-_+.]+:[a-fA-F0-9]+` Required: Yes ** [registryId](#API_CompleteLayerUpload_RequestSyntax) ** The AWS account ID, or registry alias, associated with the registry where layers are uploaded. If you do not specify a registry, the default public registry is assumed. Type: String Length Constraints: Minimum length of 2. Maximum length of 50. Required: No ** [repositoryName](#API_CompleteLayerUpload_RequestSyntax) ** The name of the repository in a public registry to associate with the image layer. Type: String Length Constraints: Minimum length of 2. Maximum length of 205. Pattern: `(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*` Required: Yes ** [uploadId](#API_CompleteLayerUpload_RequestSyntax) ** The upload ID from a previous [InitiateLayerUpload](API_InitiateLayerUpload.md) operation to associate with the image layer. Type: String Pattern: `[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}` Required: Yes ## Response Syntax ``` { "layerDigest": "string", "registryId": "string", "repositoryName": "string", "uploadId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [layerDigest](#API_CompleteLayerUpload_ResponseSyntax) ** The `sha256` digest of the image layer. Type: String Pattern: `[a-zA-Z0-9-_+.]+:[a-fA-F0-9]+` ** [registryId](#API_CompleteLayerUpload_ResponseSyntax) ** The public registry ID that's associated with the request. Type: String Pattern: `[0-9]{12}` ** [repositoryName](#API_CompleteLayerUpload_ResponseSyntax) ** The repository name that's associated with the request. Type: String Length Constraints: Minimum length of 2. Maximum length of 205. Pattern: `(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*` ** [uploadId](#API_CompleteLayerUpload_ResponseSyntax) ** The upload ID that's associated with the layer. Type: String Pattern: `[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** EmptyUploadException ** The specified layer upload doesn't contain any layer parts. HTTP Status Code: 400 ** InvalidLayerException ** The layer digest calculation performed by Amazon ECR when the image layer doesn't match the digest specified. HTTP Status Code: 400 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. HTTP Status Code: 400 ** LayerAlreadyExistsException ** The image layer already exists in the associated repository. HTTP Status Code: 400 ** LayerPartTooSmallException ** Layer parts must be at least 5 MiB in size. HTTP Status Code: 400 ** RegistryNotFoundException ** The registry doesn't exist. HTTP Status Code: 400 ** 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. HTTP Status Code: 400 ** ServerException ** These errors are usually caused by a server-side issue. HTTP Status Code: 500 ** UnsupportedCommandException ** The action isn't supported in this Region. HTTP Status Code: 400 ** UploadNotFoundException ** The upload can't be found, or the specified upload ID isn't valid for this repository. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ecr-public-2020-10-30/CompleteLayerUpload) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ecr-public-2020-10-30/CompleteLayerUpload) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ecr-public-2020-10-30/CompleteLayerUpload) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ecr-public-2020-10-30/CompleteLayerUpload) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ecr-public-2020-10-30/CompleteLayerUpload) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ecr-public-2020-10-30/CompleteLayerUpload) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ecr-public-2020-10-30/CompleteLayerUpload) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ecr-public-2020-10-30/CompleteLayerUpload) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ecr-public-2020-10-30/CompleteLayerUpload) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ecr-public-2020-10-30/CompleteLayerUpload) # CreateRepository Creates a repository in a public registry. For more information, see [Public repositories](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repositories.html) in the *Amazon Elastic Container Registry Public User Guide*. ## Request Syntax ``` { "catalogData": { "aboutText": "string", "architectures": [ "string" ], "description": "string", "logoImageBlob": blob, "operatingSystems": [ "string" ], "usageText": "string" }, "repositoryName": "string", "tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [catalogData](#API_CreateRepository_RequestSyntax) ** The details about the repository that are publicly visible in the Amazon ECR Public Gallery. Type: [RepositoryCatalogDataInput](API_RepositoryCatalogDataInput.md) object Required: No ** [repositoryName](#API_CreateRepository_RequestSyntax) ** The name to use for the repository. This appears publicly in the Amazon ECR Public Gallery. The repository name can be specified on its own (for example `nginx-web-app`) or prepended with a namespace to group the repository into a category (for example `project-a/nginx-web-app`). Type: String Length Constraints: Minimum length of 2. Maximum length of 205. Pattern: `(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*` Required: Yes ** [tags](#API_CreateRepository_RequestSyntax) ** The metadata that you apply to each repository to help categorize and organize your repositories. Each tag consists of a key and an optional value. You define both of them. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ## Response Syntax ``` { "catalogData": { "aboutText": "string", "architectures": [ "string" ], "description": "string", "logoUrl": "string", "marketplaceCertified": boolean, "operatingSystems": [ "string" ], "usageText": "string" }, "repository": { "createdAt": number, "registryId": "string", "repositoryArn": "string", "repositoryName": "string", "repositoryUri": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [catalogData](#API_CreateRepository_ResponseSyntax) ** The catalog data for a repository. This data is publicly visible in the Amazon ECR Public Gallery. Type: [RepositoryCatalogData](API_RepositoryCatalogData.md) object ** [repository](#API_CreateRepository_ResponseSyntax) ** The repository that was created. Type: [Repository](API_Repository.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. HTTP Status Code: 400 ** 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. HTTP Status Code: 400 ** LimitExceededException ** The operation didn't succeed because it would have exceeded a service limit for your account. For more information, see [Amazon ECR Public service quotas](https://docs.aws.amazon.com/AmazonECR/latest/public/public-service-quotas.html) in the Amazon Elastic Container Registry Public User Guide. HTTP Status Code: 400 ** RepositoryAlreadyExistsException ** The specified repository already exists in the specified registry. HTTP Status Code: 400 ** ServerException ** These errors are usually caused by a server-side issue. HTTP Status Code: 500 ** 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. HTTP Status Code: 400 ** UnsupportedCommandException ** The action isn't supported in this Region. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ecr-public-2020-10-30/CreateRepository) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ecr-public-2020-10-30/CreateRepository) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ecr-public-2020-10-30/CreateRepository) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ecr-public-2020-10-30/CreateRepository) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ecr-public-2020-10-30/CreateRepository) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ecr-public-2020-10-30/CreateRepository) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ecr-public-2020-10-30/CreateRepository) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ecr-public-2020-10-30/CreateRepository) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ecr-public-2020-10-30/CreateRepository) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ecr-public-2020-10-30/CreateRepository) # DeleteRepository 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. ## Request Syntax ``` { "force": boolean, "registryId": "string", "repositoryName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [force](#API_DeleteRepository_RequestSyntax) ** The force option can be used to delete a repository that contains images. If the force option is not used, the repository must be empty prior to deletion. Type: Boolean Required: No ** [registryId](#API_DeleteRepository_RequestSyntax) ** The AWS account ID that's associated with the public registry that contains the repository to delete. If you do not specify a registry, the default public registry is assumed. Type: String Pattern: `[0-9]{12}` Required: No ** [repositoryName](#API_DeleteRepository_RequestSyntax) ** The name of the repository to delete. Type: String Length Constraints: Minimum length of 2. Maximum length of 205. Pattern: `(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*` Required: Yes ## Response Syntax ``` { "repository": { "createdAt": number, "registryId": "string", "repositoryArn": "string", "repositoryName": "string", "repositoryUri": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [repository](#API_DeleteRepository_ResponseSyntax) ** The repository that was deleted. Type: [Repository](API_Repository.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. HTTP Status Code: 400 ** RepositoryNotEmptyException ** The specified repository contains images. To delete a repository that contains images, you must force the deletion with the `force` parameter. HTTP Status Code: 400 ** 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. HTTP Status Code: 400 ** ServerException ** These errors are usually caused by a server-side issue. HTTP Status Code: 500 ** UnsupportedCommandException ** The action isn't supported in this Region. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ecr-public-2020-10-30/DeleteRepository) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ecr-public-2020-10-30/DeleteRepository) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ecr-public-2020-10-30/DeleteRepository) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ecr-public-2020-10-30/DeleteRepository) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ecr-public-2020-10-30/DeleteRepository) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ecr-public-2020-10-30/DeleteRepository) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ecr-public-2020-10-30/DeleteRepository) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ecr-public-2020-10-30/DeleteRepository) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ecr-public-2020-10-30/DeleteRepository) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ecr-public-2020-10-30/DeleteRepository) # DeleteRepositoryPolicy Deletes the repository policy that's associated with the specified repository. ## Request Syntax ``` { "registryId": "string", "repositoryName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [registryId](#API_DeleteRepositoryPolicy_RequestSyntax) ** The AWS account ID that's 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. Type: String Pattern: `[0-9]{12}` Required: No ** [repositoryName](#API_DeleteRepositoryPolicy_RequestSyntax) ** The name of the repository that's associated with the repository policy to delete. Type: String Length Constraints: Minimum length of 2. Maximum length of 205. Pattern: `(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*` Required: Yes ## Response Syntax ``` { "policyText": "string", "registryId": "string", "repositoryName": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [policyText](#API_DeleteRepositoryPolicy_ResponseSyntax) ** The JSON repository policy that was deleted from the repository. Type: String Length Constraints: Minimum length of 0. Maximum length of 10240. ** [registryId](#API_DeleteRepositoryPolicy_ResponseSyntax) ** The registry ID that's associated with the request. Type: String Pattern: `[0-9]{12}` ** [repositoryName](#API_DeleteRepositoryPolicy_ResponseSyntax) ** The repository name that's associated with the request. Type: String Length Constraints: Minimum length of 2. Maximum length of 205. Pattern: `(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. HTTP Status Code: 400 ** 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. HTTP Status Code: 400 ** RepositoryPolicyNotFoundException ** The specified repository and registry combination doesn't have an associated repository policy. HTTP Status Code: 400 ** ServerException ** These errors are usually caused by a server-side issue. HTTP Status Code: 500 ** UnsupportedCommandException ** The action isn't supported in this Region. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ecr-public-2020-10-30/DeleteRepositoryPolicy) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ecr-public-2020-10-30/DeleteRepositoryPolicy) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ecr-public-2020-10-30/DeleteRepositoryPolicy) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ecr-public-2020-10-30/DeleteRepositoryPolicy) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ecr-public-2020-10-30/DeleteRepositoryPolicy) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ecr-public-2020-10-30/DeleteRepositoryPolicy) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ecr-public-2020-10-30/DeleteRepositoryPolicy) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ecr-public-2020-10-30/DeleteRepositoryPolicy) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ecr-public-2020-10-30/DeleteRepositoryPolicy) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ecr-public-2020-10-30/DeleteRepositoryPolicy) # DescribeImages Returns metadata that's related to the images in a repository in a public registry. **Note** 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. Therefore, it might return a larger image size than the image sizes that are returned by [DescribeImages](#API_DescribeImages). ## Request Syntax ``` { "imageIds": [ { "imageDigest": "string", "imageTag": "string" } ], "maxResults": number, "nextToken": "string", "registryId": "string", "repositoryName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [imageIds](#API_DescribeImages_RequestSyntax) ** The list of image IDs for the requested repository. Type: Array of [ImageIdentifier](API_ImageIdentifier.md) objects Array Members: Minimum number of 1 item. Maximum number of 100 items. Required: No ** [maxResults](#API_DescribeImages_RequestSyntax) ** The maximum number of repository results that's returned by `DescribeImages` in paginated output. When this parameter is used, `DescribeImages` only returns `maxResults` results in a single page along with a `nextToken` response element. You can see the remaining results of the initial request by sending another `DescribeImages` request with the returned `nextToken` value. This value can be between 1 and 1000. If this parameter isn't used, then `DescribeImages` returns up to 100 results and a `nextToken` value, if applicable. If you specify images with `imageIds`, you can't use this option. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No ** [nextToken](#API_DescribeImages_RequestSyntax) ** The `nextToken` value that's returned from a previous paginated `DescribeImages` request where `maxResults` was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the `nextToken` value. If there are no more results to return, this value is `null`. If you specify images with `imageIds`, you can't use this option. Type: String Required: No ** [registryId](#API_DescribeImages_RequestSyntax) ** The AWS account ID that's associated with the public registry that contains the repository where images are described. If you do not specify a registry, the default public registry is assumed. Type: String Pattern: `[0-9]{12}` Required: No ** [repositoryName](#API_DescribeImages_RequestSyntax) ** The repository that contains the images to describe. Type: String Length Constraints: Minimum length of 2. Maximum length of 205. Pattern: `(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*` Required: Yes ## Response Syntax ``` { "imageDetails": [ { "artifactMediaType": "string", "imageDigest": "string", "imageManifestMediaType": "string", "imagePushedAt": number, "imageSizeInBytes": number, "imageTags": [ "string" ], "registryId": "string", "repositoryName": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [imageDetails](#API_DescribeImages_ResponseSyntax) ** A list of [ImageDetail](API_ImageDetail.md) objects that contain data about the image. Type: Array of [ImageDetail](API_ImageDetail.md) objects ** [nextToken](#API_DescribeImages_ResponseSyntax) ** The `nextToken` value to include in a future `DescribeImages` request. When the results of a `DescribeImages` request exceed `maxResults`, you can use this value to retrieve the next page of results. If there are no more results to return, this value is `null`. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ImageNotFoundException ** The image requested doesn't exist in the specified repository. HTTP Status Code: 400 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. HTTP Status Code: 400 ** 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. HTTP Status Code: 400 ** ServerException ** These errors are usually caused by a server-side issue. HTTP Status Code: 500 ** UnsupportedCommandException ** The action isn't supported in this Region. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ecr-public-2020-10-30/DescribeImages) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ecr-public-2020-10-30/DescribeImages) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ecr-public-2020-10-30/DescribeImages) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ecr-public-2020-10-30/DescribeImages) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ecr-public-2020-10-30/DescribeImages) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ecr-public-2020-10-30/DescribeImages) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ecr-public-2020-10-30/DescribeImages) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ecr-public-2020-10-30/DescribeImages) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ecr-public-2020-10-30/DescribeImages) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ecr-public-2020-10-30/DescribeImages) # DescribeImageTags Returns the image tag details for a repository in a public registry. ## Request Syntax ``` { "maxResults": number, "nextToken": "string", "registryId": "string", "repositoryName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [maxResults](#API_DescribeImageTags_RequestSyntax) ** The maximum number of repository results that's returned by `DescribeImageTags` in paginated output. When this parameter is used, `DescribeImageTags` only returns `maxResults` results in a single page along with a `nextToken` response element. You can see the remaining results of the initial request by sending another `DescribeImageTags` request with the returned `nextToken` value. This value can be between 1 and 1000. If this parameter isn't used, then `DescribeImageTags` returns up to 100 results and a `nextToken` value, if applicable. If you specify images with `imageIds`, you can't use this option. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No ** [nextToken](#API_DescribeImageTags_RequestSyntax) ** The `nextToken` value that's returned from a previous paginated `DescribeImageTags` request where `maxResults` was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the `nextToken` value. If there are no more results to return, this value is `null`. If you specify images with `imageIds`, you can't use this option. Type: String Required: No ** [registryId](#API_DescribeImageTags_RequestSyntax) ** The AWS account ID that's associated with the public registry that contains the repository where images are described. If you do not specify a registry, the default public registry is assumed. Type: String Pattern: `[0-9]{12}` Required: No ** [repositoryName](#API_DescribeImageTags_RequestSyntax) ** The name of the repository that contains the image tag details to describe. Type: String Length Constraints: Minimum length of 2. Maximum length of 205. Pattern: `(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*` Required: Yes ## Response Syntax ``` { "imageTagDetails": [ { "createdAt": number, "imageDetail": { "artifactMediaType": "string", "imageDigest": "string", "imageManifestMediaType": "string", "imagePushedAt": number, "imageSizeInBytes": number }, "imageTag": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [imageTagDetails](#API_DescribeImageTags_ResponseSyntax) ** The image tag details for the images in the requested repository. Type: Array of [ImageTagDetail](API_ImageTagDetail.md) objects ** [nextToken](#API_DescribeImageTags_ResponseSyntax) ** The `nextToken` value to include in a future `DescribeImageTags` request. When the results of a `DescribeImageTags` request exceed `maxResults`, you can use this value to retrieve the next page of results. If there are no more results to return, this value is `null`. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. HTTP Status Code: 400 ** 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. HTTP Status Code: 400 ** ServerException ** These errors are usually caused by a server-side issue. HTTP Status Code: 500 ** UnsupportedCommandException ** The action isn't supported in this Region. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ecr-public-2020-10-30/DescribeImageTags) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ecr-public-2020-10-30/DescribeImageTags) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ecr-public-2020-10-30/DescribeImageTags) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ecr-public-2020-10-30/DescribeImageTags) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ecr-public-2020-10-30/DescribeImageTags) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ecr-public-2020-10-30/DescribeImageTags) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ecr-public-2020-10-30/DescribeImageTags) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ecr-public-2020-10-30/DescribeImageTags) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ecr-public-2020-10-30/DescribeImageTags) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ecr-public-2020-10-30/DescribeImageTags) # DescribeRegistries Returns details for a public registry. ## Request Syntax ``` { "maxResults": number, "nextToken": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [maxResults](#API_DescribeRegistries_RequestSyntax) ** The maximum number of repository results that's returned by `DescribeRegistries` in paginated output. When this parameter is used, `DescribeRegistries` only returns `maxResults` results in a single page along with a `nextToken` response element. The remaining results of the initial request can be seen by sending another `DescribeRegistries` request with the returned `nextToken` value. This value can be between 1 and 1000. If this parameter isn't used, then `DescribeRegistries` returns up to 100 results and a `nextToken` value, if applicable. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No ** [nextToken](#API_DescribeRegistries_RequestSyntax) ** The `nextToken` value that's returned from a previous paginated `DescribeRegistries` request where `maxResults` was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the `nextToken` value. If there are no more results to return, this value is `null`. 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. Type: String Required: No ## Response Syntax ``` { "nextToken": "string", "registries": [ { "aliases": [ { "defaultRegistryAlias": boolean, "name": "string", "primaryRegistryAlias": boolean, "status": "string" } ], "registryArn": "string", "registryId": "string", "registryUri": "string", "verified": boolean } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [nextToken](#API_DescribeRegistries_ResponseSyntax) ** The `nextToken` value to include in a future `DescribeRepositories` request. If the results of a `DescribeRepositories` request exceed `maxResults`, you can use this value to retrieve the next page of results. If there are no more results, this value is `null`. Type: String ** [registries](#API_DescribeRegistries_ResponseSyntax) ** An object that contains the details for a public registry. Type: Array of [Registry](API_Registry.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. HTTP Status Code: 400 ** ServerException ** These errors are usually caused by a server-side issue. HTTP Status Code: 500 ** UnsupportedCommandException ** The action isn't supported in this Region. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ecr-public-2020-10-30/DescribeRegistries) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ecr-public-2020-10-30/DescribeRegistries) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ecr-public-2020-10-30/DescribeRegistries) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ecr-public-2020-10-30/DescribeRegistries) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ecr-public-2020-10-30/DescribeRegistries) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ecr-public-2020-10-30/DescribeRegistries) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ecr-public-2020-10-30/DescribeRegistries) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ecr-public-2020-10-30/DescribeRegistries) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ecr-public-2020-10-30/DescribeRegistries) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ecr-public-2020-10-30/DescribeRegistries) # DescribeRepositories Describes repositories that are in a public registry. ## Request Syntax ``` { "maxResults": number, "nextToken": "string", "registryId": "string", "repositoryNames": [ "string" ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [maxResults](#API_DescribeRepositories_RequestSyntax) ** The maximum number of repository results that's returned by `DescribeRepositories` in paginated output. When this parameter is used, `DescribeRepositories` only returns `maxResults` results in a single page along with a `nextToken` response element. You can see the remaining results of the initial request by sending another `DescribeRepositories` request with the returned `nextToken` value. This value can be between 1 and 1000. If this parameter isn't used, then `DescribeRepositories` returns up to 100 results and a `nextToken` value, if applicable. If you specify repositories with `repositoryNames`, you can't use this option. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No ** [nextToken](#API_DescribeRepositories_RequestSyntax) ** The `nextToken` value that's returned from a previous paginated `DescribeRepositories` request where `maxResults` was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the `nextToken` value. If there are no more results to return, this value is `null`. If you specify repositories with `repositoryNames`, you can't use this option. 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. Type: String Required: No ** [registryId](#API_DescribeRepositories_RequestSyntax) ** The AWS account ID that's associated with the registry that contains the repositories to be described. If you do not specify a registry, the default public registry is assumed. Type: String Pattern: `[0-9]{12}` Required: No ** [repositoryNames](#API_DescribeRepositories_RequestSyntax) ** A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 100 items. Length Constraints: Minimum length of 2. Maximum length of 205. Pattern: `(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*` Required: No ## Response Syntax ``` { "nextToken": "string", "repositories": [ { "createdAt": number, "registryId": "string", "repositoryArn": "string", "repositoryName": "string", "repositoryUri": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [nextToken](#API_DescribeRepositories_ResponseSyntax) ** The `nextToken` value to include in a future `DescribeRepositories` request. When the results of a `DescribeRepositories` request exceed `maxResults`, this value can be used to retrieve the next page of results. If there are no more results to return, this value is `null`. Type: String ** [repositories](#API_DescribeRepositories_ResponseSyntax) ** A list of repository objects corresponding to valid repositories. Type: Array of [Repository](API_Repository.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. HTTP Status Code: 400 ** 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. HTTP Status Code: 400 ** ServerException ** These errors are usually caused by a server-side issue. HTTP Status Code: 500 ** UnsupportedCommandException ** The action isn't supported in this Region. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ecr-public-2020-10-30/DescribeRepositories) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ecr-public-2020-10-30/DescribeRepositories) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ecr-public-2020-10-30/DescribeRepositories) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ecr-public-2020-10-30/DescribeRepositories) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ecr-public-2020-10-30/DescribeRepositories) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ecr-public-2020-10-30/DescribeRepositories) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ecr-public-2020-10-30/DescribeRepositories) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ecr-public-2020-10-30/DescribeRepositories) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ecr-public-2020-10-30/DescribeRepositories) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ecr-public-2020-10-30/DescribeRepositories) # GetAuthorizationToken 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. ## Response Syntax ``` { "authorizationData": { "authorizationToken": "string", "expiresAt": number } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [authorizationData](#API_GetAuthorizationToken_ResponseSyntax) ** An authorization token data object that corresponds to a public registry. Type: [AuthorizationData](API_AuthorizationData.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. HTTP Status Code: 400 ** ServerException ** These errors are usually caused by a server-side issue. HTTP Status Code: 500 ** UnsupportedCommandException ** The action isn't supported in this Region. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ecr-public-2020-10-30/GetAuthorizationToken) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ecr-public-2020-10-30/GetAuthorizationToken) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ecr-public-2020-10-30/GetAuthorizationToken) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ecr-public-2020-10-30/GetAuthorizationToken) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ecr-public-2020-10-30/GetAuthorizationToken) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ecr-public-2020-10-30/GetAuthorizationToken) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ecr-public-2020-10-30/GetAuthorizationToken) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ecr-public-2020-10-30/GetAuthorizationToken) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ecr-public-2020-10-30/GetAuthorizationToken) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ecr-public-2020-10-30/GetAuthorizationToken) # GetRegistryCatalogData Retrieves catalog metadata for a public registry. ## Response Syntax ``` { "registryCatalogData": { "displayName": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [registryCatalogData](#API_GetRegistryCatalogData_ResponseSyntax) ** The catalog metadata for the public registry. Type: [RegistryCatalogData](API_RegistryCatalogData.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ServerException ** These errors are usually caused by a server-side issue. HTTP Status Code: 500 ** UnsupportedCommandException ** The action isn't supported in this Region. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ecr-public-2020-10-30/GetRegistryCatalogData) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ecr-public-2020-10-30/GetRegistryCatalogData) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ecr-public-2020-10-30/GetRegistryCatalogData) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ecr-public-2020-10-30/GetRegistryCatalogData) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ecr-public-2020-10-30/GetRegistryCatalogData) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ecr-public-2020-10-30/GetRegistryCatalogData) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ecr-public-2020-10-30/GetRegistryCatalogData) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ecr-public-2020-10-30/GetRegistryCatalogData) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ecr-public-2020-10-30/GetRegistryCatalogData) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ecr-public-2020-10-30/GetRegistryCatalogData) # GetRepositoryCatalogData Retrieve catalog metadata for a repository in a public registry. This metadata is displayed publicly in the Amazon ECR Public Gallery. ## Request Syntax ``` { "registryId": "string", "repositoryName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [registryId](#API_GetRepositoryCatalogData_RequestSyntax) ** The AWS account ID that's associated with the registry that contains the repositories to be described. If you do not specify a registry, the default public registry is assumed. Type: String Pattern: `[0-9]{12}` Required: No ** [repositoryName](#API_GetRepositoryCatalogData_RequestSyntax) ** The name of the repository to retrieve the catalog metadata for. Type: String Length Constraints: Minimum length of 2. Maximum length of 205. Pattern: `(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*` Required: Yes ## Response Syntax ``` { "catalogData": { "aboutText": "string", "architectures": [ "string" ], "description": "string", "logoUrl": "string", "marketplaceCertified": boolean, "operatingSystems": [ "string" ], "usageText": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [catalogData](#API_GetRepositoryCatalogData_ResponseSyntax) ** The catalog metadata for the repository. Type: [RepositoryCatalogData](API_RepositoryCatalogData.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. HTTP Status Code: 400 ** RepositoryCatalogDataNotFoundException ** The repository catalog data doesn't exist. HTTP Status Code: 400 ** 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. HTTP Status Code: 400 ** ServerException ** These errors are usually caused by a server-side issue. HTTP Status Code: 500 ** UnsupportedCommandException ** The action isn't supported in this Region. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ecr-public-2020-10-30/GetRepositoryCatalogData) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ecr-public-2020-10-30/GetRepositoryCatalogData) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ecr-public-2020-10-30/GetRepositoryCatalogData) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ecr-public-2020-10-30/GetRepositoryCatalogData) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ecr-public-2020-10-30/GetRepositoryCatalogData) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ecr-public-2020-10-30/GetRepositoryCatalogData) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ecr-public-2020-10-30/GetRepositoryCatalogData) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ecr-public-2020-10-30/GetRepositoryCatalogData) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ecr-public-2020-10-30/GetRepositoryCatalogData) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ecr-public-2020-10-30/GetRepositoryCatalogData) # GetRepositoryPolicy Retrieves the repository policy for the specified repository. ## Request Syntax ``` { "registryId": "string", "repositoryName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [registryId](#API_GetRepositoryPolicy_RequestSyntax) ** The AWS account ID that's associated with the public registry that contains the repository. If you do not specify a registry, the default public registry is assumed. Type: String Pattern: `[0-9]{12}` Required: No ** [repositoryName](#API_GetRepositoryPolicy_RequestSyntax) ** The name of the repository with the policy to retrieve. Type: String Length Constraints: Minimum length of 2. Maximum length of 205. Pattern: `(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*` Required: Yes ## Response Syntax ``` { "policyText": "string", "registryId": "string", "repositoryName": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [policyText](#API_GetRepositoryPolicy_ResponseSyntax) ** The repository policy text that's associated with the repository. The policy text will be in JSON format. Type: String Length Constraints: Minimum length of 0. Maximum length of 10240. ** [registryId](#API_GetRepositoryPolicy_ResponseSyntax) ** The registry ID that's associated with the request. Type: String Pattern: `[0-9]{12}` ** [repositoryName](#API_GetRepositoryPolicy_ResponseSyntax) ** The repository name that's associated with the request. Type: String Length Constraints: Minimum length of 2. Maximum length of 205. Pattern: `(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. HTTP Status Code: 400 ** 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. HTTP Status Code: 400 ** RepositoryPolicyNotFoundException ** The specified repository and registry combination doesn't have an associated repository policy. HTTP Status Code: 400 ** ServerException ** These errors are usually caused by a server-side issue. HTTP Status Code: 500 ** UnsupportedCommandException ** The action isn't supported in this Region. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ecr-public-2020-10-30/GetRepositoryPolicy) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ecr-public-2020-10-30/GetRepositoryPolicy) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ecr-public-2020-10-30/GetRepositoryPolicy) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ecr-public-2020-10-30/GetRepositoryPolicy) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ecr-public-2020-10-30/GetRepositoryPolicy) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ecr-public-2020-10-30/GetRepositoryPolicy) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ecr-public-2020-10-30/GetRepositoryPolicy) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ecr-public-2020-10-30/GetRepositoryPolicy) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ecr-public-2020-10-30/GetRepositoryPolicy) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ecr-public-2020-10-30/GetRepositoryPolicy) # InitiateLayerUpload 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. **Note** 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. ## Request Syntax ``` { "registryId": "string", "repositoryName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [registryId](#API_InitiateLayerUpload_RequestSyntax) ** The AWS account ID, or registry alias, that's associated with the registry to which you intend to upload layers. If you do not specify a registry, the default public registry is assumed. Type: String Length Constraints: Minimum length of 2. Maximum length of 50. Required: No ** [repositoryName](#API_InitiateLayerUpload_RequestSyntax) ** The name of the repository that you want to upload layers to. Type: String Length Constraints: Minimum length of 2. Maximum length of 205. Pattern: `(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*` Required: Yes ## Response Syntax ``` { "partSize": number, "uploadId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [partSize](#API_InitiateLayerUpload_ResponseSyntax) ** The size, in bytes, that Amazon ECR expects future layer part uploads to be. Type: Long Valid Range: Minimum value of 0. ** [uploadId](#API_InitiateLayerUpload_ResponseSyntax) ** The upload ID for the layer upload. This parameter is passed to further [UploadLayerPart](API_UploadLayerPart.md) and [CompleteLayerUpload](API_CompleteLayerUpload.md) operations. Type: String Pattern: `[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. HTTP Status Code: 400 ** RegistryNotFoundException ** The registry doesn't exist. HTTP Status Code: 400 ** 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. HTTP Status Code: 400 ** ServerException ** These errors are usually caused by a server-side issue. HTTP Status Code: 500 ** UnsupportedCommandException ** The action isn't supported in this Region. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ecr-public-2020-10-30/InitiateLayerUpload) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ecr-public-2020-10-30/InitiateLayerUpload) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ecr-public-2020-10-30/InitiateLayerUpload) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ecr-public-2020-10-30/InitiateLayerUpload) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ecr-public-2020-10-30/InitiateLayerUpload) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ecr-public-2020-10-30/InitiateLayerUpload) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ecr-public-2020-10-30/InitiateLayerUpload) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ecr-public-2020-10-30/InitiateLayerUpload) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ecr-public-2020-10-30/InitiateLayerUpload) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ecr-public-2020-10-30/InitiateLayerUpload) # ListTagsForResource List the tags for an Amazon ECR Public resource. ## Request Syntax ``` { "resourceArn": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [resourceArn](#API_ListTagsForResource_RequestSyntax) ** The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the supported resource is an Amazon ECR Public repository. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes ## Response Syntax ``` { "tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [tags](#API_ListTagsForResource_ResponseSyntax) ** The tags for the resource. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. HTTP Status Code: 400 ** 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. HTTP Status Code: 400 ** ServerException ** These errors are usually caused by a server-side issue. HTTP Status Code: 500 ** UnsupportedCommandException ** The action isn't supported in this Region. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ecr-public-2020-10-30/ListTagsForResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ecr-public-2020-10-30/ListTagsForResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ecr-public-2020-10-30/ListTagsForResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ecr-public-2020-10-30/ListTagsForResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ecr-public-2020-10-30/ListTagsForResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ecr-public-2020-10-30/ListTagsForResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ecr-public-2020-10-30/ListTagsForResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ecr-public-2020-10-30/ListTagsForResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ecr-public-2020-10-30/ListTagsForResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ecr-public-2020-10-30/ListTagsForResource) # PutImage 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. **Note** 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. ## Request Syntax ``` { "imageDigest": "string", "imageManifest": "string", "imageManifestMediaType": "string", "imageTag": "string", "registryId": "string", "repositoryName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [imageDigest](#API_PutImage_RequestSyntax) ** The image digest of the image manifest that corresponds to the image. Type: String Required: No ** [imageManifest](#API_PutImage_RequestSyntax) ** The image manifest that corresponds to the image to be uploaded. Type: String Length Constraints: Minimum length of 1. Maximum length of 4194304. Required: Yes ** [imageManifestMediaType](#API_PutImage_RequestSyntax) ** The media type of the image manifest. If you push an image manifest that doesn't contain the `mediaType` field, you must specify the `imageManifestMediaType` in the request. Type: String Required: No ** [imageTag](#API_PutImage_RequestSyntax) ** The tag to associate with the image. This parameter is optional. Type: String Length Constraints: Minimum length of 1. Maximum length of 300. Required: No ** [registryId](#API_PutImage_RequestSyntax) ** The AWS account ID, or registry alias, that's associated with the public registry that contains the repository where the image is put. If you do not specify a registry, the default public registry is assumed. Type: String Length Constraints: Minimum length of 2. Maximum length of 50. Required: No ** [repositoryName](#API_PutImage_RequestSyntax) ** The name of the repository where the image is put. Type: String Length Constraints: Minimum length of 2. Maximum length of 205. Pattern: `(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*` Required: Yes ## Response Syntax ``` { "image": { "imageId": { "imageDigest": "string", "imageTag": "string" }, "imageManifest": "string", "imageManifestMediaType": "string", "registryId": "string", "repositoryName": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [image](#API_PutImage_ResponseSyntax) ** Details of the image uploaded. Type: [Image](API_Image.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ImageAlreadyExistsException ** The specified image has already been pushed, and there were no changes to the manifest or image tag after the last push. HTTP Status Code: 400 ** ImageDigestDoesNotMatchException ** The specified image digest doesn't match the digest that Amazon ECR calculated for the image. HTTP Status Code: 400 ** ImageTagAlreadyExistsException ** The specified image is tagged with a tag that already exists. The repository is configured for tag immutability. HTTP Status Code: 400 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. HTTP Status Code: 400 ** LayersNotFoundException ** The specified layers can't be found, or the specified layer isn't valid for this repository. HTTP Status Code: 400 ** LimitExceededException ** The operation didn't succeed because it would have exceeded a service limit for your account. For more information, see [Amazon ECR Public service quotas](https://docs.aws.amazon.com/AmazonECR/latest/public/public-service-quotas.html) in the Amazon Elastic Container Registry Public User Guide. HTTP Status Code: 400 ** ReferencedImagesNotFoundException ** The manifest list is referencing an image that doesn't exist. HTTP Status Code: 400 ** RegistryNotFoundException ** The registry doesn't exist. HTTP Status Code: 400 ** 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. HTTP Status Code: 400 ** ServerException ** These errors are usually caused by a server-side issue. HTTP Status Code: 500 ** UnsupportedCommandException ** The action isn't supported in this Region. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ecr-public-2020-10-30/PutImage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ecr-public-2020-10-30/PutImage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ecr-public-2020-10-30/PutImage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ecr-public-2020-10-30/PutImage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ecr-public-2020-10-30/PutImage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ecr-public-2020-10-30/PutImage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ecr-public-2020-10-30/PutImage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ecr-public-2020-10-30/PutImage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ecr-public-2020-10-30/PutImage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ecr-public-2020-10-30/PutImage) # PutRegistryCatalogData Create or update the catalog data for a public registry. ## Request Syntax ``` { "displayName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [displayName](#API_PutRegistryCatalogData_RequestSyntax) ** The display name for a public registry. The display name is shown as the repository author in the Amazon ECR Public Gallery. The registry display name is only publicly visible in the Amazon ECR Public Gallery for verified accounts. Type: String Length Constraints: Minimum length of 0. Maximum length of 100. Required: No ## Response Syntax ``` { "registryCatalogData": { "displayName": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [registryCatalogData](#API_PutRegistryCatalogData_ResponseSyntax) ** The catalog data for the public registry. Type: [RegistryCatalogData](API_RegistryCatalogData.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. HTTP Status Code: 400 ** ServerException ** These errors are usually caused by a server-side issue. HTTP Status Code: 500 ** UnsupportedCommandException ** The action isn't supported in this Region. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ecr-public-2020-10-30/PutRegistryCatalogData) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ecr-public-2020-10-30/PutRegistryCatalogData) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ecr-public-2020-10-30/PutRegistryCatalogData) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ecr-public-2020-10-30/PutRegistryCatalogData) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ecr-public-2020-10-30/PutRegistryCatalogData) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ecr-public-2020-10-30/PutRegistryCatalogData) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ecr-public-2020-10-30/PutRegistryCatalogData) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ecr-public-2020-10-30/PutRegistryCatalogData) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ecr-public-2020-10-30/PutRegistryCatalogData) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ecr-public-2020-10-30/PutRegistryCatalogData) # PutRepositoryCatalogData Creates or updates the catalog data for a repository in a public registry. ## Request Syntax ``` { "catalogData": { "aboutText": "string", "architectures": [ "string" ], "description": "string", "logoImageBlob": blob, "operatingSystems": [ "string" ], "usageText": "string" }, "registryId": "string", "repositoryName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [catalogData](#API_PutRepositoryCatalogData_RequestSyntax) ** An object containing the catalog data for a repository. This data is publicly visible in the Amazon ECR Public Gallery. Type: [RepositoryCatalogDataInput](API_RepositoryCatalogDataInput.md) object Required: Yes ** [registryId](#API_PutRepositoryCatalogData_RequestSyntax) ** The AWS account ID that's associated with the public registry the repository is in. If you do not specify a registry, the default public registry is assumed. Type: String Pattern: `[0-9]{12}` Required: No ** [repositoryName](#API_PutRepositoryCatalogData_RequestSyntax) ** The name of the repository to create or update the catalog data for. Type: String Length Constraints: Minimum length of 2. Maximum length of 205. Pattern: `(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*` Required: Yes ## Response Syntax ``` { "catalogData": { "aboutText": "string", "architectures": [ "string" ], "description": "string", "logoUrl": "string", "marketplaceCertified": boolean, "operatingSystems": [ "string" ], "usageText": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [catalogData](#API_PutRepositoryCatalogData_ResponseSyntax) ** The catalog data for the repository. Type: [RepositoryCatalogData](API_RepositoryCatalogData.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. HTTP Status Code: 400 ** 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. HTTP Status Code: 400 ** ServerException ** These errors are usually caused by a server-side issue. HTTP Status Code: 500 ** UnsupportedCommandException ** The action isn't supported in this Region. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ecr-public-2020-10-30/PutRepositoryCatalogData) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ecr-public-2020-10-30/PutRepositoryCatalogData) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ecr-public-2020-10-30/PutRepositoryCatalogData) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ecr-public-2020-10-30/PutRepositoryCatalogData) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ecr-public-2020-10-30/PutRepositoryCatalogData) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ecr-public-2020-10-30/PutRepositoryCatalogData) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ecr-public-2020-10-30/PutRepositoryCatalogData) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ecr-public-2020-10-30/PutRepositoryCatalogData) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ecr-public-2020-10-30/PutRepositoryCatalogData) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ecr-public-2020-10-30/PutRepositoryCatalogData) # SetRepositoryPolicy Applies a repository policy to the specified public repository to control access permissions. For more information, see [Amazon ECR repository policies](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-policies.html) in the *Amazon Elastic Container Registry Public User Guide*. ## Request Syntax ``` { "force": boolean, "policyText": "string", "registryId": "string", "repositoryName": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [force](#API_SetRepositoryPolicy_RequestSyntax) ** If the policy that you want to set on a repository policy would prevent you from setting another policy in the future, you must force the [SetRepositoryPolicy](#API_SetRepositoryPolicy) operation. This prevents accidental repository lockouts. Type: Boolean Required: No ** [policyText](#API_SetRepositoryPolicy_RequestSyntax) ** The JSON repository policy text to apply to the repository. For more information, see [Amazon ECR repository policies](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-policies.html) in the *Amazon Elastic Container Registry Public User Guide*. Type: String Length Constraints: Minimum length of 0. Maximum length of 10240. Required: Yes ** [registryId](#API_SetRepositoryPolicy_RequestSyntax) ** The AWS account ID that's associated with the registry that contains the repository. If you do not specify a registry, the default public registry is assumed. Type: String Pattern: `[0-9]{12}` Required: No ** [repositoryName](#API_SetRepositoryPolicy_RequestSyntax) ** The name of the repository to receive the policy. Type: String Length Constraints: Minimum length of 2. Maximum length of 205. Pattern: `(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*` Required: Yes ## Response Syntax ``` { "policyText": "string", "registryId": "string", "repositoryName": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [policyText](#API_SetRepositoryPolicy_ResponseSyntax) ** The JSON repository policy text that's applied to the repository. Type: String Length Constraints: Minimum length of 0. Maximum length of 10240. ** [registryId](#API_SetRepositoryPolicy_ResponseSyntax) ** The registry ID that's associated with the request. Type: String Pattern: `[0-9]{12}` ** [repositoryName](#API_SetRepositoryPolicy_ResponseSyntax) ** The repository name that's associated with the request. Type: String Length Constraints: Minimum length of 2. Maximum length of 205. Pattern: `(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. HTTP Status Code: 400 ** 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. HTTP Status Code: 400 ** ServerException ** These errors are usually caused by a server-side issue. HTTP Status Code: 500 ** UnsupportedCommandException ** The action isn't supported in this Region. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ecr-public-2020-10-30/SetRepositoryPolicy) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ecr-public-2020-10-30/SetRepositoryPolicy) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ecr-public-2020-10-30/SetRepositoryPolicy) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ecr-public-2020-10-30/SetRepositoryPolicy) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ecr-public-2020-10-30/SetRepositoryPolicy) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ecr-public-2020-10-30/SetRepositoryPolicy) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ecr-public-2020-10-30/SetRepositoryPolicy) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ecr-public-2020-10-30/SetRepositoryPolicy) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ecr-public-2020-10-30/SetRepositoryPolicy) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ecr-public-2020-10-30/SetRepositoryPolicy) # TagResource 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. ## Request Syntax ``` { "resourceArn": "string", "tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [resourceArn](#API_TagResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the resource to add tags to. Currently, the supported resource is an Amazon ECR Public repository. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes ** [tags](#API_TagResource_RequestSyntax) ** 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. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. HTTP Status Code: 400 ** 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. HTTP Status Code: 400 ** 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. HTTP Status Code: 400 ** ServerException ** These errors are usually caused by a server-side issue. HTTP Status Code: 500 ** 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. HTTP Status Code: 400 ** UnsupportedCommandException ** The action isn't supported in this Region. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ecr-public-2020-10-30/TagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ecr-public-2020-10-30/TagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ecr-public-2020-10-30/TagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ecr-public-2020-10-30/TagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ecr-public-2020-10-30/TagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ecr-public-2020-10-30/TagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ecr-public-2020-10-30/TagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ecr-public-2020-10-30/TagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ecr-public-2020-10-30/TagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ecr-public-2020-10-30/TagResource) # UntagResource Deletes specified tags from a resource. ## Request Syntax ``` { "resourceArn": "string", "tagKeys": [ "string" ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [resourceArn](#API_UntagResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the resource to delete tags from. Currently, the supported resource is an Amazon ECR Public repository. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes ** [tagKeys](#API_UntagResource_RequestSyntax) ** The keys of the tags to be removed. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 200 items. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. HTTP Status Code: 400 ** 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. HTTP Status Code: 400 ** 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. HTTP Status Code: 400 ** ServerException ** These errors are usually caused by a server-side issue. HTTP Status Code: 500 ** 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. HTTP Status Code: 400 ** UnsupportedCommandException ** The action isn't supported in this Region. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ecr-public-2020-10-30/UntagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ecr-public-2020-10-30/UntagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ecr-public-2020-10-30/UntagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ecr-public-2020-10-30/UntagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ecr-public-2020-10-30/UntagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ecr-public-2020-10-30/UntagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ecr-public-2020-10-30/UntagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ecr-public-2020-10-30/UntagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ecr-public-2020-10-30/UntagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ecr-public-2020-10-30/UntagResource) # UploadLayerPart 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. **Note** 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. ## Request Syntax ``` { "layerPartBlob": blob, "partFirstByte": number, "partLastByte": number, "registryId": "string", "repositoryName": "string", "uploadId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [layerPartBlob](#API_UploadLayerPart_RequestSyntax) ** The base64-encoded layer part payload. Type: Base64-encoded binary data object Length Constraints: Minimum length of 0. Maximum length of 20971520. Required: Yes ** [partFirstByte](#API_UploadLayerPart_RequestSyntax) ** The position of the first byte of the layer part witin the overall image layer. Type: Long Valid Range: Minimum value of 0. Required: Yes ** [partLastByte](#API_UploadLayerPart_RequestSyntax) ** The position of the last byte of the layer part within the overall image layer. Type: Long Valid Range: Minimum value of 0. Required: Yes ** [registryId](#API_UploadLayerPart_RequestSyntax) ** The AWS account ID, or registry alias, that's associated with the registry that you're uploading layer parts to. If you do not specify a registry, the default public registry is assumed. Type: String Length Constraints: Minimum length of 2. Maximum length of 50. Required: No ** [repositoryName](#API_UploadLayerPart_RequestSyntax) ** The name of the repository that you're uploading layer parts to. Type: String Length Constraints: Minimum length of 2. Maximum length of 205. Pattern: `(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*` Required: Yes ** [uploadId](#API_UploadLayerPart_RequestSyntax) ** The upload ID from a previous [InitiateLayerUpload](API_InitiateLayerUpload.md) operation to associate with the layer part upload. Type: String Pattern: `[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}` Required: Yes ## Response Syntax ``` { "lastByteReceived": number, "registryId": "string", "repositoryName": "string", "uploadId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [lastByteReceived](#API_UploadLayerPart_ResponseSyntax) ** The integer value of the last byte that's received in the request. Type: Long Valid Range: Minimum value of 0. ** [registryId](#API_UploadLayerPart_ResponseSyntax) ** The registry ID that's associated with the request. Type: String Pattern: `[0-9]{12}` ** [repositoryName](#API_UploadLayerPart_ResponseSyntax) ** The repository name that's associated with the request. Type: String Length Constraints: Minimum length of 2. Maximum length of 205. Pattern: `(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*` ** [uploadId](#API_UploadLayerPart_ResponseSyntax) ** The upload ID that's associated with the request. Type: String Pattern: `[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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. ** lastValidByteReceived ** The position of the last byte of the layer part. ** registryId ** The AWS account ID that's associated with the layer part. ** repositoryName ** The name of the repository. ** uploadId ** The upload ID that's associated with the layer part. HTTP Status Code: 400 ** InvalidParameterException ** The specified parameter is invalid. Review the available parameters for the API request. HTTP Status Code: 400 ** LimitExceededException ** The operation didn't succeed because it would have exceeded a service limit for your account. For more information, see [Amazon ECR Public service quotas](https://docs.aws.amazon.com/AmazonECR/latest/public/public-service-quotas.html) in the Amazon Elastic Container Registry Public User Guide. HTTP Status Code: 400 ** RegistryNotFoundException ** The registry doesn't exist. HTTP Status Code: 400 ** 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. HTTP Status Code: 400 ** ServerException ** These errors are usually caused by a server-side issue. HTTP Status Code: 500 ** UnsupportedCommandException ** The action isn't supported in this Region. HTTP Status Code: 400 ** UploadNotFoundException ** The upload can't be found, or the specified upload ID isn't valid for this repository. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ecr-public-2020-10-30/UploadLayerPart) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ecr-public-2020-10-30/UploadLayerPart) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ecr-public-2020-10-30/UploadLayerPart) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ecr-public-2020-10-30/UploadLayerPart) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ecr-public-2020-10-30/UploadLayerPart) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ecr-public-2020-10-30/UploadLayerPart) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ecr-public-2020-10-30/UploadLayerPart) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ecr-public-2020-10-30/UploadLayerPart) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ecr-public-2020-10-30/UploadLayerPart) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ecr-public-2020-10-30/UploadLayerPart)