aws-sdk-ecr 1.25.0 → 1.30.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 60b0150ad9f4a6d7f82cf2ca541b409368954f2c
4
- data.tar.gz: 7ff3b852653e24ab526f924d3fb9a29cd2aee04b
2
+ SHA256:
3
+ metadata.gz: 641b3987e6e0c251ad4d5067182f993ec30f98b59c04f3393c740af854deb6bb
4
+ data.tar.gz: 17275740169a489493c2b53f6a34ef53b4cfc9b76eceea62e4cda3d5182c16ee
5
5
  SHA512:
6
- metadata.gz: 9234712b70fc193c8d8998ba1252affbf151a28a4d19bc95cd8a204d9a1bb69c8297f98a074f516f2a6ff18128a9b251db15ce500c4c3709ce877e8d3fe9e67e
7
- data.tar.gz: 1a4b1a59795f3deb65078da5cde605a2c3245773ee616e78d68aae33e1ac4ddde4d845c720bd73eaea8801524c18c1735010f2c0385134bb8925798ece9545de
6
+ metadata.gz: 6615dd99578aff71ec5c25b2d56ac379dbba3608c2377c11bd5b909fe56e3b6998b80e2b24aaadcdb70f28678c31d8edd56419c73939f464b49fa3b052b49a38
7
+ data.tar.gz: 9b584088d3e30d4c4fd89159f8b8669c3bc5ae407b53a5eb01ee2eaada1c50dbcc0ad4cbdd1a0ea33a82644e9b6da0bdd392171a2d704c4a66916c99dd592ec1
@@ -25,17 +25,20 @@ require_relative 'aws-sdk-ecr/customizations'
25
25
  # methods each accept a hash of request parameters and return a response
26
26
  # structure.
27
27
  #
28
+ # ecr = Aws::ECR::Client.new
29
+ # resp = ecr.batch_check_layer_availability(params)
30
+ #
28
31
  # See {Client} for more information.
29
32
  #
30
33
  # # Errors
31
34
  #
32
- # Errors returned from Amazon EC2 Container Registry all
33
- # extend {Errors::ServiceError}.
35
+ # Errors returned from Amazon EC2 Container Registry are defined in the
36
+ # {Errors} module and all extend {Errors::ServiceError}.
34
37
  #
35
38
  # begin
36
39
  # # do stuff
37
40
  # rescue Aws::ECR::Errors::ServiceError
38
- # # rescues all service API errors
41
+ # # rescues all Amazon EC2 Container Registry API errors
39
42
  # end
40
43
  #
41
44
  # See {Errors} for more information.
@@ -43,6 +46,6 @@ require_relative 'aws-sdk-ecr/customizations'
43
46
  # @service
44
47
  module Aws::ECR
45
48
 
46
- GEM_VERSION = '1.25.0'
49
+ GEM_VERSION = '1.30.0'
47
50
 
48
51
  end
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
30
30
  Aws::Plugins::GlobalConfiguration.add_identifier(:ecr)
31
31
 
32
32
  module Aws::ECR
33
+ # An API client for ECR. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
35
+ # client = Aws::ECR::Client.new(
36
+ # region: region_name,
37
+ # credentials: credentials,
38
+ # # ...
39
+ # )
40
+ #
41
+ # For details on configuring region and credentials see
42
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
43
+ #
44
+ # See {#initialize} for a full list of supported configuration options.
33
45
  class Client < Seahorse::Client::Base
34
46
 
35
47
  include Aws::ClientStubs
@@ -93,7 +105,7 @@ module Aws::ECR
93
105
  # @option options [required, String] :region
94
106
  # The AWS region to connect to. The configured `:region` is
95
107
  # used to determine the service `:endpoint`. When not passed,
96
- # a default `:region` is search for in the following locations:
108
+ # a default `:region` is searched for in the following locations:
97
109
  #
98
110
  # * `Aws.config[:region]`
99
111
  # * `ENV['AWS_REGION']`
@@ -108,6 +120,12 @@ module Aws::ECR
108
120
  # When set to `true`, a thread polling for endpoints will be running in
109
121
  # the background every 60 secs (default). Defaults to `false`.
110
122
  #
123
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
124
+ # Used only in `adaptive` retry mode. When true, the request will sleep
125
+ # until there is sufficent client side capacity to retry the request.
126
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
127
+ # not retry instead of sleeping.
128
+ #
111
129
  # @option options [Boolean] :client_side_monitoring (false)
112
130
  # When `true`, client-side metrics will be collected for all API requests from
113
131
  # this client.
@@ -132,6 +150,10 @@ module Aws::ECR
132
150
  # When `true`, an attempt is made to coerce request parameters into
133
151
  # the required types.
134
152
  #
153
+ # @option options [Boolean] :correct_clock_skew (true)
154
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
155
+ # a clock skew correction and retry requests with skewed client clocks.
156
+ #
135
157
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
158
  # Set to true to disable SDK automatically adding host prefix
137
159
  # to default service endpoint when available.
@@ -139,7 +161,7 @@ module Aws::ECR
139
161
  # @option options [String] :endpoint
140
162
  # The client endpoint is normally constructed from the `:region`
141
163
  # option. You should only configure an `:endpoint` when connecting
142
- # to test endpoints. This should be avalid HTTP(S) URI.
164
+ # to test endpoints. This should be a valid HTTP(S) URI.
143
165
  #
144
166
  # @option options [Integer] :endpoint_cache_max_entries (1000)
145
167
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +176,7 @@ module Aws::ECR
154
176
  # requests fetching endpoints information. Defaults to 60 sec.
155
177
  #
156
178
  # @option options [Boolean] :endpoint_discovery (false)
157
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
179
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
158
180
  #
159
181
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
182
  # The log formatter.
@@ -166,15 +188,29 @@ module Aws::ECR
166
188
  # The Logger instance to send log messages to. If this option
167
189
  # is not set, logging will be disabled.
168
190
  #
191
+ # @option options [Integer] :max_attempts (3)
192
+ # An integer representing the maximum number attempts that will be made for
193
+ # a single request, including the initial attempt. For example,
194
+ # setting this value to 5 will result in a request being retried up to
195
+ # 4 times. Used in `standard` and `adaptive` retry modes.
196
+ #
169
197
  # @option options [String] :profile ("default")
170
198
  # Used when loading credentials from the shared credentials file
171
199
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
200
  #
