paws (version 0.1.12)

ecr: Amazon EC2 Container Registry

Description

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.

Usage

ecr(config = list())

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Service syntax

svc <- ecr(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

batch_check_layer_availability	Checks the availability of one or more image layers in a repository
batch_delete_image	Deletes a list of specified images within a repository
batch_get_image	Gets detailed information for an image
complete_layer_upload	Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and upload ID
create_repository	Creates a repository
delete_lifecycle_policy	Deletes the lifecycle policy associated with the specified repository
delete_registry_policy	Deletes the registry permissions policy
delete_repository	Deletes a repository
delete_repository_policy	Deletes the repository policy associated with the specified repository
describe_images	Returns metadata about the images in a repository
describe_image_scan_findings	Returns the scan findings for the specified image
describe_registry	Describes the settings for a registry
describe_repositories	Describes image repositories in a registry
get_authorization_token	Retrieves an authorization token
get_download_url_for_layer	Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer
get_lifecycle_policy	Retrieves the lifecycle policy for the specified repository
get_lifecycle_policy_preview	Retrieves the results of the lifecycle policy preview request for the specified repository
get_registry_policy	Retrieves the permissions policy for a registry
get_repository_policy	Retrieves the repository policy for the specified repository
initiate_layer_upload	Notifies Amazon ECR that you intend to upload an image layer
list_images	Lists all the image IDs for the specified repository
list_tags_for_resource	List the tags for an Amazon ECR resource
put_image	Creates or updates the image manifest and tags associated with an image
put_image_scanning_configuration	Updates the image scanning configuration for the specified repository
put_image_tag_mutability	Updates the image tag mutability settings for the specified repository
put_lifecycle_policy	Creates or updates the lifecycle policy for the specified repository
put_registry_policy	Creates or updates the permissions policy for your registry
put_replication_configuration	Creates or updates the replication configuration for a registry
set_repository_policy	Applies a repository policy to the specified repository to control access permissions
start_image_scan	Starts an image vulnerability scan
start_lifecycle_policy_preview	Starts a preview of a lifecycle policy for the specified repository
tag_resource	Adds specified tags to a resource with the specified ARN
untag_resource	Deletes specified tags from a resource
upload_layer_part	Uploads an image layer part to Amazon ECR

Examples

if (FALSE) {
svc <- ecr()
# This example deletes images with the tags precise and trusty in a
# repository called ubuntu in the default registry for an account.
svc$batch_delete_image(
  imageIds = list(
    list(
      imageTag = "precise"
    )
  ),
  repositoryName = "ubuntu"
)
}