aws-elixir

v0.4.0

aws-elixir v0.4.0 AWS.ECR

Amazon EC2 Container Registry (Amazon ECR) is a managed AWS Docker registry service. Customers can use the familiar Docker CLI to push, pull, and manage images. Amazon ECR provides a secure, scalable, and reliable registry. Amazon ECR supports private Docker repositories with resource-based permissions using AWS IAM so that specific users or Amazon EC2 instances can access repositories and images. Developers can use the Docker CLI to author and manage images.

Summary

Functions

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

Check the availability of multiple image layers in a specified registry and repository

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

Deletes a list of specified images within a specified repository. Images are specified with either imageTag or imageDigest

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

Gets detailed information for specified images within a specified repository. Images are specified with either imageTag or imageDigest

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

Inform Amazon ECR that the image layer upload for a specified registry, repository name, and upload ID, has completed. You can optionally provide a sha256 digest of the image layer for data validation purposes

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

Creates an image repository

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

Deletes an existing image repository. If a repository contains images, you must use the force option to delete it

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

Deletes the repository policy from a specified repository

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

Returns metadata about the images in a repository, including image size, image tags, and creation date

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

Describes image repositories in a registry

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

Retrieves a token that is valid for a specified registry for 12 hours. This command allows you to use the docker CLI to push and pull images with Amazon ECR. If you do not specify a registry, the default registry is assumed

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

Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can only get URLs for image layers that are referenced in an image

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

Retrieves the repository policy for a specified repository

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

Notify Amazon ECR that you intend to upload an image layer

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

Lists all the image IDs for a given repository

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

Creates or updates the image manifest and tags associated with an image

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

Applies a repository policy on a specified repository to control access permissions

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

Uploads an image layer part to Amazon ECR

Functions

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

Check the availability of multiple image layers in a specified registry and repository.

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the `docker` CLI to pull, tag, and push images.
batch_delete_image(client, input, options \\ [])

Deletes a list of specified images within a specified repository. Images are specified with either 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_get_image(client, input, options \\ [])

Gets detailed information for specified images within a specified repository. Images are specified with either imageTag or imageDigest.

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

Inform Amazon ECR that the image layer upload for a specified registry, repository name, and upload ID, has completed. You can optionally provide a sha256 digest of the image layer for data validation purposes.

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the `docker` CLI to pull, tag, and push images.
create_repository(client, input, options \\ [])

Creates an image repository.

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

Deletes an existing image repository. If a repository contains images, you must use the force option to delete it.

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

Deletes the repository policy from a specified repository.

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

Returns metadata about the images in a repository, including image size, image tags, and creation date.

Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the `docker images` command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by `DescribeImages`.
describe_repositories(client, input, options \\ [])

Describes image repositories in a registry.

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

Retrieves a token that is valid for a specified registry for 12 hours. This command allows you to use the docker CLI to push and pull images with Amazon ECR. If you do not specify a registry, the default registry is assumed.

The authorizationToken returned for each registry specified is a base64 encoded string that can be decoded and used in a docker login command to authenticate to a registry. The AWS CLI offers an aws ecr get-login command that simplifies the login process.

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

Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can only get URLs for image layers that are referenced in an image.

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the `docker` CLI to pull, tag, and push images.
get_repository_policy(client, input, options \\ [])

Retrieves the repository policy for a specified repository.

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

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

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the `docker` CLI to pull, tag, and push images.
list_images(client, input, options \\ [])

Lists all the image IDs for a given repository.

You can filter images based on whether or not they are tagged by setting the tagStatus parameter to TAGGED or UNTAGGED. For example, you can filter your results to return only UNTAGGED images and then pipe that result to a BatchDeleteImage operation to delete them. Or, you can filter your results to return only TAGGED images to list all of the tags in your repository.

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

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

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the `docker` CLI to pull, tag, and push images.
set_repository_policy(client, input, options \\ [])

Applies a repository policy on a specified repository to control access permissions.

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

Uploads an image layer part to Amazon ECR.

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the `docker` CLI to pull, tag, and push images.