Class: Aws::ECR::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ECR::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-ecr/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.
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 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 basic scan type version 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 by setting the
name
parameter to eitherCLAIR
toAWS_NATIVE
. -
#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 an 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.
Instance Method Summary collapse
-
#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.
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.
429 430 431 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 429 def initialize(*args) super 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.
docker
CLI to pull, tag, and push images.
488 489 490 491 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 488 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.
576 577 578 579 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 576 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.
677 678 679 680 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 677 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.
717 718 719 720 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 717 def batch_get_repository_scanning_configuration(params = {}, = {}) req = build_request(:batch_get_repository_scanning_configuration, params) req.send_request() 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.
docker
CLI to pull, tag, and push images.
778 779 780 781 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 778 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.
859 860 861 862 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 859 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.
969 970 971 972 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 969 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.
1147 1148 1149 1150 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 1147 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.
1187 1188 1189 1190 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 1187 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.
1230 1231 1232 1233 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 1230 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.
1251 1252 1253 1254 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 1251 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.
1322 1323 1324 1325 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 1322 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.
1390 1391 1392 1393 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 1390 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.
1446 1447 1448 1449 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 1446 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.
1496 1497 1498 1499 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 1496 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
1648 1649 1650 1651 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 1648 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.
docker images
command shows the uncompressed image size, so it may
return a larger image size than the image sizes returned by
DescribeImages.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1747 1748 1749 1750 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 1747 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.
1816 1817 1818 1819 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 1816 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.
1845 1846 1847 1848 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 1845 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.
1947 1948 1949 1950 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 1947 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.
2075 2076 2077 2078 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 2075 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 basic scan type version name.
2105 2106 2107 2108 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 2105 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.
2171 2172 2173 2174 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 2171 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.
docker
CLI to pull, tag, and push images.
2223 2224 2225 2226 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 2223 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.
2263 2264 2265 2266 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 2263 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
2363 2364 2365 2366 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 2363 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.
2384 2385 2386 2387 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 2384 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.
2410 2411 2412 2413 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 2410 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.
2464 2465 2466 2467 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 2464 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.
docker
CLI to pull, tag, and push images.
2511 2512 2513 2514 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 2511 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.
2609 2610 2611 2612 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 2609 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.
2641 2642 2643 2644 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 2641 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 by setting the name
parameter to either CLAIR
to AWS_NATIVE
.
2677 2678 2679 2680 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 2677 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.
docker
CLI to pull, tag, and push images.
2747 2748 2749 2750 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 2747 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.
2799 2800 2801 2802 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 2799 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.
2852 2853 2854 2855 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 2852 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.
2899 2900 2901 2902 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 2899 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.
2945 2946 2947 2948 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 2945 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.
3007 3008 3009 3010 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 3007 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.
3078 3079 3080 3081 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 3078 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.
3139 3140 3141 3142 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 3139 def set_repository_policy(params = {}, = {}) req = build_request(:set_repository_policy, params) req.send_request() end |
#start_image_scan(params = {}) ⇒ Types::StartImageScanResponse
Starts an image vulnerability scan. An 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. For more information, see Image scanning in the Amazon Elastic Container Registry User Guide.
3196 3197 3198 3199 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 3196 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.
3243 3244 3245 3246 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 3243 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.
3280 3281 3282 3283 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 3280 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Deletes specified tags from a resource.
3308 3309 3310 3311 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 3308 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.
3355 3356 3357 3358 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 3355 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.
3510 3511 3512 3513 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 3510 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.
docker
CLI to pull, tag, and push images.
3580 3581 3582 3583 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 3580 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.
3628 3629 3630 3631 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 3628 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 |
3739 3740 3741 3742 3743 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 3739 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |