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.
-
#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_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.
-
#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_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.
-
#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.
395 396 397 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 395 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.
454 455 456 457 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 454 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.
542 543 544 545 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 542 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.
643 644 645 646 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 643 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.
683 684 685 686 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 683 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.
744 745 746 747 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 744 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.
825 826 827 828 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 825 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.
935 936 937 938 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 935 def create_repository(params = {}, = {}) req = build_request(:create_repository, params) req.send_request() end |
#delete_lifecycle_policy(params = {}) ⇒ Types::DeleteLifecyclePolicyResponse
Deletes the lifecycle policy associated with the specified repository.
975 976 977 978 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 975 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.
1018 1019 1020 1021 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 1018 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.
1039 1040 1041 1042 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 1039 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.
1110 1111 1112 1113 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 1110 def delete_repository(params = {}, = {}) req = build_request(:delete_repository, params) req.send_request() end |
#delete_repository_policy(params = {}) ⇒ Types::DeleteRepositoryPolicyResponse
Deletes the repository policy associated with the specified repository.
1166 1167 1168 1169 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 1166 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.
1216 1217 1218 1219 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 1216 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
1368 1369 1370 1371 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 1368 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.
1467 1468 1469 1470 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 1467 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.
1536 1537 1538 1539 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 1536 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.
1565 1566 1567 1568 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 1565 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.
1667 1668 1669 1670 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 1667 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 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.
1733 1734 1735 1736 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 1733 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.
1785 1786 1787 1788 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 1785 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.
1825 1826 1827 1828 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 1825 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
1925 1926 1927 1928 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 1925 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.
1946 1947 1948 1949 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 1946 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.
1972 1973 1974 1975 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 1972 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.
2026 2027 2028 2029 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 2026 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.
2073 2074 2075 2076 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 2073 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.
2171 2172 2173 2174 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 2171 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.
2203 2204 2205 2206 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 2203 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 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.
2273 2274 2275 2276 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 2273 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.
2325 2326 2327 2328 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 2325 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.
2378 2379 2380 2381 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 2378 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.
2425 2426 2427 2428 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 2425 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.
2471 2472 2473 2474 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 2471 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.
2533 2534 2535 2536 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 2533 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.
2601 2602 2603 2604 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 2601 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.
2662 2663 2664 2665 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 2662 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.
2719 2720 2721 2722 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 2719 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.
2766 2767 2768 2769 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 2766 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.
2803 2804 2805 2806 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 2803 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Deletes specified tags from a resource.
2831 2832 2833 2834 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 2831 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.
2878 2879 2880 2881 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 2878 def update_pull_through_cache_rule(params = {}, = {}) req = build_request(:update_pull_through_cache_rule, 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.
2948 2949 2950 2951 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 2948 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.
2996 2997 2998 2999 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 2996 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 |
3107 3108 3109 3110 3111 |
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/client.rb', line 3107 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |