aws-elixir

View Source AWS.ECRPUBLIC (aws-elixir v1.0.4)

Amazon Elastic Container Registry Public

Amazon Elastic Container Registry Public (Amazon ECR Public) is a managed container image registry service.

Amazon ECR provides both public and private registries to host your container images. You can use the Docker CLI or your 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.

Link to this section Summary

Functions

batch_check_layer_availability(client, input, options \\ [])

Checks the availability of one or more image layers that are within a repository in a public registry.

batch_delete_image(client, input, options \\ [])

Deletes a list of specified images that are within a repository in a public registry.

complete_layer_upload(client, input, options \\ [])

Informs Amazon ECR that the image layer upload is complete for a specified public registry, repository name, and upload ID.

create_repository(client, input, options \\ [])

Creates a repository in a public registry.

delete_repository(client, input, options \\ [])

Deletes a repository in a public registry.

delete_repository_policy(client, input, options \\ [])

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

describe_image_tags(client, input, options \\ [])

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

describe_images(client, input, options \\ [])

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

describe_registries(client, input, options \\ [])

Returns details for a public registry.

describe_repositories(client, input, options \\ [])

Describes repositories that are in a public registry.

get_authorization_token(client, input, options \\ [])

Retrieves an authorization token.

get_registry_catalog_data(client, input, options \\ [])

Retrieves catalog metadata for a public registry.

get_repository_catalog_data(client, input, options \\ [])

Retrieve catalog metadata for a repository in a public registry.

get_repository_policy(client, input, options \\ [])

Retrieves the repository policy for the specified repository.

initiate_layer_upload(client, input, options \\ [])

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

list_tags_for_resource(client, input, options \\ [])

List the tags for an Amazon ECR Public resource.

metadata()
put_image(client, input, options \\ [])

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

put_registry_catalog_data(client, input, options \\ [])

Create or update the catalog data for a public registry.

put_repository_catalog_data(client, input, options \\ [])

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

set_repository_policy(client, input, options \\ [])

Applies a repository policy to the specified public repository to control access permissions.

tag_resource(client, input, options \\ [])

Associates the specified tags to a resource with the specified resourceArn.

untag_resource(client, input, options \\ [])

Deletes specified tags from a resource.

upload_layer_part(client, input, options \\ [])

Uploads an image layer part to Amazon ECR.

Link to this section Functions

Link to this function

batch_check_layer_availability(client, input, options \\ [])

View Source

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.

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.

Link to this function

batch_delete_image(client, input, options \\ [])

View Source

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.

Link to this function

complete_layer_upload(client, input, options \\ [])

View Source

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.

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.

Link to this function

create_repository(client, input, options \\ [])

View Source

Creates a repository in a public registry.

For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide.

Link to this function

delete_repository(client, input, options \\ [])

View Source

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.

Link to this function

delete_repository_policy(client, input, options \\ [])

View Source

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

Link to this function

describe_image_tags(client, input, options \\ [])

View Source

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

Link to this function

describe_images(client, input, options \\ [])

View Source

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

Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size. Therefore, it might return a larger image size than the image sizes that are returned by DescribeImages.

Link to this function

describe_registries(client, input, options \\ [])

View Source

Returns details for a public registry.

Link to this function

describe_repositories(client, input, options \\ [])

View Source

Describes repositories that are in a public registry.

Link to this function

get_authorization_token(client, input, options \\ [])

View Source

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.

Link to this function

get_registry_catalog_data(client, input, options \\ [])

View Source

Retrieves catalog metadata for a public registry.

Link to this function

get_repository_catalog_data(client, input, options \\ [])

View Source

Retrieve catalog metadata for a repository in a public registry.

This metadata is displayed publicly in the Amazon ECR Public Gallery.

Link to this function

get_repository_policy(client, input, options \\ [])

View Source

Retrieves the repository policy for the specified repository.

Link to this function

initiate_layer_upload(client, input, options \\ [])

View Source

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.

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.

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

List the tags for an Amazon ECR Public resource.

Link to this function

metadata()

View Source
Link to this function

put_image(client, input, options \\ [])

View Source

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.

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.

Link to this function

put_registry_catalog_data(client, input, options \\ [])

View Source

Create or update the catalog data for a public registry.

Link to this function

put_repository_catalog_data(client, input, options \\ [])

View Source

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

Link to this function

set_repository_policy(client, input, options \\ [])

View Source

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.

Link to this function

tag_resource(client, input, options \\ [])

View Source

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.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Deletes specified tags from a resource.

Link to this function

upload_layer_part(client, input, options \\ [])

View Source

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.

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.