Class: Aws::ECRPublic::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ECRPublic::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-ecrpublic/lib/aws-sdk-ecrpublic/client.rb
Overview
An API client for ECRPublic. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::ECRPublic::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#batch_check_layer_availability(params = {}) ⇒ Types::BatchCheckLayerAvailabilityResponse
Checks the availability of one or more image layers that are within a repository in a public registry.
-
#batch_delete_image(params = {}) ⇒ Types::BatchDeleteImageResponse
Deletes a list of specified images that are within a repository in a public registry.
-
#complete_layer_upload(params = {}) ⇒ Types::CompleteLayerUploadResponse
Informs Amazon ECR that the image layer upload is complete for a specified public registry, repository name, and upload ID.
-
#create_repository(params = {}) ⇒ Types::CreateRepositoryResponse
Creates a repository in a public registry.
-
#delete_repository(params = {}) ⇒ Types::DeleteRepositoryResponse
Deletes a repository in a public registry.
-
#delete_repository_policy(params = {}) ⇒ Types::DeleteRepositoryPolicyResponse
Deletes the repository policy that's associated with the specified repository.
-
#describe_image_tags(params = {}) ⇒ Types::DescribeImageTagsResponse
Returns the image tag details for a repository in a public registry.
-
#describe_images(params = {}) ⇒ Types::DescribeImagesResponse
Returns metadata that's related to the images in a repository in a public registry.
-
#describe_registries(params = {}) ⇒ Types::DescribeRegistriesResponse
Returns details for a public registry.
-
#describe_repositories(params = {}) ⇒ Types::DescribeRepositoriesResponse
Describes repositories that are in a public registry.
-
#get_authorization_token(params = {}) ⇒ Types::GetAuthorizationTokenResponse
Retrieves an authorization token.
-
#get_registry_catalog_data(params = {}) ⇒ Types::GetRegistryCatalogDataResponse
Retrieves catalog metadata for a public registry.
-
#get_repository_catalog_data(params = {}) ⇒ Types::GetRepositoryCatalogDataResponse
Retrieve catalog metadata for a repository in a public registry.
-
#get_repository_policy(params = {}) ⇒ Types::GetRepositoryPolicyResponse
Retrieves the repository policy for the specified repository.
-
#initiate_layer_upload(params = {}) ⇒ Types::InitiateLayerUploadResponse
Notifies Amazon ECR that you intend to upload an image layer.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List the tags for an Amazon ECR Public resource.
-
#put_image(params = {}) ⇒ Types::PutImageResponse
Creates or updates the image manifest and tags that are associated with an image.
-
#put_registry_catalog_data(params = {}) ⇒ Types::PutRegistryCatalogDataResponse
Create or update the catalog data for a public registry.
-
#put_repository_catalog_data(params = {}) ⇒ Types::PutRepositoryCatalogDataResponse
Creates or updates the catalog data for a repository in a public registry.
-
#set_repository_policy(params = {}) ⇒ Types::SetRepositoryPolicyResponse
Applies a repository policy to the specified public repository to control access permissions.
-
#tag_resource(params = {}) ⇒ Struct
Associates the specified tags to a resource with the specified
resourceArn
. -
#untag_resource(params = {}) ⇒ Struct
Deletes specified tags from a resource.
-
#upload_layer_part(params = {}) ⇒ Types::UploadLayerPartResponse
Uploads an image layer part to Amazon ECR.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
473 474 475 |
# File 'gems/aws-sdk-ecrpublic/lib/aws-sdk-ecrpublic/client.rb', line 473 def initialize(*args) super end |
Instance Method Details
#batch_check_layer_availability(params = {}) ⇒ Types::BatchCheckLayerAvailabilityResponse
Checks the availability of one or more image layers that are within a repository in a public registry. 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.
docker
CLI to pull, tag, and push images.
532 533 534 535 |
# File 'gems/aws-sdk-ecrpublic/lib/aws-sdk-ecrpublic/client.rb', line 532 def batch_check_layer_availability(params = {}, = {}) req = build_request(:batch_check_layer_availability, params) req.send_request() end |
#batch_delete_image(params = {}) ⇒ Types::BatchDeleteImageResponse
Deletes a list of specified images that are within a repository in a
public registry. 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 digest of the image in your request.
594 595 596 597 |
# File 'gems/aws-sdk-ecrpublic/lib/aws-sdk-ecrpublic/client.rb', line 594 def batch_delete_image(params = {}, = {}) req = build_request(:batch_delete_image, params) req.send_request() end |
#complete_layer_upload(params = {}) ⇒ Types::CompleteLayerUploadResponse
Informs Amazon ECR that the image layer upload is complete for a
specified public 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 for each new image layer to verify that the upload is complete.
docker
CLI to pull, tag, and push images.
656 657 658 659 |
# File 'gems/aws-sdk-ecrpublic/lib/aws-sdk-ecrpublic/client.rb', line 656 def complete_layer_upload(params = {}, = {}) req = build_request(:complete_layer_upload, params) req.send_request() end |
#create_repository(params = {}) ⇒ Types::CreateRepositoryResponse
Creates a repository in a public registry. For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide.
733 734 735 736 |
# File 'gems/aws-sdk-ecrpublic/lib/aws-sdk-ecrpublic/client.rb', line 733 def create_repository(params = {}, = {}) req = build_request(:create_repository, params) req.send_request() end |
#delete_repository(params = {}) ⇒ Types::DeleteRepositoryResponse
Deletes a repository in a public registry. If the repository contains
images, you must either manually delete all images in the repository
or use the force
option. This option deletes all images on your
behalf before deleting the repository.
780 781 782 783 |
# File 'gems/aws-sdk-ecrpublic/lib/aws-sdk-ecrpublic/client.rb', line 780 def delete_repository(params = {}, = {}) req = build_request(:delete_repository, params) req.send_request() end |
#delete_repository_policy(params = {}) ⇒ Types::DeleteRepositoryPolicyResponse
Deletes the repository policy that's associated with the specified repository.
820 821 822 823 |
# File 'gems/aws-sdk-ecrpublic/lib/aws-sdk-ecrpublic/client.rb', line 820 def delete_repository_policy(params = {}, = {}) req = build_request(:delete_repository_policy, params) req.send_request() end |
#describe_image_tags(params = {}) ⇒ Types::DescribeImageTagsResponse
Returns the image tag details for a repository in a public registry.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
887 888 889 890 |
# File 'gems/aws-sdk-ecrpublic/lib/aws-sdk-ecrpublic/client.rb', line 887 def (params = {}, = {}) req = build_request(:describe_image_tags, params) req.send_request() end |
#describe_images(params = {}) ⇒ Types::DescribeImagesResponse
Returns metadata that's related to the images in a repository in a public registry.
docker images
command shows the uncompressed image size. Therefore,
it might return a larger image size than the image sizes that are
returned by DescribeImages.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
973 974 975 976 |
# File 'gems/aws-sdk-ecrpublic/lib/aws-sdk-ecrpublic/client.rb', line 973 def describe_images(params = {}, = {}) req = build_request(:describe_images, params) req.send_request() end |
#describe_registries(params = {}) ⇒ Types::DescribeRegistriesResponse
Returns details for a public registry.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1036 1037 1038 1039 |
# File 'gems/aws-sdk-ecrpublic/lib/aws-sdk-ecrpublic/client.rb', line 1036 def describe_registries(params = {}, = {}) req = build_request(:describe_registries, params) req.send_request() end |
#describe_repositories(params = {}) ⇒ Types::DescribeRepositoriesResponse
Describes repositories that are in a public registry.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1109 1110 1111 1112 |
# File 'gems/aws-sdk-ecrpublic/lib/aws-sdk-ecrpublic/client.rb', line 1109 def describe_repositories(params = {}, = {}) req = build_request(:describe_repositories, params) req.send_request() end |
#get_authorization_token(params = {}) ⇒ Types::GetAuthorizationTokenResponse
Retrieves an authorization token. An authorization token represents
your IAM authentication credentials. You can use it to access any
Amazon ECR registry that your IAM principal has access to. The
authorization token is valid for 12 hours. This API requires the
ecr-public:GetAuthorizationToken
and sts:GetServiceBearerToken
permissions.
1134 1135 1136 1137 |
# File 'gems/aws-sdk-ecrpublic/lib/aws-sdk-ecrpublic/client.rb', line 1134 def (params = {}, = {}) req = build_request(:get_authorization_token, params) req.send_request() end |
#get_registry_catalog_data(params = {}) ⇒ Types::GetRegistryCatalogDataResponse
Retrieves catalog metadata for a public registry.
1153 1154 1155 1156 |
# File 'gems/aws-sdk-ecrpublic/lib/aws-sdk-ecrpublic/client.rb', line 1153 def get_registry_catalog_data(params = {}, = {}) req = build_request(:get_registry_catalog_data, params) req.send_request() end |
#get_repository_catalog_data(params = {}) ⇒ Types::GetRepositoryCatalogDataResponse
Retrieve catalog metadata for a repository in a public registry. This metadata is displayed publicly in the Amazon ECR Public Gallery.
1196 1197 1198 1199 |
# File 'gems/aws-sdk-ecrpublic/lib/aws-sdk-ecrpublic/client.rb', line 1196 def get_repository_catalog_data(params = {}, = {}) req = build_request(:get_repository_catalog_data, params) req.send_request() end |
#get_repository_policy(params = {}) ⇒ Types::GetRepositoryPolicyResponse
Retrieves the repository policy for the specified repository.
1234 1235 1236 1237 |
# File 'gems/aws-sdk-ecrpublic/lib/aws-sdk-ecrpublic/client.rb', line 1234 def get_repository_policy(params = {}, = {}) req = build_request(:get_repository_policy, params) req.send_request() end |
#initiate_layer_upload(params = {}) ⇒ Types::InitiateLayerUploadResponse
Notifies Amazon ECR that you intend to upload an image layer.
When an image is pushed, the InitiateLayerUpload API is called once for each image layer that hasn't already been uploaded. Whether an image layer uploads is determined by the BatchCheckLayerAvailability API action.
docker
CLI to pull, tag, and push images.
1281 1282 1283 1284 |
# File 'gems/aws-sdk-ecrpublic/lib/aws-sdk-ecrpublic/client.rb', line 1281 def initiate_layer_upload(params = {}, = {}) req = build_request(:initiate_layer_upload, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List the tags for an Amazon ECR Public resource.
1313 1314 1315 1316 |
# File 'gems/aws-sdk-ecrpublic/lib/aws-sdk-ecrpublic/client.rb', line 1313 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_image(params = {}) ⇒ Types::PutImageResponse
Creates or updates the image manifest and tags that are 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 that are associated with the image.
docker
CLI to pull, tag, and push images.
1384 1385 1386 1387 |
# File 'gems/aws-sdk-ecrpublic/lib/aws-sdk-ecrpublic/client.rb', line 1384 def put_image(params = {}, = {}) req = build_request(:put_image, params) req.send_request() end |
#put_registry_catalog_data(params = {}) ⇒ Types::PutRegistryCatalogDataResponse
Create or update the catalog data for a public registry.
1418 1419 1420 1421 |
# File 'gems/aws-sdk-ecrpublic/lib/aws-sdk-ecrpublic/client.rb', line 1418 def put_registry_catalog_data(params = {}, = {}) req = build_request(:put_registry_catalog_data, params) req.send_request() end |
#put_repository_catalog_data(params = {}) ⇒ Types::PutRepositoryCatalogDataResponse
Creates or updates the catalog data for a repository in a public registry.
1473 1474 1475 1476 |
# File 'gems/aws-sdk-ecrpublic/lib/aws-sdk-ecrpublic/client.rb', line 1473 def put_repository_catalog_data(params = {}, = {}) req = build_request(:put_repository_catalog_data, params) req.send_request() end |
#set_repository_policy(params = {}) ⇒ Types::SetRepositoryPolicyResponse
Applies a repository policy to the specified public repository to control access permissions. For more information, see Amazon ECR Repository Policies in the Amazon Elastic Container Registry User Guide.
1535 1536 1537 1538 |
# File 'gems/aws-sdk-ecrpublic/lib/aws-sdk-ecrpublic/client.rb', line 1535 def set_repository_policy(params = {}, = {}) req = build_request(:set_repository_policy, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Associates the specified tags to a resource with the specified
resourceArn
. If existing tags on a resource aren't specified in the
request parameters, they aren't changed. When a resource is deleted,
the tags associated with that resource are also deleted.
1572 1573 1574 1575 |
# File 'gems/aws-sdk-ecrpublic/lib/aws-sdk-ecrpublic/client.rb', line 1572 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Deletes specified tags from a resource.
1599 1600 1601 1602 |
# File 'gems/aws-sdk-ecrpublic/lib/aws-sdk-ecrpublic/client.rb', line 1599 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#upload_layer_part(params = {}) ⇒ Types::UploadLayerPartResponse
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 (about 20MB). The UploadLayerPart API is called once for each new image layer part.
docker
CLI to pull, tag, and push images.
1669 1670 1671 1672 |
# File 'gems/aws-sdk-ecrpublic/lib/aws-sdk-ecrpublic/client.rb', line 1669 def upload_layer_part(params = {}, = {}) req = build_request(:upload_layer_part, params) req.send_request() end |