lib/aws-sdk-ecr/client.rb in aws-sdk-ecr-1.26.0 vs lib/aws-sdk-ecr/client.rb in aws-sdk-ecr-1.27.0

- old
+ new

@@ -30,15 +30,15 @@ Aws::Plugins::GlobalConfiguration.add_identifier(:ecr) module Aws::ECR # 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, - # # ... - # ) + # 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. @@ -227,20 +227,24 @@ # used by the default backoff function. This option is only used in the # `legacy` retry mode. # # @option options [String] :retry_mode ("legacy") # Specifies which retry algorithm to use. Values are: - # * `legacy` - The pre-existing retry behavior. This is default value if - # no retry mode is provided. - # * `standard` - A standardized set of retry rules across the AWS SDKs. - # This includes support for retry quotas, which limit the number of - # unsuccessful retries a client can make. - # * `adaptive` - An experimental retry mode that includes all the - # functionality of `standard` mode along with automatic client side - # throttling. This is a provisional mode that may change behavior - # in the future. # + # * `legacy` - The pre-existing retry behavior. This is default value if + # no retry mode is provided. + # + # * `standard` - A standardized set of retry rules across the AWS SDKs. + # This includes support for retry quotas, which limit the number of + # unsuccessful retries a client can make. + # + # * `adaptive` - An experimental retry mode that includes all the + # functionality of `standard` mode along with automatic client side + # throttling. This is a provisional mode that may change behavior + # in the future. + # + # # @option options [String] :secret_access_key # # @option options [String] :session_token # # @option options [Boolean] :simple_json (false) @@ -273,12 +277,11 @@ # seconds to wait when opening a HTTP session before raising a # `Timeout::Error`. # # @option options [Integer] :http_read_timeout (60) The default # number of seconds to wait for response data. This value can - # safely be set - # per-request on the session yielded by {#session_for}. + # safely be set per-request on the session. # # @option options [Float] :http_idle_timeout (5) The number of # seconds a connection is allowed to sit idle before it is # considered stale. Stale connections are closed and removed # from the pool before making a request. @@ -286,11 +289,11 @@ # @option options [Float] :http_continue_timeout (1) The number of # seconds to wait for a 100-continue response before sending the # request body. This option has no effect unless the request has # "Expect" header set to "100-continue". Defaults to `nil` which # disables this behaviour. This value can safely be set per - # request on the session yielded by {#session_for}. + # request on the session. # # @option options [Boolean] :http_wire_trace (false) When `true`, # HTTP debug output will be sent to the `:logger`. # # @option options [Boolean] :ssl_verify_peer (true) When `true`, @@ -316,20 +319,17 @@ # @!group API Operations # 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 is, then the image - # layer is skipped. + # to verify if it has been uploaded before. If it has been uploaded, + # then the image layer is skipped. # - # When an image is pulled from a repository, each image layer is checked - # once to verify it is available to be pulled. + # <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 markdown="1"> This operation is used by the Amazon ECR proxy, and it is not intended - # for general use by customers for pulling and pushing images. In most - # cases, you should use the `docker` CLI to pull, tag, and push images. - # # </note> # # @option params [String] :registry_id # The AWS account ID associated with the registry that contains the # image layers to check. If you do not specify a registry, the default @@ -450,11 +450,11 @@ # resp.image_ids[0].image_digest #=> String # resp.image_ids[0].image_tag #=> String # resp.failures #=> Array # resp.failures[0].image_id.image_digest #=> String # resp.failures[0].image_id.image_tag #=> String - # resp.failures[0].failure_code #=> String, one of "InvalidImageDigest", "InvalidImageTag", "ImageTagDoesNotMatchDigest", "ImageNotFound", "MissingDigestAndTag" + # resp.failures[0].failure_code #=> String, one of "InvalidImageDigest", "InvalidImageTag", "ImageTagDoesNotMatchDigest", "ImageNotFound", "MissingDigestAndTag", "ImageReferencedByManifestList" # resp.failures[0].failure_reason #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/BatchDeleteImage AWS API Documentation # # @overload batch_delete_image(params = {}) @@ -550,11 +550,11 @@ # resp.images[0].image_id.image_tag #=> String # resp.images[0].image_manifest #=> String # resp.failures #=> Array # resp.failures[0].image_id.image_digest #=> String # resp.failures[0].image_id.image_tag #=> String - # resp.failures[0].failure_code #=> String, one of "InvalidImageDigest", "InvalidImageTag", "ImageTagDoesNotMatchDigest", "ImageNotFound", "MissingDigestAndTag" + # resp.failures[0].failure_code #=> String, one of "InvalidImageDigest", "InvalidImageTag", "ImageTagDoesNotMatchDigest", "ImageNotFound", "MissingDigestAndTag", "ImageReferencedByManifestList" # resp.failures[0].failure_reason #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/BatchGetImage AWS API Documentation # # @overload batch_get_image(params = {}) @@ -570,13 +570,13 @@ # 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 it is not intended - # for general use by customers for pulling and pushing images. In most - # cases, you should use the `docker` CLI to pull, tag, and push images. + # <note 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> # # @option params [String] :registry_id # The AWS account ID associated with the registry to which to upload @@ -916,10 +916,12 @@ # * {Types::DescribeImageScanFindingsResponse#image_id #image_id} => Types::ImageIdentifier # * {Types::DescribeImageScanFindingsResponse#image_scan_status #image_scan_status} => Types::ImageScanStatus # * {Types::DescribeImageScanFindingsResponse#image_scan_findings #image_scan_findings} => Types::ImageScanFindings # * {Types::DescribeImageScanFindingsResponse#next_token #next_token} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.describe_image_scan_findings({ # registry_id: "RegistryId", # repository_name: "RepositoryName", # required @@ -951,10 +953,15 @@ # resp.image_scan_findings.findings[0].attributes[0].value #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil> # resp.image_scan_findings.finding_severity_counts #=> Hash # resp.image_scan_findings.finding_severity_counts["FindingSeverity"] #=> Integer # resp.next_token #=> String # + # + # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage): + # + # * image_scan_complete + # # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/DescribeImageScanFindings AWS API Documentation # # @overload describe_image_scan_findings(params = {}) # @param [Hash] params ({}) def describe_image_scan_findings(params = {}, options = {}) @@ -1009,10 +1016,12 @@ # @return [Types::DescribeImagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeImagesResponse#image_details #image_details} => Array&lt;Types::ImageDetail&gt; # * {Types::DescribeImagesResponse#next_token #next_token} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.describe_images({ # registry_id: "RegistryId", # repository_name: "RepositoryName", # required @@ -1097,11 +1106,13 @@ # @return [Types::DescribeRepositoriesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeRepositoriesResponse#repositories #repositories} => Array&lt;Types::Repository&gt; # * {Types::DescribeRepositoriesResponse#next_token #next_token} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # + # # @example Example: To describe all repositories in the current account # # # The following example obtains a list and description of all repositories in the default registry to which the current # # user has access. # @@ -1223,15 +1234,15 @@ # 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. + # per image layer that is not already cached. # - # <note markdown="1"> This operation is used by the Amazon ECR proxy, and it is not intended - # for general use by customers for pulling and pushing images. In most - # cases, you should use the `docker` CLI to pull, tag, and push images. + # <note 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> # # @option params [String] :registry_id # The AWS account ID associated with the registry that contains the @@ -1360,10 +1371,12 @@ # * {Types::GetLifecyclePolicyPreviewResponse#status #status} => String # * {Types::GetLifecyclePolicyPreviewResponse#next_token #next_token} => String # * {Types::GetLifecyclePolicyPreviewResponse#preview_results #preview_results} => Array&lt;Types::LifecyclePolicyPreviewResult&gt; # * {Types::GetLifecyclePolicyPreviewResponse#summary #summary} => Types::LifecyclePolicyPreviewSummary # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.get_lifecycle_policy_preview({ # registry_id: "RegistryId", # repository_name: "RepositoryName", # required @@ -1394,10 +1407,15 @@ # resp.preview_results[0].image_pushed_at #=> Time # resp.preview_results[0].action.type #=> String, one of "EXPIRE" # resp.preview_results[0].applied_rule_priority #=> Integer # resp.summary.expiring_image_total_count #=> Integer # + # + # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage): + # + # * lifecycle_policy_preview_complete + # # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/GetLifecyclePolicyPreview AWS API Documentation # # @overload get_lifecycle_policy_preview(params = {}) # @param [Hash] params ({}) def get_lifecycle_policy_preview(params = {}, options = {}) @@ -1460,17 +1478,17 @@ end # 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 an image - # layer has been uploaded before is determined by the + # 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 it is not intended - # for general use by customers for pulling and pushing images. In most - # cases, you should use the `docker` CLI to pull, tag, and push images. + # <note 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> # # @option params [String] :registry_id # The AWS account ID associated with the registry to which you intend to @@ -1553,11 +1571,13 @@ # @return [Types::ListImagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListImagesResponse#image_ids #image_ids} => Array&lt;Types::ImageIdentifier&gt; # * {Types::ListImagesResponse#next_token #next_token} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # + # # @example Example: To list all images in a repository # # # This example lists all of the images in the repository named ubuntu in the default registry in the current account. # # resp = client.list_images({ @@ -1637,15 +1657,15 @@ # 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 tags associated with the image. + # and the tags associated with the image. # - # <note markdown="1"> This operation is used by the Amazon ECR proxy, and it is not intended - # for general use by customers for pulling and pushing images. In most - # cases, you should use the `docker` CLI to pull, tag, and push images. + # <note 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> # # @option params [String] :registry_id # The AWS account ID associated with the registry that contains the @@ -2073,13 +2093,13 @@ # 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 it is not intended - # for general use by customers for pulling and pushing images. In most - # cases, you should use the `docker` CLI to pull, tag, and push images. + # <note 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> # # @option params [String] :registry_id # The AWS account ID associated with the registry to which you are @@ -2147,11 +2167,11 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-ecr' - context[:gem_version] = '1.26.0' + context[:gem_version] = '1.27.0' Seahorse::Client::Request.new(handlers, context) end # Polls an API operation until a resource enters a desired state. # @@ -2213,13 +2233,13 @@ # ## 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 | + # | waiter_name | params | :delay | :max_attempts | + # | --------------------------------- | ------------------------------------- | -------- | ------------- | + # | image_scan_complete | {Client#describe_image_scan_findings} | 5 | 60 | + # | lifecycle_policy_preview_complete | {Client#get_lifecycle_policy_preview} | 5 | 20 | # # @raise [Errors::FailureStateError] Raised when the waiter terminates # because the waiter has entered a state that it will not transition # out of, preventing success. #