201
+ # @option options [Proc] :retry_backoff
202
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
203
+ # This option is only used in the `legacy` retry mode.
204
+ #
173
205
  # @option options [Float] :retry_base_delay (0.3)
174
- # The base delay in seconds used by the default backoff function.
206
+ # The base delay in seconds used by the default backoff function. This option
207
+ # is only used in the `legacy` retry mode.
175
208
  #
176
209
  # @option options [Symbol] :retry_jitter (:none)
177
- # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
210
+ # A delay randomiser function used by the default backoff function.
211
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
212
+ # otherwise a Proc that takes and returns a number. This option is only used
213
+ # in the `legacy` retry mode.
178
214
  #
179
215
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
216
  #
@@ -182,11 +218,30 @@ module Aws::ECR
182
218
  # The maximum number of times to retry failed requests. Only
183
219
  # ~ 500 level server errors and certain ~ 400 level client errors
184
220
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # errors from expired credentials.
221
+ # checksum errors, networking errors, timeout errors, auth errors,
222
+ # endpoint discovery, and errors from expired credentials.
223
+ # This option is only used in the `legacy` retry mode.
187
224
  #
188
225
  # @option options [Integer] :retry_max_delay (0)
189
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
226
+ # The maximum number of seconds to delay between retries (0 for no limit)
227
+ # used by the default backoff function. This option is only used in the
228
+ # `legacy` retry mode.
229
+ #
230
+ # @option options [String] :retry_mode ("legacy")
231
+ # Specifies which retry algorithm to use. Values are:
232
+ #
233
+ # * `legacy` - The pre-existing retry behavior. This is default value if
234
+ # no retry mode is provided.
235
+ #
236
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
237
+ # This includes support for retry quotas, which limit the number of
238
+ # unsuccessful retries a client can make.
239
+ #
240
+ # * `adaptive` - An experimental retry mode that includes all the
241
+ # functionality of `standard` mode along with automatic client side
242
+ # throttling. This is a provisional mode that may change behavior
243
+ # in the future.
244
+ #
190
245
  #
191
246
  # @option options [String] :secret_access_key
192
247
  #
@@ -219,16 +274,15 @@ module Aws::ECR
219
274
  # requests through. Formatted like 'http://proxy.com:123'.
220
275
  #
221
276
  # @option options [Float] :http_open_timeout (15) The number of
222
- # seconds to wait when opening a HTTP session before rasing a
277
+ # seconds to wait when opening a HTTP session before raising a
223
278
  # `Timeout::Error`.
224
279
  #
225
280
  # @option options [Integer] :http_read_timeout (60) The default
226
281
  # number of seconds to wait for response data. This value can
227
- # safely be set
228
- # per-request on the session yeidled by {#session_for}.
282
+ # safely be set per-request on the session.
229
283
  #
230
284
  # @option options [Float] :http_idle_timeout (5) The number of
231
- # seconds a connection is allowed to sit idble before it is
285
+ # seconds a connection is allowed to sit idle before it is
232
286
  # considered stale. Stale connections are closed and removed
233
287
  # from the pool before making a request.
234
288
  #
@@ -237,7 +291,7 @@ module Aws::ECR
237
291
  # request body. This option has no effect unless the request has
238
292
  # "Expect" header set to "100-continue". Defaults to `nil` which
239
293
  # disables this behaviour. This value can safely be set per
240
- # request on the session yeidled by {#session_for}.
294
+ # request on the session.
241
295
  #
242
296
  # @option options [Boolean] :http_wire_trace (false) When `true`,
243
297
  # HTTP debug output will be sent to the `:logger`.
@@ -267,15 +321,12 @@ module Aws::ECR
267
321
  # Checks the availability of one or more image layers in a repository.
268
322
  #
269
323
  # When an image is pushed to a repository, each image layer is checked
270
- # to verify if it has been uploaded before. If it is, then the image
271
- # layer is skipped.
324
+ # to verify if it has been uploaded before. If it has been uploaded,
325
+ # then the image layer is skipped.
272
326
  #
273
- # When an image is pulled from a repository, each image layer is checked
274
- # once to verify it is available to be pulled.
275
- #
276
- # <note markdown="1"> This operation is used by the Amazon ECR proxy, and it is not intended
277
- # for general use by customers for pulling and pushing images. In most
278
- # cases, you should use the `docker` CLI to pull, tag, and push images.
327
+ # <note markdown="1"> This operation is used by the Amazon ECR proxy and is not generally
328
+ # used by customers for pulling and pushing images. In most cases, you
329
+ # should use the `docker` CLI to pull, tag, and push images.
279
330
  #
280
331
  # </note>
281
332
  #
@@ -401,7 +452,7 @@ module Aws::ECR
401
452
  # resp.failures #=> Array
402
453
  # resp.failures[0].image_id.image_digest #=> String
403
454
  # resp.failures[0].image_id.image_tag #=> String
404
- # resp.failures[0].failure_code #=> String, one of "InvalidImageDigest", "InvalidImageTag", "ImageTagDoesNotMatchDigest", "ImageNotFound", "MissingDigestAndTag"
455
+ # resp.failures[0].failure_code #=> String, one of "InvalidImageDigest", "InvalidImageTag", "ImageTagDoesNotMatchDigest", "ImageNotFound", "MissingDigestAndTag", "ImageReferencedByManifestList"
405
456
  # resp.failures[0].failure_reason #=> String
406
457
  #
407
458
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/BatchDeleteImage AWS API Documentation
@@ -498,10 +549,11 @@ module Aws::ECR
498
549
  # resp.images[0].image_id.image_digest #=> String
499
550
  # resp.images[0].image_id.image_tag #=> String
500
551
  # resp.images[0].image_manifest #=> String
552
+ # resp.images[0].image_manifest_media_type #=> String
501
553
  # resp.failures #=> Array
502
554
  # resp.failures[0].image_id.image_digest #=> String
503
555
  # resp.failures[0].image_id.image_tag #=> String
504
- # resp.failures[0].failure_code #=> String, one of "InvalidImageDigest", "InvalidImageTag", "ImageTagDoesNotMatchDigest", "ImageNotFound", "MissingDigestAndTag"
556
+ # resp.failures[0].failure_code #=> String, one of "InvalidImageDigest", "InvalidImageTag", "ImageTagDoesNotMatchDigest", "ImageNotFound", "MissingDigestAndTag", "ImageReferencedByManifestList"
505
557
  # resp.failures[0].failure_reason #=> String
506
558
  #
507
559
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/BatchGetImage AWS API Documentation
@@ -521,9 +573,9 @@ module Aws::ECR
521
573
  # When an image is pushed, the CompleteLayerUpload API is called once
522
574
  # per each new image layer to verify that the upload has completed.
523
575
  #
524
- # <note markdown="1"> This operation is used by the Amazon ECR proxy, and it is not intended
525
- # for general use by customers for pulling and pushing images. In most
526
- # cases, you should use the `docker` CLI to pull, tag, and push images.
576
+ # <note markdown="1"> This operation is used by the Amazon ECR proxy and is not generally
577
+ # used by customers for pulling and pushing images. In most cases, you
578
+ # should use the `docker` CLI to pull, tag, and push images.
527
579
  #
528
580
  # </note>
529
581
  #
@@ -867,6 +919,8 @@ module Aws::ECR
867
919
  # * {Types::DescribeImageScanFindingsResponse#image_scan_findings #image_scan_findings} => Types::ImageScanFindings
868
920
  # * {Types::DescribeImageScanFindingsResponse#next_token #next_token} => String
869
921
  #
922
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
923
+ #
870
924
  # @example Request syntax with placeholder values
871
925
  #
872
926
  # resp = client.describe_image_scan_findings({
@@ -902,6 +956,11 @@ module Aws::ECR
902
956
  # resp.image_scan_findings.finding_severity_counts["FindingSeverity"] #=> Integer
903
957
  # resp.next_token #=> String
904
958
  #
959
+ #
960
+ # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
961
+ #
962
+ # * image_scan_complete
963
+ #
905
964
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/DescribeImageScanFindings AWS API Documentation
906
965
  #
907
966
  # @overload describe_image_scan_findings(params = {})
@@ -960,6 +1019,8 @@ module Aws::ECR
960
1019
  # * {Types::DescribeImagesResponse#image_details #image_details} => Array&lt;Types::ImageDetail&gt;
961
1020
  # * {Types::DescribeImagesResponse#next_token #next_token} => String
962
1021
  #
1022
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1023
+ #
963
1024
  # @example Request syntax with placeholder values
964
1025
  #
965
1026
  # resp = client.describe_images({
@@ -1048,6 +1109,8 @@ module Aws::ECR
1048
1109
  # * {Types::DescribeRepositoriesResponse#repositories #repositories} => Array&lt;Types::Repository&gt;
1049
1110
  # * {Types::DescribeRepositoriesResponse#next_token #next_token} => String
1050
1111
  #
1112
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1113
+ #
1051
1114
  #
1052
1115
  # @example Example: To describe all repositories in the current account
1053
1116
  #
@@ -1174,11 +1237,11 @@ module Aws::ECR
1174
1237
  # referenced in an image.
1175
1238
  #
1176
1239
  # When an image is pulled, the GetDownloadUrlForLayer API is called once
1177
- # per image layer.
1240
+ # per image layer that is not already cached.
1178
1241
  #
1179
- # <note markdown="1"> This operation is used by the Amazon ECR proxy, and it is not intended
1180
- # for general use by customers for pulling and pushing images. In most
1181
- # cases, you should use the `docker` CLI to pull, tag, and push images.
1242
+ # <note markdown="1"> This operation is used by the Amazon ECR proxy and is not generally
1243
+ # used by customers for pulling and pushing images. In most cases, you
1244
+ # should use the `docker` CLI to pull, tag, and push images.
1182
1245
  #
1183
1246
  # </note>
1184
1247
  #
@@ -1311,6 +1374,8 @@ module Aws::ECR
1311
1374
  # * {Types::GetLifecyclePolicyPreviewResponse#preview_results #preview_results} => Array&lt;Types::LifecyclePolicyPreviewResult&gt;
1312
1375
  # * {Types::GetLifecyclePolicyPreviewResponse#summary #summary} => Types::LifecyclePolicyPreviewSummary
1313
1376
  #
1377
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1378
+ #
1314
1379
  # @example Request syntax with placeholder values
1315
1380
  #
1316
1381
  # resp = client.get_lifecycle_policy_preview({
@@ -1345,6 +1410,11 @@ module Aws::ECR
1345
1410
  # resp.preview_results[0].applied_rule_priority #=> Integer
1346
1411
  # resp.summary.expiring_image_total_count #=> Integer
1347
1412
  #
1413
+ #
1414
+ # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
1415
+ #
1416
+ # * lifecycle_policy_preview_complete
1417
+ #
1348
1418
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/GetLifecyclePolicyPreview AWS API Documentation
1349
1419
  #
1350
1420
  # @overload get_lifecycle_policy_preview(params = {})
@@ -1411,13 +1481,13 @@ module Aws::ECR
1411
1481
  # Notifies Amazon ECR that you intend to upload an image layer.
1412
1482
  #
1413
1483
  # When an image is pushed, the InitiateLayerUpload API is called once
1414
- # per image layer that has not already been uploaded. Whether an image
1415
- # layer has been uploaded before is determined by the
1484
+ # per image layer that has not already been uploaded. Whether or not an
1485
+ # image layer has been uploaded is determined by the
1416
1486
  # BatchCheckLayerAvailability API action.
1417
1487
  #
1418
- # <note markdown="1"> This operation is used by the Amazon ECR proxy, and it is not intended
1419
- # for general use by customers for pulling and pushing images. In most
1420
- # cases, you should use the `docker` CLI to pull, tag, and push images.
1488
+ # <note markdown="1"> This operation is used by the Amazon ECR proxy and is not generally
1489
+ # used by customers for pulling and pushing images. In most cases, you
1490
+ # should use the `docker` CLI to pull, tag, and push images.
1421
1491
  #
1422
1492
  # </note>
1423
1493
  #
@@ -1504,6 +1574,8 @@ module Aws::ECR
1504
1574
  # * {Types::ListImagesResponse#image_ids #image_ids} => Array&lt;Types::ImageIdentifier&gt;
1505
1575
  # * {Types::ListImagesResponse#next_token #next_token} => String
1506
1576
  #
1577
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1578
+ #
1507
1579
  #
1508
1580
  # @example Example: To list all images in a repository
1509
1581
  #
@@ -1588,11 +1660,11 @@ module Aws::ECR
1588
1660
  #
1589
1661
  # When an image is pushed and all new image layers have been uploaded,
1590
1662
  # the PutImage API is called once to create or update the image manifest
1591
- # and tags associated with the image.
1663
+ # and the tags associated with the image.
1592
1664
  #
1593
- # <note markdown="1"> This operation is used by the Amazon ECR proxy, and it is not intended
1594
- # for general use by customers for pulling and pushing images. In most
1595
- # cases, you should use the `docker` CLI to pull, tag, and push images.
1665
+ # <note markdown="1"> This operation is used by the Amazon ECR proxy and is not generally
1666
+ # used by customers for pulling and pushing images. In most cases, you
1667
+ # should use the `docker` CLI to pull, tag, and push images.
1596
1668
  #
1597
1669
  # </note>
1598
1670
  #
@@ -1607,6 +1679,11 @@ module Aws::ECR
1607
1679
  # @option params [required, String] :image_manifest
1608
1680
  # The image manifest corresponding to the image to be uploaded.
1609
1681
  #
1682
+ # @option params [String] :image_manifest_media_type
1683
+ # The media type of the image manifest. If you push an image manifest
1684
+ # that does not contain the `mediaType` field, you must specify the
1685
+ # `imageManifestMediaType` in the request.
1686
+ #
1610
1687
  # @option params [String] :image_tag
1611
1688
  # The tag to associate with the image. This parameter is required for
1612
1689
  # images that use the Docker Image Manifest V2 Schema 2 or OCI formats.
@@ -1621,6 +1698,7 @@ module Aws::ECR
1621
1698
  # registry_id: "RegistryId",
1622
1699
  # repository_name: "RepositoryName", # required
1623
1700
  # image_manifest: "ImageManifest", # required
1701
+ # image_manifest_media_type: "MediaType",
1624
1702
  # image_tag: "ImageTag",
1625
1703
  # })
1626
1704
  #
@@ -1631,6 +1709,7 @@ module Aws::ECR
1631
1709
  # resp.image.image_id.image_digest #=> String
1632
1710
  # resp.image.image_id.image_tag #=> String
1633
1711
  # resp.image.image_manifest #=> String
1712
+ # resp.image.image_manifest_media_type #=> String
1634
1713
  #
1635
1714
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/PutImage AWS API Documentation
1636
1715
  #
@@ -1794,7 +1873,7 @@ module Aws::ECR
1794
1873
  #
1795
1874
  #
1796
1875
  #
1797
- # [1]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicies.html
1876
+ # [1]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policies.html
1798
1877
  #
1799
1878
  # @option params [String] :registry_id
1800
1879
  # The AWS account ID associated with the registry that contains the
@@ -1806,12 +1885,12 @@ module Aws::ECR
1806
1885
  #
1807
1886
  # @option params [required, String] :policy_text
1808
1887
  # The JSON repository policy text to apply to the repository. For more
1809
- # information, see [Amazon ECR Repository Policy Examples][1] in the
1810
- # *Amazon Elastic Container Registry User Guide*.
1888
+ # information, see [Amazon ECR Repository Policies][1] in the *Amazon
1889
+ # Elastic Container Registry User Guide*.
1811
1890
  #
1812
1891
  #
1813
1892
  #
1814
- # [1]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicyExamples.html
1893
+ # [1]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html
1815
1894
  #
1816
1895
  # @option params [Boolean] :force
1817
1896
  # If the policy you are attempting to set on a repository policy would
@@ -2024,9 +2103,9 @@ module Aws::ECR
2024
2103
  # about 20MB). The UploadLayerPart API is called once per each new image
2025
2104
  # layer part.
2026
2105
  #
2027
- # <note markdown="1"> This operation is used by the Amazon ECR proxy, and it is not intended
2028
- # for general use by customers for pulling and pushing images. In most
2029
- # cases, you should use the `docker` CLI to pull, tag, and push images.
2106
+ # <note markdown="1"> This operation is used by the Amazon ECR proxy and is not generally
2107
+ # used by customers for pulling and pushing images. In most cases, you
2108
+ # should use the `docker` CLI to pull, tag, and push images.
2030
2109
  #
2031
2110
  # </note>
2032
2111
  #
@@ -2043,10 +2122,12 @@ module Aws::ECR
2043
2122
  # associate with the layer part upload.
2044
2123
  #
2045
2124
  # @option params [required, Integer] :part_first_byte
2046
- # The integer value of the first byte of the layer part.
2125
+ # The position of the first byte of the layer part witin the overall
2126
+ # image layer.
2047
2127
  #
2048
2128
  # @option params [required, Integer] :part_last_byte
2049
- # The integer value of the last byte of the layer part.
2129
+ # The position of the last byte of the layer part within the overall
2130
+ # image layer.
2050
2131
  #
2051
2132
  # @option params [required, String, IO] :layer_part_blob
2052
2133
  # The base64-encoded layer part payload.
@@ -2098,7 +2179,7 @@ module Aws::ECR
2098
2179
  params: params,
2099
2180
  config: config)
2100
2181
  context[:gem_name] = 'aws-sdk-ecr'
2101
- context[:gem_version] = '1.25.0'
2182
+ context[:gem_version] = '1.30.0'
2102
2183
  Seahorse::Client::Request.new(handlers, context)
2103
2184
  end
2104
2185
 
@@ -2164,10 +2245,10 @@ module Aws::ECR
2164
2245
  # The following table lists the valid waiter names, the operations they call,
2165
2246
  # and the default `:delay` and `:max_attempts` values.
2166
2247
  #
2167
- # | waiter_name | params | :delay | :max_attempts |
2168
- # | --------------------------------- | ------------------------------- | -------- | ------------- |
2169
- # | image_scan_complete | {#describe_image_scan_findings} | 5 | 60 |
2170
- # | lifecycle_policy_preview_complete | {#get_lifecycle_policy_preview} | 5 | 20 |
2248
+ # | waiter_name | params | :delay | :max_attempts |
2249
+ # | --------------------------------- | ------------------------------------- | -------- | ------------- |
2250
+ # | image_scan_complete | {Client#describe_image_scan_findings} | 5 | 60 |
2251
+ # | lifecycle_policy_preview_complete | {Client#get_lifecycle_policy_preview} | 5 | 20 |
2171
2252
  #
2172
2253
  # @raise [Errors::FailureStateError] Raised when the waiter terminates
2173
2254
  # because the waiter has entered a state that it will not transition
@@ -146,6 +146,7 @@ module Aws::ECR
146
146
  PutImageTagMutabilityResponse = Shapes::StructureShape.new(name: 'PutImageTagMutabilityResponse')
147
147
  PutLifecyclePolicyRequest = Shapes::StructureShape.new(name: 'PutLifecyclePolicyRequest')
148
148
  PutLifecyclePolicyResponse = Shapes::StructureShape.new(name: 'PutLifecyclePolicyResponse')
149
+ ReferencedImagesNotFoundException = Shapes::StructureShape.new(name: 'ReferencedImagesNotFoundException')
149
150
  RegistryId = Shapes::StringShape.new(name: 'RegistryId')
150
151
  Repository = Shapes::StructureShape.new(name: 'Repository')
151
152
  RepositoryAlreadyExistsException = Shapes::StructureShape.new(name: 'RepositoryAlreadyExistsException')
@@ -178,6 +179,7 @@ module Aws::ECR
178
179
  TagStatus = Shapes::StringShape.new(name: 'TagStatus')
179
180
  TagValue = Shapes::StringShape.new(name: 'TagValue')
180
181
  TooManyTagsException = Shapes::StructureShape.new(name: 'TooManyTagsException')
182
+ UnsupportedImageTypeException = Shapes::StructureShape.new(name: 'UnsupportedImageTypeException')
181
183
  UntagResourceRequest = Shapes::StructureShape.new(name: 'UntagResourceRequest')
182
184
  UntagResourceResponse = Shapes::StructureShape.new(name: 'UntagResourceResponse')
183
185
  UploadId = Shapes::StringShape.new(name: 'UploadId')
@@ -381,6 +383,7 @@ module Aws::ECR
381
383
  Image.add_member(:repository_name, Shapes::ShapeRef.new(shape: RepositoryName, location_name: "repositoryName"))
382
384
  Image.add_member(:image_id, Shapes::ShapeRef.new(shape: ImageIdentifier, location_name: "imageId"))
383
385
  Image.add_member(:image_manifest, Shapes::ShapeRef.new(shape: ImageManifest, location_name: "imageManifest"))
386
+ Image.add_member(:image_manifest_media_type, Shapes::ShapeRef.new(shape: MediaType, location_name: "imageManifestMediaType"))
384
387
  Image.struct_class = Types::Image
385
388
 
386
389
  ImageAlreadyExistsException.add_member(:message, Shapes::ShapeRef.new(shape: ExceptionMessage, location_name: "message"))
@@ -556,6 +559,7 @@ module Aws::ECR
556
559
  PutImageRequest.add_member(:registry_id, Shapes::ShapeRef.new(shape: RegistryId, location_name: "registryId"))
557
560
  PutImageRequest.add_member(:repository_name, Shapes::ShapeRef.new(shape: RepositoryName, required: true, location_name: "repositoryName"))
558
561
  PutImageRequest.add_member(:image_manifest, Shapes::ShapeRef.new(shape: ImageManifest, required: true, location_name: "imageManifest"))
562
+ PutImageRequest.add_member(:image_manifest_media_type, Shapes::ShapeRef.new(shape: MediaType, location_name: "imageManifestMediaType"))
559
563
  PutImageRequest.add_member(:image_tag, Shapes::ShapeRef.new(shape: ImageTag, location_name: "imageTag"))
560
564
  PutImageRequest.struct_class = Types::PutImageRequest
561
565
 
@@ -592,6 +596,9 @@ module Aws::ECR
592
596
  PutLifecyclePolicyResponse.add_member(:lifecycle_policy_text, Shapes::ShapeRef.new(shape: LifecyclePolicyText, location_name: "lifecyclePolicyText"))
593
597
  PutLifecyclePolicyResponse.struct_class = Types::PutLifecyclePolicyResponse
594
598
 
599
+ ReferencedImagesNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: ExceptionMessage, location_name: "message"))
600
+ ReferencedImagesNotFoundException.struct_class = Types::ReferencedImagesNotFoundException
601
+
595
602
  Repository.add_member(:repository_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "repositoryArn"))
596
603
  Repository.add_member(:registry_id, Shapes::ShapeRef.new(shape: RegistryId, location_name: "registryId"))
597
604
  Repository.add_member(:repository_name, Shapes::ShapeRef.new(shape: RepositoryName, location_name: "repositoryName"))
@@ -673,6 +680,9 @@ module Aws::ECR
673
680
  TooManyTagsException.add_member(:message, Shapes::ShapeRef.new(shape: ExceptionMessage, location_name: "message"))
674
681
  TooManyTagsException.struct_class = Types::TooManyTagsException
675
682
 
683
+ UnsupportedImageTypeException.add_member(:message, Shapes::ShapeRef.new(shape: ExceptionMessage, location_name: "message"))
684
+ UnsupportedImageTypeException.struct_class = Types::UnsupportedImageTypeException
685
+
676
686
  UntagResourceRequest.add_member(:resource_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "resourceArn"))
677
687
  UntagResourceRequest.add_member(:tag_keys, Shapes::ShapeRef.new(shape: TagKeyList, required: true, location_name: "tagKeys"))
678
688
  UntagResourceRequest.struct_class = Types::UntagResourceRequest
@@ -984,6 +994,7 @@ module Aws::ECR
984
994
  o.errors << Shapes::ShapeRef.new(shape: RepositoryNotFoundException)
985
995
  o.errors << Shapes::ShapeRef.new(shape: ImageAlreadyExistsException)
986
996
  o.errors << Shapes::ShapeRef.new(shape: LayersNotFoundException)
997
+ o.errors << Shapes::ShapeRef.new(shape: ReferencedImagesNotFoundException)
987
998
  o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
988
999
  o.errors << Shapes::ShapeRef.new(shape: ImageTagAlreadyExistsException)
989
1000
  end)
@@ -1040,6 +1051,8 @@ module Aws::ECR
1040
1051
  o.output = Shapes::ShapeRef.new(shape: StartImageScanResponse)
1041
1052
  o.errors << Shapes::ShapeRef.new(shape: ServerException)
1042
1053
  o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
1054
+ o.errors << Shapes::ShapeRef.new(shape: UnsupportedImageTypeException)
1055
+ o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
1043
1056
  o.errors << Shapes::ShapeRef.new(shape: RepositoryNotFoundException)
1044
1057
  o.errors << Shapes::ShapeRef.new(shape: ImageNotFoundException)
1045
1058
  end)
@@ -6,6 +6,54 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::ECR
9
+
10
+ # When ECR returns an error response, the Ruby SDK constructs and raises an error.
11
+ # These errors all extend Aws::ECR::Errors::ServiceError < {Aws::Errors::ServiceError}
12
+ #
13
+ # You can rescue all ECR errors using ServiceError:
14
+ #
15
+ # begin
16
+ # # do stuff
17
+ # rescue Aws::ECR::Errors::ServiceError
18
+ # # rescues all ECR API errors
19
+ # end
20
+ #
21
+ #
22
+ # ## Request Context
23
+ # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
24
+ # information about the request that generated the error.
25
+ # See {Seahorse::Client::RequestContext} for more information.
26
+ #
27
+ # ## Error Classes
28
+ # * {EmptyUploadException}
29
+ # * {ImageAlreadyExistsException}
30
+ # * {ImageNotFoundException}
31
+ # * {ImageTagAlreadyExistsException}
32
+ # * {InvalidLayerException}
33
+ # * {InvalidLayerPartException}
34
+ # * {InvalidParameterException}
35
+ # * {InvalidTagParameterException}
36
+ # * {LayerAlreadyExistsException}
37
+ # * {LayerInaccessibleException}
38
+ # * {LayerPartTooSmallException}
39
+ # * {LayersNotFoundException}
40
+ # * {LifecyclePolicyNotFoundException}
41
+ # * {LifecyclePolicyPreviewInProgressException}
42
+ # * {LifecyclePolicyPreviewNotFoundException}
43
+ # * {LimitExceededException}
44
+ # * {ReferencedImagesNotFoundException}
45
+ # * {RepositoryAlreadyExistsException}
46
+ # * {RepositoryNotEmptyException}
47
+ # * {RepositoryNotFoundException}
48
+ # * {RepositoryPolicyNotFoundException}
49
+ # * {ScanNotFoundException}
50
+ # * {ServerException}
51
+ # * {TooManyTagsException}
52
+ # * {UnsupportedImageTypeException}
53
+ # * {UploadNotFoundException}
54
+ #
55
+ # Additionally, error classes are dynamically generated for service errors based on the error code
56
+ # if they are not defined above.
9
57
  module Errors
10
58
 
11
59
  extend Aws::Errors::DynamicErrors
@@ -23,7 +71,6 @@ module Aws::ECR
23
71
  def message
24
72
  @message || @data[:message]
25
73
  end
26
-
27
74
  end
28
75
 
29
76
  class ImageAlreadyExistsException < ServiceError
@@ -39,7 +86,6 @@ module Aws::ECR
39
86
  def message
40
87
  @message || @data[:message]
41
88
  end
42
-
43
89
  end
44
90
 
45
91
  class ImageNotFoundException < ServiceError
@@ -55,7 +101,6 @@ module Aws::ECR
55
101
  def message
56
102
  @message || @data[:message]
57
103
  end
58
-
59
104
  end
60
105
 
61
106
  class ImageTagAlreadyExistsException < ServiceError
@@ -71,7 +116,6 @@ module Aws::ECR
71
116
  def message
72
117
  @message || @data[:message]
73
118
  end
74
-
75
119
  end
76
120
 
77
121
  class InvalidLayerException < ServiceError
@@ -87,7 +131,6 @@ module Aws::ECR
87
131
  def message
88
132
  @message || @data[:message]
89
133
  end
90
-
91
134
  end
92
135
 
93
136
  class InvalidLayerPartException < ServiceError
@@ -123,7 +166,6 @@ module Aws::ECR
123
166
  def message
124
167
  @message || @data[:message]
125
168
  end
126
-
127
169
  end
128
170
 
129
171
  class InvalidParameterException < ServiceError
@@ -139,7 +181,6 @@ module Aws::ECR
139
181
  def message
140
182
  @message || @data[:message]
141
183
  end
142
-
143
184
  end
144
185
 
145
186
  class InvalidTagParameterException < ServiceError
@@ -155,7 +196,6 @@ module Aws::ECR
155
196
  def message
156
197
  @message || @data[:message]
157
198
  end
158
-
159
199
  end
160
200
 
161
201
  class LayerAlreadyExistsException < ServiceError
@@ -171,7 +211,6 @@ module Aws::ECR
171
211
  def message
172
212
  @message || @data[:message]
173
213
  end
174
-
175
214
  end
176
215
 
177
216
  class LayerInaccessibleException < ServiceError
@@ -187,7 +226,6 @@ module Aws::ECR
187
226
  def message
188
227
  @message || @data[:message]
189
228
  end
190
-
191
229
  end
192
230
 
193
231
  class LayerPartTooSmallException < ServiceError
@@ -203,7 +241,6 @@ module Aws::ECR
203
241
  def message
204
242
  @message || @data[:message]
205
243
  end
206
-
207
244
  end
208
245
 
209
246
  class LayersNotFoundException < ServiceError
@@ -219,7 +256,6 @@ module Aws::ECR
219
256
  def message
220
257
  @message || @data[:message]
221
258
  end
222
-
223
259
  end
224
260
 
225
261
  class LifecyclePolicyNotFoundException < ServiceError
@@ -235,7 +271,6 @@ module Aws::ECR
235
271
  def message
236
272
  @message || @data[:message]
237
273
  end
238
-
239
274
  end
240
275
 
241
276
  class LifecyclePolicyPreviewInProgressException < ServiceError
@@ -251,7 +286,6 @@ module Aws::ECR
251
286
  def message
252
287
  @message || @data[:message]
253
288
  end
254
-
255
289
  end
256
290
 
257
291
  class LifecyclePolicyPreviewNotFoundException < ServiceError
@@ -267,7 +301,6 @@ module Aws::ECR
267
301
  def message
268
302
  @message || @data[:message]
269
303
  end
270
-
271
304
  end
272
305
 
273
306
  class LimitExceededException < ServiceError
@@ -283,7 +316,21 @@ module Aws::ECR
283
316
  def message
284
317
  @message || @data[:message]
285
318
  end
