aws-sdk-ecrpublic 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,394 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::ECRPublic
11
+
12
+ # When ECRPublic returns an error response, the Ruby SDK constructs and raises an error.
13
+ # These errors all extend Aws::ECRPublic::Errors::ServiceError < {Aws::Errors::ServiceError}
14
+ #
15
+ # You can rescue all ECRPublic errors using ServiceError:
16
+ #
17
+ # begin
18
+ # # do stuff
19
+ # rescue Aws::ECRPublic::Errors::ServiceError
20
+ # # rescues all ECRPublic API errors
21
+ # end
22
+ #
23
+ #
24
+ # ## Request Context
25
+ # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
26
+ # information about the request that generated the error.
27
+ # See {Seahorse::Client::RequestContext} for more information.
28
+ #
29
+ # ## Error Classes
30
+ # * {EmptyUploadException}
31
+ # * {ImageAlreadyExistsException}
32
+ # * {ImageDigestDoesNotMatchException}
33
+ # * {ImageNotFoundException}
34
+ # * {ImageTagAlreadyExistsException}
35
+ # * {InvalidLayerException}
36
+ # * {InvalidLayerPartException}
37
+ # * {InvalidParameterException}
38
+ # * {LayerAlreadyExistsException}
39
+ # * {LayerPartTooSmallException}
40
+ # * {LayersNotFoundException}
41
+ # * {LimitExceededException}
42
+ # * {ReferencedImagesNotFoundException}
43
+ # * {RegistryNotFoundException}
44
+ # * {RepositoryAlreadyExistsException}
45
+ # * {RepositoryNotEmptyException}
46
+ # * {RepositoryNotFoundException}
47
+ # * {RepositoryPolicyNotFoundException}
48
+ # * {ServerException}
49
+ # * {UnsupportedCommandException}
50
+ # * {UploadNotFoundException}
51
+ #
52
+ # Additionally, error classes are dynamically generated for service errors based on the error code
53
+ # if they are not defined above.
54
+ module Errors
55
+
56
+ extend Aws::Errors::DynamicErrors
57
+
58
+ class EmptyUploadException < ServiceError
59
+
60
+ # @param [Seahorse::Client::RequestContext] context
61
+ # @param [String] message
62
+ # @param [Aws::ECRPublic::Types::EmptyUploadException] data
63
+ def initialize(context, message, data = Aws::EmptyStructure.new)
64
+ super(context, message, data)
65
+ end
66
+
67
+ # @return [String]
68
+ def message
69
+ @message || @data[:message]
70
+ end
71
+ end
72
+
73
+ class ImageAlreadyExistsException < ServiceError
74
+
75
+ # @param [Seahorse::Client::RequestContext] context
76
+ # @param [String] message
77
+ # @param [Aws::ECRPublic::Types::ImageAlreadyExistsException] data
78
+ def initialize(context, message, data = Aws::EmptyStructure.new)
79
+ super(context, message, data)
80
+ end
81
+
82
+ # @return [String]
83
+ def message
84
+ @message || @data[:message]
85
+ end
86
+ end
87
+
88
+ class ImageDigestDoesNotMatchException < ServiceError
89
+
90
+ # @param [Seahorse::Client::RequestContext] context
91
+ # @param [String] message
92
+ # @param [Aws::ECRPublic::Types::ImageDigestDoesNotMatchException] data
93
+ def initialize(context, message, data = Aws::EmptyStructure.new)
94
+ super(context, message, data)
95
+ end
96
+
97
+ # @return [String]
98
+ def message
99
+ @message || @data[:message]
100
+ end
101
+ end
102
+
103
+ class ImageNotFoundException < ServiceError
104
+
105
+ # @param [Seahorse::Client::RequestContext] context
106
+ # @param [String] message
107
+ # @param [Aws::ECRPublic::Types::ImageNotFoundException] data
108
+ def initialize(context, message, data = Aws::EmptyStructure.new)
109
+ super(context, message, data)
110
+ end
111
+
112
+ # @return [String]
113
+ def message
114
+ @message || @data[:message]
115
+ end
116
+ end
117
+
118
+ class ImageTagAlreadyExistsException < ServiceError
119
+
120
+ # @param [Seahorse::Client::RequestContext] context
121
+ # @param [String] message
122
+ # @param [Aws::ECRPublic::Types::ImageTagAlreadyExistsException] data
123
+ def initialize(context, message, data = Aws::EmptyStructure.new)
124
+ super(context, message, data)
125
+ end
126
+
127
+ # @return [String]
128
+ def message
129
+ @message || @data[:message]
130
+ end
131
+ end
132
+
133
+ class InvalidLayerException < ServiceError
134
+
135
+ # @param [Seahorse::Client::RequestContext] context
136
+ # @param [String] message
137
+ # @param [Aws::ECRPublic::Types::InvalidLayerException] data
138
+ def initialize(context, message, data = Aws::EmptyStructure.new)
139
+ super(context, message, data)
140
+ end
141
+
142
+ # @return [String]
143
+ def message
144
+ @message || @data[:message]
145
+ end
146
+ end
147
+
148
+ class InvalidLayerPartException < ServiceError
149
+
150
+ # @param [Seahorse::Client::RequestContext] context
151
+ # @param [String] message
152
+ # @param [Aws::ECRPublic::Types::InvalidLayerPartException] data
153
+ def initialize(context, message, data = Aws::EmptyStructure.new)
154
+ super(context, message, data)
155
+ end
156
+
157
+ # @return [String]
158
+ def registry_id
159
+ @data[:registry_id]
160
+ end
161
+
162
+ # @return [String]
163
+ def repository_name
164
+ @data[:repository_name]
165
+ end
166
+
167
+ # @return [String]
168
+ def upload_id
169
+ @data[:upload_id]
170
+ end
171
+
172
+ # @return [String]
173
+ def last_valid_byte_received
174
+ @data[:last_valid_byte_received]
175
+ end
176
+
177
+ # @return [String]
178
+ def message
179
+ @message || @data[:message]
180
+ end
181
+ end
182
+
183
+ class InvalidParameterException < ServiceError
184
+
185
+ # @param [Seahorse::Client::RequestContext] context
186
+ # @param [String] message
187
+ # @param [Aws::ECRPublic::Types::InvalidParameterException] data
188
+ def initialize(context, message, data = Aws::EmptyStructure.new)
189
+ super(context, message, data)
190
+ end
191
+
192
+ # @return [String]
193
+ def message
194
+ @message || @data[:message]
195
+ end
196
+ end
197
+
198
+ class LayerAlreadyExistsException < ServiceError
199
+
200
+ # @param [Seahorse::Client::RequestContext] context
201
+ # @param [String] message
202
+ # @param [Aws::ECRPublic::Types::LayerAlreadyExistsException] data
203
+ def initialize(context, message, data = Aws::EmptyStructure.new)
204
+ super(context, message, data)
205
+ end
206
+
207
+ # @return [String]
208
+ def message
209
+ @message || @data[:message]
210
+ end
211
+ end
212
+
213
+ class LayerPartTooSmallException < ServiceError
214
+
215
+ # @param [Seahorse::Client::RequestContext] context
216
+ # @param [String] message
217
+ # @param [Aws::ECRPublic::Types::LayerPartTooSmallException] data
218
+ def initialize(context, message, data = Aws::EmptyStructure.new)
219
+ super(context, message, data)
220
+ end
221
+
222
+ # @return [String]
223
+ def message
224
+ @message || @data[:message]
225
+ end
226
+ end
227
+
228
+ class LayersNotFoundException < ServiceError
229
+
230
+ # @param [Seahorse::Client::RequestContext] context
231
+ # @param [String] message
232
+ # @param [Aws::ECRPublic::Types::LayersNotFoundException] data
233
+ def initialize(context, message, data = Aws::EmptyStructure.new)
234
+ super(context, message, data)
235
+ end
236
+
237
+ # @return [String]
238
+ def message
239
+ @message || @data[:message]
240
+ end
241
+ end
242
+
243
+ class LimitExceededException < ServiceError
244
+
245
+ # @param [Seahorse::Client::RequestContext] context
246
+ # @param [String] message
247
+ # @param [Aws::ECRPublic::Types::LimitExceededException] data
248
+ def initialize(context, message, data = Aws::EmptyStructure.new)
249
+ super(context, message, data)
250
+ end
251
+
252
+ # @return [String]
253
+ def message
254
+ @message || @data[:message]
255
+ end
256
+ end
257
+
258
+ class ReferencedImagesNotFoundException < ServiceError
259
+
260
+ # @param [Seahorse::Client::RequestContext] context
261
+ # @param [String] message
262
+ # @param [Aws::ECRPublic::Types::ReferencedImagesNotFoundException] data
263
+ def initialize(context, message, data = Aws::EmptyStructure.new)
264
+ super(context, message, data)
265
+ end
266
+
267
+ # @return [String]
268
+ def message
269
+ @message || @data[:message]
270
+ end
271
+ end
272
+
273
+ class RegistryNotFoundException < ServiceError
274
+
275
+ # @param [Seahorse::Client::RequestContext] context
276
+ # @param [String] message
277
+ # @param [Aws::ECRPublic::Types::RegistryNotFoundException] data
278
+ def initialize(context, message, data = Aws::EmptyStructure.new)
279
+ super(context, message, data)
280
+ end
281
+
282
+ # @return [String]
283
+ def message
284
+ @message || @data[:message]
285
+ end
286
+ end
287
+
288
+ class RepositoryAlreadyExistsException < ServiceError
289
+
290
+ # @param [Seahorse::Client::RequestContext] context
291
+ # @param [String] message
292
+ # @param [Aws::ECRPublic::Types::RepositoryAlreadyExistsException] data
293
+ def initialize(context, message, data = Aws::EmptyStructure.new)
294
+ super(context, message, data)
295
+ end
296
+
297
+ # @return [String]
298
+ def message
299
+ @message || @data[:message]
300
+ end
301
+ end
302
+
303
+ class RepositoryNotEmptyException < ServiceError
304
+
305
+ # @param [Seahorse::Client::RequestContext] context
306
+ # @param [String] message
307
+ # @param [Aws::ECRPublic::Types::RepositoryNotEmptyException] data
308
+ def initialize(context, message, data = Aws::EmptyStructure.new)
309
+ super(context, message, data)
310
+ end
311
+
312
+ # @return [String]
313
+ def message
314
+ @message || @data[:message]
315
+ end
316
+ end
317
+
318
+ class RepositoryNotFoundException < ServiceError
319
+
320
+ # @param [Seahorse::Client::RequestContext] context
321
+ # @param [String] message
322
+ # @param [Aws::ECRPublic::Types::RepositoryNotFoundException] data
323
+ def initialize(context, message, data = Aws::EmptyStructure.new)
324
+ super(context, message, data)
325
+ end
326
+
327
+ # @return [String]
328
+ def message
329
+ @message || @data[:message]
330
+ end
331
+ end
332
+
333
+ class RepositoryPolicyNotFoundException < ServiceError
334
+
335
+ # @param [Seahorse::Client::RequestContext] context
336
+ # @param [String] message
337
+ # @param [Aws::ECRPublic::Types::RepositoryPolicyNotFoundException] data
338
+ def initialize(context, message, data = Aws::EmptyStructure.new)
339
+ super(context, message, data)
340
+ end
341
+
342
+ # @return [String]
343
+ def message
344
+ @message || @data[:message]
345
+ end
346
+ end
347
+
348
+ class ServerException < ServiceError
349
+
350
+ # @param [Seahorse::Client::RequestContext] context
351
+ # @param [String] message
352
+ # @param [Aws::ECRPublic::Types::ServerException] data
353
+ def initialize(context, message, data = Aws::EmptyStructure.new)
354
+ super(context, message, data)
355
+ end
356
+
357
+ # @return [String]
358
+ def message
359
+ @message || @data[:message]
360
+ end
361
+ end
362
+
363
+ class UnsupportedCommandException < ServiceError
364
+
365
+ # @param [Seahorse::Client::RequestContext] context
366
+ # @param [String] message
367
+ # @param [Aws::ECRPublic::Types::UnsupportedCommandException] data
368
+ def initialize(context, message, data = Aws::EmptyStructure.new)
369
+ super(context, message, data)
370
+ end
371
+
372
+ # @return [String]
373
+ def message
374
+ @message || @data[:message]
375
+ end
376
+ end
377
+
378
+ class UploadNotFoundException < ServiceError
379
+
380
+ # @param [Seahorse::Client::RequestContext] context
381
+ # @param [String] message
382
+ # @param [Aws::ECRPublic::Types::UploadNotFoundException] data
383
+ def initialize(context, message, data = Aws::EmptyStructure.new)
384
+ super(context, message, data)
385
+ end
386
+
387
+ # @return [String]
388
+ def message
389
+ @message || @data[:message]
390
+ end
391
+ end
392
+
393
+ end
394
+ end
@@ -0,0 +1,26 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::ECRPublic
11
+
12
+ class Resource
13
+
14
+ # @param options ({})
15
+ # @option options [Client] :client
16
+ def initialize(options = {})
17
+ @client = options[:client] || Client.new(options)
18
+ end
19
+
20
+ # @return [Client]
21
+ def client
22
+ @client
23
+ end
24
+
25
+ end
26
+ end
@@ -0,0 +1,2043 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::ECRPublic
11
+ module Types
12
+
13
+ # An authorization token data object that corresponds to a public
14
+ # registry.
15
+ #
16
+ # @!attribute [rw] authorization_token
17
+ # A base64-encoded string that contains authorization data for a
18
+ # public Amazon ECR registry. When the string is decoded, it is
19
+ # presented in the format `user:password` for public registry
20
+ # authentication using `docker login`.
21
+ # @return [String]
22
+ #
23
+ # @!attribute [rw] expires_at
24
+ # The Unix time in seconds and milliseconds when the authorization
25
+ # token expires. Authorization tokens are valid for 12 hours.
26
+ # @return [Time]
27
+ #
28
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/AuthorizationData AWS API Documentation
29
+ #
30
+ class AuthorizationData < Struct.new(
31
+ :authorization_token,
32
+ :expires_at)
33
+ SENSITIVE = []
34
+ include Aws::Structure
35
+ end
36
+
37
+ # @note When making an API call, you may pass BatchCheckLayerAvailabilityRequest
38
+ # data as a hash:
39
+ #
40
+ # {
41
+ # registry_id: "RegistryIdOrAlias",
42
+ # repository_name: "RepositoryName", # required
43
+ # layer_digests: ["BatchedOperationLayerDigest"], # required
44
+ # }
45
+ #
46
+ # @!attribute [rw] registry_id
47
+ # The AWS account ID associated with the public registry that contains
48
+ # the image layers to check. If you do not specify a registry, the
49
+ # default public registry is assumed.
50
+ # @return [String]
51
+ #
52
+ # @!attribute [rw] repository_name
53
+ # The name of the repository that is associated with the image layers
54
+ # to check.
55
+ # @return [String]
56
+ #
57
+ # @!attribute [rw] layer_digests
58
+ # The digests of the image layers to check.
59
+ # @return [Array<String>]
60
+ #
61
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/BatchCheckLayerAvailabilityRequest AWS API Documentation
62
+ #
63
+ class BatchCheckLayerAvailabilityRequest < Struct.new(
64
+ :registry_id,
65
+ :repository_name,
66
+ :layer_digests)
67
+ SENSITIVE = []
68
+ include Aws::Structure
69
+ end
70
+
71
+ # @!attribute [rw] layers
72
+ # A list of image layer objects corresponding to the image layer
73
+ # references in the request.
74
+ # @return [Array<Types::Layer>]
75
+ #
76
+ # @!attribute [rw] failures
77
+ # Any failures associated with the call.
78
+ # @return [Array<Types::LayerFailure>]
79
+ #
80
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/BatchCheckLayerAvailabilityResponse AWS API Documentation
81
+ #
82
+ class BatchCheckLayerAvailabilityResponse < Struct.new(
83
+ :layers,
84
+ :failures)
85
+ SENSITIVE = []
86
+ include Aws::Structure
87
+ end
88
+
89
+ # @note When making an API call, you may pass BatchDeleteImageRequest
90
+ # data as a hash:
91
+ #
92
+ # {
93
+ # registry_id: "RegistryId",
94
+ # repository_name: "RepositoryName", # required
95
+ # image_ids: [ # required
96
+ # {
97
+ # image_digest: "ImageDigest",
98
+ # image_tag: "ImageTag",
99
+ # },
100
+ # ],
101
+ # }
102
+ #
103
+ # @!attribute [rw] registry_id
104
+ # The AWS account ID associated with the registry that contains the
105
+ # image to delete. If you do not specify a registry, the default
106
+ # public registry is assumed.
107
+ # @return [String]
108
+ #
109
+ # @!attribute [rw] repository_name
110
+ # The repository in a public registry that contains the image to
111
+ # delete.
112
+ # @return [String]
113
+ #
114
+ # @!attribute [rw] image_ids
115
+ # A list of image ID references that correspond to images to delete.
116
+ # The format of the `imageIds` reference is `imageTag=tag` or
117
+ # `imageDigest=digest`.
118
+ # @return [Array<Types::ImageIdentifier>]
119
+ #
120
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/BatchDeleteImageRequest AWS API Documentation
121
+ #
122
+ class BatchDeleteImageRequest < Struct.new(
123
+ :registry_id,
124
+ :repository_name,
125
+ :image_ids)
126
+ SENSITIVE = []
127
+ include Aws::Structure
128
+ end
129
+
130
+ # @!attribute [rw] image_ids
131
+ # The image IDs of the deleted images.
132
+ # @return [Array<Types::ImageIdentifier>]
133
+ #
134
+ # @!attribute [rw] failures
135
+ # Any failures associated with the call.
136
+ # @return [Array<Types::ImageFailure>]
137
+ #
138
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/BatchDeleteImageResponse AWS API Documentation
139
+ #
140
+ class BatchDeleteImageResponse < Struct.new(
141
+ :image_ids,
142
+ :failures)
143
+ SENSITIVE = []
144
+ include Aws::Structure
145
+ end
146
+
147
+ # @note When making an API call, you may pass CompleteLayerUploadRequest
148
+ # data as a hash:
149
+ #
150
+ # {
151
+ # registry_id: "RegistryIdOrAlias",
152
+ # repository_name: "RepositoryName", # required
153
+ # upload_id: "UploadId", # required
154
+ # layer_digests: ["LayerDigest"], # required
155
+ # }
156
+ #
157
+ # @!attribute [rw] registry_id
158
+ # The AWS account ID associated with the registry to which to upload
159
+ # layers. If you do not specify a registry, the default public
160
+ # registry is assumed.
161
+ # @return [String]
162
+ #
163
+ # @!attribute [rw] repository_name
164
+ # The name of the repository in a public registry to associate with
165
+ # the image layer.
166
+ # @return [String]
167
+ #
168
+ # @!attribute [rw] upload_id
169
+ # The upload ID from a previous InitiateLayerUpload operation to
170
+ # associate with the image layer.
171
+ # @return [String]
172
+ #
173
+ # @!attribute [rw] layer_digests
174
+ # The `sha256` digest of the image layer.
175
+ # @return [Array<String>]
176
+ #
177
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/CompleteLayerUploadRequest AWS API Documentation
178
+ #
179
+ class CompleteLayerUploadRequest < Struct.new(
180
+ :registry_id,
181
+ :repository_name,
182
+ :upload_id,
183
+ :layer_digests)
184
+ SENSITIVE = []
185
+ include Aws::Structure
186
+ end
187
+
188
+ # @!attribute [rw] registry_id
189
+ # The public registry ID associated with the request.
190
+ # @return [String]
191
+ #
192
+ # @!attribute [rw] repository_name
193
+ # The repository name associated with the request.
194
+ # @return [String]
195
+ #
196
+ # @!attribute [rw] upload_id
197
+ # The upload ID associated with the layer.
198
+ # @return [String]
199
+ #
200
+ # @!attribute [rw] layer_digest
201
+ # The `sha256` digest of the image layer.
202
+ # @return [String]
203
+ #
204
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/CompleteLayerUploadResponse AWS API Documentation
205
+ #
206
+ class CompleteLayerUploadResponse < Struct.new(
207
+ :registry_id,
208
+ :repository_name,
209
+ :upload_id,
210
+ :layer_digest)
211
+ SENSITIVE = []
212
+ include Aws::Structure
213
+ end
214
+
215
+ # @note When making an API call, you may pass CreateRepositoryRequest
216
+ # data as a hash:
217
+ #
218
+ # {
219
+ # repository_name: "RepositoryName", # required
220
+ # catalog_data: {
221
+ # description: "RepositoryDescription",
222
+ # architectures: ["Architecture"],
223
+ # operating_systems: ["OperatingSystem"],
224
+ # logo_image_blob: "data",
225
+ # about_text: "AboutText",
226
+ # usage_text: "UsageText",
227
+ # },
228
+ # }
229
+ #
230
+ # @!attribute [rw] repository_name
231
+ # The name to use for the repository. This appears publicly in the
232
+ # Amazon ECR Public Gallery. The repository name may be specified on
233
+ # its own (such as `nginx-web-app`) or it can be prepended with a
234
+ # namespace to group the repository into a category (such as
235
+ # `project-a/nginx-web-app`).
236
+ # @return [String]
237
+ #
238
+ # @!attribute [rw] catalog_data
239
+ # The details about the repository that are publicly visible in the
240
+ # Amazon ECR Public Gallery.
241
+ # @return [Types::RepositoryCatalogDataInput]
242
+ #
243
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/CreateRepositoryRequest AWS API Documentation
244
+ #
245
+ class CreateRepositoryRequest < Struct.new(
246
+ :repository_name,
247
+ :catalog_data)
248
+ SENSITIVE = []
249
+ include Aws::Structure
250
+ end
251
+
252
+ # @!attribute [rw] repository
253
+ # The repository that was created.
254
+ # @return [Types::Repository]
255
+ #
256
+ # @!attribute [rw] catalog_data
257
+ # The catalog data for a repository. This data is publicly visible in
258
+ # the Amazon ECR Public Gallery.
259
+ # @return [Types::RepositoryCatalogData]
260
+ #
261
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/CreateRepositoryResponse AWS API Documentation
262
+ #
263
+ class CreateRepositoryResponse < Struct.new(
264
+ :repository,
265
+ :catalog_data)
266
+ SENSITIVE = []
267
+ include Aws::Structure
268
+ end
269
+
270
+ # @note When making an API call, you may pass DeleteRepositoryPolicyRequest
271
+ # data as a hash:
272
+ #
273
+ # {
274
+ # registry_id: "RegistryId",
275
+ # repository_name: "RepositoryName", # required
276
+ # }
277
+ #
278
+ # @!attribute [rw] registry_id
279
+ # The AWS account ID associated with the public registry that contains
280
+ # the repository policy to delete. If you do not specify a registry,
281
+ # the default public registry is assumed.
282
+ # @return [String]
283
+ #
284
+ # @!attribute [rw] repository_name
285
+ # The name of the repository that is associated with the repository
286
+ # policy to delete.
287
+ # @return [String]
288
+ #
289
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/DeleteRepositoryPolicyRequest AWS API Documentation
290
+ #
291
+ class DeleteRepositoryPolicyRequest < Struct.new(
292
+ :registry_id,
293
+ :repository_name)
294
+ SENSITIVE = []
295
+ include Aws::Structure
296
+ end
297
+
298
+ # @!attribute [rw] registry_id
299
+ # The registry ID associated with the request.
300
+ # @return [String]
301
+ #
302
+ # @!attribute [rw] repository_name
303
+ # The repository name associated with the request.
304
+ # @return [String]
305
+ #
306
+ # @!attribute [rw] policy_text
307
+ # The JSON repository policy that was deleted from the repository.
308
+ # @return [String]
309
+ #
310
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/DeleteRepositoryPolicyResponse AWS API Documentation
311
+ #
312
+ class DeleteRepositoryPolicyResponse < Struct.new(
313
+ :registry_id,
314
+ :repository_name,
315
+ :policy_text)
316
+ SENSITIVE = []
317
+ include Aws::Structure
318
+ end
319
+
320
+ # @note When making an API call, you may pass DeleteRepositoryRequest
321
+ # data as a hash:
322
+ #
323
+ # {
324
+ # registry_id: "RegistryId",
325
+ # repository_name: "RepositoryName", # required
326
+ # force: false,
327
+ # }
328
+ #
329
+ # @!attribute [rw] registry_id
330
+ # The AWS account ID associated with the public registry that contains
331
+ # the repository to delete. If you do not specify a registry, the
332
+ # default public registry is assumed.
333
+ # @return [String]
334
+ #
335
+ # @!attribute [rw] repository_name
336
+ # The name of the repository to delete.
337
+ # @return [String]
338
+ #
339
+ # @!attribute [rw] force
340
+ # If a repository contains images, forces the deletion.
341
+ # @return [Boolean]
342
+ #
343
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/DeleteRepositoryRequest AWS API Documentation
344
+ #
345
+ class DeleteRepositoryRequest < Struct.new(
346
+ :registry_id,
347
+ :repository_name,
348
+ :force)
349
+ SENSITIVE = []
350
+ include Aws::Structure
351
+ end
352
+
353
+ # @!attribute [rw] repository
354
+ # The repository that was deleted.
355
+ # @return [Types::Repository]
356
+ #
357
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/DeleteRepositoryResponse AWS API Documentation
358
+ #
359
+ class DeleteRepositoryResponse < Struct.new(
360
+ :repository)
361
+ SENSITIVE = []
362
+ include Aws::Structure
363
+ end
364
+
365
+ # @note When making an API call, you may pass DescribeImageTagsRequest
366
+ # data as a hash:
367
+ #
368
+ # {
369
+ # registry_id: "RegistryId",
370
+ # repository_name: "RepositoryName", # required
371
+ # next_token: "NextToken",
372
+ # max_results: 1,
373
+ # }
374
+ #
375
+ # @!attribute [rw] registry_id
376
+ # The AWS account ID associated with the public registry that contains
377
+ # the repository in which to describe images. If you do not specify a
378
+ # registry, the default public registry is assumed.
379
+ # @return [String]
380
+ #
381
+ # @!attribute [rw] repository_name
382
+ # The name of the repository that contains the image tag details to
383
+ # describe.
384
+ # @return [String]
385
+ #
386
+ # @!attribute [rw] next_token
387
+ # The `nextToken` value returned from a previous paginated
388
+ # `DescribeImageTags` request where `maxResults` was used and the
389
+ # results exceeded the value of that parameter. Pagination continues
390
+ # from the end of the previous results that returned the `nextToken`
391
+ # value. This value is `null` when there are no more results to
392
+ # return. This option cannot be used when you specify images with
393
+ # `imageIds`.
394
+ # @return [String]
395
+ #
396
+ # @!attribute [rw] max_results
397
+ # The maximum number of repository results returned by
398
+ # `DescribeImageTags` in paginated output. When this parameter is
399
+ # used, `DescribeImageTags` only returns `maxResults` results in a
400
+ # single page along with a `nextToken` response element. The remaining
401
+ # results of the initial request can be seen by sending another
402
+ # `DescribeImageTags` request with the returned `nextToken` value.
403
+ # This value can be between 1 and 1000. If this parameter is not used,
404
+ # then `DescribeImageTags` returns up to 100 results and a `nextToken`
405
+ # value, if applicable. This option cannot be used when you specify
406
+ # images with `imageIds`.
407
+ # @return [Integer]
408
+ #
409
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/DescribeImageTagsRequest AWS API Documentation
410
+ #
411
+ class DescribeImageTagsRequest < Struct.new(
412
+ :registry_id,
413
+ :repository_name,
414
+ :next_token,
415
+ :max_results)
416
+ SENSITIVE = []
417
+ include Aws::Structure
418
+ end
419
+
420
+ # @!attribute [rw] image_tag_details
421
+ # The image tag details for the images in the requested repository.
422
+ # @return [Array<Types::ImageTagDetail>]
423
+ #
424
+ # @!attribute [rw] next_token
425
+ # The `nextToken` value to include in a future `DescribeImageTags`
426
+ # request. When the results of a `DescribeImageTags` request exceed
427
+ # `maxResults`, this value can be used to retrieve the next page of
428
+ # results. This value is `null` when there are no more results to
429
+ # return.
430
+ # @return [String]
431
+ #
432
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/DescribeImageTagsResponse AWS API Documentation
433
+ #
434
+ class DescribeImageTagsResponse < Struct.new(
435
+ :image_tag_details,
436
+ :next_token)
437
+ SENSITIVE = []
438
+ include Aws::Structure
439
+ end
440
+
441
+ # @note When making an API call, you may pass DescribeImagesRequest
442
+ # data as a hash:
443
+ #
444
+ # {
445
+ # registry_id: "RegistryId",
446
+ # repository_name: "RepositoryName", # required
447
+ # image_ids: [
448
+ # {
449
+ # image_digest: "ImageDigest",
450
+ # image_tag: "ImageTag",
451
+ # },
452
+ # ],
453
+ # next_token: "NextToken",
454
+ # max_results: 1,
455
+ # }
456
+ #
457
+ # @!attribute [rw] registry_id
458
+ # The AWS account ID associated with the public registry that contains
459
+ # the repository in which to describe images. If you do not specify a
460
+ # registry, the default public registry is assumed.
461
+ # @return [String]
462
+ #
463
+ # @!attribute [rw] repository_name
464
+ # The repository that contains the images to describe.
465
+ # @return [String]
466
+ #
467
+ # @!attribute [rw] image_ids
468
+ # The list of image IDs for the requested repository.
469
+ # @return [Array<Types::ImageIdentifier>]
470
+ #
471
+ # @!attribute [rw] next_token
472
+ # The `nextToken` value returned from a previous paginated
473
+ # `DescribeImages` request where `maxResults` was used and the results
474
+ # exceeded the value of that parameter. Pagination continues from the
475
+ # end of the previous results that returned the `nextToken` value.
476
+ # This value is `null` when there are no more results to return. This
477
+ # option cannot be used when you specify images with `imageIds`.
478
+ # @return [String]
479
+ #
480
+ # @!attribute [rw] max_results
481
+ # The maximum number of repository results returned by
482
+ # `DescribeImages` in paginated output. When this parameter is used,
483
+ # `DescribeImages` only returns `maxResults` results in a single page
484
+ # along with a `nextToken` response element. The remaining results of
485
+ # the initial request can be seen by sending another `DescribeImages`
486
+ # request with the returned `nextToken` value. This value can be
487
+ # between 1 and 1000. If this parameter is not used, then
488
+ # `DescribeImages` returns up to 100 results and a `nextToken` value,
489
+ # if applicable. This option cannot be used when you specify images
490
+ # with `imageIds`.
491
+ # @return [Integer]
492
+ #
493
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/DescribeImagesRequest AWS API Documentation
494
+ #
495
+ class DescribeImagesRequest < Struct.new(
496
+ :registry_id,
497
+ :repository_name,
498
+ :image_ids,
499
+ :next_token,
500
+ :max_results)
501
+ SENSITIVE = []
502
+ include Aws::Structure
503
+ end
504
+
505
+ # @!attribute [rw] image_details
506
+ # A list of ImageDetail objects that contain data about the image.
507
+ # @return [Array<Types::ImageDetail>]
508
+ #
509
+ # @!attribute [rw] next_token
510
+ # The `nextToken` value to include in a future `DescribeImages`
511
+ # request. When the results of a `DescribeImages` request exceed
512
+ # `maxResults`, this value can be used to retrieve the next page of
513
+ # results. This value is `null` when there are no more results to
514
+ # return.
515
+ # @return [String]
516
+ #
517
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/DescribeImagesResponse AWS API Documentation
518
+ #
519
+ class DescribeImagesResponse < Struct.new(
520
+ :image_details,
521
+ :next_token)
522
+ SENSITIVE = []
523
+ include Aws::Structure
524
+ end
525
+
526
+ # @note When making an API call, you may pass DescribeRegistriesRequest
527
+ # data as a hash:
528
+ #
529
+ # {
530
+ # next_token: "NextToken",
531
+ # max_results: 1,
532
+ # }
533
+ #
534
+ # @!attribute [rw] next_token
535
+ # The `nextToken` value returned from a previous paginated
536
+ # `DescribeRegistries` request where `maxResults` was used and the
537
+ # results exceeded the value of that parameter. Pagination continues
538
+ # from the end of the previous results that returned the `nextToken`
539
+ # value. This value is `null` when there are no more results to
540
+ # return.
541
+ #
542
+ # <note markdown="1"> This token should be treated as an opaque identifier that is only
543
+ # used to retrieve the next items in a list and not for other
544
+ # programmatic purposes.
545
+ #
546
+ # </note>
547
+ # @return [String]
548
+ #
549
+ # @!attribute [rw] max_results
550
+ # The maximum number of repository results returned by
551
+ # `DescribeRegistries` in paginated output. When this parameter is
552
+ # used, `DescribeRegistries` only returns `maxResults` results in a
553
+ # single page along with a `nextToken` response element. The remaining
554
+ # results of the initial request can be seen by sending another
555
+ # `DescribeRegistries` request with the returned `nextToken` value.
556
+ # This value can be between 1 and 1000. If this parameter is not used,
557
+ # then `DescribeRegistries` returns up to 100 results and a
558
+ # `nextToken` value, if applicable.
559
+ # @return [Integer]
560
+ #
561
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/DescribeRegistriesRequest AWS API Documentation
562
+ #
563
+ class DescribeRegistriesRequest < Struct.new(
564
+ :next_token,
565
+ :max_results)
566
+ SENSITIVE = []
567
+ include Aws::Structure
568
+ end
569
+
570
+ # @!attribute [rw] registries
571
+ # An object containing the details for a public registry.
572
+ # @return [Array<Types::Registry>]
573
+ #
574
+ # @!attribute [rw] next_token
575
+ # The `nextToken` value to include in a future `DescribeRepositories`
576
+ # request. When the results of a `DescribeRepositories` request exceed
577
+ # `maxResults`, this value can be used to retrieve the next page of
578
+ # results. This value is `null` when there are no more results to
579
+ # return.
580
+ # @return [String]
581
+ #
582
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/DescribeRegistriesResponse AWS API Documentation
583
+ #
584
+ class DescribeRegistriesResponse < Struct.new(
585
+ :registries,
586
+ :next_token)
587
+ SENSITIVE = []
588
+ include Aws::Structure
589
+ end
590
+
591
+ # @note When making an API call, you may pass DescribeRepositoriesRequest
592
+ # data as a hash:
593
+ #
594
+ # {
595
+ # registry_id: "RegistryId",
596
+ # repository_names: ["RepositoryName"],
597
+ # next_token: "NextToken",
598
+ # max_results: 1,
599
+ # }
600
+ #
601
+ # @!attribute [rw] registry_id
602
+ # The AWS account ID associated with the registry that contains the
603
+ # repositories to be described. If you do not specify a registry, the
604
+ # default public registry is assumed.
605
+ # @return [String]
606
+ #
607
+ # @!attribute [rw] repository_names
608
+ # A list of repositories to describe. If this parameter is omitted,
609
+ # then all repositories in a registry are described.
610
+ # @return [Array<String>]
611
+ #
612
+ # @!attribute [rw] next_token
613
+ # The `nextToken` value returned from a previous paginated
614
+ # `DescribeRepositories` request where `maxResults` was used and the
615
+ # results exceeded the value of that parameter. Pagination continues
616
+ # from the end of the previous results that returned the `nextToken`
617
+ # value. This value is `null` when there are no more results to
618
+ # return. This option cannot be used when you specify repositories
619
+ # with `repositoryNames`.
620
+ #
621
+ # <note markdown="1"> This token should be treated as an opaque identifier that is only
622
+ # used to retrieve the next items in a list and not for other
623
+ # programmatic purposes.
624
+ #
625
+ # </note>
626
+ # @return [String]
627
+ #
628
+ # @!attribute [rw] max_results
629
+ # The maximum number of repository results returned by
630
+ # `DescribeRepositories` in paginated output. When this parameter is
631
+ # used, `DescribeRepositories` only returns `maxResults` results in a
632
+ # single page along with a `nextToken` response element. The remaining
633
+ # results of the initial request can be seen by sending another
634
+ # `DescribeRepositories` request with the returned `nextToken` value.
635
+ # This value can be between 1 and 1000. If this parameter is not used,
636
+ # then `DescribeRepositories` returns up to 100 results and a
637
+ # `nextToken` value, if applicable. This option cannot be used when
638
+ # you specify repositories with `repositoryNames`.
639
+ # @return [Integer]
640
+ #
641
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/DescribeRepositoriesRequest AWS API Documentation
642
+ #
643
+ class DescribeRepositoriesRequest < Struct.new(
644
+ :registry_id,
645
+ :repository_names,
646
+ :next_token,
647
+ :max_results)
648
+ SENSITIVE = []
649
+ include Aws::Structure
650
+ end
651
+
652
+ # @!attribute [rw] repositories
653
+ # A list of repository objects corresponding to valid repositories.
654
+ # @return [Array<Types::Repository>]
655
+ #
656
+ # @!attribute [rw] next_token
657
+ # The `nextToken` value to include in a future `DescribeRepositories`
658
+ # request. When the results of a `DescribeRepositories` request exceed
659
+ # `maxResults`, this value can be used to retrieve the next page of
660
+ # results. This value is `null` when there are no more results to
661
+ # return.
662
+ # @return [String]
663
+ #
664
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/DescribeRepositoriesResponse AWS API Documentation
665
+ #
666
+ class DescribeRepositoriesResponse < Struct.new(
667
+ :repositories,
668
+ :next_token)
669
+ SENSITIVE = []
670
+ include Aws::Structure
671
+ end
672
+
673
+ # The specified layer upload does not contain any layer parts.
674
+ #
675
+ # @!attribute [rw] message
676
+ # @return [String]
677
+ #
678
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/EmptyUploadException AWS API Documentation
679
+ #
680
+ class EmptyUploadException < Struct.new(
681
+ :message)
682
+ SENSITIVE = []
683
+ include Aws::Structure
684
+ end
685
+
686
+ # @api private
687
+ #
688
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/GetAuthorizationTokenRequest AWS API Documentation
689
+ #
690
+ class GetAuthorizationTokenRequest < Aws::EmptyStructure; end
691
+
692
+ # @!attribute [rw] authorization_data
693
+ # An authorization token data object that corresponds to a public
694
+ # registry.
695
+ # @return [Types::AuthorizationData]
696
+ #
697
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/GetAuthorizationTokenResponse AWS API Documentation
698
+ #
699
+ class GetAuthorizationTokenResponse < Struct.new(
700
+ :authorization_data)
701
+ SENSITIVE = []
702
+ include Aws::Structure
703
+ end
704
+
705
+ # @api private
706
+ #
707
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/GetRegistryCatalogDataRequest AWS API Documentation
708
+ #
709
+ class GetRegistryCatalogDataRequest < Aws::EmptyStructure; end
710
+
711
+ # @!attribute [rw] registry_catalog_data
712
+ # The catalog metadata for the public registry.
713
+ # @return [Types::RegistryCatalogData]
714
+ #
715
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/GetRegistryCatalogDataResponse AWS API Documentation
716
+ #
717
+ class GetRegistryCatalogDataResponse < Struct.new(
718
+ :registry_catalog_data)
719
+ SENSITIVE = []
720
+ include Aws::Structure
721
+ end
722
+
723
+ # @note When making an API call, you may pass GetRepositoryCatalogDataRequest
724
+ # data as a hash:
725
+ #
726
+ # {
727
+ # registry_id: "RegistryId",
728
+ # repository_name: "RepositoryName", # required
729
+ # }
730
+ #
731
+ # @!attribute [rw] registry_id
732
+ # The AWS account ID associated with the registry that contains the
733
+ # repositories to be described. If you do not specify a registry, the
734
+ # default public registry is assumed.
735
+ # @return [String]
736
+ #
737
+ # @!attribute [rw] repository_name
738
+ # The name of the repository to retrieve the catalog metadata for.
739
+ # @return [String]
740
+ #
741
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/GetRepositoryCatalogDataRequest AWS API Documentation
742
+ #
743
+ class GetRepositoryCatalogDataRequest < Struct.new(
744
+ :registry_id,
745
+ :repository_name)
746
+ SENSITIVE = []
747
+ include Aws::Structure
748
+ end
749
+
750
+ # @!attribute [rw] catalog_data
751
+ # The catalog metadata for the repository.
752
+ # @return [Types::RepositoryCatalogData]
753
+ #
754
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/GetRepositoryCatalogDataResponse AWS API Documentation
755
+ #
756
+ class GetRepositoryCatalogDataResponse < Struct.new(
757
+ :catalog_data)
758
+ SENSITIVE = []
759
+ include Aws::Structure
760
+ end
761
+
762
+ # @note When making an API call, you may pass GetRepositoryPolicyRequest
763
+ # data as a hash:
764
+ #
765
+ # {
766
+ # registry_id: "RegistryId",
767
+ # repository_name: "RepositoryName", # required
768
+ # }
769
+ #
770
+ # @!attribute [rw] registry_id
771
+ # The AWS account ID associated with the public registry that contains
772
+ # the repository. If you do not specify a registry, the default public
773
+ # registry is assumed.
774
+ # @return [String]
775
+ #
776
+ # @!attribute [rw] repository_name
777
+ # The name of the repository with the policy to retrieve.
778
+ # @return [String]
779
+ #
780
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/GetRepositoryPolicyRequest AWS API Documentation
781
+ #
782
+ class GetRepositoryPolicyRequest < Struct.new(
783
+ :registry_id,
784
+ :repository_name)
785
+ SENSITIVE = []
786
+ include Aws::Structure
787
+ end
788
+
789
+ # @!attribute [rw] registry_id
790
+ # The registry ID associated with the request.
791
+ # @return [String]
792
+ #
793
+ # @!attribute [rw] repository_name
794
+ # The repository name associated with the request.
795
+ # @return [String]
796
+ #
797
+ # @!attribute [rw] policy_text
798
+ # The repository policy text associated with the repository. The
799
+ # policy text will be in JSON format.
800
+ # @return [String]
801
+ #
802
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/GetRepositoryPolicyResponse AWS API Documentation
803
+ #
804
+ class GetRepositoryPolicyResponse < Struct.new(
805
+ :registry_id,
806
+ :repository_name,
807
+ :policy_text)
808
+ SENSITIVE = []
809
+ include Aws::Structure
810
+ end
811
+
812
+ # An object representing an Amazon ECR image.
813
+ #
814
+ # @!attribute [rw] registry_id
815
+ # The AWS account ID associated with the registry containing the
816
+ # image.
817
+ # @return [String]
818
+ #
819
+ # @!attribute [rw] repository_name
820
+ # The name of the repository associated with the image.
821
+ # @return [String]
822
+ #
823
+ # @!attribute [rw] image_id
824
+ # An object containing the image tag and image digest associated with
825
+ # an image.
826
+ # @return [Types::ImageIdentifier]
827
+ #
828
+ # @!attribute [rw] image_manifest
829
+ # The image manifest associated with the image.
830
+ # @return [String]
831
+ #
832
+ # @!attribute [rw] image_manifest_media_type
833
+ # The manifest media type of the image.
834
+ # @return [String]
835
+ #
836
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/Image AWS API Documentation
837
+ #
838
+ class Image < Struct.new(
839
+ :registry_id,
840
+ :repository_name,
841
+ :image_id,
842
+ :image_manifest,
843
+ :image_manifest_media_type)
844
+ SENSITIVE = []
845
+ include Aws::Structure
846
+ end
847
+
848
+ # The specified image has already been pushed, and there were no changes
849
+ # to the manifest or image tag after the last push.
850
+ #
851
+ # @!attribute [rw] message
852
+ # @return [String]
853
+ #
854
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/ImageAlreadyExistsException AWS API Documentation
855
+ #
856
+ class ImageAlreadyExistsException < Struct.new(
857
+ :message)
858
+ SENSITIVE = []
859
+ include Aws::Structure
860
+ end
861
+
862
+ # An object that describes an image returned by a DescribeImages
863
+ # operation.
864
+ #
865
+ # @!attribute [rw] registry_id
866
+ # The AWS account ID associated with the public registry to which this
867
+ # image belongs.
868
+ # @return [String]
869
+ #
870
+ # @!attribute [rw] repository_name
871
+ # The name of the repository to which this image belongs.
872
+ # @return [String]
873
+ #
874
+ # @!attribute [rw] image_digest
875
+ # The `sha256` digest of the image manifest.
876
+ # @return [String]
877
+ #
878
+ # @!attribute [rw] image_tags
879
+ # The list of tags associated with this image.
880
+ # @return [Array<String>]
881
+ #
882
+ # @!attribute [rw] image_size_in_bytes
883
+ # The size, in bytes, of the image in the repository.
884
+ #
885
+ # If the image is a manifest list, this will be the max size of all
886
+ # manifests in the list.
887
+ #
888
+ # <note markdown="1"> Beginning with Docker version 1.9, the Docker client compresses
889
+ # image layers before pushing them to a V2 Docker registry. The output
890
+ # of the `docker images` command shows the uncompressed image size, so
891
+ # it may return a larger image size than the image sizes returned by
892
+ # DescribeImages.
893
+ #
894
+ # </note>
895
+ # @return [Integer]
896
+ #
897
+ # @!attribute [rw] image_pushed_at
898
+ # The date and time, expressed in standard JavaScript date format, at
899
+ # which the current image was pushed to the repository.
900
+ # @return [Time]
901
+ #
902
+ # @!attribute [rw] image_manifest_media_type
903
+ # The media type of the image manifest.
904
+ # @return [String]
905
+ #
906
+ # @!attribute [rw] artifact_media_type
907
+ # The artifact media type of the image.
908
+ # @return [String]
909
+ #
910
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/ImageDetail AWS API Documentation
911
+ #
912
+ class ImageDetail < Struct.new(
913
+ :registry_id,
914
+ :repository_name,
915
+ :image_digest,
916
+ :image_tags,
917
+ :image_size_in_bytes,
918
+ :image_pushed_at,
919
+ :image_manifest_media_type,
920
+ :artifact_media_type)
921
+ SENSITIVE = []
922
+ include Aws::Structure
923
+ end
924
+
925
+ # The specified image digest does not match the digest that Amazon ECR
926
+ # calculated for the image.
927
+ #
928
+ # @!attribute [rw] message
929
+ # @return [String]
930
+ #
931
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/ImageDigestDoesNotMatchException AWS API Documentation
932
+ #
933
+ class ImageDigestDoesNotMatchException < Struct.new(
934
+ :message)
935
+ SENSITIVE = []
936
+ include Aws::Structure
937
+ end
938
+
939
+ # An object representing an Amazon ECR image failure.
940
+ #
941
+ # @!attribute [rw] image_id
942
+ # The image ID associated with the failure.
943
+ # @return [Types::ImageIdentifier]
944
+ #
945
+ # @!attribute [rw] failure_code
946
+ # The code associated with the failure.
947
+ # @return [String]
948
+ #
949
+ # @!attribute [rw] failure_reason
950
+ # The reason for the failure.
951
+ # @return [String]
952
+ #
953
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/ImageFailure AWS API Documentation
954
+ #
955
+ class ImageFailure < Struct.new(
956
+ :image_id,
957
+ :failure_code,
958
+ :failure_reason)
959
+ SENSITIVE = []
960
+ include Aws::Structure
961
+ end
962
+
963
+ # An object with identifying information for an Amazon ECR image.
964
+ #
965
+ # @note When making an API call, you may pass ImageIdentifier
966
+ # data as a hash:
967
+ #
968
+ # {
969
+ # image_digest: "ImageDigest",
970
+ # image_tag: "ImageTag",
971
+ # }
972
+ #
973
+ # @!attribute [rw] image_digest
974
+ # The `sha256` digest of the image manifest.
975
+ # @return [String]
976
+ #
977
+ # @!attribute [rw] image_tag
978
+ # The tag used for the image.
979
+ # @return [String]
980
+ #
981
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/ImageIdentifier AWS API Documentation
982
+ #
983
+ class ImageIdentifier < Struct.new(
984
+ :image_digest,
985
+ :image_tag)
986
+ SENSITIVE = []
987
+ include Aws::Structure
988
+ end
989
+
990
+ # The image requested does not exist in the specified repository.
991
+ #
992
+ # @!attribute [rw] message
993
+ # @return [String]
994
+ #
995
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/ImageNotFoundException AWS API Documentation
996
+ #
997
+ class ImageNotFoundException < Struct.new(
998
+ :message)
999
+ SENSITIVE = []
1000
+ include Aws::Structure
1001
+ end
1002
+
1003
+ # The specified image is tagged with a tag that already exists. The
1004
+ # repository is configured for tag immutability.
1005
+ #
1006
+ # @!attribute [rw] message
1007
+ # @return [String]
1008
+ #
1009
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/ImageTagAlreadyExistsException AWS API Documentation
1010
+ #
1011
+ class ImageTagAlreadyExistsException < Struct.new(
1012
+ :message)
1013
+ SENSITIVE = []
1014
+ include Aws::Structure
1015
+ end
1016
+
1017
+ # An object representing the image tag details for an image.
1018
+ #
1019
+ # @!attribute [rw] image_tag
1020
+ # The tag associated with the image.
1021
+ # @return [String]
1022
+ #
1023
+ # @!attribute [rw] created_at
1024
+ # The time stamp indicating when the image tag was created.
1025
+ # @return [Time]
1026
+ #
1027
+ # @!attribute [rw] image_detail
1028
+ # An object that describes the details of an image.
1029
+ # @return [Types::ReferencedImageDetail]
1030
+ #
1031
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/ImageTagDetail AWS API Documentation
1032
+ #
1033
+ class ImageTagDetail < Struct.new(
1034
+ :image_tag,
1035
+ :created_at,
1036
+ :image_detail)
1037
+ SENSITIVE = []
1038
+ include Aws::Structure
1039
+ end
1040
+
1041
+ # @note When making an API call, you may pass InitiateLayerUploadRequest
1042
+ # data as a hash:
1043
+ #
1044
+ # {
1045
+ # registry_id: "RegistryIdOrAlias",
1046
+ # repository_name: "RepositoryName", # required
1047
+ # }
1048
+ #
1049
+ # @!attribute [rw] registry_id
1050
+ # The AWS account ID associated with the registry to which you intend
1051
+ # to upload layers. If you do not specify a registry, the default
1052
+ # public registry is assumed.
1053
+ # @return [String]
1054
+ #
1055
+ # @!attribute [rw] repository_name
1056
+ # The name of the repository to which you intend to upload layers.
1057
+ # @return [String]
1058
+ #
1059
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/InitiateLayerUploadRequest AWS API Documentation
1060
+ #
1061
+ class InitiateLayerUploadRequest < Struct.new(
1062
+ :registry_id,
1063
+ :repository_name)
1064
+ SENSITIVE = []
1065
+ include Aws::Structure
1066
+ end
1067
+
1068
+ # @!attribute [rw] upload_id
1069
+ # The upload ID for the layer upload. This parameter is passed to
1070
+ # further UploadLayerPart and CompleteLayerUpload operations.
1071
+ # @return [String]
1072
+ #
1073
+ # @!attribute [rw] part_size
1074
+ # The size, in bytes, that Amazon ECR expects future layer part
1075
+ # uploads to be.
1076
+ # @return [Integer]
1077
+ #
1078
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/InitiateLayerUploadResponse AWS API Documentation
1079
+ #
1080
+ class InitiateLayerUploadResponse < Struct.new(
1081
+ :upload_id,
1082
+ :part_size)
1083
+ SENSITIVE = []
1084
+ include Aws::Structure
1085
+ end
1086
+
1087
+ # The layer digest calculation performed by Amazon ECR upon receipt of
1088
+ # the image layer does not match the digest specified.
1089
+ #
1090
+ # @!attribute [rw] message
1091
+ # @return [String]
1092
+ #
1093
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/InvalidLayerException AWS API Documentation
1094
+ #
1095
+ class InvalidLayerException < Struct.new(
1096
+ :message)
1097
+ SENSITIVE = []
1098
+ include Aws::Structure
1099
+ end
1100
+
1101
+ # The layer part size is not valid, or the first byte specified is not
1102
+ # consecutive to the last byte of a previous layer part upload.
1103
+ #
1104
+ # @!attribute [rw] registry_id
1105
+ # The AWS account ID associated with the layer part.
1106
+ # @return [String]
1107
+ #
1108
+ # @!attribute [rw] repository_name
1109
+ # The name of the repository.
1110
+ # @return [String]
1111
+ #
1112
+ # @!attribute [rw] upload_id
1113
+ # The upload ID associated with the layer part.
1114
+ # @return [String]
1115
+ #
1116
+ # @!attribute [rw] last_valid_byte_received
1117
+ # The position of the last byte of the layer part.
1118
+ # @return [Integer]
1119
+ #
1120
+ # @!attribute [rw] message
1121
+ # @return [String]
1122
+ #
1123
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/InvalidLayerPartException AWS API Documentation
1124
+ #
1125
+ class InvalidLayerPartException < Struct.new(
1126
+ :registry_id,
1127
+ :repository_name,
1128
+ :upload_id,
1129
+ :last_valid_byte_received,
1130
+ :message)
1131
+ SENSITIVE = []
1132
+ include Aws::Structure
1133
+ end
1134
+
1135
+ # The specified parameter is invalid. Review the available parameters
1136
+ # for the API request.
1137
+ #
1138
+ # @!attribute [rw] message
1139
+ # @return [String]
1140
+ #
1141
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/InvalidParameterException AWS API Documentation
1142
+ #
1143
+ class InvalidParameterException < Struct.new(
1144
+ :message)
1145
+ SENSITIVE = []
1146
+ include Aws::Structure
1147
+ end
1148
+
1149
+ # An object representing an Amazon ECR image layer.
1150
+ #
1151
+ # @!attribute [rw] layer_digest
1152
+ # The `sha256` digest of the image layer.
1153
+ # @return [String]
1154
+ #
1155
+ # @!attribute [rw] layer_availability
1156
+ # The availability status of the image layer.
1157
+ # @return [String]
1158
+ #
1159
+ # @!attribute [rw] layer_size
1160
+ # The size, in bytes, of the image layer.
1161
+ # @return [Integer]
1162
+ #
1163
+ # @!attribute [rw] media_type
1164
+ # The media type of the layer, such as
1165
+ # `application/vnd.docker.image.rootfs.diff.tar.gzip` or
1166
+ # `application/vnd.oci.image.layer.v1.tar+gzip`.
1167
+ # @return [String]
1168
+ #
1169
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/Layer AWS API Documentation
1170
+ #
1171
+ class Layer < Struct.new(
1172
+ :layer_digest,
1173
+ :layer_availability,
1174
+ :layer_size,
1175
+ :media_type)
1176
+ SENSITIVE = []
1177
+ include Aws::Structure
1178
+ end
1179
+
1180
+ # The image layer already exists in the associated repository.
1181
+ #
1182
+ # @!attribute [rw] message
1183
+ # @return [String]
1184
+ #
1185
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/LayerAlreadyExistsException AWS API Documentation
1186
+ #
1187
+ class LayerAlreadyExistsException < Struct.new(
1188
+ :message)
1189
+ SENSITIVE = []
1190
+ include Aws::Structure
1191
+ end
1192
+
1193
+ # An object representing an Amazon ECR image layer failure.
1194
+ #
1195
+ # @!attribute [rw] layer_digest
1196
+ # The layer digest associated with the failure.
1197
+ # @return [String]
1198
+ #
1199
+ # @!attribute [rw] failure_code
1200
+ # The failure code associated with the failure.
1201
+ # @return [String]
1202
+ #
1203
+ # @!attribute [rw] failure_reason
1204
+ # The reason for the failure.
1205
+ # @return [String]
1206
+ #
1207
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/LayerFailure AWS API Documentation
1208
+ #
1209
+ class LayerFailure < Struct.new(
1210
+ :layer_digest,
1211
+ :failure_code,
1212
+ :failure_reason)
1213
+ SENSITIVE = []
1214
+ include Aws::Structure
1215
+ end
1216
+
1217
+ # Layer parts must be at least 5 MiB in size.
1218
+ #
1219
+ # @!attribute [rw] message
1220
+ # @return [String]
1221
+ #
1222
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/LayerPartTooSmallException AWS API Documentation
1223
+ #
1224
+ class LayerPartTooSmallException < Struct.new(
1225
+ :message)
1226
+ SENSITIVE = []
1227
+ include Aws::Structure
1228
+ end
1229
+
1230
+ # The specified layers could not be found, or the specified layer is not
1231
+ # valid for this repository.
1232
+ #
1233
+ # @!attribute [rw] message
1234
+ # @return [String]
1235
+ #
1236
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/LayersNotFoundException AWS API Documentation
1237
+ #
1238
+ class LayersNotFoundException < Struct.new(
1239
+ :message)
1240
+ SENSITIVE = []
1241
+ include Aws::Structure
1242
+ end
1243
+
1244
+ # The operation did not succeed because it would have exceeded a service
1245
+ # limit for your account. For more information, see [Amazon ECR Service
1246
+ # Quotas][1] in the Amazon Elastic Container Registry User Guide.
1247
+ #
1248
+ #
1249
+ #
1250
+ # [1]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/service-quotas.html
1251
+ #
1252
+ # @!attribute [rw] message
1253
+ # @return [String]
1254
+ #
1255
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/LimitExceededException AWS API Documentation
1256
+ #
1257
+ class LimitExceededException < Struct.new(
1258
+ :message)
1259
+ SENSITIVE = []
1260
+ include Aws::Structure
1261
+ end
1262
+
1263
+ # @note When making an API call, you may pass PutImageRequest
1264
+ # data as a hash:
1265
+ #
1266
+ # {
1267
+ # registry_id: "RegistryIdOrAlias",
1268
+ # repository_name: "RepositoryName", # required
1269
+ # image_manifest: "ImageManifest", # required
1270
+ # image_manifest_media_type: "MediaType",
1271
+ # image_tag: "ImageTag",
1272
+ # image_digest: "ImageDigest",
1273
+ # }
1274
+ #
1275
+ # @!attribute [rw] registry_id
1276
+ # The AWS account ID associated with the public registry that contains
1277
+ # the repository in which to put the image. If you do not specify a
1278
+ # registry, the default public registry is assumed.
1279
+ # @return [String]
1280
+ #
1281
+ # @!attribute [rw] repository_name
1282
+ # The name of the repository in which to put the image.
1283
+ # @return [String]
1284
+ #
1285
+ # @!attribute [rw] image_manifest
1286
+ # The image manifest corresponding to the image to be uploaded.
1287
+ # @return [String]
1288
+ #
1289
+ # @!attribute [rw] image_manifest_media_type
1290
+ # The media type of the image manifest. If you push an image manifest
1291
+ # that does not contain the `mediaType` field, you must specify the
1292
+ # `imageManifestMediaType` in the request.
1293
+ # @return [String]
1294
+ #
1295
+ # @!attribute [rw] image_tag
1296
+ # The tag to associate with the image. This parameter is required for
1297
+ # images that use the Docker Image Manifest V2 Schema 2 or Open
1298
+ # Container Initiative (OCI) formats.
1299
+ # @return [String]
1300
+ #
1301
+ # @!attribute [rw] image_digest
1302
+ # The image digest of the image manifest corresponding to the image.
1303
+ # @return [String]
1304
+ #
1305
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/PutImageRequest AWS API Documentation
1306
+ #
1307
+ class PutImageRequest < Struct.new(
1308
+ :registry_id,
1309
+ :repository_name,
1310
+ :image_manifest,
1311
+ :image_manifest_media_type,
1312
+ :image_tag,
1313
+ :image_digest)
1314
+ SENSITIVE = []
1315
+ include Aws::Structure
1316
+ end
1317
+
1318
+ # @!attribute [rw] image
1319
+ # Details of the image uploaded.
1320
+ # @return [Types::Image]
1321
+ #
1322
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/PutImageResponse AWS API Documentation
1323
+ #
1324
+ class PutImageResponse < Struct.new(
1325
+ :image)
1326
+ SENSITIVE = []
1327
+ include Aws::Structure
1328
+ end
1329
+
1330
+ # @note When making an API call, you may pass PutRegistryCatalogDataRequest
1331
+ # data as a hash:
1332
+ #
1333
+ # {
1334
+ # display_name: "RegistryDisplayName",
1335
+ # }
1336
+ #
1337
+ # @!attribute [rw] display_name
1338
+ # The display name for a public registry. The display name is shown as
1339
+ # the repository author in the Amazon ECR Public Gallery.
1340
+ #
1341
+ # <note markdown="1"> The registry display name is only publicly visible in the Amazon ECR
1342
+ # Public Gallery for verified accounts.
1343
+ #
1344
+ # </note>
1345
+ # @return [String]
1346
+ #
1347
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/PutRegistryCatalogDataRequest AWS API Documentation
1348
+ #
1349
+ class PutRegistryCatalogDataRequest < Struct.new(
1350
+ :display_name)
1351
+ SENSITIVE = []
1352
+ include Aws::Structure
1353
+ end
1354
+
1355
+ # @!attribute [rw] registry_catalog_data
1356
+ # The catalog data for the public registry.
1357
+ # @return [Types::RegistryCatalogData]
1358
+ #
1359
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/PutRegistryCatalogDataResponse AWS API Documentation
1360
+ #
1361
+ class PutRegistryCatalogDataResponse < Struct.new(
1362
+ :registry_catalog_data)
1363
+ SENSITIVE = []
1364
+ include Aws::Structure
1365
+ end
1366
+
1367
+ # @note When making an API call, you may pass PutRepositoryCatalogDataRequest
1368
+ # data as a hash:
1369
+ #
1370
+ # {
1371
+ # registry_id: "RegistryId",
1372
+ # repository_name: "RepositoryName", # required
1373
+ # catalog_data: { # required
1374
+ # description: "RepositoryDescription",
1375
+ # architectures: ["Architecture"],
1376
+ # operating_systems: ["OperatingSystem"],
1377
+ # logo_image_blob: "data",
1378
+ # about_text: "AboutText",
1379
+ # usage_text: "UsageText",
1380
+ # },
1381
+ # }
1382
+ #
1383
+ # @!attribute [rw] registry_id
1384
+ # The AWS account ID associated with the public registry the
1385
+ # repository is in. If you do not specify a registry, the default
1386
+ # public registry is assumed.
1387
+ # @return [String]
1388
+ #
1389
+ # @!attribute [rw] repository_name
1390
+ # The name of the repository to create or update the catalog data for.
1391
+ # @return [String]
1392
+ #
1393
+ # @!attribute [rw] catalog_data
1394
+ # An object containing the catalog data for a repository. This data is
1395
+ # publicly visible in the Amazon ECR Public Gallery.
1396
+ # @return [Types::RepositoryCatalogDataInput]
1397
+ #
1398
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/PutRepositoryCatalogDataRequest AWS API Documentation
1399
+ #
1400
+ class PutRepositoryCatalogDataRequest < Struct.new(
1401
+ :registry_id,
1402
+ :repository_name,
1403
+ :catalog_data)
1404
+ SENSITIVE = []
1405
+ include Aws::Structure
1406
+ end
1407
+
1408
+ # @!attribute [rw] catalog_data
1409
+ # The catalog data for the repository.
1410
+ # @return [Types::RepositoryCatalogData]
1411
+ #
1412
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/PutRepositoryCatalogDataResponse AWS API Documentation
1413
+ #
1414
+ class PutRepositoryCatalogDataResponse < Struct.new(
1415
+ :catalog_data)
1416
+ SENSITIVE = []
1417
+ include Aws::Structure
1418
+ end
1419
+
1420
+ # An object that describes the image tag details returned by a
1421
+ # DescribeImageTags action.
1422
+ #
1423
+ # @!attribute [rw] image_digest
1424
+ # The `sha256` digest of the image manifest.
1425
+ # @return [String]
1426
+ #
1427
+ # @!attribute [rw] image_size_in_bytes
1428
+ # The size, in bytes, of the image in the repository.
1429
+ #
1430
+ # If the image is a manifest list, this will be the max size of all
1431
+ # manifests in the list.
1432
+ #
1433
+ # <note markdown="1"> Beginning with Docker version 1.9, the Docker client compresses
1434
+ # image layers before pushing them to a V2 Docker registry. The output
1435
+ # of the `docker images` command shows the uncompressed image size, so
1436
+ # it may return a larger image size than the image sizes returned by
1437
+ # DescribeImages.
1438
+ #
1439
+ # </note>
1440
+ # @return [Integer]
1441
+ #
1442
+ # @!attribute [rw] image_pushed_at
1443
+ # The date and time, expressed in standard JavaScript date format, at
1444
+ # which the current image tag was pushed to the repository.
1445
+ # @return [Time]
1446
+ #
1447
+ # @!attribute [rw] image_manifest_media_type
1448
+ # The media type of the image manifest.
1449
+ # @return [String]
1450
+ #
1451
+ # @!attribute [rw] artifact_media_type
1452
+ # The artifact media type of the image.
1453
+ # @return [String]
1454
+ #
1455
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/ReferencedImageDetail AWS API Documentation
1456
+ #
1457
+ class ReferencedImageDetail < Struct.new(
1458
+ :image_digest,
1459
+ :image_size_in_bytes,
1460
+ :image_pushed_at,
1461
+ :image_manifest_media_type,
1462
+ :artifact_media_type)
1463
+ SENSITIVE = []
1464
+ include Aws::Structure
1465
+ end
1466
+
1467
+ # The manifest list is referencing an image that does not exist.
1468
+ #
1469
+ # @!attribute [rw] message
1470
+ # @return [String]
1471
+ #
1472
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/ReferencedImagesNotFoundException AWS API Documentation
1473
+ #
1474
+ class ReferencedImagesNotFoundException < Struct.new(
1475
+ :message)
1476
+ SENSITIVE = []
1477
+ include Aws::Structure
1478
+ end
1479
+
1480
+ # The details of a public registry.
1481
+ #
1482
+ # @!attribute [rw] registry_id
1483
+ # The AWS account ID associated with the registry. If you do not
1484
+ # specify a registry, the default public registry is assumed.
1485
+ # @return [String]
1486
+ #
1487
+ # @!attribute [rw] registry_arn
1488
+ # The Amazon Resource Name (ARN) of the public registry.
1489
+ # @return [String]
1490
+ #
1491
+ # @!attribute [rw] registry_uri
1492
+ # The URI of a public registry. The URI contains a universal prefix
1493
+ # and the registry alias.
1494
+ # @return [String]
1495
+ #
1496
+ # @!attribute [rw] verified
1497
+ # Whether the account is verified. This indicates whether the account
1498
+ # is an AWS Marketplace vendor. If an account is verified, each public
1499
+ # repository will received a verified account badge on the Amazon ECR
1500
+ # Public Gallery.
1501
+ # @return [Boolean]
1502
+ #
1503
+ # @!attribute [rw] aliases
1504
+ # An array of objects representing the aliases for a public registry.
1505
+ # @return [Array<Types::RegistryAlias>]
1506
+ #
1507
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/Registry AWS API Documentation
1508
+ #
1509
+ class Registry < Struct.new(
1510
+ :registry_id,
1511
+ :registry_arn,
1512
+ :registry_uri,
1513
+ :verified,
1514
+ :aliases)
1515
+ SENSITIVE = []
1516
+ include Aws::Structure
1517
+ end
1518
+
1519
+ # An object representing the aliases for a public registry. A public
1520
+ # registry is given an alias upon creation but a custom alias can be set
1521
+ # using the Amazon ECR console. For more information, see
1522
+ # [Registries][1] in the *Amazon Elastic Container Registry User Guide*.
1523
+ #
1524
+ #
1525
+ #
1526
+ # [1]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/Registries.html
1527
+ #
1528
+ # @!attribute [rw] name
1529
+ # The name of the registry alias.
1530
+ # @return [String]
1531
+ #
1532
+ # @!attribute [rw] status
1533
+ # The status of the registry alias.
1534
+ # @return [String]
1535
+ #
1536
+ # @!attribute [rw] primary_registry_alias
1537
+ # Whether or not the registry alias is the primary alias for the
1538
+ # registry. If true, the alias is the primary registry alias and is
1539
+ # displayed in both the repository URL and the image URI used in the
1540
+ # `docker pull` commands on the Amazon ECR Public Gallery.
1541
+ #
1542
+ # <note markdown="1"> A registry alias that is not the primary registry alias can be used
1543
+ # in the repository URI in a `docker pull` command.
1544
+ #
1545
+ # </note>
1546
+ # @return [Boolean]
1547
+ #
1548
+ # @!attribute [rw] default_registry_alias
1549
+ # Whether or not the registry alias is the default alias for the
1550
+ # registry. When the first public repository is created, your public
1551
+ # registry is assigned a default registry alias.
1552
+ # @return [Boolean]
1553
+ #
1554
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/RegistryAlias AWS API Documentation
1555
+ #
1556
+ class RegistryAlias < Struct.new(
1557
+ :name,
1558
+ :status,
1559
+ :primary_registry_alias,
1560
+ :default_registry_alias)
1561
+ SENSITIVE = []
1562
+ include Aws::Structure
1563
+ end
1564
+
1565
+ # The metadata for a public registry.
1566
+ #
1567
+ # @!attribute [rw] display_name
1568
+ # The display name for a public registry. This appears on the Amazon
1569
+ # ECR Public Gallery.
1570
+ #
1571
+ # Only accounts that have the verified account badge can have a
1572
+ # registry display name.
1573
+ # @return [String]
1574
+ #
1575
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/RegistryCatalogData AWS API Documentation
1576
+ #
1577
+ class RegistryCatalogData < Struct.new(
1578
+ :display_name)
1579
+ SENSITIVE = []
1580
+ include Aws::Structure
1581
+ end
1582
+
1583
+ # The registry does not exist.
1584
+ #
1585
+ # @!attribute [rw] message
1586
+ # @return [String]
1587
+ #
1588
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/RegistryNotFoundException AWS API Documentation
1589
+ #
1590
+ class RegistryNotFoundException < Struct.new(
1591
+ :message)
1592
+ SENSITIVE = []
1593
+ include Aws::Structure
1594
+ end
1595
+
1596
+ # An object representing a repository.
1597
+ #
1598
+ # @!attribute [rw] repository_arn
1599
+ # The Amazon Resource Name (ARN) that identifies the repository. The
1600
+ # ARN contains the `arn:aws:ecr` namespace, followed by the region of
1601
+ # the repository, AWS account ID of the repository owner, repository
1602
+ # namespace, and repository name. For example,
1603
+ # `arn:aws:ecr:region:012345678910:repository/test`.
1604
+ # @return [String]
1605
+ #
1606
+ # @!attribute [rw] registry_id
1607
+ # The AWS account ID associated with the public registry that contains
1608
+ # the repository.
1609
+ # @return [String]
1610
+ #
1611
+ # @!attribute [rw] repository_name
1612
+ # The name of the repository.
1613
+ # @return [String]
1614
+ #
1615
+ # @!attribute [rw] repository_uri
1616
+ # The URI for the repository. You can use this URI for container image
1617
+ # `push` and `pull` operations.
1618
+ # @return [String]
1619
+ #
1620
+ # @!attribute [rw] created_at
1621
+ # The date and time, in JavaScript date format, when the repository
1622
+ # was created.
1623
+ # @return [Time]
1624
+ #
1625
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/Repository AWS API Documentation
1626
+ #
1627
+ class Repository < Struct.new(
1628
+ :repository_arn,
1629
+ :registry_id,
1630
+ :repository_name,
1631
+ :repository_uri,
1632
+ :created_at)
1633
+ SENSITIVE = []
1634
+ include Aws::Structure
1635
+ end
1636
+
1637
+ # The specified repository already exists in the specified registry.
1638
+ #
1639
+ # @!attribute [rw] message
1640
+ # @return [String]
1641
+ #
1642
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/RepositoryAlreadyExistsException AWS API Documentation
1643
+ #
1644
+ class RepositoryAlreadyExistsException < Struct.new(
1645
+ :message)
1646
+ SENSITIVE = []
1647
+ include Aws::Structure
1648
+ end
1649
+
1650
+ # The catalog data for a repository. This data is publicly visible in
1651
+ # the Amazon ECR Public Gallery.
1652
+ #
1653
+ # @!attribute [rw] description
1654
+ # The short description of the repository.
1655
+ # @return [String]
1656
+ #
1657
+ # @!attribute [rw] architectures
1658
+ # The architecture tags that are associated with the repository.
1659
+ #
1660
+ # <note markdown="1"> Only supported operating system tags appear publicly in the Amazon
1661
+ # ECR Public Gallery. For more information, see
1662
+ # RepositoryCatalogDataInput.
1663
+ #
1664
+ # </note>
1665
+ # @return [Array<String>]
1666
+ #
1667
+ # @!attribute [rw] operating_systems
1668
+ # The operating system tags that are associated with the repository.
1669
+ #
1670
+ # <note markdown="1"> Only supported operating system tags appear publicly in the Amazon
1671
+ # ECR Public Gallery. For more information, see
1672
+ # RepositoryCatalogDataInput.
1673
+ #
1674
+ # </note>
1675
+ # @return [Array<String>]
1676
+ #
1677
+ # @!attribute [rw] logo_url
1678
+ # The URL containing the logo associated with the repository.
1679
+ # @return [String]
1680
+ #
1681
+ # @!attribute [rw] about_text
1682
+ # The longform description of the contents of the repository. This
1683
+ # text appears in the repository details on the Amazon ECR Public
1684
+ # Gallery.
1685
+ # @return [String]
1686
+ #
1687
+ # @!attribute [rw] usage_text
1688
+ # The longform usage details of the contents of the repository. The
1689
+ # usage text provides context for users of the repository.
1690
+ # @return [String]
1691
+ #
1692
+ # @!attribute [rw] marketplace_certified
1693
+ # Whether or not the repository is certified by AWS Marketplace.
1694
+ # @return [Boolean]
1695
+ #
1696
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/RepositoryCatalogData AWS API Documentation
1697
+ #
1698
+ class RepositoryCatalogData < Struct.new(
1699
+ :description,
1700
+ :architectures,
1701
+ :operating_systems,
1702
+ :logo_url,
1703
+ :about_text,
1704
+ :usage_text,
1705
+ :marketplace_certified)
1706
+ SENSITIVE = []
1707
+ include Aws::Structure
1708
+ end
1709
+
1710
+ # An object containing the catalog data for a repository. This data is
1711
+ # publicly visible in the Amazon ECR Public Gallery.
1712
+ #
1713
+ # @note When making an API call, you may pass RepositoryCatalogDataInput
1714
+ # data as a hash:
1715
+ #
1716
+ # {
1717
+ # description: "RepositoryDescription",
1718
+ # architectures: ["Architecture"],
1719
+ # operating_systems: ["OperatingSystem"],
1720
+ # logo_image_blob: "data",
1721
+ # about_text: "AboutText",
1722
+ # usage_text: "UsageText",
1723
+ # }
1724
+ #
1725
+ # @!attribute [rw] description
1726
+ # A short description of the contents of the repository. This text
1727
+ # appears in both the image details and also when searching for
1728
+ # repositories on the Amazon ECR Public Gallery.
1729
+ # @return [String]
1730
+ #
1731
+ # @!attribute [rw] architectures
1732
+ # The system architecture that the images in the repository are
1733
+ # compatible with. On the Amazon ECR Public Gallery, the following
1734
+ # supported architectures will appear as badges on the repository and
1735
+ # are used as search filters.
1736
+ #
1737
+ # * `Linux`
1738
+ #
1739
+ # * `Windows`
1740
+ #
1741
+ # <note markdown="1"> If an unsupported tag is added to your repository catalog data, it
1742
+ # will be associated with the repository and can be retrieved using
1743
+ # the API but will not be discoverable in the Amazon ECR Public
1744
+ # Gallery.
1745
+ #
1746
+ # </note>
1747
+ # @return [Array<String>]
1748
+ #
1749
+ # @!attribute [rw] operating_systems
1750
+ # The operating systems that the images in the repository are
1751
+ # compatible with. On the Amazon ECR Public Gallery, the following
1752
+ # supported operating systems will appear as badges on the repository
1753
+ # and are used as search filters.
1754
+ #
1755
+ # * `ARM`
1756
+ #
1757
+ # * `ARM 64`
1758
+ #
1759
+ # * `x86`
1760
+ #
1761
+ # * `x86-64`
1762
+ #
1763
+ # <note markdown="1"> If an unsupported tag is added to your repository catalog data, it
1764
+ # will be associated with the repository and can be retrieved using
1765
+ # the API but will not be discoverable in the Amazon ECR Public
1766
+ # Gallery.
1767
+ #
1768
+ # </note>
1769
+ # @return [Array<String>]
1770
+ #
1771
+ # @!attribute [rw] logo_image_blob
1772
+ # The base64-encoded repository logo payload.
1773
+ #
1774
+ # <note markdown="1"> The repository logo is only publicly visible in the Amazon ECR
1775
+ # Public Gallery for verified accounts.
1776
+ #
1777
+ # </note>
1778
+ # @return [String]
1779
+ #
1780
+ # @!attribute [rw] about_text
1781
+ # A detailed description of the contents of the repository. It is
1782
+ # publicly visible in the Amazon ECR Public Gallery. The text must be
1783
+ # in markdown format.
1784
+ # @return [String]
1785
+ #
1786
+ # @!attribute [rw] usage_text
1787
+ # Detailed information on how to use the contents of the repository.
1788
+ # It is publicly visible in the Amazon ECR Public Gallery. The usage
1789
+ # text provides context, support information, and additional usage
1790
+ # details for users of the repository. The text must be in markdown
1791
+ # format.
1792
+ # @return [String]
1793
+ #
1794
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/RepositoryCatalogDataInput AWS API Documentation
1795
+ #
1796
+ class RepositoryCatalogDataInput < Struct.new(
1797
+ :description,
1798
+ :architectures,
1799
+ :operating_systems,
1800
+ :logo_image_blob,
1801
+ :about_text,
1802
+ :usage_text)
1803
+ SENSITIVE = []
1804
+ include Aws::Structure
1805
+ end
1806
+
1807
+ # The specified repository contains images. To delete a repository that
1808
+ # contains images, you must force the deletion with the `force`
1809
+ # parameter.
1810
+ #
1811
+ # @!attribute [rw] message
1812
+ # @return [String]
1813
+ #
1814
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/RepositoryNotEmptyException AWS API Documentation
1815
+ #
1816
+ class RepositoryNotEmptyException < Struct.new(
1817
+ :message)
1818
+ SENSITIVE = []
1819
+ include Aws::Structure
1820
+ end
1821
+
1822
+ # The specified repository could not be found. Check the spelling of the
1823
+ # specified repository and ensure that you are performing operations on
1824
+ # the correct registry.
1825
+ #
1826
+ # @!attribute [rw] message
1827
+ # @return [String]
1828
+ #
1829
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/RepositoryNotFoundException AWS API Documentation
1830
+ #
1831
+ class RepositoryNotFoundException < Struct.new(
1832
+ :message)
1833
+ SENSITIVE = []
1834
+ include Aws::Structure
1835
+ end
1836
+
1837
+ # The specified repository and registry combination does not have an
1838
+ # associated repository policy.
1839
+ #
1840
+ # @!attribute [rw] message
1841
+ # @return [String]
1842
+ #
1843
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/RepositoryPolicyNotFoundException AWS API Documentation
1844
+ #
1845
+ class RepositoryPolicyNotFoundException < Struct.new(
1846
+ :message)
1847
+ SENSITIVE = []
1848
+ include Aws::Structure
1849
+ end
1850
+
1851
+ # These errors are usually caused by a server-side issue.
1852
+ #
1853
+ # @!attribute [rw] message
1854
+ # @return [String]
1855
+ #
1856
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/ServerException AWS API Documentation
1857
+ #
1858
+ class ServerException < Struct.new(
1859
+ :message)
1860
+ SENSITIVE = []
1861
+ include Aws::Structure
1862
+ end
1863
+
1864
+ # @note When making an API call, you may pass SetRepositoryPolicyRequest
1865
+ # data as a hash:
1866
+ #
1867
+ # {
1868
+ # registry_id: "RegistryId",
1869
+ # repository_name: "RepositoryName", # required
1870
+ # policy_text: "RepositoryPolicyText", # required
1871
+ # force: false,
1872
+ # }
1873
+ #
1874
+ # @!attribute [rw] registry_id
1875
+ # The AWS account ID associated with the registry that contains the
1876
+ # repository. If you do not specify a registry, the default public
1877
+ # registry is assumed.
1878
+ # @return [String]
1879
+ #
1880
+ # @!attribute [rw] repository_name
1881
+ # The name of the repository to receive the policy.
1882
+ # @return [String]
1883
+ #
1884
+ # @!attribute [rw] policy_text
1885
+ # The JSON repository policy text to apply to the repository. For more
1886
+ # information, see [Amazon ECR Repository Policies][1] in the *Amazon
1887
+ # Elastic Container Registry User Guide*.
1888
+ #
1889
+ #
1890
+ #
1891
+ # [1]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html
1892
+ # @return [String]
1893
+ #
1894
+ # @!attribute [rw] force
1895
+ # If the policy you are attempting to set on a repository policy would
1896
+ # prevent you from setting another policy in the future, you must
1897
+ # force the SetRepositoryPolicy operation. This is intended to prevent
1898
+ # accidental repository lock outs.
1899
+ # @return [Boolean]
1900
+ #
1901
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/SetRepositoryPolicyRequest AWS API Documentation
1902
+ #
1903
+ class SetRepositoryPolicyRequest < Struct.new(
1904
+ :registry_id,
1905
+ :repository_name,
1906
+ :policy_text,
1907
+ :force)
1908
+ SENSITIVE = []
1909
+ include Aws::Structure
1910
+ end
1911
+
1912
+ # @!attribute [rw] registry_id
1913
+ # The registry ID associated with the request.
1914
+ # @return [String]
1915
+ #
1916
+ # @!attribute [rw] repository_name
1917
+ # The repository name associated with the request.
1918
+ # @return [String]
1919
+ #
1920
+ # @!attribute [rw] policy_text
1921
+ # The JSON repository policy text applied to the repository.
1922
+ # @return [String]
1923
+ #
1924
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/SetRepositoryPolicyResponse AWS API Documentation
1925
+ #
1926
+ class SetRepositoryPolicyResponse < Struct.new(
1927
+ :registry_id,
1928
+ :repository_name,
1929
+ :policy_text)
1930
+ SENSITIVE = []
1931
+ include Aws::Structure
1932
+ end
1933
+
1934
+ # The action is not supported in this Region.
1935
+ #
1936
+ # @!attribute [rw] message
1937
+ # @return [String]
1938
+ #
1939
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/UnsupportedCommandException AWS API Documentation
1940
+ #
1941
+ class UnsupportedCommandException < Struct.new(
1942
+ :message)
1943
+ SENSITIVE = []
1944
+ include Aws::Structure
1945
+ end
1946
+
1947
+ # @note When making an API call, you may pass UploadLayerPartRequest
1948
+ # data as a hash:
1949
+ #
1950
+ # {
1951
+ # registry_id: "RegistryIdOrAlias",
1952
+ # repository_name: "RepositoryName", # required
1953
+ # upload_id: "UploadId", # required
1954
+ # part_first_byte: 1, # required
1955
+ # part_last_byte: 1, # required
1956
+ # layer_part_blob: "data", # required
1957
+ # }
1958
+ #
1959
+ # @!attribute [rw] registry_id
1960
+ # The AWS account ID associated with the registry to which you are
1961
+ # uploading layer parts. If you do not specify a registry, the default
1962
+ # public registry is assumed.
1963
+ # @return [String]
1964
+ #
1965
+ # @!attribute [rw] repository_name
1966
+ # The name of the repository to which you are uploading layer parts.
1967
+ # @return [String]
1968
+ #
1969
+ # @!attribute [rw] upload_id
1970
+ # The upload ID from a previous InitiateLayerUpload operation to
1971
+ # associate with the layer part upload.
1972
+ # @return [String]
1973
+ #
1974
+ # @!attribute [rw] part_first_byte
1975
+ # The position of the first byte of the layer part witin the overall
1976
+ # image layer.
1977
+ # @return [Integer]
1978
+ #
1979
+ # @!attribute [rw] part_last_byte
1980
+ # The position of the last byte of the layer part within the overall
1981
+ # image layer.
1982
+ # @return [Integer]
1983
+ #
1984
+ # @!attribute [rw] layer_part_blob
1985
+ # The base64-encoded layer part payload.
1986
+ # @return [String]
1987
+ #
1988
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/UploadLayerPartRequest AWS API Documentation
1989
+ #
1990
+ class UploadLayerPartRequest < Struct.new(
1991
+ :registry_id,
1992
+ :repository_name,
1993
+ :upload_id,
1994
+ :part_first_byte,
1995
+ :part_last_byte,
1996
+ :layer_part_blob)
1997
+ SENSITIVE = []
1998
+ include Aws::Structure
1999
+ end
2000
+
2001
+ # @!attribute [rw] registry_id
2002
+ # The registry ID associated with the request.
2003
+ # @return [String]
2004
+ #
2005
+ # @!attribute [rw] repository_name
2006
+ # The repository name associated with the request.
2007
+ # @return [String]
2008
+ #
2009
+ # @!attribute [rw] upload_id
2010
+ # The upload ID associated with the request.
2011
+ # @return [String]
2012
+ #
2013
+ # @!attribute [rw] last_byte_received
2014
+ # The integer value of the last byte received in the request.
2015
+ # @return [Integer]
2016
+ #
2017
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/UploadLayerPartResponse AWS API Documentation
2018
+ #
2019
+ class UploadLayerPartResponse < Struct.new(
2020
+ :registry_id,
2021
+ :repository_name,
2022
+ :upload_id,
2023
+ :last_byte_received)
2024
+ SENSITIVE = []
2025
+ include Aws::Structure
2026
+ end
2027
+
2028
+ # The upload could not be found, or the specified upload ID is not valid
2029
+ # for this repository.
2030
+ #
2031
+ # @!attribute [rw] message
2032
+ # @return [String]
2033
+ #
2034
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ecr-public-2020-10-30/UploadNotFoundException AWS API Documentation
2035
+ #
2036
+ class UploadNotFoundException < Struct.new(
2037
+ :message)
2038
+ SENSITIVE = []
2039
+ include Aws::Structure
2040
+ end
2041
+
2042
+ end
2043
+ end