Class: Aws::ECR::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ECR::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-ecr/client.rb
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#batch_check_layer_availability(params = {}) ⇒ Types::BatchCheckLayerAvailabilityResponse
Check the availability of multiple image layers in a specified registry and repository.
-
#batch_delete_image(params = {}) ⇒ Types::BatchDeleteImageResponse
Deletes a list of specified images within a specified repository.
-
#batch_get_image(params = {}) ⇒ Types::BatchGetImageResponse
Gets detailed information for specified images within a specified repository.
-
#complete_layer_upload(params = {}) ⇒ Types::CompleteLayerUploadResponse
Inform Amazon ECR that the image layer upload for a specified registry, repository name, and upload ID, has completed.
-
#create_repository(params = {}) ⇒ Types::CreateRepositoryResponse
Creates an image repository.
-
#delete_repository(params = {}) ⇒ Types::DeleteRepositoryResponse
Deletes an existing image repository.
-
#delete_repository_policy(params = {}) ⇒ Types::DeleteRepositoryPolicyResponse
Deletes the repository policy from a specified repository.
-
#describe_images(params = {}) ⇒ Types::DescribeImagesResponse
Returns metadata about the images in a repository, including image size, image tags, and creation date.
-
#describe_repositories(params = {}) ⇒ Types::DescribeRepositoriesResponse
Describes image repositories in a registry.
-
#get_authorization_token(params = {}) ⇒ Types::GetAuthorizationTokenResponse
Retrieves a token that is valid for a specified registry for 12 hours.
-
#get_download_url_for_layer(params = {}) ⇒ Types::GetDownloadUrlForLayerResponse
Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer.
-
#get_repository_policy(params = {}) ⇒ Types::GetRepositoryPolicyResponse
Retrieves the repository policy for a specified repository.
-
#initiate_layer_upload(params = {}) ⇒ Types::InitiateLayerUploadResponse
Notify Amazon ECR that you intend to upload an image layer.
-
#list_images(params = {}) ⇒ Types::ListImagesResponse
Lists all the image IDs for a given repository.
-
#put_image(params = {}) ⇒ Types::PutImageResponse
Creates or updates the image manifest and tags associated with an image.
-
#set_repository_policy(params = {}) ⇒ Types::SetRepositoryPolicyResponse
Applies a repository policy on a specified repository to control access permissions.
-
#upload_layer_part(params = {}) ⇒ Types::UploadLayerPartResponse
Uploads an image layer part to Amazon ECR.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(*args) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(*args) ⇒ Client
Returns a new instance of Client.
152 153 154 |
# File 'lib/aws-sdk-ecr/client.rb', line 152 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1299 1300 1301 |
# File 'lib/aws-sdk-ecr/client.rb', line 1299 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1302 1303 1304 |
# File 'lib/aws-sdk-ecr/client.rb', line 1302 def errors_module Errors end |
Instance Method Details
#batch_check_layer_availability(params = {}) ⇒ Types::BatchCheckLayerAvailabilityResponse
Check the availability of multiple image layers in a specified registry and repository.
<note markdown=“1”> This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the ‘docker` CLI to pull, tag, and push images.
</note>
208 209 210 211 |
# File 'lib/aws-sdk-ecr/client.rb', line 208 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 within a specified repository. Images are specified with either ‘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.
295 296 297 298 |
# File 'lib/aws-sdk-ecr/client.rb', line 295 def batch_delete_image(params = {}, = {}) req = build_request(:batch_delete_image, params) req.send_request() end |
#batch_get_image(params = {}) ⇒ Types::BatchGetImageResponse
Gets detailed information for specified images within a specified repository. Images are specified with either ‘imageTag` or `imageDigest`.
392 393 394 395 |
# File 'lib/aws-sdk-ecr/client.rb', line 392 def batch_get_image(params = {}, = {}) req = build_request(:batch_get_image, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 |
# File 'lib/aws-sdk-ecr/client.rb', line 1277 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-ecr' context[:gem_version] = '1.0.0' Seahorse::Client::Request.new(handlers, context) end |
#complete_layer_upload(params = {}) ⇒ Types::CompleteLayerUploadResponse
Inform Amazon ECR that the image layer upload for a specified registry, repository name, and upload ID, has completed. You can optionally provide a ‘sha256` digest of the image layer for data validation purposes.
<note markdown=“1”> This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the ‘docker` CLI to pull, tag, and push images.
</note>
450 451 452 453 |
# File 'lib/aws-sdk-ecr/client.rb', line 450 def complete_layer_upload(params = {}, = {}) req = build_request(:complete_layer_upload, params) req.send_request() end |
#create_repository(params = {}) ⇒ Types::CreateRepositoryResponse
Creates an image repository.
503 504 505 506 |
# File 'lib/aws-sdk-ecr/client.rb', line 503 def create_repository(params = {}, = {}) req = build_request(:create_repository, params) req.send_request() end |
#delete_repository(params = {}) ⇒ Types::DeleteRepositoryResponse
Deletes an existing image repository. If a repository contains images, you must use the ‘force` option to delete it.
565 566 567 568 |
# File 'lib/aws-sdk-ecr/client.rb', line 565 def delete_repository(params = {}, = {}) req = build_request(:delete_repository, params) req.send_request() end |
#delete_repository_policy(params = {}) ⇒ Types::DeleteRepositoryPolicyResponse
Deletes the repository policy from a specified repository.
620 621 622 623 |
# File 'lib/aws-sdk-ecr/client.rb', line 620 def delete_repository_policy(params = {}, = {}) req = build_request(:delete_repository_policy, params) req.send_request() end |
#describe_images(params = {}) ⇒ Types::DescribeImagesResponse
Returns metadata about the images in a repository, including image size, image tags, and creation date.
<note markdown=“1”> 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.
</note>
708 709 710 711 |
# File 'lib/aws-sdk-ecr/client.rb', line 708 def describe_images(params = {}, = {}) req = build_request(:describe_images, params) req.send_request() end |
#describe_repositories(params = {}) ⇒ Types::DescribeRepositoriesResponse
Describes image repositories in a registry.
800 801 802 803 |
# File 'lib/aws-sdk-ecr/client.rb', line 800 def describe_repositories(params = {}, = {}) req = build_request(:describe_repositories, params) req.send_request() end |
#get_authorization_token(params = {}) ⇒ Types::GetAuthorizationTokenResponse
Retrieves a token that is valid for a specified registry for 12 hours. This command allows you to use the ‘docker` CLI to push and pull images with Amazon ECR. If you do not specify a registry, the default registry is assumed.
The ‘authorizationToken` returned for each registry specified is a base64 encoded string that can be decoded and used in a `docker login` command to authenticate to a registry. The AWS CLI offers an `aws ecr get-login` command that simplifies the login process.
860 861 862 863 |
# File 'lib/aws-sdk-ecr/client.rb', line 860 def (params = {}, = {}) req = build_request(:get_authorization_token, params) req.send_request() end |
#get_download_url_for_layer(params = {}) ⇒ Types::GetDownloadUrlForLayerResponse
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.
<note markdown=“1”> This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the ‘docker` CLI to pull, tag, and push images.
</note>
909 910 911 912 |
# File 'lib/aws-sdk-ecr/client.rb', line 909 def get_download_url_for_layer(params = {}, = {}) req = build_request(:get_download_url_for_layer, params) req.send_request() end |
#get_repository_policy(params = {}) ⇒ Types::GetRepositoryPolicyResponse
Retrieves the repository policy for a specified repository.
963 964 965 966 |
# File 'lib/aws-sdk-ecr/client.rb', line 963 def get_repository_policy(params = {}, = {}) req = build_request(:get_repository_policy, params) req.send_request() end |
#initiate_layer_upload(params = {}) ⇒ Types::InitiateLayerUploadResponse
Notify Amazon ECR that you intend to upload an image layer.
<note markdown=“1”> This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the ‘docker` CLI to pull, tag, and push images.
</note>
1005 1006 1007 1008 |
# File 'lib/aws-sdk-ecr/client.rb', line 1005 def initiate_layer_upload(params = {}, = {}) req = build_request(:initiate_layer_upload, params) req.send_request() end |
#list_images(params = {}) ⇒ Types::ListImagesResponse
Lists all the image IDs for a given repository.
You can filter images based on whether or not they are tagged by setting the ‘tagStatus` parameter to `TAGGED` or `UNTAGGED`. 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.
1101 1102 1103 1104 |
# File 'lib/aws-sdk-ecr/client.rb', line 1101 def list_images(params = {}, = {}) req = build_request(:list_images, params) req.send_request() end |
#put_image(params = {}) ⇒ Types::PutImageResponse
Creates or updates the image manifest and tags associated with an image.
<note markdown=“1”> This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the ‘docker` CLI to pull, tag, and push images.
</note>
1155 1156 1157 1158 |
# File 'lib/aws-sdk-ecr/client.rb', line 1155 def put_image(params = {}, = {}) req = build_request(:put_image, params) req.send_request() end |
#set_repository_policy(params = {}) ⇒ Types::SetRepositoryPolicyResponse
Applies a repository policy on a specified repository to control access permissions.
1205 1206 1207 1208 |
# File 'lib/aws-sdk-ecr/client.rb', line 1205 def set_repository_policy(params = {}, = {}) req = build_request(:set_repository_policy, params) req.send_request() end |
#upload_layer_part(params = {}) ⇒ Types::UploadLayerPartResponse
Uploads an image layer part to Amazon ECR.
<note markdown=“1”> This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the ‘docker` CLI to pull, tag, and push images.
</note>
1268 1269 1270 1271 |
# File 'lib/aws-sdk-ecr/client.rb', line 1268 def upload_layer_part(params = {}, = {}) req = build_request(:upload_layer_part, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1292 1293 1294 |
# File 'lib/aws-sdk-ecr/client.rb', line 1292 def waiter_names [] end |