319
+ end
320
+
321
+ class ReferencedImagesNotFoundException < ServiceError
322
+
323
+ # @param [Seahorse::Client::RequestContext] context
324
+ # @param [String] message
325
+ # @param [Aws::ECR::Types::ReferencedImagesNotFoundException] data
326
+ def initialize(context, message, data = Aws::EmptyStructure.new)
327
+ super(context, message, data)
328
+ end
286
329
 
330
+ # @return [String]
331
+ def message
332
+ @message || @data[:message]
333
+ end
287
334
  end
288
335
 
289
336
  class RepositoryAlreadyExistsException < ServiceError
@@ -299,7 +346,6 @@ module Aws::ECR
299
346
  def message
300
347
  @message || @data[:message]
301
348
  end
302
-
303
349
  end
304
350
 
305
351
  class RepositoryNotEmptyException < ServiceError
@@ -315,7 +361,6 @@ module Aws::ECR
315
361
  def message
316
362
  @message || @data[:message]
317
363
  end
318
-
319
364
  end
320
365
 
321
366
  class RepositoryNotFoundException < ServiceError
@@ -331,7 +376,6 @@ module Aws::ECR
331
376
  def message
332
377
  @message || @data[:message]
333
378
  end
334
-
335
379
  end
336
380
 
337
381
  class RepositoryPolicyNotFoundException < ServiceError
@@ -347,7 +391,6 @@ module Aws::ECR
347
391
  def message
348
392
  @message || @data[:message]
349
393
  end
350
-
351
394
  end
352
395
 
353
396
  class ScanNotFoundException < ServiceError
@@ -363,7 +406,6 @@ module Aws::ECR
363
406
  def message
364
407
  @message || @data[:message]
365
408
  end
366
-
367
409
  end
368
410
 
369
411
  class ServerException < ServiceError
@@ -379,7 +421,6 @@ module Aws::ECR
379
421
  def message
380
422
  @message || @data[:message]
381
423
  end
382
-
383
424
  end
384
425
 
385
426
  class TooManyTagsException < ServiceError
@@ -395,7 +436,21 @@ module Aws::ECR
395
436
  def message
396
437
  @message || @data[:message]
397
438
  end
439
+ end
440
+
441
+ class UnsupportedImageTypeException < ServiceError
398
442
 
443
+ # @param [Seahorse::Client::RequestContext] context
444
+ # @param [String] message
445
+ # @param [Aws::ECR::Types::UnsupportedImageTypeException] data
446
+ def initialize(context, message, data = Aws::EmptyStructure.new)
447
+ super(context, message, data)
448
+ end
449
+
450
+ # @return [String]
451
+ def message
452
+ @message || @data[:message]
453
+ end
399
454
  end
400
455
 
401
456
  class UploadNotFoundException < ServiceError
@@ -411,7 +466,6 @@ module Aws::ECR
411
466
  def message
412
467
  @message || @data[:message]
413
468
  end
414
-
415
469
  end
416
470
 
417
471
  end
@@ -6,6 +6,7 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::ECR
9
+
9
10
  class Resource
10
11
 
11
12
  # @param options ({})
@@ -1131,13 +1131,18 @@ module Aws::ECR
1131
1131
  # The image manifest associated with the image.
1132
1132
  # @return [String]
1133
1133
  #
1134
+ # @!attribute [rw] image_manifest_media_type
1135
+ # The media type associated with the image manifest.
1136
+ # @return [String]
1137
+ #
1134
1138
  # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/Image AWS API Documentation
1135
1139
  #
1136
1140
  class Image < Struct.new(
1137
1141
  :registry_id,
1138
1142
  :repository_name,
1139
1143
  :image_id,
1140
- :image_manifest)
1144
+ :image_manifest,
1145
+ :image_manifest_media_type)
1141
1146
  include Aws::Structure
1142
1147
  end
1143
1148
 
@@ -1178,6 +1183,9 @@ module Aws::ECR
1178
1183
  # @!attribute [rw] image_size_in_bytes
1179
1184
  # The size, in bytes, of the image in the repository.
1180
1185
  #
1186
+ # If the image is a manifest list, this will be the max size of all
1187
+ # manifests in the list.
1188
+ #
1181
1189
  # <note markdown="1"> Beginning with Docker version 1.9, the Docker client compresses
1182
1190
  # image layers before pushing them to a V2 Docker registry. The output
1183
1191
  # of the `docker images` command shows the uncompressed image size, so
@@ -1763,13 +1771,12 @@ module Aws::ECR
1763
1771
  end
1764
1772
 
1765
1773
  # The operation did not succeed because it would have exceeded a service
1766
- # limit for your account. For more information, see [Amazon ECR Default
1767
- # Service Limits][1] in the Amazon Elastic Container Registry User
1768
- # Guide.
1774
+ # limit for your account. For more information, see [Amazon ECR Service
1775
+ # Quotas][1] in the Amazon Elastic Container Registry User Guide.
1769
1776
  #
1770
1777
  #
1771
1778
  #
1772
- # [1]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/service_limits.html
1779
+ # [1]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/service-quotas.html
1773
1780
  #
1774
1781
  # @!attribute [rw] message
1775
1782
  # The error message associated with the exception.
@@ -1924,6 +1931,7 @@ module Aws::ECR
1924
1931
  # registry_id: "RegistryId",
1925
1932
  # repository_name: "RepositoryName", # required
1926
1933
  # image_manifest: "ImageManifest", # required
1934
+ # image_manifest_media_type: "MediaType",
1927
1935
  # image_tag: "ImageTag",
1928
1936
  # }
1929
1937
  #
@@ -1941,6 +1949,12 @@ module Aws::ECR
1941
1949
  # The image manifest corresponding to the image to be uploaded.
1942
1950
  # @return [String]
1943
1951
  #
1952
+ # @!attribute [rw] image_manifest_media_type
1953
+ # The media type of the image manifest. If you push an image manifest
1954
+ # that does not contain the `mediaType` field, you must specify the
1955
+ # `imageManifestMediaType` in the request.
1956
+ # @return [String]
1957
+ #
1944
1958
  # @!attribute [rw] image_tag
1945
1959
  # The tag to associate with the image. This parameter is required for
1946
1960
  # images that use the Docker Image Manifest V2 Schema 2 or OCI
@@ -1953,6 +1967,7 @@ module Aws::ECR
1953
1967
  :registry_id,
1954
1968
  :repository_name,
1955
1969
  :image_manifest,
1970
+ :image_manifest_media_type,
1956
1971
  :image_tag)
1957
1972
  include Aws::Structure
