aws_ecr_public
Amazon Elastic Container Registry Public
Amazon Elastic Container Registry (Amazon ECR) is a managed container image registry service.
Amazon ECR provides both public and private registries to host your container images. You can use the familiar Docker CLI, or their preferred client, to push, pull, and manage images. Amazon ECR provides a secure, scalable, and reliable registry for your Docker or Open Container Initiative (OCI) images. Amazon ECR supports public repositories with this API. For information about the Amazon ECR API for private repositories, see Amazon Elastic Container Registry API Reference.Summary
Functions
-
batch_check_layer_availability(Client, Input)
Checks the availability of one or more image layers within a repository in a public registry.
- batch_check_layer_availability(Client, Input, Options)
-
batch_delete_image(Client, Input)
Deletes a list of specified images within a repository in a public registry.
- batch_delete_image(Client, Input, Options)
-
complete_layer_upload(Client, Input)
Informs Amazon ECR that the image layer upload has completed for a specified public registry, repository name, and upload ID.
- complete_layer_upload(Client, Input, Options)
-
create_repository(Client, Input)
Creates a repository in a public registry.
- create_repository(Client, Input, Options)
-
delete_repository(Client, Input)
Deletes a repository in a public registry.
- delete_repository(Client, Input, Options)
-
delete_repository_policy(Client, Input)
Deletes the repository policy associated with the specified repository.
- delete_repository_policy(Client, Input, Options)
-
describe_image_tags(Client, Input)
Returns the image tag details for a repository in a public registry.
- describe_image_tags(Client, Input, Options)
-
describe_images(Client, Input)
Returns metadata about the images in a repository in a public registry.
- describe_images(Client, Input, Options)
-
describe_registries(Client, Input)
Returns details for a public registry.
- describe_registries(Client, Input, Options)
-
describe_repositories(Client, Input)
Describes repositories in a public registry.
- describe_repositories(Client, Input, Options)
-
get_authorization_token(Client, Input)
Retrieves an authorization token.
- get_authorization_token(Client, Input, Options)
-
get_registry_catalog_data(Client, Input)
Retrieves catalog metadata for a public registry.
- get_registry_catalog_data(Client, Input, Options)
-
get_repository_catalog_data(Client, Input)
Retrieve catalog metadata for a repository in a public registry.
- get_repository_catalog_data(Client, Input, Options)
-
get_repository_policy(Client, Input)
Retrieves the repository policy for the specified repository.
- get_repository_policy(Client, Input, Options)
-
initiate_layer_upload(Client, Input)
Notifies Amazon ECR that you intend to upload an image layer.
- initiate_layer_upload(Client, Input, Options)
-
list_tags_for_resource(Client, Input)
List the tags for an Amazon ECR Public resource.
- list_tags_for_resource(Client, Input, Options)
-
put_image(Client, Input)
Creates or updates the image manifest and tags associated with an image.
- put_image(Client, Input, Options)
-
put_registry_catalog_data(Client, Input)
Create or updates the catalog data for a public registry.
- put_registry_catalog_data(Client, Input, Options)
-
put_repository_catalog_data(Client, Input)
Creates or updates the catalog data for a repository in a public registry.
- put_repository_catalog_data(Client, Input, Options)
-
set_repository_policy(Client, Input)
Applies a repository policy to the specified public repository to control access permissions.
- set_repository_policy(Client, Input, Options)
-
tag_resource(Client, Input)
Associates the specified tags to a resource with the specified
resourceArn
. - tag_resource(Client, Input, Options)
-
untag_resource(Client, Input)
Deletes specified tags from a resource.
- untag_resource(Client, Input, Options)
-
upload_layer_part(Client, Input)
Uploads an image layer part to Amazon ECR.
- upload_layer_part(Client, Input, Options)
Functions
batch_check_layer_availability(Client, Input)
Checks the availability of one or more image layers within a repository in a public registry.
When an image is pushed to a repository, each image layer is checked to verify if it has been uploaded before. If it has been uploaded, then the image layer is skipped.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use thedocker
CLI to pull, tag, and push images.
batch_check_layer_availability(Client, Input, Options)
batch_delete_image(Client, Input)
Deletes a list of specified images within a repository in a public registry.
Images are specified with either an imageTag
or imageDigest
.
You can remove a tag from an image by specifying the image's tag in your request. When you remove the last tag from an image, the image is deleted from your repository.
You can completely delete an image (and all of its tags) by specifying the image's digest in your request.batch_delete_image(Client, Input, Options)
complete_layer_upload(Client, Input)
Informs Amazon ECR that the image layer upload has completed for a specified public registry, repository name, and upload ID.
You can optionally provide a sha256
digest of the image layer for data
validation purposes.
When an image is pushed, the CompleteLayerUpload API is called once per each new image layer to verify that the upload has completed.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use thedocker
CLI to pull, tag, and push images.
complete_layer_upload(Client, Input, Options)
create_repository(Client, Input)
Creates a repository in a public registry.
For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide.create_repository(Client, Input, Options)
delete_repository(Client, Input)
Deletes a repository in a public registry.
If the repository contains images, you must either delete all images in the repository or use theforce
option which deletes all images on your
behalf before deleting the repository.
delete_repository(Client, Input, Options)
delete_repository_policy(Client, Input)
Deletes the repository policy associated with the specified repository.
delete_repository_policy(Client, Input, Options)
describe_image_tags(Client, Input)
Returns the image tag details for a repository in a public registry.
describe_image_tags(Client, Input, Options)
describe_images(Client, Input)
Returns metadata about the images in a repository in a public registry.
Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of thedocker images
command shows the uncompressed image size, so it may
return a larger image size than the image sizes returned by
DescribeImages
.
describe_images(Client, Input, Options)
describe_registries(Client, Input)
Returns details for a public registry.
describe_registries(Client, Input, Options)
describe_repositories(Client, Input)
Describes repositories in a public registry.
describe_repositories(Client, Input, Options)
get_authorization_token(Client, Input)
Retrieves an authorization token.
An authorization token represents your IAM authentication credentials and can be used to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid for 12 hours. This API requires theecr-public:GetAuthorizationToken
and
sts:GetServiceBearerToken
permissions.
get_authorization_token(Client, Input, Options)
get_registry_catalog_data(Client, Input)
Retrieves catalog metadata for a public registry.
get_registry_catalog_data(Client, Input, Options)
get_repository_catalog_data(Client, Input)
Retrieve catalog metadata for a repository in a public registry.
This metadata is displayed publicly in the Amazon ECR Public Gallery.get_repository_catalog_data(Client, Input, Options)
get_repository_policy(Client, Input)
Retrieves the repository policy for the specified repository.
get_repository_policy(Client, Input, Options)
initiate_layer_upload(Client, Input)
Notifies Amazon ECR that you intend to upload an image layer.
When an image is pushed, the InitiateLayerUpload API is called once per image layer that has not already been uploaded. Whether or not an image layer has been uploaded is determined by the BatchCheckLayerAvailability API action.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use thedocker
CLI to pull, tag, and push images.
initiate_layer_upload(Client, Input, Options)
list_tags_for_resource(Client, Input)
List the tags for an Amazon ECR Public resource.
list_tags_for_resource(Client, Input, Options)
put_image(Client, Input)
Creates or updates the image manifest and tags associated with an image.
When an image is pushed and all new image layers have been uploaded, the PutImage API is called once to create or update the image manifest and the tags associated with the image.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use thedocker
CLI to pull, tag, and push images.
put_image(Client, Input, Options)
put_registry_catalog_data(Client, Input)
Create or updates the catalog data for a public registry.
put_registry_catalog_data(Client, Input, Options)
put_repository_catalog_data(Client, Input)
Creates or updates the catalog data for a repository in a public registry.
put_repository_catalog_data(Client, Input, Options)
set_repository_policy(Client, Input)
Applies a repository policy to the specified public repository to control access permissions.
For more information, see Amazon ECR Repository Policies in the Amazon Elastic Container Registry User Guide.set_repository_policy(Client, Input, Options)
tag_resource(Client, Input)
Associates the specified tags to a resource with the specified
resourceArn
.
tag_resource(Client, Input, Options)
untag_resource(Client, Input)
Deletes specified tags from a resource.
untag_resource(Client, Input, Options)
upload_layer_part(Client, Input)
Uploads an image layer part to Amazon ECR.
When an image is pushed, each new image layer is uploaded in parts. The maximum size of each image layer part can be 20971520 bytes (or about 20MB). The UploadLayerPart API is called once per each new image layer part.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use thedocker
CLI to pull, tag, and push images.