aws-elixir

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

Amazon Elastic Container Registry

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

Customers 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 private repositories with resource-based permissions using IAM so that specific users or Amazon EC2 instances can access repositories and images.

Amazon ECR has service endpoints in each supported Region. For more information, see Amazon ECR endpoints in the Amazon Web Services General Reference.

Link to this section Summary

Functions

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

Checks the availability of one or more image layers in a repository.

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

Deletes a list of specified images within a repository.

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

Gets detailed information for an image.

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

Gets the scanning configuration for one or more repositories.

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

Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and upload ID.

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

Creates a pull through cache rule.

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

Creates a repository.

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

Creates a repository creation template.

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

Deletes the lifecycle policy associated with the specified repository.

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

Deletes a pull through cache rule.

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

Deletes the registry permissions policy.

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

Deletes a repository.

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

Deletes a repository creation template.

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

Deletes the repository policy associated with the specified repository.

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

Returns the replication status for a specified image.

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

Returns the scan findings for the specified image.

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

Returns metadata about the images in a repository.

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

Returns the pull through cache rules for a registry.

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

Describes the settings for a registry.

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

Describes image repositories in a registry.

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

Returns details about the repository creation templates in a registry.

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

Retrieves the basic scan type version name.

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

Retrieves an authorization token.

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

Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer.

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

Retrieves the lifecycle policy for the specified repository.

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

Retrieves the results of the lifecycle policy preview request for the specified repository.

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

Retrieves the permissions policy for a registry.

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

Retrieves the scanning configuration for a 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_images(client, input, options \\ [])

Lists all the image IDs for the specified repository.

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

List the tags for an Amazon ECR resource.

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

Allows you to change the basic scan type version by setting the name parameter to either CLAIR to AWS_NATIVE.

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

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

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

The PutImageScanningConfiguration API is being deprecated, in favor of specifying the image scanning configuration at the registry level.

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

Updates the image tag mutability settings for the specified repository.

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

Creates or updates the lifecycle policy for the specified repository.

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

Creates or updates the permissions policy for your registry.

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

Creates or updates the scanning configuration for your private registry.

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

Creates or updates the replication configuration for a registry.

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

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

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

Starts an image vulnerability scan.

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

Starts a preview of a lifecycle policy for the specified repository.

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

Adds specified tags to a resource with the specified ARN.

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

Deletes specified tags from a resource.

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

Updates an existing pull through cache rule.

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

Updates an existing repository creation template.

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

Uploads an image layer part to Amazon ECR.

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

Validates an existing pull through cache rule for an upstream registry that requires authentication.

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 in a repository.

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 within a repository.

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.

Link to this function

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

View Source

Gets detailed information for an image.

Images are specified with either an imageTag or imageDigest.

When an image is pulled, the BatchGetImage API is called once to retrieve the image manifest.

Link to this function

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

View Source

Gets the scanning configuration for one or more repositories.

Link to this function

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

View Source

Informs Amazon ECR that the image layer upload has completed for a specified 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 the docker CLI to pull, tag, and push images.

Link to this function

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

View Source

Creates a pull through cache rule.

A pull through cache rule provides a way to cache images from an upstream registry source in your Amazon ECR private registry. For more information, see Using pull through cache rules in the Amazon Elastic Container Registry User Guide.

Link to this function

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

View Source

Creates a repository.

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

Link to this function

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

View Source

Creates a repository creation template.

This template is used to define the settings for repositories created by Amazon ECR on your behalf. For example, repositories created through pull through cache actions. For more information, see Private repository creation templates in the Amazon Elastic Container Registry User Guide.

Link to this function

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

View Source

Deletes the lifecycle policy associated with the specified repository.

Link to this function

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

View Source

Deletes a pull through cache rule.

Link to this function

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

View Source

Deletes the registry permissions policy.

Link to this function

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

View Source

Deletes a repository.

If the repository isn't empty, you must either delete the contents of the repository or use the force option to delete the repository and have Amazon ECR delete all of its contents on your behalf.

Link to this function

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

View Source

Deletes a repository creation template.

Link to this function

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

View Source

Deletes the repository policy associated with the specified repository.

Link to this function

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

View Source

Returns the replication status for a specified image.

Link to this function

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

View Source

Returns the scan findings for the specified image.

Link to this function

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

View Source

Returns metadata about the images in a repository.

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.