1958
1973
  end
@@ -2137,6 +2152,18 @@ module Aws::ECR
2137
2152
  include Aws::Structure
2138
2153
  end
2139
2154
 
2155
+ # The manifest list is referencing an image that does not exist.
2156
+ #
2157
+ # @!attribute [rw] message
2158
+ # @return [String]
2159
+ #
2160
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/ReferencedImagesNotFoundException AWS API Documentation
2161
+ #
2162
+ class ReferencedImagesNotFoundException < Struct.new(
2163
+ :message)
2164
+ include Aws::Structure
2165
+ end
2166
+
2140
2167
  # An object representing a repository.
2141
2168
  #
2142
2169
  # @!attribute [rw] repository_arn
@@ -2292,12 +2319,12 @@ module Aws::ECR
2292
2319
  #
2293
2320
  # @!attribute [rw] policy_text
2294
2321
  # The JSON repository policy text to apply to the repository. For more
2295
- # information, see [Amazon ECR Repository Policy Examples][1] in the
2296
- # *Amazon Elastic Container Registry User Guide*.
2322
+ # information, see [Amazon ECR Repository Policies][1] in the *Amazon
2323
+ # Elastic Container Registry User Guide*.
2297
2324
  #
2298
2325
  #
2299
2326
  #
2300
- # [1]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicyExamples.html
2327
+ # [1]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html
2301
2328
  # @return [String]
2302
2329
  #
2303
2330
  # @!attribute [rw] force
@@ -2542,6 +2569,18 @@ module Aws::ECR
2542
2569
  include Aws::Structure
2543
2570
  end
2544
2571
 
2572
+ # The image is of a type that cannot be scanned.
2573
+ #
2574
+ # @!attribute [rw] message
2575
+ # @return [String]
2576
+ #
2577
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/UnsupportedImageTypeException AWS API Documentation
2578
+ #
2579
+ class UnsupportedImageTypeException < Struct.new(
2580
+ :message)
2581
+ include Aws::Structure
2582
+ end
2583
+
2545
2584
  # @note When making an API call, you may pass UntagResourceRequest
2546
2585
  # data as a hash:
2547
2586
  #
@@ -2600,11 +2639,13 @@ module Aws::ECR
2600
2639
  # @return [String]
2601
2640
  #
2602
2641
  # @!attribute [rw] part_first_byte
2603
- # The integer value of the first byte of the layer part.
2642
+ # The position of the first byte of the layer part witin the overall
2643
+ # image layer.
2604
2644
  # @return [Integer]
2605
2645
  #
2606
2646
  # @!attribute [rw] part_last_byte
2607
- # The integer value of the last byte of the layer part.
2647
+ # The position of the last byte of the layer part within the overall
2648
+ # image layer.
2608
2649
  # @return [Integer]
2609
2650
  #
2610
2651
  # @!attribute [rw] layer_part_blob
@@ -8,6 +8,68 @@
8
8
  require 'aws-sdk-core/waiters'
9
9
 
10
10
  module Aws::ECR
11
+ # Waiters are utility methods that poll for a particular state to occur
12
+ # on a client. Waiters can fail after a number of attempts at a polling
13
+ # interval defined for the service client.
14
+ #
15
+ # For a list of operations that can be waited for and the
16
+ # client methods called for each operation, see the table below or the
17
+ # {Client#wait_until} field documentation for the {Client}.
18
+ #
19
+ # # Invoking a Waiter
20
+ # To invoke a waiter, call #wait_until on a {Client}. The first parameter
21
+ # is the waiter name, which is specific to the service client and indicates
22
+ # which operation is being waited for. The second parameter is a hash of
23
+ # parameters that are passed to the client method called by the waiter,
24
+ # which varies according to the waiter name.
25
+ #
26
+ # # Wait Failures
27
+ # To catch errors in a waiter, use WaiterFailed,
28
+ # as shown in the following example.
29
+ #
30
+ # rescue rescue Aws::Waiters::Errors::WaiterFailed => error
31
+ # puts "failed waiting for instance running: #{error.message}
32
+ # end
33
+ #
34
+ # # Configuring a Waiter
35
+ # Each waiter has a default polling interval and a maximum number of
36
+ # attempts it will make before returning control to your program.
37
+ # To set these values, use the `max_attempts` and `delay` parameters
38
+ # in your `#wait_until` call.
39
+ # The following example waits for up to 25 seconds, polling every five seconds.
40
+ #
41
+ # client.wait_until(...) do |w|
42
+ # w.max_attempts = 5
43
+ # w.delay = 5
44
+ # end
45
+ #
46
+ # To disable wait failures, set the value of either of these parameters
47
+ # to `nil`.
48
+ #
49
+ # # Extending a Waiter
50
+ # To modify the behavior of waiters, you can register callbacks that are
51
+ # triggered before each polling attempt and before waiting.
52
+ #
53
+ # The following example implements an exponential backoff in a waiter
54
+ # by doubling the amount of time to wait on every attempt.
55
+ #
56
+ # client.wait_until(...) do |w|
57
+ # w.interval = 0 # disable normal sleep
58
+ # w.before_wait do |n, resp|
59
+ # sleep(n ** 2)
60
+ # end
61
+ # end
62
+ #
63
+ # # Available Waiters
64
+ #
65
+ # The following table lists the valid waiter names, the operations they call,
66
+ # and the default `:delay` and `:max_attempts` values.
67
+ #
68
+ # | waiter_name | params | :delay | :max_attempts |
69
+ # | --------------------------------- | ------------------------------------- | -------- | ------------- |
70
+ # | image_scan_complete | {Client#describe_image_scan_findings} | 5 | 60 |
71
+ # | lifecycle_policy_preview_complete | {Client#get_lifecycle_policy_preview} | 5 | 20 |
72
+ #
11
73
  module Waiters
12
74
 
13
75
  # Wait until an image scan is complete and findings can be accessed
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-ecr
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.25.0
4
+ version: 1.30.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-02-06 00:00:00.000000000 Z
11
+ date: 2020-05-28 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -82,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
82
82
  version: '0'
83
83
  requirements: []
84
84
  rubyforge_project:
85
- rubygems_version: 2.5.2.3
85
+ rubygems_version: 2.7.6.2
86
86
  signing_key:
87
87
  specification_version: 4
88
88
  summary: AWS SDK for Ruby - Amazon ECR