Client
ecrpublic | R Documentation |
Amazon Elastic Container Registry Public¶
Description¶
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.
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 <- ecrpublic(
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 that are within a repository in a public registry
- batch_delete_image
- Deletes a list of specified images that are within a repository in a public registry
- complete_layer_upload
- Informs Amazon ECR that the image layer upload is complete for a specified public registry, repository name, and upload ID
- create_repository
- Creates a repository in a public registry
- delete_repository
- Deletes a repository in a public registry
- delete_repository_policy
- Deletes the repository policy that's associated with the specified repository
- describe_images
- Returns metadata that's related to the images in a repository in a public registry
- describe_image_tags
- Returns the image tag details for a repository in a public registry
- describe_registries
- Returns details for a public registry
- describe_repositories
- Describes repositories that are in a public registry
- get_authorization_token
- Retrieves an authorization token
- get_registry_catalog_data
- Retrieves catalog metadata for a public registry
- get_repository_catalog_data
- Retrieve catalog metadata for a repository in a public 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_tags_for_resource
- List the tags for an Amazon ECR Public resource
- put_image
- Creates or updates the image manifest and tags that are associated with an image
- put_registry_catalog_data
- Create or update the catalog data for a public registry
- put_repository_catalog_data
- Creates or updates the catalog data for a repository in a public registry
- set_repository_policy
- Applies a repository policy to the specified public repository to control access permissions
- tag_resource
- Associates the specified tags to a resource with the specified resourceArn
- untag_resource
- Deletes specified tags from a resource
- upload_layer_part
- Uploads an image layer part to Amazon ECR