There are more AWS SDK examples available in the [AWS Doc SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples) GitHub repo.
# Actions for Amazon ECR using AWS SDKs
The following code examples demonstrate how to perform individual Amazon ECR actions with AWS SDKs. Each example includes a link to GitHub, where you can find instructions for setting up and running the code.
These excerpts call the Amazon ECR API and are code excerpts from larger programs that must be run in context. You can see actions in context in [Scenarios for Amazon ECR using AWS SDKs](ecr_code_examples_scenarios.md).
The following examples include only the most commonly used actions. For a complete list, see the [Amazon Elastic Container Registry API Reference](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/Welcome.html).
**Topics**
+ [`CreateRepository`](ecr_example_ecr_CreateRepository_section.md)
+ [`DeleteRepository`](ecr_example_ecr_DeleteRepository_section.md)
+ [`DescribeImages`](ecr_example_ecr_DescribeImages_section.md)
+ [`DescribeRepositories`](ecr_example_ecr_DescribeRepositories_section.md)
+ [`GetAuthorizationToken`](ecr_example_ecr_GetAuthorizationToken_section.md)
+ [`GetRepositoryPolicy`](ecr_example_ecr_GetRepositoryPolicy_section.md)
+ [`ListImages`](ecr_example_ecr_ListImages_section.md)
+ [`PushImageCmd`](ecr_example_ecr_PushImageCmd_section.md)
+ [`PutLifeCyclePolicy`](ecr_example_ecr_PutLifeCyclePolicy_section.md)
+ [`SetRepositoryPolicy`](ecr_example_ecr_SetRepositoryPolicy_section.md)
+ [`StartLifecyclePolicyPreview`](ecr_example_ecr_StartLifecyclePolicyPreview_section.md)
# Use `CreateRepository` with an AWS SDK or CLI
The following code examples show how to use `CreateRepository`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code examples:
+ [Learn the basics](ecr_example_ecr_Scenario_RepositoryManagement_section.md)
+ [Getting started with Amazon ECR](ecr_example_ecr_GettingStarted_078_section.md)
------
#### [ CLI ]
**AWS CLI**
**Example 1: To create a repository**
The following `create-repository` example creates a repository inside the specified namespace in the default registry for an account.
```
aws ecr create-repository \
--repository-name project-a/sample-repo
```
Output:
```
{
"repository": {
"registryId": "123456789012",
"repositoryName": "project-a/sample-repo",
"repositoryArn": "arn:aws:ecr:us-west-2:123456789012:repository/project-a/sample-repo"
}
}
```
For more information, see [Creating a Repository](https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-create.html) in the *Amazon ECR User Guide*.
**Example 2: To create a repository configured with image tag immutability**
The following `create-repository` example creates a repository configured for tag immutability in the default registry for an account.
```
aws ecr create-repository \
--repository-name project-a/sample-repo \
--image-tag-mutability IMMUTABLE
```
Output:
```
{
"repository": {
"registryId": "123456789012",
"repositoryName": "project-a/sample-repo",
"repositoryArn": "arn:aws:ecr:us-west-2:123456789012:repository/project-a/sample-repo",
"imageTagMutability": "IMMUTABLE"
}
}
```
For more information, see [Image Tag Mutability](https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-tag-mutability.html) in the *Amazon ECR User Guide*.
**Example 3: To create a repository configured with a scanning configuration**
The following `create-repository` example creates a repository configured to perform a vulnerability scan on image push in the default registry for an account.
```
aws ecr create-repository \
--repository-name project-a/sample-repo \
--image-scanning-configuration scanOnPush=true
```
Output:
```
{
"repository": {
"registryId": "123456789012",
"repositoryName": "project-a/sample-repo",
"repositoryArn": "arn:aws:ecr:us-west-2:123456789012:repository/project-a/sample-repo",
"imageScanningConfiguration": {
"scanOnPush": true
}
}
}
```
For more information, see [Image Scanning](https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning.html) in the *Amazon ECR User Guide*.
+ For API details, see [CreateRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/create-repository.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/ecr#code-examples).
```
/**
* Creates an Amazon Elastic Container Registry (Amazon ECR) repository.
*
* @param repoName the name of the repository to create.
* @return the Amazon Resource Name (ARN) of the created repository, or an empty string if the operation failed.
* @throws IllegalArgumentException If repository name is invalid.
* @throws RuntimeException if an error occurs while creating the repository.
*/
public String createECRRepository(String repoName) {
if (repoName == null || repoName.isEmpty()) {
throw new IllegalArgumentException("Repository name cannot be null or empty");
}
CreateRepositoryRequest request = CreateRepositoryRequest.builder()
.repositoryName(repoName)
.build();
CompletableFuture response = getAsyncClient().createRepository(request);
try {
CreateRepositoryResponse result = response.join();
if (result != null) {
System.out.println("The " + repoName + " repository was created successfully.");
return result.repository().repositoryArn();
} else {
throw new RuntimeException("Unexpected response type");
}
} catch (CompletionException e) {
Throwable cause = e.getCause();
if (cause instanceof EcrException ex) {
if ("RepositoryAlreadyExistsException".equals(ex.awsErrorDetails().errorCode())) {
System.out.println("The Amazon ECR repository already exists, moving on...");
DescribeRepositoriesRequest describeRequest = DescribeRepositoriesRequest.builder()
.repositoryNames(repoName)
.build();
DescribeRepositoriesResponse describeResponse = getAsyncClient().describeRepositories(describeRequest).join();
return describeResponse.repositories().get(0).repositoryArn();
} else {
throw new RuntimeException(ex);
}
} else {
throw new RuntimeException(e);
}
}
}
```
+ For API details, see [CreateRepository](https://docs.aws.amazon.com/goto/SdkForJavaV2/ecr-2015-09-21/CreateRepository) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/ecr#code-examples).
```
/**
* Creates an Amazon Elastic Container Registry (Amazon ECR) repository.
*
* @param repoName the name of the repository to create.
* @return the Amazon Resource Name (ARN) of the created repository, or an empty string if the operation failed.
* @throws RepositoryAlreadyExistsException if the repository exists.
* @throws EcrException if an error occurs while creating the repository.
*/
suspend fun createECRRepository(repoName: String?): String? {
val request =
CreateRepositoryRequest {
repositoryName = repoName
}
return try {
EcrClient.fromEnvironment { region = "us-east-1" }.use { ecrClient ->
val response = ecrClient.createRepository(request)
response.repository?.repositoryArn
}
} catch (e: RepositoryAlreadyExistsException) {
println("Repository already exists: $repoName")
repoName?.let { getRepoARN(it) }
} catch (e: EcrException) {
println("An error occurred: ${e.message}")
null
}
}
```
+ For API details, see [CreateRepository](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/ecr#code-examples).
```
class ECRWrapper:
def __init__(self, ecr_client: client):
self.ecr_client = ecr_client
@classmethod
def from_client(cls) -> "ECRWrapper":
"""
Creates a ECRWrapper instance with a default Amazon ECR client.
:return: An instance of ECRWrapper initialized with the default Amazon ECR client.
"""
ecr_client = boto3.client("ecr")
return cls(ecr_client)
def create_repository(self, repository_name: str) -> dict[str, any]:
"""
Creates an ECR repository.
:param repository_name: The name of the repository to create.
:return: A dictionary of the created repository.
"""
try:
response = self.ecr_client.create_repository(repositoryName=repository_name)
return response["repository"]
except ClientError as err:
if err.response["Error"]["Code"] == "RepositoryAlreadyExistsException":
print(f"Repository {repository_name} already exists.")
response = self.ecr_client.describe_repositories(
repositoryNames=[repository_name]
)
return self.describe_repositories([repository_name])[0]
else:
logger.error(
"Error creating repository %s. Here's why %s",
repository_name,
err.response["Error"]["Message"],
)
raise
```
+ For API details, see [CreateRepository](https://docs.aws.amazon.com/goto/boto3/ecr-2015-09-21/CreateRepository) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ecr#code-examples).
```
TRY.
" iv_repository_name = 'my-repository'
oo_result = lo_ecr->createrepository(
iv_repositoryname = iv_repository_name ).
DATA(lv_repository_uri) = oo_result->get_repository( )->get_repositoryuri( ).
MESSAGE |Repository created with URI: { lv_repository_uri }| TYPE 'I'.
CATCH /aws1/cx_ecrrepositoryalrexex.
" If repository already exists, retrieve it
DATA lt_repo_names TYPE /aws1/cl_ecrrepositorynamels00=>tt_repositorynamelist.
APPEND NEW /aws1/cl_ecrrepositorynamels00( iv_value = iv_repository_name ) TO lt_repo_names.
DATA(lo_describe_result) = lo_ecr->describerepositories( it_repositorynames = lt_repo_names ).
DATA(lt_repos) = lo_describe_result->get_repositories( ).
IF lines( lt_repos ) > 0.
READ TABLE lt_repos INDEX 1 INTO DATA(lo_repo).
oo_result = NEW /aws1/cl_ecrcrerepositoryrsp( io_repository = lo_repo ).
MESSAGE |Repository { iv_repository_name } already exists.| TYPE 'I'.
ENDIF.
ENDTRY.
```
+ For API details, see [CreateRepository](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `DeleteRepository` with an AWS SDK or CLI
The following code examples show how to use `DeleteRepository`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code examples:
+ [Learn the basics](ecr_example_ecr_Scenario_RepositoryManagement_section.md)
+ [Getting started with Amazon ECR](ecr_example_ecr_GettingStarted_078_section.md)
------
#### [ CLI ]
**AWS CLI**
**To delete a repository**
The following `delete-repository` example command force deletes the specified repository in the default registry for an account. The `--force` flag is required if the repository contains images.
```
aws ecr delete-repository \
--repository-name ubuntu \
--force
```
Output:
```
{
"repository": {
"registryId": "123456789012",
"repositoryName": "ubuntu",
"repositoryArn": "arn:aws:ecr:us-west-2:123456789012:repository/ubuntu"
}
}
```
For more information, see [Deleting a Repository](https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-delete.html) in the *Amazon ECR User Guide*.
+ For API details, see [DeleteRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/delete-repository.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/ecr#code-examples).
```
/**
* Deletes an ECR (Elastic Container Registry) repository.
*
* @param repoName the name of the repository to delete.
* @throws IllegalArgumentException if the repository name is null or empty.
* @throws EcrException if there is an error deleting the repository.
* @throws RuntimeException if an unexpected error occurs during the deletion process.
*/
public void deleteECRRepository(String repoName) {
if (repoName == null || repoName.isEmpty()) {
throw new IllegalArgumentException("Repository name cannot be null or empty");
}
DeleteRepositoryRequest repositoryRequest = DeleteRepositoryRequest.builder()
.force(true)
.repositoryName(repoName)
.build();
CompletableFuture response = getAsyncClient().deleteRepository(repositoryRequest);
response.whenComplete((deleteRepositoryResponse, ex) -> {
if (deleteRepositoryResponse != null) {
System.out.println("You have successfully deleted the " + repoName + " repository");
} else {
Throwable cause = ex.getCause();
if (cause instanceof EcrException) {
throw (EcrException) cause;
} else {
throw new RuntimeException("Unexpected error: " + cause.getMessage(), cause);
}
}
});
// Wait for the CompletableFuture to complete
response.join();
}
```
+ For API details, see [DeleteRepository](https://docs.aws.amazon.com/goto/SdkForJavaV2/ecr-2015-09-21/DeleteRepository) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/ecr#code-examples).
```
/**
* Deletes an ECR (Elastic Container Registry) repository.
*
* @param repoName the name of the repository to delete.
*/
suspend fun deleteECRRepository(repoName: String) {
if (repoName.isNullOrEmpty()) {
throw IllegalArgumentException("Repository name cannot be null or empty")
}
val repositoryRequest =
DeleteRepositoryRequest {
force = true
repositoryName = repoName
}
EcrClient.fromEnvironment { region = "us-east-1" }.use { ecrClient ->
ecrClient.deleteRepository(repositoryRequest)
println("You have successfully deleted the $repoName repository")
}
}
```
+ For API details, see [DeleteRepository](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/ecr#code-examples).
```
class ECRWrapper:
def __init__(self, ecr_client: client):
self.ecr_client = ecr_client
@classmethod
def from_client(cls) -> "ECRWrapper":
"""
Creates a ECRWrapper instance with a default Amazon ECR client.
:return: An instance of ECRWrapper initialized with the default Amazon ECR client.
"""
ecr_client = boto3.client("ecr")
return cls(ecr_client)
def delete_repository(self, repository_name: str):
"""
Deletes an ECR repository.
:param repository_name: The name of the repository to delete.
"""
try:
self.ecr_client.delete_repository(
repositoryName=repository_name, force=True
)
print(f"Deleted repository {repository_name}.")
except ClientError as err:
logger.error(
"Couldn't delete repository %s.. Here's why %s",
repository_name,
err.response["Error"]["Message"],
)
raise
```
+ For API details, see [DeleteRepository](https://docs.aws.amazon.com/goto/boto3/ecr-2015-09-21/DeleteRepository) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ecr#code-examples).
```
TRY.
" iv_repository_name = 'my-repository'
lo_ecr->deleterepository(
iv_repositoryname = iv_repository_name
iv_force = abap_true ).
MESSAGE |Repository { iv_repository_name } deleted.| TYPE 'I'.
CATCH /aws1/cx_ecrrepositorynotfndex.
MESSAGE 'Repository not found.' TYPE 'I'.
ENDTRY.
```
+ For API details, see [DeleteRepository](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `DescribeImages` with an AWS SDK or CLI
The following code examples show how to use `DescribeImages`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Learn the basics](ecr_example_ecr_Scenario_RepositoryManagement_section.md)
------
#### [ CLI ]
**AWS CLI**
**To describe an image in a repository**
The following `describe-images` example displays details about an image in the `cluster-autoscaler` repository with the tag `v1.13.6`.
```
aws ecr describe-images \
--repository-name cluster-autoscaler \
--image-ids imageTag=v1.13.6
```
Output:
```
{
"imageDetails": [
{
"registryId": "012345678910",
"repositoryName": "cluster-autoscaler",
"imageDigest": "sha256:4a1c6567c38904384ebc64e35b7eeddd8451110c299e3368d2210066487d97e5",
"imageTags": [
"v1.13.6"
],
"imageSizeInBytes": 48318255,
"imagePushedAt": 1565128275.0
}
]
}
```
+ For API details, see [DescribeImages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/describe-images.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/ecr#code-examples).
```
/**
* Verifies the existence of an image in an Amazon Elastic Container Registry (Amazon ECR) repository asynchronously.
*
* @param repositoryName The name of the Amazon ECR repository.
* @param imageTag The tag of the image to verify.
* @throws EcrException if there is an error retrieving the image information from Amazon ECR.
* @throws CompletionException if the asynchronous operation completes exceptionally.
*/
public void verifyImage(String repositoryName, String imageTag) {
DescribeImagesRequest request = DescribeImagesRequest.builder()
.repositoryName(repositoryName)
.imageIds(ImageIdentifier.builder().imageTag(imageTag).build())
.build();
CompletableFuture response = getAsyncClient().describeImages(request);
response.whenComplete((describeImagesResponse, ex) -> {
if (ex != null) {
if (ex instanceof CompletionException) {
Throwable cause = ex.getCause();
if (cause instanceof EcrException) {
throw (EcrException) cause;
} else {
throw new RuntimeException("Unexpected error: " + cause.getMessage(), cause);
}
} else {
throw new RuntimeException("Unexpected error: " + ex.getCause());
}
} else if (describeImagesResponse != null && !describeImagesResponse.imageDetails().isEmpty()) {
System.out.println("Image is present in the repository.");
} else {
System.out.println("Image is not present in the repository.");
}
});
// Wait for the CompletableFuture to complete.
response.join();
}
```
+ For API details, see [DescribeImages](https://docs.aws.amazon.com/goto/SdkForJavaV2/ecr-2015-09-21/DescribeImages) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/ecr#code-examples).
```
/**
* Verifies the existence of an image in an Amazon Elastic Container Registry (Amazon ECR) repository asynchronously.
*
* @param repositoryName The name of the Amazon ECR repository.
* @param imageTag The tag of the image to verify.
*/
suspend fun verifyImage(
repoName: String?,
imageTagVal: String?,
) {
require(!(repoName == null || repoName.isEmpty())) { "Repository name cannot be null or empty" }
require(!(imageTagVal == null || imageTagVal.isEmpty())) { "Image tag cannot be null or empty" }
val imageId =
ImageIdentifier {
imageTag = imageTagVal
}
val request =
DescribeImagesRequest {
repositoryName = repoName
imageIds = listOf(imageId)
}
EcrClient.fromEnvironment { region = "us-east-1" }.use { ecrClient ->
val describeImagesResponse = ecrClient.describeImages(request)
if (describeImagesResponse != null && !describeImagesResponse.imageDetails?.isEmpty()!!) {
println("Image is present in the repository.")
} else {
println("Image is not present in the repository.")
}
}
}
```
+ For API details, see [DescribeImages](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/ecr#code-examples).
```
class ECRWrapper:
def __init__(self, ecr_client: client):
self.ecr_client = ecr_client
@classmethod
def from_client(cls) -> "ECRWrapper":
"""
Creates a ECRWrapper instance with a default Amazon ECR client.
:return: An instance of ECRWrapper initialized with the default Amazon ECR client.
"""
ecr_client = boto3.client("ecr")
return cls(ecr_client)
def describe_images(
self, repository_name: str, image_ids: list[str] = None
) -> list[dict]:
"""
Describes ECR images.
:param repository_name: The name of the repository to describe images for.
:param image_ids: The optional IDs of images to describe.
:return: The list of image descriptions.
"""
try:
params = {
"repositoryName": repository_name,
}
if image_ids is not None:
params["imageIds"] = [{"imageTag": tag} for tag in image_ids]
paginator = self.ecr_client.get_paginator("describe_images")
image_descriptions = []
for page in paginator.paginate(**params):
image_descriptions.extend(page["imageDetails"])
return image_descriptions
except ClientError as err:
logger.error(
"Couldn't describe images. Here's why %s",
err.response["Error"]["Message"],
)
raise
```
+ For API details, see [DescribeImages](https://docs.aws.amazon.com/goto/boto3/ecr-2015-09-21/DescribeImages) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ecr#code-examples).
```
TRY.
" iv_repository_name = 'my-repository'
" it_image_ids = VALUE #( ( NEW /aws1/cl_ecrimageidentifier( iv_imagetag = 'latest' ) ) )
IF it_image_ids IS NOT INITIAL.
oo_result = lo_ecr->describeimages(
iv_repositoryname = iv_repository_name
it_imageids = it_image_ids ).
ELSE.
oo_result = lo_ecr->describeimages(
iv_repositoryname = iv_repository_name ).
ENDIF.
DATA(lt_image_details) = oo_result->get_imagedetails( ).
MESSAGE |Found { lines( lt_image_details ) } images in repository.| TYPE 'I'.
CATCH /aws1/cx_ecrrepositorynotfndex.
MESSAGE 'Repository not found.' TYPE 'I'.
CATCH /aws1/cx_ecrimagenotfoundex.
MESSAGE 'Image not found.' TYPE 'I'.
CATCH /aws1/cx_ecrinvalidparameterex.
MESSAGE 'Invalid parameter provided.' TYPE 'I'.
ENDTRY.
```
+ For API details, see [DescribeImages](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `DescribeRepositories` with an AWS SDK or CLI
The following code examples show how to use `DescribeRepositories`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Learn the basics](ecr_example_ecr_Scenario_RepositoryManagement_section.md)
------
#### [ CLI ]
**AWS CLI**
**To describe the repositories in a registry**
This example describes the repositories in the default registry for an account.
Command:
```
aws ecr describe-repositories
```
Output:
```
{
"repositories": [
{
"registryId": "012345678910",
"repositoryName": "ubuntu",
"repositoryArn": "arn:aws:ecr:us-west-2:012345678910:repository/ubuntu"
},
{
"registryId": "012345678910",
"repositoryName": "test",
"repositoryArn": "arn:aws:ecr:us-west-2:012345678910:repository/test"
}
]
}
```
+ For API details, see [DescribeRepositories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/describe-repositories.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/ecr#code-examples).
```
/**
* Retrieves the repository URI for the specified repository name.
*
* @param repoName the name of the repository to retrieve the URI for.
* @return the repository URI for the specified repository name.
* @throws EcrException if there is an error retrieving the repository information.
* @throws CompletionException if the asynchronous operation completes exceptionally.
*/
public void getRepositoryURI(String repoName) {
DescribeRepositoriesRequest request = DescribeRepositoriesRequest.builder()
.repositoryNames(repoName)
.build();
CompletableFuture response = getAsyncClient().describeRepositories(request);
response.whenComplete((describeRepositoriesResponse, ex) -> {
if (ex != null) {
Throwable cause = ex.getCause();
if (cause instanceof InterruptedException) {
Thread.currentThread().interrupt();
String errorMessage = "Thread interrupted while waiting for asynchronous operation: " + cause.getMessage();
throw new RuntimeException(errorMessage, cause);
} else if (cause instanceof EcrException) {
throw (EcrException) cause;
} else {
String errorMessage = "Unexpected error: " + cause.getMessage();
throw new RuntimeException(errorMessage, cause);
}
} else {
if (describeRepositoriesResponse != null) {
if (!describeRepositoriesResponse.repositories().isEmpty()) {
String repositoryUri = describeRepositoriesResponse.repositories().get(0).repositoryUri();
System.out.println("Repository URI found: " + repositoryUri);
} else {
System.out.println("No repositories found for the given name.");
}
} else {
System.err.println("No response received from describeRepositories.");
}
}
});
response.join();
}
```
+ For API details, see [DescribeRepositories](https://docs.aws.amazon.com/goto/SdkForJavaV2/ecr-2015-09-21/DescribeRepositories) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/ecr#code-examples).
```
/**
* Retrieves the repository URI for the specified repository name.
*
* @param repoName the name of the repository to retrieve the URI for.
* @return the repository URI for the specified repository name.
*/
suspend fun getRepositoryURI(repoName: String?): String? {
require(!(repoName == null || repoName.isEmpty())) { "Repository name cannot be null or empty" }
val request =
DescribeRepositoriesRequest {
repositoryNames = listOf(repoName)
}
EcrClient.fromEnvironment { region = "us-east-1" }.use { ecrClient ->
val describeRepositoriesResponse = ecrClient.describeRepositories(request)
if (!describeRepositoriesResponse.repositories?.isEmpty()!!) {
return describeRepositoriesResponse?.repositories?.get(0)?.repositoryUri
} else {
println("No repositories found for the given name.")
return ""
}
}
}
```
+ For API details, see [DescribeRepositories](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/ecr#code-examples).
```
class ECRWrapper:
def __init__(self, ecr_client: client):
self.ecr_client = ecr_client
@classmethod
def from_client(cls) -> "ECRWrapper":
"""
Creates a ECRWrapper instance with a default Amazon ECR client.
:return: An instance of ECRWrapper initialized with the default Amazon ECR client.
"""
ecr_client = boto3.client("ecr")
return cls(ecr_client)
def describe_repositories(self, repository_names: list[str]) -> list[dict]:
"""
Describes ECR repositories.
:param repository_names: The names of the repositories to describe.
:return: The list of repository descriptions.
"""
try:
response = self.ecr_client.describe_repositories(
repositoryNames=repository_names
)
return response["repositories"]
except ClientError as err:
logger.error(
"Couldn't describe repositories. Here's why %s",
err.response["Error"]["Message"],
)
raise
```
+ For API details, see [DescribeRepositories](https://docs.aws.amazon.com/goto/boto3/ecr-2015-09-21/DescribeRepositories) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ Rust ]
**SDK for Rust**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/ecr#code-examples).
```
async fn show_repos(client: &aws_sdk_ecr::Client) -> Result<(), aws_sdk_ecr::Error> {
let rsp = client.describe_repositories().send().await?;
let repos = rsp.repositories();
println!("Found {} repositories:", repos.len());
for repo in repos {
println!(" ARN: {}", repo.repository_arn().unwrap());
println!(" Name: {}", repo.repository_name().unwrap());
}
Ok(())
}
```
+ For API details, see [DescribeRepositories](https://docs.rs/aws-sdk-ecr/latest/aws_sdk_ecr/client/struct.Client.html#method.describe_repositories) in *AWS SDK for Rust API reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ecr#code-examples).
```
TRY.
" it_repository_names = VALUE #( ( NEW /aws1/cl_ecrrepositorynamels00( iv_value = 'my-repository' ) ) )
oo_result = lo_ecr->describerepositories(
it_repositorynames = it_repository_names ).
DATA(lt_repositories) = oo_result->get_repositories( ).
MESSAGE |Found { lines( lt_repositories ) } repositories.| TYPE 'I'.
CATCH /aws1/cx_ecrrepositorynotfndex.
MESSAGE 'Repository not found.' TYPE 'I'.
ENDTRY.
```
+ For API details, see [DescribeRepositories](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `GetAuthorizationToken` with an AWS SDK or CLI
The following code examples show how to use `GetAuthorizationToken`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Learn the basics](ecr_example_ecr_Scenario_RepositoryManagement_section.md)
------
#### [ CLI ]
**AWS CLI**
**To get an authorization token for your default registry**
The following `get-authorization-token` example command gets an authorization token for your default registry.
```
aws ecr get-authorization-token
```
Output:
```
{
"authorizationData": [
{
"authorizationToken": "QVdTOkN...",
"expiresAt": 1448875853.241,
"proxyEndpoint": "https://123456789012.dkr.ecr.us-west-2.amazonaws.com"
}
]
}
```
+ For API details, see [GetAuthorizationToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/get-authorization-token.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/ecr#code-examples).
```
/**
* Retrieves the authorization token for Amazon Elastic Container Registry (ECR).
* This method makes an asynchronous call to the ECR client to retrieve the authorization token.
* If the operation is successful, the method prints the token to the console.
* If an exception occurs, the method handles the exception and prints the error message.
*
* @throws EcrException if there is an error retrieving the authorization token from ECR.
* @throws RuntimeException if there is an unexpected error during the operation.
*/
public void getAuthToken() {
CompletableFuture response = getAsyncClient().getAuthorizationToken();
response.whenComplete((authorizationTokenResponse, ex) -> {
if (authorizationTokenResponse != null) {
AuthorizationData authorizationData = authorizationTokenResponse.authorizationData().get(0);
String token = authorizationData.authorizationToken();
if (!token.isEmpty()) {
System.out.println("The token was successfully retrieved.");
}
} else {
if (ex.getCause() instanceof EcrException) {
throw (EcrException) ex.getCause();
} else {
String errorMessage = "Unexpected error occurred: " + ex.getMessage();
throw new RuntimeException(errorMessage, ex); // Rethrow the exception
}
}
});
response.join();
}
```
+ For API details, see [GetAuthorizationToken](https://docs.aws.amazon.com/goto/SdkForJavaV2/ecr-2015-09-21/GetAuthorizationToken) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/ecr#code-examples).
```
/**
* Retrieves the authorization token for Amazon Elastic Container Registry (ECR).
*
*/
suspend fun getAuthToken() {
EcrClient.fromEnvironment { region = "us-east-1" }.use { ecrClient ->
// Retrieve the authorization token for ECR.
val response = ecrClient.getAuthorizationToken()
val authorizationData = response.authorizationData?.get(0)
val token = authorizationData?.authorizationToken
if (token != null) {
println("The token was successfully retrieved.")
}
}
}
```
+ For API details, see [GetAuthorizationToken](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/ecr#code-examples).
```
class ECRWrapper:
def __init__(self, ecr_client: client):
self.ecr_client = ecr_client
@classmethod
def from_client(cls) -> "ECRWrapper":
"""
Creates a ECRWrapper instance with a default Amazon ECR client.
:return: An instance of ECRWrapper initialized with the default Amazon ECR client.
"""
ecr_client = boto3.client("ecr")
return cls(ecr_client)
def get_authorization_token(self) -> str:
"""
Gets an authorization token for an ECR repository.
:return: The authorization token.
"""
try:
response = self.ecr_client.get_authorization_token()
return response["authorizationData"][0]["authorizationToken"]
except ClientError as err:
logger.error(
"Couldn't get authorization token. Here's why %s",
err.response["Error"]["Message"],
)
raise
```
+ For API details, see [GetAuthorizationToken](https://docs.aws.amazon.com/goto/boto3/ecr-2015-09-21/GetAuthorizationToken) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ecr#code-examples).
```
TRY.
oo_result = lo_ecr->getauthorizationtoken( ).
DATA(lt_auth_data) = oo_result->get_authorizationdata( ).
IF lines( lt_auth_data ) > 0.
READ TABLE lt_auth_data INDEX 1 INTO DATA(lo_auth_data).
DATA(lv_token) = lo_auth_data->get_authorizationtoken( ).
MESSAGE 'Authorization token retrieved.' TYPE 'I'.
ENDIF.
CATCH /aws1/cx_ecrserverexception.
MESSAGE 'Server exception occurred.' TYPE 'I'.
ENDTRY.
```
+ For API details, see [GetAuthorizationToken](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `GetRepositoryPolicy` with an AWS SDK or CLI
The following code examples show how to use `GetRepositoryPolicy`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Learn the basics](ecr_example_ecr_Scenario_RepositoryManagement_section.md)
------
#### [ CLI ]
**AWS CLI**
**To retrieve the repository policy for a repository**
The following `get-repository-policy` example displays details about the repository policy for the `cluster-autoscaler` repository.
```
aws ecr get-repository-policy \
--repository-name cluster-autoscaler
```
Output:
```
{
"registryId": "012345678910",
"repositoryName": "cluster-autoscaler",
"policyText": "{\n \"Version\" : \"2008-10-17\",\n \"Statement\" : [ {\n \"Sid\" : \"allow public pull\",\n \"Effect\" : \"Allow\",\n \"Principal\" : \"*\",\n \"Action\" : [ \"ecr:BatchCheckLayerAvailability\", \"ecr:BatchGetImage\", \"ecr:GetDownloadUrlForLayer\" ]\n } ]\n}"
}
```
+ For API details, see [GetRepositoryPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/get-repository-policy.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/ecr#code-examples).
```
/**
* Gets the repository policy for the specified repository.
*
* @param repoName the name of the repository.
* @throws EcrException if an AWS error occurs while getting the repository policy.
*/
public String getRepoPolicy(String repoName) {
if (repoName == null || repoName.isEmpty()) {
throw new IllegalArgumentException("Repository name cannot be null or empty");
}
GetRepositoryPolicyRequest getRepositoryPolicyRequest = GetRepositoryPolicyRequest.builder()
.repositoryName(repoName)
.build();
CompletableFuture response = getAsyncClient().getRepositoryPolicy(getRepositoryPolicyRequest);
response.whenComplete((resp, ex) -> {
if (resp != null) {
System.out.println("Repository policy retrieved successfully.");
} else {
if (ex.getCause() instanceof EcrException) {
throw (EcrException) ex.getCause();
} else {
String errorMessage = "Unexpected error occurred: " + ex.getMessage();
throw new RuntimeException(errorMessage, ex);
}
}
});
GetRepositoryPolicyResponse result = response.join();
return result != null ? result.policyText() : null;
}
```
+ For API details, see [GetRepositoryPolicy](https://docs.aws.amazon.com/goto/SdkForJavaV2/ecr-2015-09-21/GetRepositoryPolicy) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/ecr#code-examples).
```
/**
* Gets the repository policy for the specified repository.
*
* @param repoName the name of the repository.
*/
suspend fun getRepoPolicy(repoName: String?): String? {
require(!(repoName == null || repoName.isEmpty())) { "Repository name cannot be null or empty" }
// Create the request
val getRepositoryPolicyRequest =
GetRepositoryPolicyRequest {
repositoryName = repoName
}
EcrClient.fromEnvironment { region = "us-east-1" }.use { ecrClient ->
val response = ecrClient.getRepositoryPolicy(getRepositoryPolicyRequest)
val responseText = response.policyText
return responseText
}
}
```
+ For API details, see [GetRepositoryPolicy](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/ecr#code-examples).
```
class ECRWrapper:
def __init__(self, ecr_client: client):
self.ecr_client = ecr_client
@classmethod
def from_client(cls) -> "ECRWrapper":
"""
Creates a ECRWrapper instance with a default Amazon ECR client.
:return: An instance of ECRWrapper initialized with the default Amazon ECR client.
"""
ecr_client = boto3.client("ecr")
return cls(ecr_client)
def get_repository_policy(self, repository_name: str) -> str:
"""
Gets the policy for an ECR repository.
:param repository_name: The name of the repository to get the policy for.
:return: The policy text.
"""
try:
response = self.ecr_client.get_repository_policy(
repositoryName=repository_name
)
return response["policyText"]
except ClientError as err:
if err.response["Error"]["Code"] == "RepositoryPolicyNotFoundException":
logger.error("Repository does not exist. %s.", repository_name)
raise
else:
logger.error(
"Couldn't get repository policy for repository %s. Here's why %s",
repository_name,
err.response["Error"]["Message"],
)
raise
```
+ For API details, see [GetRepositoryPolicy](https://docs.aws.amazon.com/goto/boto3/ecr-2015-09-21/GetRepositoryPolicy) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ecr#code-examples).
```
TRY.
" iv_repository_name = 'my-repository'
oo_result = lo_ecr->getrepositorypolicy(
iv_repositoryname = iv_repository_name ).
DATA(lv_policy_text) = oo_result->get_policytext( ).
MESSAGE 'Repository policy retrieved.' TYPE 'I'.
CATCH /aws1/cx_ecrrepositorynotfndex.
MESSAGE 'Repository not found.' TYPE 'I'.
CATCH /aws1/cx_ecrrepositoryplynot00.
MESSAGE 'Repository policy not found.' TYPE 'I'.
ENDTRY.
```
+ For API details, see [GetRepositoryPolicy](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `ListImages` with an AWS SDK or CLI
The following code examples show how to use `ListImages`.
------
#### [ CLI ]
**AWS CLI**
**To list the images in a repository**
The following `list-images` example displays a list of the images in the `cluster-autoscaler` repository.
```
aws ecr list-images \
--repository-name cluster-autoscaler
```
Output:
```
{
"imageIds": [
{
"imageDigest": "sha256:99c6fb4377e9a420a1eb3b410a951c9f464eff3b7dbc76c65e434e39b94b6570",
"imageTag": "v1.13.8"
},
{
"imageDigest": "sha256:99c6fb4377e9a420a1eb3b410a951c9f464eff3b7dbc76c65e434e39b94b6570",
"imageTag": "v1.13.7"
},
{
"imageDigest": "sha256:4a1c6567c38904384ebc64e35b7eeddd8451110c299e3368d2210066487d97e5",
"imageTag": "v1.13.6"
}
]
}
```
+ For API details, see [ListImages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/list-images.html) in *AWS CLI Command Reference*.
------
#### [ Rust ]
**SDK for Rust**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/ecr#code-examples).
```
async fn show_images(
client: &aws_sdk_ecr::Client,
repository: &str,
) -> Result<(), aws_sdk_ecr::Error> {
let rsp = client
.list_images()
.repository_name(repository)
.send()
.await?;
let images = rsp.image_ids();
println!("found {} images", images.len());
for image in images {
println!(
"image: {}:{}",
image.image_tag().unwrap(),
image.image_digest().unwrap()
);
}
Ok(())
}
```
+ For API details, see [ListImages](https://docs.rs/aws-sdk-ecr/latest/aws_sdk_ecr/client/struct.Client.html#method.list_images) in *AWS SDK for Rust API reference*.
------
# Use `PushImageCmd` with an AWS SDK
The following code examples show how to use `PushImageCmd`.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/ecr#code-examples).
```
/**
* Pushes a Docker image to an Amazon Elastic Container Registry (ECR) repository.
*
* @param repoName the name of the ECR repository to push the image to.
* @param imageName the name of the Docker image.
*/
public void pushDockerImage(String repoName, String imageName) {
System.out.println("Pushing " + imageName + " to Amazon ECR will take a few seconds.");
CompletableFuture authResponseFuture = getAsyncClient().getAuthorizationToken()
.thenApply(response -> {
String token = response.authorizationData().get(0).authorizationToken();
String decodedToken = new String(Base64.getDecoder().decode(token));
String password = decodedToken.substring(4);
DescribeRepositoriesResponse descrRepoResponse = getAsyncClient().describeRepositories(b -> b.repositoryNames(repoName)).join();
Repository repoData = descrRepoResponse.repositories().stream().filter(r -> r.repositoryName().equals(repoName)).findFirst().orElse(null);
assert repoData != null;
String registryURL = repoData.repositoryUri().split("/")[0];
AuthConfig authConfig = new AuthConfig()
.withUsername("AWS")
.withPassword(password)
.withRegistryAddress(registryURL);
return authConfig;
})
.thenCompose(authConfig -> {
DescribeRepositoriesResponse descrRepoResponse = getAsyncClient().describeRepositories(b -> b.repositoryNames(repoName)).join();
Repository repoData = descrRepoResponse.repositories().stream().filter(r -> r.repositoryName().equals(repoName)).findFirst().orElse(null);
getDockerClient().tagImageCmd(imageName + ":latest", repoData.repositoryUri() + ":latest", imageName).exec();
try {
getDockerClient().pushImageCmd(repoData.repositoryUri()).withTag("echo-text").withAuthConfig(authConfig).start().awaitCompletion();
System.out.println("The " + imageName + " was pushed to ECR");
} catch (InterruptedException e) {
throw (RuntimeException) e.getCause();
}
return CompletableFuture.completedFuture(authConfig);
});
authResponseFuture.join();
}
```
+ For API details, see [PushImageCmd](https://docs.aws.amazon.com/goto/SdkForJavaV2/ecr-2015-09-21/PushImageCmd) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/ecr#code-examples).
```
/**
* Pushes a Docker image to an Amazon Elastic Container Registry (ECR) repository.
*
* @param repoName the name of the ECR repository to push the image to.
* @param imageName the name of the Docker image.
*/
suspend fun pushDockerImage(
repoName: String,
imageName: String,
) {
println("Pushing $imageName to $repoName will take a few seconds")
val authConfig = getAuthConfig(repoName)
EcrClient.fromEnvironment { region = "us-east-1" }.use { ecrClient ->
val desRequest =
DescribeRepositoriesRequest {
repositoryNames = listOf(repoName)
}
val describeRepoResponse = ecrClient.describeRepositories(desRequest)
val repoData =
describeRepoResponse.repositories?.firstOrNull { it.repositoryName == repoName }
?: throw RuntimeException("Repository not found: $repoName")
val tagImageCmd = getDockerClient()?.tagImageCmd("$imageName", "${repoData.repositoryUri}", imageName)
if (tagImageCmd != null) {
tagImageCmd.exec()
}
val pushImageCmd =
repoData.repositoryUri?.let {
dockerClient?.pushImageCmd(it)
// ?.withTag("latest")
?.withAuthConfig(authConfig)
}
try {
if (pushImageCmd != null) {
pushImageCmd.start().awaitCompletion()
}
println("The $imageName was pushed to Amazon ECR")
} catch (e: IOException) {
throw RuntimeException(e)
}
}
}
```
+ For API details, see [PushImageCmd](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
# Use `PutLifeCyclePolicy` with an AWS SDK or CLI
The following code examples show how to use `PutLifeCyclePolicy`.
------
#### [ CLI ]
**AWS CLI**
**To create a lifecycle policy**
The following `put-lifecycle-policy` example creates a lifecycle policy for the specified repository in the default registry for an account.
```
aws ecr put-lifecycle-policy \
--repository-name "project-a/amazon-ecs-sample" \
--lifecycle-policy-text "file://policy.json"
```
Contents of `policy.json`:
```
{
"rules": [
{
"rulePriority": 1,
"description": "Expire images older than 14 days",
"selection": {
"tagStatus": "untagged",
"countType": "sinceImagePushed",
"countUnit": "days",
"countNumber": 14
},
"action": {
"type": "expire"
}
}
]
}
```
Output:
```
{
"registryId": "",
"repositoryName": "project-a/amazon-ecs-sample",
"lifecyclePolicyText": "{\"rules\":[{\"rulePriority\":1,\"description\":\"Expire images older than 14 days\",\"selection\":{\"tagStatus\":\"untagged\",\"countType\":\"sinceImagePushed\",\"countUnit\":\"days\",\"countNumber\":14},\"action\":{\"type\":\"expire\"}}]}"
}
```
For more information, see [Lifecycle Policies](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html) in the *Amazon ECR User Guide*.
+ For API details, see [PutLifeCyclePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/put-life-cycle-policy.html) in *AWS CLI Command Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/ecr#code-examples).
```
class ECRWrapper:
def __init__(self, ecr_client: client):
self.ecr_client = ecr_client
@classmethod
def from_client(cls) -> "ECRWrapper":
"""
Creates a ECRWrapper instance with a default Amazon ECR client.
:return: An instance of ECRWrapper initialized with the default Amazon ECR client.
"""
ecr_client = boto3.client("ecr")
return cls(ecr_client)
def put_lifecycle_policy(self, repository_name: str, lifecycle_policy_text: str):
"""
Puts a lifecycle policy for an ECR repository.
:param repository_name: The name of the repository to put the lifecycle policy for.
:param lifecycle_policy_text: The lifecycle policy text to put.
"""
try:
self.ecr_client.put_lifecycle_policy(
repositoryName=repository_name,
lifecyclePolicyText=lifecycle_policy_text,
)
print(f"Put lifecycle policy for repository {repository_name}.")
except ClientError as err:
logger.error(
"Couldn't put lifecycle policy for repository %s. Here's why %s",
repository_name,
err.response["Error"]["Message"],
)
raise
```
Example that puts an expiration date policy.
```
def put_expiration_policy(self):
"""
Puts an expiration policy on the ECR repository.
"""
policy_json = {
"rules": [
{
"rulePriority": 1,
"description": "Expire images older than 14 days",
"selection": {
"tagStatus": "any",
"countType": "sinceImagePushed",
"countUnit": "days",
"countNumber": 14,
},
"action": {"type": "expire"},
}
]
}
self.ecr_wrapper.put_lifecycle_policy(
self.repository_name, json.dumps(policy_json)
)
```
+ For API details, see [PutLifeCyclePolicy](https://docs.aws.amazon.com/goto/boto3/ecr-2015-09-21/PutLifeCyclePolicy) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ecr#code-examples).
```
TRY.
" iv_repository_name = 'my-repository'
" iv_lifecycle_policy_text = '{"rules":[{"rulePriority":1,"description":"Expire images older than 14 days",...}]}'
lo_ecr->putlifecyclepolicy(
iv_repositoryname = iv_repository_name
iv_lifecyclepolicytext = iv_lifecycle_policy_text ).
MESSAGE |Lifecycle policy set for repository { iv_repository_name }.| TYPE 'I'.
CATCH /aws1/cx_ecrrepositorynotfndex.
MESSAGE 'Repository not found.' TYPE 'I'.
CATCH /aws1/cx_ecrvalidationex.
MESSAGE 'Invalid lifecycle policy format.' TYPE 'I'.
ENDTRY.
```
+ For API details, see [PutLifeCyclePolicy](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `SetRepositoryPolicy` with an AWS SDK or CLI
The following code examples show how to use `SetRepositoryPolicy`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Learn the basics](ecr_example_ecr_Scenario_RepositoryManagement_section.md)
------
#### [ CLI ]
**AWS CLI**
**To set the repository policy for a repository**
The following `set-repository-policy` example attaches a repository policy contained in a file to the `cluster-autoscaler` repository.
```
aws ecr set-repository-policy \
--repository-name cluster-autoscaler \
--policy-text file://my-policy.json
```
Contents of `my-policy.json`:
```
{
"Version":"2012-10-17",
"Statement" : [
{
"Sid" : "allow public pull",
"Effect" : "Allow",
"Principal" : "*",
"Action" : [
"ecr:BatchCheckLayerAvailability",
"ecr:BatchGetImage",
"ecr:GetDownloadUrlForLayer"
]
}
]
}
```
Output:
```
{
"registryId": "012345678910",
"repositoryName": "cluster-autoscaler",
"policyText": "{\n \"Version\" : \"2008-10-17\",\n \"Statement\" : [ {\n \"Sid\" : \"allow public pull\",\n \"Effect\" : \"Allow\",\n \"Principal\" : \"*\",\n \"Action\" : [ \"ecr:BatchCheckLayerAvailability\", \"ecr:BatchGetImage\", \"ecr:GetDownloadUrlForLayer\" ]\n } ]\n}"
}
```
+ For API details, see [SetRepositoryPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/set-repository-policy.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/ecr#code-examples).
```
/**
* Sets the repository policy for the specified ECR repository.
*
* @param repoName the name of the ECR repository.
* @param iamRole the IAM role to be granted access to the repository.
* @throws RepositoryPolicyNotFoundException if the repository policy does not exist.
* @throws EcrException if there is an unexpected error setting the repository policy.
*/
public void setRepoPolicy(String repoName, String iamRole) {
/*
This example policy document grants the specified AWS principal the permission to perform the
`ecr:BatchGetImage` action. This policy is designed to allow the specified principal
to retrieve Docker images from the ECR repository.
*/
String policyDocumentTemplate = """
{
"Version":"2012-10-17",
"Statement" : [ {
"Sid" : "new statement",
"Effect" : "Allow",
"Principal" : {
"AWS" : "%s"
},
"Action" : "ecr:BatchGetImage"
} ]
}
""";
String policyDocument = String.format(policyDocumentTemplate, iamRole);
SetRepositoryPolicyRequest setRepositoryPolicyRequest = SetRepositoryPolicyRequest.builder()
.repositoryName(repoName)
.policyText(policyDocument)
.build();
CompletableFuture response = getAsyncClient().setRepositoryPolicy(setRepositoryPolicyRequest);
response.whenComplete((resp, ex) -> {
if (resp != null) {
System.out.println("Repository policy set successfully.");
} else {
Throwable cause = ex.getCause();
if (cause instanceof RepositoryPolicyNotFoundException) {
throw (RepositoryPolicyNotFoundException) cause;
} else if (cause instanceof EcrException) {
throw (EcrException) cause;
} else {
String errorMessage = "Unexpected error: " + cause.getMessage();
throw new RuntimeException(errorMessage, cause);
}
}
});
response.join();
}
```
+ For API details, see [SetRepositoryPolicy](https://docs.aws.amazon.com/goto/SdkForJavaV2/ecr-2015-09-21/SetRepositoryPolicy) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/ecr#code-examples).
```
/**
* Sets the repository policy for the specified ECR repository.
*
* @param repoName the name of the ECR repository.
* @param iamRole the IAM role to be granted access to the repository.
*/
suspend fun setRepoPolicy(
repoName: String?,
iamRole: String?,
) {
val policyDocumentTemplate =
"""
{
"Version":"2012-10-17",
"Statement" : [ {
"Sid" : "new statement",
"Effect" : "Allow",
"Principal" : {
"AWS" : "$iamRole"
},
"Action" : "ecr:BatchGetImage"
} ]
}
""".trimIndent()
val setRepositoryPolicyRequest =
SetRepositoryPolicyRequest {
repositoryName = repoName
policyText = policyDocumentTemplate
}
EcrClient.fromEnvironment { region = "us-east-1" }.use { ecrClient ->
val response = ecrClient.setRepositoryPolicy(setRepositoryPolicyRequest)
if (response != null) {
println("Repository policy set successfully.")
}
}
}
```
+ For API details, see [SetRepositoryPolicy](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/ecr#code-examples).
```
class ECRWrapper:
def __init__(self, ecr_client: client):
self.ecr_client = ecr_client
@classmethod
def from_client(cls) -> "ECRWrapper":
"""
Creates a ECRWrapper instance with a default Amazon ECR client.
:return: An instance of ECRWrapper initialized with the default Amazon ECR client.
"""
ecr_client = boto3.client("ecr")
return cls(ecr_client)
def set_repository_policy(self, repository_name: str, policy_text: str):
"""
Sets the policy for an ECR repository.
:param repository_name: The name of the repository to set the policy for.
:param policy_text: The policy text to set.
"""
try:
self.ecr_client.set_repository_policy(
repositoryName=repository_name, policyText=policy_text
)
print(f"Set repository policy for repository {repository_name}.")
except ClientError as err:
if err.response["Error"]["Code"] == "RepositoryPolicyNotFoundException":
logger.error("Repository does not exist. %s.", repository_name)
raise
else:
logger.error(
"Couldn't set repository policy for repository %s. Here's why %s",
repository_name,
err.response["Error"]["Message"],
)
raise
```
Example that grants an IAM role download access.
```
def grant_role_download_access(self, role_arn: str):
"""
Grants the specified role access to download images from the ECR repository.
:param role_arn: The ARN of the role to grant access to.
"""
policy_json = {
"Version":"2012-10-17",
"Statement": [
{
"Sid": "AllowDownload",
"Effect": "Allow",
"Principal": {"AWS": role_arn},
"Action": ["ecr:BatchGetImage"],
}
],
}
self.ecr_wrapper.set_repository_policy(
self.repository_name, json.dumps(policy_json)
)
```
+ For API details, see [SetRepositoryPolicy](https://docs.aws.amazon.com/goto/boto3/ecr-2015-09-21/SetRepositoryPolicy) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ecr#code-examples).
```
TRY.
" iv_repository_name = 'my-repository'
" iv_policy_text = '{"Version":"2012-10-17", "Statement":[...]}'
lo_ecr->setrepositorypolicy(
iv_repositoryname = iv_repository_name
iv_policytext = iv_policy_text ).
MESSAGE |Policy set for repository { iv_repository_name }.| TYPE 'I'.
CATCH /aws1/cx_ecrrepositorynotfndex.
MESSAGE 'Repository not found.' TYPE 'I'.
ENDTRY.
```
+ For API details, see [SetRepositoryPolicy](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `StartLifecyclePolicyPreview` with an AWS SDK or CLI
The following code examples show how to use `StartLifecyclePolicyPreview`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Learn the basics](ecr_example_ecr_Scenario_RepositoryManagement_section.md)
------
#### [ CLI ]
**AWS CLI**
**To create a lifecycle policy preview**
The following `start-lifecycle-policy-preview` example creates a lifecycle policy preview defined by a JSON file for the specified repository.
```
aws ecr start-lifecycle-policy-preview \
--repository-name "project-a/amazon-ecs-sample" \
--lifecycle-policy-text "file://policy.json"
```
Contents of `policy.json`:
```
{
"rules": [
{
"rulePriority": 1,
"description": "Expire images older than 14 days",
"selection": {
"tagStatus": "untagged",
"countType": "sinceImagePushed",
"countUnit": "days",
"countNumber": 14
},
"action": {
"type": "expire"
}
}
]
}
```
Output:
```
{
"registryId": "012345678910",
"repositoryName": "project-a/amazon-ecs-sample",
"lifecyclePolicyText": "{\n \"rules\": [\n {\n \"rulePriority\": 1,\n \"description\": \"Expire images older than 14 days\",\n \"selection\": {\n \"tagStatus\": \"untagged\",\n \"countType\": \"sinceImagePushed\",\n \"countUnit\": \"days\",\n \"countNumber\": 14\n },\n \"action\": {\n \"type\": \"expire\"\n }\n }\n ]\n}\n",
"status": "IN_PROGRESS"
}
```
+ For API details, see [StartLifecyclePolicyPreview](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/start-lifecycle-policy-preview.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/ecr#code-examples).
```
/**
* Verifies the existence of an image in an Amazon Elastic Container Registry (Amazon ECR) repository asynchronously.
*
* @param repositoryName The name of the Amazon ECR repository.
* @param imageTag The tag of the image to verify.
* @throws EcrException if there is an error retrieving the image information from Amazon ECR.
* @throws CompletionException if the asynchronous operation completes exceptionally.
*/
public void verifyImage(String repositoryName, String imageTag) {
DescribeImagesRequest request = DescribeImagesRequest.builder()
.repositoryName(repositoryName)
.imageIds(ImageIdentifier.builder().imageTag(imageTag).build())
.build();
CompletableFuture response = getAsyncClient().describeImages(request);
response.whenComplete((describeImagesResponse, ex) -> {
if (ex != null) {
if (ex instanceof CompletionException) {
Throwable cause = ex.getCause();
if (cause instanceof EcrException) {
throw (EcrException) cause;
} else {
throw new RuntimeException("Unexpected error: " + cause.getMessage(), cause);
}
} else {
throw new RuntimeException("Unexpected error: " + ex.getCause());
}
} else if (describeImagesResponse != null && !describeImagesResponse.imageDetails().isEmpty()) {
System.out.println("Image is present in the repository.");
} else {
System.out.println("Image is not present in the repository.");
}
});
// Wait for the CompletableFuture to complete.
response.join();
}
```
+ For API details, see [StartLifecyclePolicyPreview](https://docs.aws.amazon.com/goto/SdkForJavaV2/ecr-2015-09-21/StartLifecyclePolicyPreview) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Kotlin ]
**SDK for Kotlin**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/ecr#code-examples).
```
/**
* Verifies the existence of an image in an Amazon Elastic Container Registry (Amazon ECR) repository asynchronously.
*
* @param repositoryName The name of the Amazon ECR repository.
* @param imageTag The tag of the image to verify.
*/
suspend fun verifyImage(
repoName: String?,
imageTagVal: String?,
) {
require(!(repoName == null || repoName.isEmpty())) { "Repository name cannot be null or empty" }
require(!(imageTagVal == null || imageTagVal.isEmpty())) { "Image tag cannot be null or empty" }
val imageId =
ImageIdentifier {
imageTag = imageTagVal
}
val request =
DescribeImagesRequest {
repositoryName = repoName
imageIds = listOf(imageId)
}
EcrClient.fromEnvironment { region = "us-east-1" }.use { ecrClient ->
val describeImagesResponse = ecrClient.describeImages(request)
if (describeImagesResponse != null && !describeImagesResponse.imageDetails?.isEmpty()!!) {
println("Image is present in the repository.")
} else {
println("Image is not present in the repository.")
}
}
}
```
+ For API details, see [StartLifecyclePolicyPreview](https://sdk.amazonaws.com/kotlin/api/latest/index.html) in *AWS SDK for Kotlin API reference*.
------