Client
ecr | R Documentation |
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.
Amazon ECR has service endpoints in each supported Region. For more information, see Amazon ECR endpoints in the Amazon Web Services General Reference.
Usage¶
Arguments¶
config
Optional configuration of credentials, endpoint, and/or region.
credentials:
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to
true
to force the request to use path-style addressing, i.e.http://s3.amazonaws.com/BUCKET/KEY
.sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
credentials
Optional credentials shorthand for the config parameter
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
endpoint
Optional shorthand for complete URL to use for the constructed client.
region
Optional shorthand for AWS Region used in instantiating the client.
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.
Service syntax¶
svc <- ecr(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
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
- Gets the scanning configuration for one or more repositories
- complete_layer_upload
- Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and upload ID
- create_pull_through_cache_rule
- Creates a pull through cache rule
- create_repository
- Creates a repository
- create_repository_creation_template
- Creates a repository creation template
- delete_lifecycle_policy
- Deletes the lifecycle policy associated with the specified repository
- delete_pull_through_cache_rule
- Deletes a pull through cache rule
- delete_registry_policy
- Deletes the registry permissions policy
- delete_repository
- Deletes a repository
- delete_repository_creation_template
- Deletes a repository creation template
- delete_repository_policy
- Deletes the repository policy associated with the specified repository
- describe_image_replication_status
- Returns the replication status for a specified image
- describe_images
- Returns metadata about the images in a repository
- describe_image_scan_findings
- Returns the scan findings for the specified image
- describe_pull_through_cache_rules
- Returns the pull through cache rules for a registry
- describe_registry
- Describes the settings for a registry
- describe_repositories
- Describes image repositories in a registry
- Returns details about the repository creation templates in a registry
- get_account_setting
- Retrieves the basic scan type version name
- 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_registry_scanning_configuration
- Retrieves the scanning configuration 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_account_setting
- Allows you to change the basic scan type version by setting the name parameter to either CLAIR to AWS_NATIVE
- put_image
- Creates or updates the image manifest and tags associated with an image
- put_image_scanning_configuration
- The PutImageScanningConfiguration API is being deprecated, in favor of specifying the image scanning configuration at the registry level
- 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_registry_scanning_configuration
- Creates or updates the scanning configuration for your private 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
- update_pull_through_cache_rule
- Updates an existing pull through cache rule
- update_repository_creation_template
- Updates an existing repository creation template
- upload_layer_part
- Uploads an image layer part to Amazon ECR
- validate_pull_through_cache_rule
- Validates an existing pull through cache rule for an upstream registry that requires authentication
Examples¶
## Not run:
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"
)
## End(Not run)