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
Overview
An API client for ECR. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::ECR::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#batch_check_layer_availability(params = {}) ⇒ Types::BatchCheckLayerAvailabilityResponse
Checks the availability of one or more image layers in a repository.
-
#batch_delete_image(params = {}) ⇒ Types::BatchDeleteImageResponse
Deletes a list of specified images within a repository.
-
#batch_get_image(params = {}) ⇒ Types::BatchGetImageResponse
Gets detailed information for an image.
-
#batch_get_repository_scanning_configuration(params = {}) ⇒ Types::BatchGetRepositoryScanningConfigurationResponse
Gets the scanning configuration for one or more repositories.
-
#complete_layer_upload(params = {}) ⇒ Types::CompleteLayerUploadResponse
Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and upload ID.
-
#create_pull_through_cache_rule(params = {}) ⇒ Types::CreatePullThroughCacheRuleResponse
Creates a pull through cache rule.
-
#create_repository(params = {}) ⇒ Types::CreateRepositoryResponse
Creates a repository.
-
#create_repository_creation_template(params = {}) ⇒ Types::CreateRepositoryCreationTemplateResponse
Creates a repository creation template.
-
#delete_lifecycle_policy(params = {}) ⇒ Types::DeleteLifecyclePolicyResponse
Deletes the lifecycle policy associated with the specified repository.
-
#delete_pull_through_cache_rule(params = {}) ⇒ Types::DeletePullThroughCacheRuleResponse
Deletes a pull through cache rule.
-
#delete_registry_policy(params = {}) ⇒ Types::DeleteRegistryPolicyResponse
Deletes the registry permissions policy.
-
#delete_repository(params = {}) ⇒ Types::DeleteRepositoryResponse
Deletes a repository.
-
#delete_repository_creation_template(params = {}) ⇒ Types::DeleteRepositoryCreationTemplateResponse
Deletes a repository creation template.
-
#delete_repository_policy(params = {}) ⇒ Types::DeleteRepositoryPolicyResponse
Deletes the repository policy associated with the specified repository.
-
#describe_image_replication_status(params = {}) ⇒ Types::DescribeImageReplicationStatusResponse
Returns the replication status for a specified image.
-
#describe_image_scan_findings(params = {}) ⇒ Types::DescribeImageScanFindingsResponse
Returns the scan findings for the specified image.
-
#describe_images(params = {}) ⇒ Types::DescribeImagesResponse
Returns metadata about the images in a repository.
-
#describe_pull_through_cache_rules(params = {}) ⇒ Types::DescribePullThroughCacheRulesResponse
Returns the pull through cache rules for a registry.
-
#describe_registry(params = {}) ⇒ Types::DescribeRegistryResponse
Describes the settings for a registry.
-
#describe_repositories(params = {}) ⇒ Types::DescribeRepositoriesResponse
Describes image repositories in a registry.
-
#describe_repository_creation_templates(params = {}) ⇒ Types::DescribeRepositoryCreationTemplatesResponse
Returns details about the repository creation templates in a registry.
-
#get_account_setting(params = {}) ⇒ Types::GetAccountSettingResponse
Retrieves the account setting value for the specified setting name.
-
#get_authorization_token(params = {}) ⇒ Types::GetAuthorizationTokenResponse
Retrieves an authorization token.
-
#get_download_url_for_layer(params = {}) ⇒ Types::GetDownloadUrlForLayerResponse
Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer.
-
#get_lifecycle_policy(params = {}) ⇒ Types::GetLifecyclePolicyResponse
Retrieves the lifecycle policy for the specified repository.
-
#get_lifecycle_policy_preview(params = {}) ⇒ Types::GetLifecyclePolicyPreviewResponse
Retrieves the results of the lifecycle policy preview request for the specified repository.
-
#get_registry_policy(params = {}) ⇒ Types::GetRegistryPolicyResponse
Retrieves the permissions policy for a registry.
-
#get_registry_scanning_configuration(params = {}) ⇒ Types::GetRegistryScanningConfigurationResponse
Retrieves the scanning configuration for a 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_images(params = {}) ⇒ Types::ListImagesResponse
Lists all the image IDs for the specified repository.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List the tags for an Amazon ECR resource.
-
#put_account_setting(params = {}) ⇒ Types::PutAccountSettingResponse
Allows you to change the basic scan type version or registry policy scope.
-
#put_image(params = {}) ⇒ Types::PutImageResponse
Creates or updates the image manifest and tags associated with an image.
-
#put_image_scanning_configuration(params = {}) ⇒ Types::PutImageScanningConfigurationResponse
The ‘PutImageScanningConfiguration` API is being deprecated, in favor of specifying the image scanning configuration at the registry level.
-
#put_image_tag_mutability(params = {}) ⇒ Types::PutImageTagMutabilityResponse
Updates the image tag mutability settings for the specified repository.
-
#put_lifecycle_policy(params = {}) ⇒ Types::PutLifecyclePolicyResponse
Creates or updates the lifecycle policy for the specified repository.
-
#put_registry_policy(params = {}) ⇒ Types::PutRegistryPolicyResponse
Creates or updates the permissions policy for your registry.
-
#put_registry_scanning_configuration(params = {}) ⇒ Types::PutRegistryScanningConfigurationResponse
Creates or updates the scanning configuration for your private registry.
-
#put_replication_configuration(params = {}) ⇒ Types::PutReplicationConfigurationResponse
Creates or updates the replication configuration for a registry.
-
#set_repository_policy(params = {}) ⇒ Types::SetRepositoryPolicyResponse
Applies a repository policy to the specified repository to control access permissions.
-
#start_image_scan(params = {}) ⇒ Types::StartImageScanResponse
Starts a basic image vulnerability scan.
-
#start_lifecycle_policy_preview(params = {}) ⇒ Types::StartLifecyclePolicyPreviewResponse
Starts a preview of a lifecycle policy for the specified repository.
-
#tag_resource(params = {}) ⇒ Struct
Adds specified tags to a resource with the specified ARN.
-
#untag_resource(params = {}) ⇒ Struct
Deletes specified tags from a resource.
-
#update_pull_through_cache_rule(params = {}) ⇒ Types::UpdatePullThroughCacheRuleResponse
Updates an existing pull through cache rule.
-
#update_repository_creation_template(params = {}) ⇒ Types::UpdateRepositoryCreationTemplateResponse
Updates an existing repository creation template.
-
#upload_layer_part(params = {}) ⇒ Types::UploadLayerPartResponse
Uploads an image layer part to Amazon ECR.
-
#validate_pull_through_cache_rule(params = {}) ⇒ Types::ValidatePullThroughCacheRuleResponse
Validates an existing pull through cache rule for an upstream registry that requires authentication.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
474 475 476 |
# File 'lib/aws-sdk-ecr/client.rb', line 474 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.
3835 3836 3837 |
# File 'lib/aws-sdk-ecr/client.rb', line 3835 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.
3838 3839 3840 |
# File 'lib/aws-sdk-ecr/client.rb', line 3838 def errors_module Errors end |
Instance Method Details
#batch_check_layer_availability(params = {}) ⇒ Types::BatchCheckLayerAvailabilityResponse
Checks the availability of one or more image layers in a repository.
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.
<note markdown=“1”> This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the ‘docker` CLI to pull, tag, and push images.
</note>
533 534 535 536 |
# File 'lib/aws-sdk-ecr/client.rb', line 533 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 repository. 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 image’s digest in your request.
621 622 623 624 |
# File 'lib/aws-sdk-ecr/client.rb', line 621 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 an image. Images are specified with either an ‘imageTag` or `imageDigest`.
When an image is pulled, the BatchGetImage API is called once to retrieve the image manifest.
722 723 724 725 |
# File 'lib/aws-sdk-ecr/client.rb', line 722 def batch_get_image(params = {}, = {}) req = build_request(:batch_get_image, params) req.send_request() end |
#batch_get_repository_scanning_configuration(params = {}) ⇒ Types::BatchGetRepositoryScanningConfigurationResponse
Gets the scanning configuration for one or more repositories.
762 763 764 765 |
# File 'lib/aws-sdk-ecr/client.rb', line 762 def batch_get_repository_scanning_configuration(params = {}, = {}) req = build_request(:batch_get_repository_scanning_configuration, 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.
3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 |
# File 'lib/aws-sdk-ecr/client.rb', line 3693 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) tracer = config.telemetry_provider.tracer_provider.tracer( Aws::Telemetry.module_to_tracer_name('Aws::ECR') ) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config, tracer: tracer ) context[:gem_name] = 'aws-sdk-ecr' context[:gem_version] = '1.97.0' Seahorse::Client::Request.new(handlers, context) end |
#complete_layer_upload(params = {}) ⇒ Types::CompleteLayerUploadResponse
Informs Amazon ECR that the image layer upload has completed for a specified 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 per each new image layer to verify that the upload has completed.
<note markdown=“1”> This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the ‘docker` CLI to pull, tag, and push images.
</note>
823 824 825 826 |
# File 'lib/aws-sdk-ecr/client.rb', line 823 def complete_layer_upload(params = {}, = {}) req = build_request(:complete_layer_upload, params) req.send_request() end |
#create_pull_through_cache_rule(params = {}) ⇒ Types::CreatePullThroughCacheRuleResponse
Creates a pull through cache rule. A pull through cache rule provides a way to cache images from an upstream registry source in your Amazon ECR private registry. For more information, see [Using pull through cache rules] in the *Amazon Elastic Container Registry User Guide*.
[1]: docs.aws.amazon.com/AmazonECR/latest/userguide/pull-through-cache.html
904 905 906 907 |
# File 'lib/aws-sdk-ecr/client.rb', line 904 def create_pull_through_cache_rule(params = {}, = {}) req = build_request(:create_pull_through_cache_rule, params) req.send_request() end |
#create_repository(params = {}) ⇒ Types::CreateRepositoryResponse
Creates a repository. For more information, see [Amazon ECR repositories] in the *Amazon Elastic Container Registry User Guide*.
[1]: docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html
1014 1015 1016 1017 |
# File 'lib/aws-sdk-ecr/client.rb', line 1014 def create_repository(params = {}, = {}) req = build_request(:create_repository, params) req.send_request() end |
#create_repository_creation_template(params = {}) ⇒ Types::CreateRepositoryCreationTemplateResponse
Creates a repository creation template. This template is used to define the settings for repositories created by Amazon ECR on your behalf. For example, repositories created through pull through cache actions. For more information, see [Private repository creation templates] in the *Amazon Elastic Container Registry User Guide*.
[1]: docs.aws.amazon.com/AmazonECR/latest/userguide/repository-creation-templates.html
1192 1193 1194 1195 |
# File 'lib/aws-sdk-ecr/client.rb', line 1192 def create_repository_creation_template(params = {}, = {}) req = build_request(:create_repository_creation_template, params) req.send_request() end |
#delete_lifecycle_policy(params = {}) ⇒ Types::DeleteLifecyclePolicyResponse
Deletes the lifecycle policy associated with the specified repository.
1232 1233 1234 1235 |
# File 'lib/aws-sdk-ecr/client.rb', line 1232 def delete_lifecycle_policy(params = {}, = {}) req = build_request(:delete_lifecycle_policy, params) req.send_request() end |
#delete_pull_through_cache_rule(params = {}) ⇒ Types::DeletePullThroughCacheRuleResponse
Deletes a pull through cache rule.
1275 1276 1277 1278 |
# File 'lib/aws-sdk-ecr/client.rb', line 1275 def delete_pull_through_cache_rule(params = {}, = {}) req = build_request(:delete_pull_through_cache_rule, params) req.send_request() end |
#delete_registry_policy(params = {}) ⇒ Types::DeleteRegistryPolicyResponse
Deletes the registry permissions policy.
1296 1297 1298 1299 |
# File 'lib/aws-sdk-ecr/client.rb', line 1296 def delete_registry_policy(params = {}, = {}) req = build_request(:delete_registry_policy, params) req.send_request() end |
#delete_repository(params = {}) ⇒ Types::DeleteRepositoryResponse
Deletes a repository. If the repository isn’t empty, you must either delete the contents of the repository or use the ‘force` option to delete the repository and have Amazon ECR delete all of its contents on your behalf.
1367 1368 1369 1370 |
# File 'lib/aws-sdk-ecr/client.rb', line 1367 def delete_repository(params = {}, = {}) req = build_request(:delete_repository, params) req.send_request() end |
#delete_repository_creation_template(params = {}) ⇒ Types::DeleteRepositoryCreationTemplateResponse
Deletes a repository creation template.
1435 1436 1437 1438 |
# File 'lib/aws-sdk-ecr/client.rb', line 1435 def delete_repository_creation_template(params = {}, = {}) req = build_request(:delete_repository_creation_template, params) req.send_request() end |
#delete_repository_policy(params = {}) ⇒ Types::DeleteRepositoryPolicyResponse
Deletes the repository policy associated with the specified repository.
1491 1492 1493 1494 |
# File 'lib/aws-sdk-ecr/client.rb', line 1491 def delete_repository_policy(params = {}, = {}) req = build_request(:delete_repository_policy, params) req.send_request() end |
#describe_image_replication_status(params = {}) ⇒ Types::DescribeImageReplicationStatusResponse
Returns the replication status for a specified image.
1541 1542 1543 1544 |
# File 'lib/aws-sdk-ecr/client.rb', line 1541 def describe_image_replication_status(params = {}, = {}) req = build_request(:describe_image_replication_status, params) req.send_request() end |
#describe_image_scan_findings(params = {}) ⇒ Types::DescribeImageScanFindingsResponse
Returns the scan findings for the specified image.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
The following waiters are defined for this operation (see #wait_until for detailed usage):
* image_scan_complete
1696 1697 1698 1699 |
# File 'lib/aws-sdk-ecr/client.rb', line 1696 def describe_image_scan_findings(params = {}, = {}) req = build_request(:describe_image_scan_findings, params) req.send_request() end |
#describe_images(params = {}) ⇒ Types::DescribeImagesResponse
Returns metadata about the images in a repository.
<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>
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1795 1796 1797 1798 |
# File 'lib/aws-sdk-ecr/client.rb', line 1795 def describe_images(params = {}, = {}) req = build_request(:describe_images, params) req.send_request() end |
#describe_pull_through_cache_rules(params = {}) ⇒ Types::DescribePullThroughCacheRulesResponse
Returns the pull through cache rules for a registry.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1864 1865 1866 1867 |
# File 'lib/aws-sdk-ecr/client.rb', line 1864 def describe_pull_through_cache_rules(params = {}, = {}) req = build_request(:describe_pull_through_cache_rules, params) req.send_request() end |
#describe_registry(params = {}) ⇒ Types::DescribeRegistryResponse
Describes the settings for a registry. The replication configuration for a repository can be created or updated with the PutReplicationConfiguration API action.
1893 1894 1895 1896 |
# File 'lib/aws-sdk-ecr/client.rb', line 1893 def describe_registry(params = {}, = {}) req = build_request(:describe_registry, params) req.send_request() end |
#describe_repositories(params = {}) ⇒ Types::DescribeRepositoriesResponse
Describes image repositories in a registry.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1995 1996 1997 1998 |
# File 'lib/aws-sdk-ecr/client.rb', line 1995 def describe_repositories(params = {}, = {}) req = build_request(:describe_repositories, params) req.send_request() end |
#describe_repository_creation_templates(params = {}) ⇒ Types::DescribeRepositoryCreationTemplatesResponse
Returns details about the repository creation templates in a registry. The ‘prefixes` request parameter can be used to return the details for a specific repository creation template.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2123 2124 2125 2126 |
# File 'lib/aws-sdk-ecr/client.rb', line 2123 def describe_repository_creation_templates(params = {}, = {}) req = build_request(:describe_repository_creation_templates, params) req.send_request() end |
#get_account_setting(params = {}) ⇒ Types::GetAccountSettingResponse
Retrieves the account setting value for the specified setting name.
2154 2155 2156 2157 |
# File 'lib/aws-sdk-ecr/client.rb', line 2154 def get_account_setting(params = {}, = {}) req = build_request(:get_account_setting, params) req.send_request() end |
#get_authorization_token(params = {}) ⇒ Types::GetAuthorizationTokenResponse
Retrieves an authorization token. An authorization token represents your IAM authentication credentials and can be used to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid for 12 hours.
The ‘authorizationToken` returned is a base64 encoded string that can be decoded and used in a `docker login` command to authenticate to a registry. The CLI offers an `get-login-password` command that simplifies the login process. For more information, see [Registry authentication] in the *Amazon Elastic Container Registry User Guide*.
[1]: docs.aws.amazon.com/AmazonECR/latest/userguide/Registries.html#registry_auth
2220 2221 2222 2223 |
# File 'lib/aws-sdk-ecr/client.rb', line 2220 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.
When an image is pulled, the GetDownloadUrlForLayer API is called once per image layer that is not already cached.
<note markdown=“1”> This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the ‘docker` CLI to pull, tag, and push images.
</note>
2272 2273 2274 2275 |
# File 'lib/aws-sdk-ecr/client.rb', line 2272 def get_download_url_for_layer(params = {}, = {}) req = build_request(:get_download_url_for_layer, params) req.send_request() end |
#get_lifecycle_policy(params = {}) ⇒ Types::GetLifecyclePolicyResponse
Retrieves the lifecycle policy for the specified repository.
2312 2313 2314 2315 |
# File 'lib/aws-sdk-ecr/client.rb', line 2312 def get_lifecycle_policy(params = {}, = {}) req = build_request(:get_lifecycle_policy, params) req.send_request() end |
#get_lifecycle_policy_preview(params = {}) ⇒ Types::GetLifecyclePolicyPreviewResponse
Retrieves the results of the lifecycle policy preview request for the specified repository.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
The following waiters are defined for this operation (see #wait_until for detailed usage):
* lifecycle_policy_preview_complete
2412 2413 2414 2415 |
# File 'lib/aws-sdk-ecr/client.rb', line 2412 def get_lifecycle_policy_preview(params = {}, = {}) req = build_request(:get_lifecycle_policy_preview, params) req.send_request() end |
#get_registry_policy(params = {}) ⇒ Types::GetRegistryPolicyResponse
Retrieves the permissions policy for a registry.
2433 2434 2435 2436 |
# File 'lib/aws-sdk-ecr/client.rb', line 2433 def get_registry_policy(params = {}, = {}) req = build_request(:get_registry_policy, params) req.send_request() end |
#get_registry_scanning_configuration(params = {}) ⇒ Types::GetRegistryScanningConfigurationResponse
Retrieves the scanning configuration for a registry.
2459 2460 2461 2462 |
# File 'lib/aws-sdk-ecr/client.rb', line 2459 def get_registry_scanning_configuration(params = {}, = {}) req = build_request(:get_registry_scanning_configuration, params) req.send_request() end |
#get_repository_policy(params = {}) ⇒ Types::GetRepositoryPolicyResponse
Retrieves the repository policy for the specified repository.
2513 2514 2515 2516 |
# File 'lib/aws-sdk-ecr/client.rb', line 2513 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 per image layer that has not already been uploaded. Whether or not an image layer has been uploaded is determined by the BatchCheckLayerAvailability API action.
<note markdown=“1”> This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the ‘docker` CLI to pull, tag, and push images.
</note>
2560 2561 2562 2563 |
# File 'lib/aws-sdk-ecr/client.rb', line 2560 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 the specified repository.
You can filter images based on whether or not they are tagged by using the ‘tagStatus` filter and specifying either `TAGGED`, `UNTAGGED` or `ANY`. 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2658 2659 2660 2661 |
# File 'lib/aws-sdk-ecr/client.rb', line 2658 def list_images(params = {}, = {}) req = build_request(:list_images, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List the tags for an Amazon ECR resource.
2690 2691 2692 2693 |
# File 'lib/aws-sdk-ecr/client.rb', line 2690 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_account_setting(params = {}) ⇒ Types::PutAccountSettingResponse
Allows you to change the basic scan type version or registry policy scope.
2729 2730 2731 2732 |
# File 'lib/aws-sdk-ecr/client.rb', line 2729 def put_account_setting(params = {}, = {}) req = build_request(:put_account_setting, params) req.send_request() end |
#put_image(params = {}) ⇒ Types::PutImageResponse
Creates or updates the image manifest and tags 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 associated with the image.
<note markdown=“1”> This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the ‘docker` CLI to pull, tag, and push images.
</note>
2799 2800 2801 2802 |
# File 'lib/aws-sdk-ecr/client.rb', line 2799 def put_image(params = {}, = {}) req = build_request(:put_image, params) req.send_request() end |
#put_image_scanning_configuration(params = {}) ⇒ Types::PutImageScanningConfigurationResponse
The ‘PutImageScanningConfiguration` API is being deprecated, in favor of specifying the image scanning configuration at the registry level. For more information, see PutRegistryScanningConfiguration.
Updates the image scanning configuration for the specified repository.
2851 2852 2853 2854 |
# File 'lib/aws-sdk-ecr/client.rb', line 2851 def put_image_scanning_configuration(params = {}, = {}) req = build_request(:put_image_scanning_configuration, params) req.send_request() end |
#put_image_tag_mutability(params = {}) ⇒ Types::PutImageTagMutabilityResponse
Updates the image tag mutability settings for the specified repository. For more information, see [Image tag mutability] in the *Amazon Elastic Container Registry User Guide*.
[1]: docs.aws.amazon.com/AmazonECR/latest/userguide/image-tag-mutability.html
2904 2905 2906 2907 |
# File 'lib/aws-sdk-ecr/client.rb', line 2904 def put_image_tag_mutability(params = {}, = {}) req = build_request(:put_image_tag_mutability, params) req.send_request() end |
#put_lifecycle_policy(params = {}) ⇒ Types::PutLifecyclePolicyResponse
Creates or updates the lifecycle policy for the specified repository. For more information, see [Lifecycle policy template].
[1]: docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html
2951 2952 2953 2954 |
# File 'lib/aws-sdk-ecr/client.rb', line 2951 def put_lifecycle_policy(params = {}, = {}) req = build_request(:put_lifecycle_policy, params) req.send_request() end |
#put_registry_policy(params = {}) ⇒ Types::PutRegistryPolicyResponse
Creates or updates the permissions policy for your registry.
A registry policy is used to specify permissions for another Amazon Web Services account and is used when configuring cross-account replication. For more information, see [Registry permissions] in the *Amazon Elastic Container Registry User Guide*.
[1]: docs.aws.amazon.com/AmazonECR/latest/userguide/registry-permissions.html
2997 2998 2999 3000 |
# File 'lib/aws-sdk-ecr/client.rb', line 2997 def put_registry_policy(params = {}, = {}) req = build_request(:put_registry_policy, params) req.send_request() end |
#put_registry_scanning_configuration(params = {}) ⇒ Types::PutRegistryScanningConfigurationResponse
Creates or updates the scanning configuration for your private registry.
3059 3060 3061 3062 |
# File 'lib/aws-sdk-ecr/client.rb', line 3059 def put_registry_scanning_configuration(params = {}, = {}) req = build_request(:put_registry_scanning_configuration, params) req.send_request() end |
#put_replication_configuration(params = {}) ⇒ Types::PutReplicationConfigurationResponse
Creates or updates the replication configuration for a registry. The existing replication configuration for a repository can be retrieved with the DescribeRegistry API action. The first time the PutReplicationConfiguration API is called, a service-linked IAM role is created in your account for the replication process. For more information, see [Using service-linked roles for Amazon ECR] in the *Amazon Elastic Container Registry User Guide*. For more information on the custom role for replication, see [Creating an IAM role for replication].
<note markdown=“1”> When configuring cross-account replication, the destination account must grant the source account permission to replicate. This permission is controlled using a registry permissions policy. For more information, see PutRegistryPolicy.
</note>
[1]: docs.aws.amazon.com/AmazonECR/latest/userguide/using-service-linked-roles.html [2]: docs.aws.amazon.com/AmazonECR/latest/userguide/replication-creation-templates.html#roles-creatingrole-user-console
3130 3131 3132 3133 |
# File 'lib/aws-sdk-ecr/client.rb', line 3130 def put_replication_configuration(params = {}, = {}) req = build_request(:put_replication_configuration, params) req.send_request() end |
#set_repository_policy(params = {}) ⇒ Types::SetRepositoryPolicyResponse
Applies a repository policy to the specified repository to control access permissions. For more information, see [Amazon ECR Repository policies] in the *Amazon Elastic Container Registry User Guide*.
[1]: docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policies.html
3191 3192 3193 3194 |
# File 'lib/aws-sdk-ecr/client.rb', line 3191 def set_repository_policy(params = {}, = {}) req = build_request(:set_repository_policy, params) req.send_request() end |
#start_image_scan(params = {}) ⇒ Types::StartImageScanResponse
Starts a basic image vulnerability scan.
A basic image scan can only be started once per 24 hours on an individual image. This limit includes if an image was scanned on initial push. You can start up to 100,000 basic scans per 24 hours. This limit includes both scans on initial push and scans initiated by the StartImageScan API. For more information, see [Basic scanning] in the *Amazon Elastic Container Registry User Guide*.
[1]: docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning-basic.html
3252 3253 3254 3255 |
# File 'lib/aws-sdk-ecr/client.rb', line 3252 def start_image_scan(params = {}, = {}) req = build_request(:start_image_scan, params) req.send_request() end |
#start_lifecycle_policy_preview(params = {}) ⇒ Types::StartLifecyclePolicyPreviewResponse
Starts a preview of a lifecycle policy for the specified repository. This allows you to see the results before associating the lifecycle policy with the repository.
3299 3300 3301 3302 |
# File 'lib/aws-sdk-ecr/client.rb', line 3299 def start_lifecycle_policy_preview(params = {}, = {}) req = build_request(:start_lifecycle_policy_preview, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds specified tags to a resource with the specified ARN. Existing tags on a resource are not changed if they are not specified in the request parameters.
3336 3337 3338 3339 |
# File 'lib/aws-sdk-ecr/client.rb', line 3336 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Deletes specified tags from a resource.
3364 3365 3366 3367 |
# File 'lib/aws-sdk-ecr/client.rb', line 3364 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_pull_through_cache_rule(params = {}) ⇒ Types::UpdatePullThroughCacheRuleResponse
Updates an existing pull through cache rule.
3411 3412 3413 3414 |
# File 'lib/aws-sdk-ecr/client.rb', line 3411 def update_pull_through_cache_rule(params = {}, = {}) req = build_request(:update_pull_through_cache_rule, params) req.send_request() end |
#update_repository_creation_template(params = {}) ⇒ Types::UpdateRepositoryCreationTemplateResponse
Updates an existing repository creation template.
3566 3567 3568 3569 |
# File 'lib/aws-sdk-ecr/client.rb', line 3566 def update_repository_creation_template(params = {}, = {}) req = build_request(:update_repository_creation_template, 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 (or about 20MB). The UploadLayerPart API is called once per each new image layer part.
<note markdown=“1”> This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the ‘docker` CLI to pull, tag, and push images.
</note>
3636 3637 3638 3639 |
# File 'lib/aws-sdk-ecr/client.rb', line 3636 def upload_layer_part(params = {}, = {}) req = build_request(:upload_layer_part, params) req.send_request() end |
#validate_pull_through_cache_rule(params = {}) ⇒ Types::ValidatePullThroughCacheRuleResponse
Validates an existing pull through cache rule for an upstream registry that requires authentication. This will retrieve the contents of the Amazon Web Services Secrets Manager secret, verify the syntax, and then validate that authentication to the upstream registry is successful.
3684 3685 3686 3687 |
# File 'lib/aws-sdk-ecr/client.rb', line 3684 def validate_pull_through_cache_rule(params = {}, = {}) req = build_request(:validate_pull_through_cache_rule, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
## Basic Usage
A waiter will call an API operation until:
-
It is successful
-
It enters a terminal state
-
It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)
## Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
## Callbacks
You can be notified before each polling attempt and before each delay. If you throw ‘:success` or `:failure` from these callbacks, it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
## Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
## Valid Waiters
The following table lists the valid waiter names, the operations they call, and the default ‘:delay` and `:max_attempts` values.
| waiter_name | params | :delay | :max_attempts | | ——————————— | ————————————- | ——– | ————- | | image_scan_complete | #describe_image_scan_findings | 5 | 60 | | lifecycle_policy_preview_complete | #get_lifecycle_policy_preview | 5 | 20 |
3800 3801 3802 3803 3804 |
# File 'lib/aws-sdk-ecr/client.rb', line 3800 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) 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.
3808 3809 3810 |
# File 'lib/aws-sdk-ecr/client.rb', line 3808 def waiter_names waiters.keys end |