Link to this function

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

View Source

Returns the pull through cache rules for a registry.

Link to this function

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

View Source

Describes the settings for a registry.

The replication configuration for a repository can be created or updated with the PutReplicationConfiguration API action.

Link to this function

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

View Source

Describes image repositories in a registry.

Link to this function

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

View Source

Returns details about the repository creation templates in a registry.

The prefixes request parameter can be used to return the details for a specific repository creation template.

Link to this function

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

View Source

Retrieves the basic scan type version name.

Link to this function

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

View Source

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.

The authorizationToken returned is a base64 encoded string that can be decoded and used in a docker login command to authenticate to a registry. The CLI offers an get-login-password command that simplifies the login process. For more information, see Registry authentication in the Amazon Elastic Container Registry User Guide.

Link to this function

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

View Source

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.

When an image is pulled, the GetDownloadUrlForLayer API is called once per image layer that is not already cached.

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

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

View Source

Retrieves the lifecycle policy for the specified repository.

Link to this function

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

View Source

Retrieves the results of the lifecycle policy preview request for the specified repository.

Link to this function

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

View Source

Retrieves the permissions policy for a registry.

Link to this function

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

View Source

Retrieves the scanning configuration for a registry.

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 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 the docker CLI to pull, tag, and push images.

Link to this function

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

View Source

Lists all the image IDs for the specified repository.

You can filter images based on whether or not they are tagged by using the tagStatus filter and specifying either TAGGED, UNTAGGED or ANY. 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.

Link to this function

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

View Source

List the tags for an Amazon ECR resource.

Link to this function

metadata()

View Source
Link to this function

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

View Source

Allows you to change the basic scan type version by setting the name parameter to either CLAIR to AWS_NATIVE.

Link to this function

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

View Source

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 the docker CLI to pull, tag, and push images.

Link to this function

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

View Source

The PutImageScanningConfiguration API is being deprecated, in favor of specifying the image scanning configuration at the registry level.

For more information, see PutRegistryScanningConfiguration.

Updates the image scanning configuration for the specified repository.

Link to this function

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

View Source

Updates the image tag mutability settings for the specified repository.

For more information, see Image tag mutability in the Amazon Elastic Container Registry User Guide.

Link to this function

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

View Source

Creates or updates the lifecycle policy for the specified repository.

For more information, see Lifecycle policy template.

Link to this function

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

View Source

Creates or updates the permissions policy for your registry.

A registry policy is used to specify permissions for another Amazon Web Services account and is used when configuring cross-account replication. For more information, see Registry permissions in the Amazon Elastic Container Registry User Guide.

Link to this function

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

View Source

Creates or updates the scanning configuration for your private registry.

Link to this function

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

View Source

Creates or updates the replication configuration for a registry.

The existing replication configuration for a repository can be retrieved with the DescribeRegistry API action. The first time the PutReplicationConfiguration API is called, a service-linked IAM role is created in your account for the replication process. For more information, see Using service-linked roles for Amazon ECR in the Amazon Elastic Container Registry User Guide. For more information on the custom role for replication, see Creating an IAM role for replication.

When configuring cross-account replication, the destination account must grant the source account permission to replicate. This permission is controlled using a registry permissions policy. For more information, see PutRegistryPolicy.

Link to this function

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

View Source

Applies a repository policy to the specified 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

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

View Source

Starts an image vulnerability scan.

An image scan can only be started once per 24 hours on an individual image. This limit includes if an image was scanned on initial push. For more information, see Image scanning in the Amazon Elastic Container Registry User Guide.

Link to this function

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

View Source

Starts a preview of a lifecycle policy for the specified repository.

This allows you to see the results before associating the lifecycle policy with the repository.

Link to this function

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

View Source

Adds specified tags to a resource with the specified ARN.

Existing tags on a resource are not changed if they are not specified in the request parameters.

Link to this function

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

View Source

Deletes specified tags from a resource.

Link to this function

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

View Source

Updates an existing pull through cache rule.

Link to this function

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

View Source

Updates an existing repository creation template.

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 (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 the docker CLI to pull, tag, and push images.

Link to this function

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

View Source

Validates an existing pull through cache rule for an upstream registry that requires authentication.

This will retrieve the contents of the Amazon Web Services Secrets Manager secret, verify the syntax, and then validate that authentication to the upstream registry is successful.