aws-sdk-signer 1.1.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 +7 -0
- data/lib/aws-sdk-signer.rb +48 -0
- data/lib/aws-sdk-signer/client.rb +822 -0
- data/lib/aws-sdk-signer/client_api.rb +415 -0
- data/lib/aws-sdk-signer/customizations.rb +0 -0
- data/lib/aws-sdk-signer/errors.rb +14 -0
- data/lib/aws-sdk-signer/resource.rb +23 -0
- data/lib/aws-sdk-signer/types.rb +976 -0
- data/lib/aws-sdk-signer/waiters.rb +62 -0
- metadata +83 -0
@@ -0,0 +1,976 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::Signer
|
9
|
+
module Types
|
10
|
+
|
11
|
+
# @note When making an API call, you may pass CancelSigningProfileRequest
|
12
|
+
# data as a hash:
|
13
|
+
#
|
14
|
+
# {
|
15
|
+
# profile_name: "ProfileName", # required
|
16
|
+
# }
|
17
|
+
#
|
18
|
+
# @!attribute [rw] profile_name
|
19
|
+
# The name of the signing profile to be canceled.
|
20
|
+
# @return [String]
|
21
|
+
#
|
22
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/CancelSigningProfileRequest AWS API Documentation
|
23
|
+
#
|
24
|
+
class CancelSigningProfileRequest < Struct.new(
|
25
|
+
:profile_name)
|
26
|
+
include Aws::Structure
|
27
|
+
end
|
28
|
+
|
29
|
+
# @note When making an API call, you may pass DescribeSigningJobRequest
|
30
|
+
# data as a hash:
|
31
|
+
#
|
32
|
+
# {
|
33
|
+
# job_id: "JobId", # required
|
34
|
+
# }
|
35
|
+
#
|
36
|
+
# @!attribute [rw] job_id
|
37
|
+
# The ID of the signing job on input.
|
38
|
+
# @return [String]
|
39
|
+
#
|
40
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/DescribeSigningJobRequest AWS API Documentation
|
41
|
+
#
|
42
|
+
class DescribeSigningJobRequest < Struct.new(
|
43
|
+
:job_id)
|
44
|
+
include Aws::Structure
|
45
|
+
end
|
46
|
+
|
47
|
+
# @!attribute [rw] job_id
|
48
|
+
# The ID of the signing job on output.
|
49
|
+
# @return [String]
|
50
|
+
#
|
51
|
+
# @!attribute [rw] source
|
52
|
+
# The object that contains the name of your S3 bucket or your raw
|
53
|
+
# code.
|
54
|
+
# @return [Types::Source]
|
55
|
+
#
|
56
|
+
# @!attribute [rw] signing_material
|
57
|
+
# Amazon Resource Name (ARN) of your code signing certificate.
|
58
|
+
# @return [Types::SigningMaterial]
|
59
|
+
#
|
60
|
+
# @!attribute [rw] platform_id
|
61
|
+
# The microcontroller platform to which your signed code image will be
|
62
|
+
# distributed.
|
63
|
+
# @return [String]
|
64
|
+
#
|
65
|
+
# @!attribute [rw] profile_name
|
66
|
+
# The name of the profile that initiated the signing operation.
|
67
|
+
# @return [String]
|
68
|
+
#
|
69
|
+
# @!attribute [rw] overrides
|
70
|
+
# A list of any overrides that were applied to the signing operation.
|
71
|
+
# @return [Types::SigningPlatformOverrides]
|
72
|
+
#
|
73
|
+
# @!attribute [rw] signing_parameters
|
74
|
+
# Map of user-assigned key-value pairs used during signing. These
|
75
|
+
# values contain any information that you specified for use in your
|
76
|
+
# signing job.
|
77
|
+
# @return [Hash<String,String>]
|
78
|
+
#
|
79
|
+
# @!attribute [rw] created_at
|
80
|
+
# Date and time that the signing job was created.
|
81
|
+
# @return [Time]
|
82
|
+
#
|
83
|
+
# @!attribute [rw] completed_at
|
84
|
+
# Date and time that the signing job was completed.
|
85
|
+
# @return [Time]
|
86
|
+
#
|
87
|
+
# @!attribute [rw] requested_by
|
88
|
+
# The IAM principal that requested the signing job.
|
89
|
+
# @return [String]
|
90
|
+
#
|
91
|
+
# @!attribute [rw] status
|
92
|
+
# Status of the signing job.
|
93
|
+
# @return [String]
|
94
|
+
#
|
95
|
+
# @!attribute [rw] status_reason
|
96
|
+
# String value that contains the status reason.
|
97
|
+
# @return [String]
|
98
|
+
#
|
99
|
+
# @!attribute [rw] signed_object
|
100
|
+
# Name of the S3 bucket where the signed code image is saved by AWS
|
101
|
+
# Signer.
|
102
|
+
# @return [Types::SignedObject]
|
103
|
+
#
|
104
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/DescribeSigningJobResponse AWS API Documentation
|
105
|
+
#
|
106
|
+
class DescribeSigningJobResponse < Struct.new(
|
107
|
+
:job_id,
|
108
|
+
:source,
|
109
|
+
:signing_material,
|
110
|
+
:platform_id,
|
111
|
+
:profile_name,
|
112
|
+
:overrides,
|
113
|
+
:signing_parameters,
|
114
|
+
:created_at,
|
115
|
+
:completed_at,
|
116
|
+
:requested_by,
|
117
|
+
:status,
|
118
|
+
:status_reason,
|
119
|
+
:signed_object)
|
120
|
+
include Aws::Structure
|
121
|
+
end
|
122
|
+
|
123
|
+
# Points to an `S3Destination` object that contains information about
|
124
|
+
# your S3 bucket.
|
125
|
+
#
|
126
|
+
# @note When making an API call, you may pass Destination
|
127
|
+
# data as a hash:
|
128
|
+
#
|
129
|
+
# {
|
130
|
+
# s3: {
|
131
|
+
# bucket_name: "BucketName",
|
132
|
+
# prefix: "Prefix",
|
133
|
+
# },
|
134
|
+
# }
|
135
|
+
#
|
136
|
+
# @!attribute [rw] s3
|
137
|
+
# The `S3Destination` object.
|
138
|
+
# @return [Types::S3Destination]
|
139
|
+
#
|
140
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/Destination AWS API Documentation
|
141
|
+
#
|
142
|
+
class Destination < Struct.new(
|
143
|
+
:s3)
|
144
|
+
include Aws::Structure
|
145
|
+
end
|
146
|
+
|
147
|
+
# The encryption algorithm options that are available to an AWS Signer
|
148
|
+
# job.
|
149
|
+
#
|
150
|
+
# @!attribute [rw] allowed_values
|
151
|
+
# The set of accepted encryption algorithms that are allowed in an AWS
|
152
|
+
# Signer job.
|
153
|
+
# @return [Array<String>]
|
154
|
+
#
|
155
|
+
# @!attribute [rw] default_value
|
156
|
+
# The default encryption algorithm that is used by an AWS Signer job.
|
157
|
+
# @return [String]
|
158
|
+
#
|
159
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/EncryptionAlgorithmOptions AWS API Documentation
|
160
|
+
#
|
161
|
+
class EncryptionAlgorithmOptions < Struct.new(
|
162
|
+
:allowed_values,
|
163
|
+
:default_value)
|
164
|
+
include Aws::Structure
|
165
|
+
end
|
166
|
+
|
167
|
+
# @note When making an API call, you may pass GetSigningPlatformRequest
|
168
|
+
# data as a hash:
|
169
|
+
#
|
170
|
+
# {
|
171
|
+
# platform_id: "PlatformId", # required
|
172
|
+
# }
|
173
|
+
#
|
174
|
+
# @!attribute [rw] platform_id
|
175
|
+
# The ID of the target signing platform.
|
176
|
+
# @return [String]
|
177
|
+
#
|
178
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/GetSigningPlatformRequest AWS API Documentation
|
179
|
+
#
|
180
|
+
class GetSigningPlatformRequest < Struct.new(
|
181
|
+
:platform_id)
|
182
|
+
include Aws::Structure
|
183
|
+
end
|
184
|
+
|
185
|
+
# @!attribute [rw] platform_id
|
186
|
+
# The ID of the target signing platform.
|
187
|
+
# @return [String]
|
188
|
+
#
|
189
|
+
# @!attribute [rw] display_name
|
190
|
+
# The display name of the target signing platform.
|
191
|
+
# @return [String]
|
192
|
+
#
|
193
|
+
# @!attribute [rw] partner
|
194
|
+
# A list of partner entities that use the target signing platform.
|
195
|
+
# @return [String]
|
196
|
+
#
|
197
|
+
# @!attribute [rw] target
|
198
|
+
# The validation template that is used by the target signing platform.
|
199
|
+
# @return [String]
|
200
|
+
#
|
201
|
+
# @!attribute [rw] category
|
202
|
+
# The category type of the target signing platform.
|
203
|
+
# @return [String]
|
204
|
+
#
|
205
|
+
# @!attribute [rw] signing_configuration
|
206
|
+
# A list of configurations applied to the target platform at signing.
|
207
|
+
# @return [Types::SigningConfiguration]
|
208
|
+
#
|
209
|
+
# @!attribute [rw] signing_image_format
|
210
|
+
# The format of the target platform's signing image.
|
211
|
+
# @return [Types::SigningImageFormat]
|
212
|
+
#
|
213
|
+
# @!attribute [rw] max_size_in_mb
|
214
|
+
# The maximum size (in MB) of the payload that can be signed by the
|
215
|
+
# target platform.
|
216
|
+
# @return [Integer]
|
217
|
+
#
|
218
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/GetSigningPlatformResponse AWS API Documentation
|
219
|
+
#
|
220
|
+
class GetSigningPlatformResponse < Struct.new(
|
221
|
+
:platform_id,
|
222
|
+
:display_name,
|
223
|
+
:partner,
|
224
|
+
:target,
|
225
|
+
:category,
|
226
|
+
:signing_configuration,
|
227
|
+
:signing_image_format,
|
228
|
+
:max_size_in_mb)
|
229
|
+
include Aws::Structure
|
230
|
+
end
|
231
|
+
|
232
|
+
# @note When making an API call, you may pass GetSigningProfileRequest
|
233
|
+
# data as a hash:
|
234
|
+
#
|
235
|
+
# {
|
236
|
+
# profile_name: "ProfileName", # required
|
237
|
+
# }
|
238
|
+
#
|
239
|
+
# @!attribute [rw] profile_name
|
240
|
+
# The name of the target signing profile.
|
241
|
+
# @return [String]
|
242
|
+
#
|
243
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/GetSigningProfileRequest AWS API Documentation
|
244
|
+
#
|
245
|
+
class GetSigningProfileRequest < Struct.new(
|
246
|
+
:profile_name)
|
247
|
+
include Aws::Structure
|
248
|
+
end
|
249
|
+
|
250
|
+
# @!attribute [rw] profile_name
|
251
|
+
# The name of the target signing profile.
|
252
|
+
# @return [String]
|
253
|
+
#
|
254
|
+
# @!attribute [rw] signing_material
|
255
|
+
# The ARN of the certificate that the target profile uses for signing
|
256
|
+
# operations.
|
257
|
+
# @return [Types::SigningMaterial]
|
258
|
+
#
|
259
|
+
# @!attribute [rw] platform_id
|
260
|
+
# The ID of the platform that is used by the target signing profile.
|
261
|
+
# @return [String]
|
262
|
+
#
|
263
|
+
# @!attribute [rw] overrides
|
264
|
+
# A list of overrides applied by the target signing profile for
|
265
|
+
# signing operations.
|
266
|
+
# @return [Types::SigningPlatformOverrides]
|
267
|
+
#
|
268
|
+
# @!attribute [rw] signing_parameters
|
269
|
+
# A map of key-value pairs for signing operations that is attached to
|
270
|
+
# the target signing profile.
|
271
|
+
# @return [Hash<String,String>]
|
272
|
+
#
|
273
|
+
# @!attribute [rw] status
|
274
|
+
# The status of the target signing profile.
|
275
|
+
# @return [String]
|
276
|
+
#
|
277
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/GetSigningProfileResponse AWS API Documentation
|
278
|
+
#
|
279
|
+
class GetSigningProfileResponse < Struct.new(
|
280
|
+
:profile_name,
|
281
|
+
:signing_material,
|
282
|
+
:platform_id,
|
283
|
+
:overrides,
|
284
|
+
:signing_parameters,
|
285
|
+
:status)
|
286
|
+
include Aws::Structure
|
287
|
+
end
|
288
|
+
|
289
|
+
# The hash algorithms that are available to an AWS Signer job.
|
290
|
+
#
|
291
|
+
# @!attribute [rw] allowed_values
|
292
|
+
# The set of accepted hash algorithms allowed in an AWS Signer job.
|
293
|
+
# @return [Array<String>]
|
294
|
+
#
|
295
|
+
# @!attribute [rw] default_value
|
296
|
+
# The default hash algorithm that is used in an AWS Signer job.
|
297
|
+
# @return [String]
|
298
|
+
#
|
299
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/HashAlgorithmOptions AWS API Documentation
|
300
|
+
#
|
301
|
+
class HashAlgorithmOptions < Struct.new(
|
302
|
+
:allowed_values,
|
303
|
+
:default_value)
|
304
|
+
include Aws::Structure
|
305
|
+
end
|
306
|
+
|
307
|
+
# @note When making an API call, you may pass ListSigningJobsRequest
|
308
|
+
# data as a hash:
|
309
|
+
#
|
310
|
+
# {
|
311
|
+
# status: "InProgress", # accepts InProgress, Failed, Succeeded
|
312
|
+
# platform_id: "PlatformId",
|
313
|
+
# requested_by: "RequestedBy",
|
314
|
+
# max_results: 1,
|
315
|
+
# next_token: "NextToken",
|
316
|
+
# }
|
317
|
+
#
|
318
|
+
# @!attribute [rw] status
|
319
|
+
# A status value with which to filter your results.
|
320
|
+
# @return [String]
|
321
|
+
#
|
322
|
+
# @!attribute [rw] platform_id
|
323
|
+
# The ID of microcontroller platform that you specified for the
|
324
|
+
# distribution of your code image.
|
325
|
+
# @return [String]
|
326
|
+
#
|
327
|
+
# @!attribute [rw] requested_by
|
328
|
+
# The IAM principal that requested the signing job.
|
329
|
+
# @return [String]
|
330
|
+
#
|
331
|
+
# @!attribute [rw] max_results
|
332
|
+
# Specifies the maximum number of items to return in the response. Use
|
333
|
+
# this parameter when paginating results. If additional items exist
|
334
|
+
# beyond the number you specify, the `nextToken` element is set in the
|
335
|
+
# response. Use the `nextToken` value in a subsequent request to
|
336
|
+
# retrieve additional items.
|
337
|
+
# @return [Integer]
|
338
|
+
#
|
339
|
+
# @!attribute [rw] next_token
|
340
|
+
# String for specifying the next set of paginated results to return.
|
341
|
+
# After you receive a response with truncated results, use this
|
342
|
+
# parameter in a subsequent request. Set it to the value of
|
343
|
+
# `nextToken` from the response that you just received.
|
344
|
+
# @return [String]
|
345
|
+
#
|
346
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/ListSigningJobsRequest AWS API Documentation
|
347
|
+
#
|
348
|
+
class ListSigningJobsRequest < Struct.new(
|
349
|
+
:status,
|
350
|
+
:platform_id,
|
351
|
+
:requested_by,
|
352
|
+
:max_results,
|
353
|
+
:next_token)
|
354
|
+
include Aws::Structure
|
355
|
+
end
|
356
|
+
|
357
|
+
# @!attribute [rw] jobs
|
358
|
+
# A list of your signing jobs.
|
359
|
+
# @return [Array<Types::SigningJob>]
|
360
|
+
#
|
361
|
+
# @!attribute [rw] next_token
|
362
|
+
# String for specifying the next set of paginated results.
|
363
|
+
# @return [String]
|
364
|
+
#
|
365
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/ListSigningJobsResponse AWS API Documentation
|
366
|
+
#
|
367
|
+
class ListSigningJobsResponse < Struct.new(
|
368
|
+
:jobs,
|
369
|
+
:next_token)
|
370
|
+
include Aws::Structure
|
371
|
+
end
|
372
|
+
|
373
|
+
# @note When making an API call, you may pass ListSigningPlatformsRequest
|
374
|
+
# data as a hash:
|
375
|
+
#
|
376
|
+
# {
|
377
|
+
# category: "String",
|
378
|
+
# partner: "String",
|
379
|
+
# target: "String",
|
380
|
+
# max_results: 1,
|
381
|
+
# next_token: "String",
|
382
|
+
# }
|
383
|
+
#
|
384
|
+
# @!attribute [rw] category
|
385
|
+
# The category type of a signing platform.
|
386
|
+
# @return [String]
|
387
|
+
#
|
388
|
+
# @!attribute [rw] partner
|
389
|
+
# Any partner entities connected to a signing platform.
|
390
|
+
# @return [String]
|
391
|
+
#
|
392
|
+
# @!attribute [rw] target
|
393
|
+
# The validation template that is used by the target signing platform.
|
394
|
+
# @return [String]
|
395
|
+
#
|
396
|
+
# @!attribute [rw] max_results
|
397
|
+
# The maximum number of results to be returned by this operation.
|
398
|
+
# @return [Integer]
|
399
|
+
#
|
400
|
+
# @!attribute [rw] next_token
|
401
|
+
# Value for specifying the next set of paginated results to return.
|
402
|
+
# After you receive a response with truncated results, use this
|
403
|
+
# parameter in a subsequent request. Set it to the value of
|
404
|
+
# `nextToken` from the response that you just received.
|
405
|
+
# @return [String]
|
406
|
+
#
|
407
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/ListSigningPlatformsRequest AWS API Documentation
|
408
|
+
#
|
409
|
+
class ListSigningPlatformsRequest < Struct.new(
|
410
|
+
:category,
|
411
|
+
:partner,
|
412
|
+
:target,
|
413
|
+
:max_results,
|
414
|
+
:next_token)
|
415
|
+
include Aws::Structure
|
416
|
+
end
|
417
|
+
|
418
|
+
# @!attribute [rw] platforms
|
419
|
+
# A list of all platforms that match the request parameters.
|
420
|
+
# @return [Array<Types::SigningPlatform>]
|
421
|
+
#
|
422
|
+
# @!attribute [rw] next_token
|
423
|
+
# Value for specifying the next set of paginated results to return.
|
424
|
+
# @return [String]
|
425
|
+
#
|
426
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/ListSigningPlatformsResponse AWS API Documentation
|
427
|
+
#
|
428
|
+
class ListSigningPlatformsResponse < Struct.new(
|
429
|
+
:platforms,
|
430
|
+
:next_token)
|
431
|
+
include Aws::Structure
|
432
|
+
end
|
433
|
+
|
434
|
+
# @note When making an API call, you may pass ListSigningProfilesRequest
|
435
|
+
# data as a hash:
|
436
|
+
#
|
437
|
+
# {
|
438
|
+
# include_canceled: false,
|
439
|
+
# max_results: 1,
|
440
|
+
# next_token: "NextToken",
|
441
|
+
# }
|
442
|
+
#
|
443
|
+
# @!attribute [rw] include_canceled
|
444
|
+
# Designates whether to include profiles with the status of
|
445
|
+
# `CANCELED`.
|
446
|
+
# @return [Boolean]
|
447
|
+
#
|
448
|
+
# @!attribute [rw] max_results
|
449
|
+
# The maximum number of profiles to be returned.
|
450
|
+
# @return [Integer]
|
451
|
+
#
|
452
|
+
# @!attribute [rw] next_token
|
453
|
+
# Value for specifying the next set of paginated results to return.
|
454
|
+
# After you receive a response with truncated results, use this
|
455
|
+
# parameter in a subsequent request. Set it to the value of
|
456
|
+
# `nextToken` from the response that you just received.
|
457
|
+
# @return [String]
|
458
|
+
#
|
459
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/ListSigningProfilesRequest AWS API Documentation
|
460
|
+
#
|
461
|
+
class ListSigningProfilesRequest < Struct.new(
|
462
|
+
:include_canceled,
|
463
|
+
:max_results,
|
464
|
+
:next_token)
|
465
|
+
include Aws::Structure
|
466
|
+
end
|
467
|
+
|
468
|
+
# @!attribute [rw] profiles
|
469
|
+
# A list of profiles that are available in the AWS account. This
|
470
|
+
# includes profiles with the status of `CANCELED` if the
|
471
|
+
# `includeCanceled` parameter is set to `true`.
|
472
|
+
# @return [Array<Types::SigningProfile>]
|
473
|
+
#
|
474
|
+
# @!attribute [rw] next_token
|
475
|
+
# Value for specifying the next set of paginated results to return.
|
476
|
+
# @return [String]
|
477
|
+
#
|
478
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/ListSigningProfilesResponse AWS API Documentation
|
479
|
+
#
|
480
|
+
class ListSigningProfilesResponse < Struct.new(
|
481
|
+
:profiles,
|
482
|
+
:next_token)
|
483
|
+
include Aws::Structure
|
484
|
+
end
|
485
|
+
|
486
|
+
# @note When making an API call, you may pass PutSigningProfileRequest
|
487
|
+
# data as a hash:
|
488
|
+
#
|
489
|
+
# {
|
490
|
+
# profile_name: "ProfileName", # required
|
491
|
+
# signing_material: { # required
|
492
|
+
# certificate_arn: "CertificateArn", # required
|
493
|
+
# },
|
494
|
+
# platform_id: "PlatformId", # required
|
495
|
+
# overrides: {
|
496
|
+
# signing_configuration: {
|
497
|
+
# encryption_algorithm: "RSA", # accepts RSA, ECDSA
|
498
|
+
# hash_algorithm: "SHA1", # accepts SHA1, SHA256
|
499
|
+
# },
|
500
|
+
# },
|
501
|
+
# signing_parameters: {
|
502
|
+
# "SigningParameterKey" => "SigningParameterValue",
|
503
|
+
# },
|
504
|
+
# }
|
505
|
+
#
|
506
|
+
# @!attribute [rw] profile_name
|
507
|
+
# The name of the signing profile to be created.
|
508
|
+
# @return [String]
|
509
|
+
#
|
510
|
+
# @!attribute [rw] signing_material
|
511
|
+
# The AWS Certificate Manager certificate that will be used to sign
|
512
|
+
# code with the new signing profile.
|
513
|
+
# @return [Types::SigningMaterial]
|
514
|
+
#
|
515
|
+
# @!attribute [rw] platform_id
|
516
|
+
# The ID of the signing profile to be created.
|
517
|
+
# @return [String]
|
518
|
+
#
|
519
|
+
# @!attribute [rw] overrides
|
520
|
+
# A subfield of `platform`. This specifies any different configuration
|
521
|
+
# options that you want to apply to the chosen platform (such as a
|
522
|
+
# different `hash-algorithm` or `signing-algorithm`).
|
523
|
+
# @return [Types::SigningPlatformOverrides]
|
524
|
+
#
|
525
|
+
# @!attribute [rw] signing_parameters
|
526
|
+
# Map of key-value pairs for signing. These can include any
|
527
|
+
# information that you want to use during signing.
|
528
|
+
# @return [Hash<String,String>]
|
529
|
+
#
|
530
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/PutSigningProfileRequest AWS API Documentation
|
531
|
+
#
|
532
|
+
class PutSigningProfileRequest < Struct.new(
|
533
|
+
:profile_name,
|
534
|
+
:signing_material,
|
535
|
+
:platform_id,
|
536
|
+
:overrides,
|
537
|
+
:signing_parameters)
|
538
|
+
include Aws::Structure
|
539
|
+
end
|
540
|
+
|
541
|
+
# @!attribute [rw] arn
|
542
|
+
# The Amazon Resource Name (ARN) of the signing profile created.
|
543
|
+
# @return [String]
|
544
|
+
#
|
545
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/PutSigningProfileResponse AWS API Documentation
|
546
|
+
#
|
547
|
+
class PutSigningProfileResponse < Struct.new(
|
548
|
+
:arn)
|
549
|
+
include Aws::Structure
|
550
|
+
end
|
551
|
+
|
552
|
+
# The name and prefix of the S3 bucket where AWS Signer saves your
|
553
|
+
# signed objects.
|
554
|
+
#
|
555
|
+
# @note When making an API call, you may pass S3Destination
|
556
|
+
# data as a hash:
|
557
|
+
#
|
558
|
+
# {
|
559
|
+
# bucket_name: "BucketName",
|
560
|
+
# prefix: "Prefix",
|
561
|
+
# }
|
562
|
+
#
|
563
|
+
# @!attribute [rw] bucket_name
|
564
|
+
# Name of the S3 bucket.
|
565
|
+
# @return [String]
|
566
|
+
#
|
567
|
+
# @!attribute [rw] prefix
|
568
|
+
# An Amazon S3 prefix that you can use to limit responses to those
|
569
|
+
# that begin with the specified prefix.
|
570
|
+
# @return [String]
|
571
|
+
#
|
572
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/S3Destination AWS API Documentation
|
573
|
+
#
|
574
|
+
class S3Destination < Struct.new(
|
575
|
+
:bucket_name,
|
576
|
+
:prefix)
|
577
|
+
include Aws::Structure
|
578
|
+
end
|
579
|
+
|
580
|
+
# The S3 bucket name and key where AWS Signer saved your signed code
|
581
|
+
# image.
|
582
|
+
#
|
583
|
+
# @!attribute [rw] bucket_name
|
584
|
+
# Name of the S3 bucket.
|
585
|
+
# @return [String]
|
586
|
+
#
|
587
|
+
# @!attribute [rw] key
|
588
|
+
# Key name that uniquely identifies a signed code image in your
|
589
|
+
# bucket.
|
590
|
+
# @return [String]
|
591
|
+
#
|
592
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/S3SignedObject AWS API Documentation
|
593
|
+
#
|
594
|
+
class S3SignedObject < Struct.new(
|
595
|
+
:bucket_name,
|
596
|
+
:key)
|
597
|
+
include Aws::Structure
|
598
|
+
end
|
599
|
+
|
600
|
+
# Information about the S3 bucket where you saved your unsigned code.
|
601
|
+
#
|
602
|
+
# @note When making an API call, you may pass S3Source
|
603
|
+
# data as a hash:
|
604
|
+
#
|
605
|
+
# {
|
606
|
+
# bucket_name: "BucketName", # required
|
607
|
+
# key: "Key", # required
|
608
|
+
# version: "Version", # required
|
609
|
+
# }
|
610
|
+
#
|
611
|
+
# @!attribute [rw] bucket_name
|
612
|
+
# Name of the S3 bucket.
|
613
|
+
# @return [String]
|
614
|
+
#
|
615
|
+
# @!attribute [rw] key
|
616
|
+
# Key name of the bucket object that contains your unsigned code.
|
617
|
+
# @return [String]
|
618
|
+
#
|
619
|
+
# @!attribute [rw] version
|
620
|
+
# Version of your source image in your version enabled S3 bucket.
|
621
|
+
# @return [String]
|
622
|
+
#
|
623
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/S3Source AWS API Documentation
|
624
|
+
#
|
625
|
+
class S3Source < Struct.new(
|
626
|
+
:bucket_name,
|
627
|
+
:key,
|
628
|
+
:version)
|
629
|
+
include Aws::Structure
|
630
|
+
end
|
631
|
+
|
632
|
+
# Points to an `S3SignedObject` object that contains information about
|
633
|
+
# your signed code image.
|
634
|
+
#
|
635
|
+
# @!attribute [rw] s3
|
636
|
+
# The `S3SignedObject`.
|
637
|
+
# @return [Types::S3SignedObject]
|
638
|
+
#
|
639
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/SignedObject AWS API Documentation
|
640
|
+
#
|
641
|
+
class SignedObject < Struct.new(
|
642
|
+
:s3)
|
643
|
+
include Aws::Structure
|
644
|
+
end
|
645
|
+
|
646
|
+
# The configuration of an AWS Signer operation.
|
647
|
+
#
|
648
|
+
# @!attribute [rw] encryption_algorithm_options
|
649
|
+
# The encryption algorithm options that are available for an AWS
|
650
|
+
# Signer job.
|
651
|
+
# @return [Types::EncryptionAlgorithmOptions]
|
652
|
+
#
|
653
|
+
# @!attribute [rw] hash_algorithm_options
|
654
|
+
# The hash algorithm options that are available for an AWS Signer job.
|
655
|
+
# @return [Types::HashAlgorithmOptions]
|
656
|
+
#
|
657
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/SigningConfiguration AWS API Documentation
|
658
|
+
#
|
659
|
+
class SigningConfiguration < Struct.new(
|
660
|
+
:encryption_algorithm_options,
|
661
|
+
:hash_algorithm_options)
|
662
|
+
include Aws::Structure
|
663
|
+
end
|
664
|
+
|
665
|
+
# A signing configuration that overrides the default encryption or hash
|
666
|
+
# algorithm of a signing job.
|
667
|
+
#
|
668
|
+
# @note When making an API call, you may pass SigningConfigurationOverrides
|
669
|
+
# data as a hash:
|
670
|
+
#
|
671
|
+
# {
|
672
|
+
# encryption_algorithm: "RSA", # accepts RSA, ECDSA
|
673
|
+
# hash_algorithm: "SHA1", # accepts SHA1, SHA256
|
674
|
+
# }
|
675
|
+
#
|
676
|
+
# @!attribute [rw] encryption_algorithm
|
677
|
+
# A specified override of the default encryption algorithm that is
|
678
|
+
# used in an AWS Signer job.
|
679
|
+
# @return [String]
|
680
|
+
#
|
681
|
+
# @!attribute [rw] hash_algorithm
|
682
|
+
# A specified override of the default hash algorithm that is used in
|
683
|
+
# an AWS Signer job.
|
684
|
+
# @return [String]
|
685
|
+
#
|
686
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/SigningConfigurationOverrides AWS API Documentation
|
687
|
+
#
|
688
|
+
class SigningConfigurationOverrides < Struct.new(
|
689
|
+
:encryption_algorithm,
|
690
|
+
:hash_algorithm)
|
691
|
+
include Aws::Structure
|
692
|
+
end
|
693
|
+
|
694
|
+
# The image format of an AWS Signer platform or profile.
|
695
|
+
#
|
696
|
+
# @!attribute [rw] supported_formats
|
697
|
+
# The supported formats of an AWS Signer signing image.
|
698
|
+
# @return [Array<String>]
|
699
|
+
#
|
700
|
+
# @!attribute [rw] default_format
|
701
|
+
# The default format of an AWS Signer signing image.
|
702
|
+
# @return [String]
|
703
|
+
#
|
704
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/SigningImageFormat AWS API Documentation
|
705
|
+
#
|
706
|
+
class SigningImageFormat < Struct.new(
|
707
|
+
:supported_formats,
|
708
|
+
:default_format)
|
709
|
+
include Aws::Structure
|
710
|
+
end
|
711
|
+
|
712
|
+
# Contains information about a signing job.
|
713
|
+
#
|
714
|
+
# @!attribute [rw] job_id
|
715
|
+
# The ID of the signing job.
|
716
|
+
# @return [String]
|
717
|
+
#
|
718
|
+
# @!attribute [rw] source
|
719
|
+
# A `Source` that contains information about a signing job's code
|
720
|
+
# image source.
|
721
|
+
# @return [Types::Source]
|
722
|
+
#
|
723
|
+
# @!attribute [rw] signed_object
|
724
|
+
# A `SignedObject` structure that contains information about a signing
|
725
|
+
# job's signed code image.
|
726
|
+
# @return [Types::SignedObject]
|
727
|
+
#
|
728
|
+
# @!attribute [rw] signing_material
|
729
|
+
# A `SigningMaterial` object that contains the Amazon Resource Name
|
730
|
+
# (ARN) of the certificate used for the signing job.
|
731
|
+
# @return [Types::SigningMaterial]
|
732
|
+
#
|
733
|
+
# @!attribute [rw] created_at
|
734
|
+
# The date and time that the signing job was created.
|
735
|
+
# @return [Time]
|
736
|
+
#
|
737
|
+
# @!attribute [rw] status
|
738
|
+
# The status of the signing job.
|
739
|
+
# @return [String]
|
740
|
+
#
|
741
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/SigningJob AWS API Documentation
|
742
|
+
#
|
743
|
+
class SigningJob < Struct.new(
|
744
|
+
:job_id,
|
745
|
+
:source,
|
746
|
+
:signed_object,
|
747
|
+
:signing_material,
|
748
|
+
:created_at,
|
749
|
+
:status)
|
750
|
+
include Aws::Structure
|
751
|
+
end
|
752
|
+
|
753
|
+
# The ACM certificate that is used to sign your code.
|
754
|
+
#
|
755
|
+
# @note When making an API call, you may pass SigningMaterial
|
756
|
+
# data as a hash:
|
757
|
+
#
|
758
|
+
# {
|
759
|
+
# certificate_arn: "CertificateArn", # required
|
760
|
+
# }
|
761
|
+
#
|
762
|
+
# @!attribute [rw] certificate_arn
|
763
|
+
# The Amazon Resource Name (ARN) of the certificates that is used to
|
764
|
+
# sign your code.
|
765
|
+
# @return [String]
|
766
|
+
#
|
767
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/SigningMaterial AWS API Documentation
|
768
|
+
#
|
769
|
+
class SigningMaterial < Struct.new(
|
770
|
+
:certificate_arn)
|
771
|
+
include Aws::Structure
|
772
|
+
end
|
773
|
+
|
774
|
+
# Contains information about the signing configurations and parameters
|
775
|
+
# that is used to perform an AWS Signer job.
|
776
|
+
#
|
777
|
+
# @!attribute [rw] platform_id
|
778
|
+
# The ID of an AWS Signer platform.
|
779
|
+
# @return [String]
|
780
|
+
#
|
781
|
+
# @!attribute [rw] display_name
|
782
|
+
# The display name of an AWS Signer platform.
|
783
|
+
# @return [String]
|
784
|
+
#
|
785
|
+
# @!attribute [rw] partner
|
786
|
+
# Any partner entities linked to an AWS Signer platform.
|
787
|
+
# @return [String]
|
788
|
+
#
|
789
|
+
# @!attribute [rw] target
|
790
|
+
# The types of targets that can be signed by an AWS Signer platform.
|
791
|
+
# @return [String]
|
792
|
+
#
|
793
|
+
# @!attribute [rw] category
|
794
|
+
# The category of an AWS Signer platform.
|
795
|
+
# @return [String]
|
796
|
+
#
|
797
|
+
# @!attribute [rw] signing_configuration
|
798
|
+
# The configuration of an AWS Signer platform. This includes the
|
799
|
+
# designated hash algorithm and encryption algorithm of a signing
|
800
|
+
# platform.
|
801
|
+
# @return [Types::SigningConfiguration]
|
802
|
+
#
|
803
|
+
# @!attribute [rw] signing_image_format
|
804
|
+
# The signing image format that is used by an AWS Signer platform.
|
805
|
+
# @return [Types::SigningImageFormat]
|
806
|
+
#
|
807
|
+
# @!attribute [rw] max_size_in_mb
|
808
|
+
# The maximum size (in MB) of code that can be signed by a AWS Signer
|
809
|
+
# platform.
|
810
|
+
# @return [Integer]
|
811
|
+
#
|
812
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/SigningPlatform AWS API Documentation
|
813
|
+
#
|
814
|
+
class SigningPlatform < Struct.new(
|
815
|
+
:platform_id,
|
816
|
+
:display_name,
|
817
|
+
:partner,
|
818
|
+
:target,
|
819
|
+
:category,
|
820
|
+
:signing_configuration,
|
821
|
+
:signing_image_format,
|
822
|
+
:max_size_in_mb)
|
823
|
+
include Aws::Structure
|
824
|
+
end
|
825
|
+
|
826
|
+
# Any overrides that are applied to the signing configuration of an AWS
|
827
|
+
# Signer platform.
|
828
|
+
#
|
829
|
+
# @note When making an API call, you may pass SigningPlatformOverrides
|
830
|
+
# data as a hash:
|
831
|
+
#
|
832
|
+
# {
|
833
|
+
# signing_configuration: {
|
834
|
+
# encryption_algorithm: "RSA", # accepts RSA, ECDSA
|
835
|
+
# hash_algorithm: "SHA1", # accepts SHA1, SHA256
|
836
|
+
# },
|
837
|
+
# }
|
838
|
+
#
|
839
|
+
# @!attribute [rw] signing_configuration
|
840
|
+
# A signing configuration that overrides the default encryption or
|
841
|
+
# hash algorithm of a signing job.
|
842
|
+
# @return [Types::SigningConfigurationOverrides]
|
843
|
+
#
|
844
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/SigningPlatformOverrides AWS API Documentation
|
845
|
+
#
|
846
|
+
class SigningPlatformOverrides < Struct.new(
|
847
|
+
:signing_configuration)
|
848
|
+
include Aws::Structure
|
849
|
+
end
|
850
|
+
|
851
|
+
# Contains information about the ACM certificates and AWS Signer
|
852
|
+
# configuration parameters that can be used by a given AWS Signer user.
|
853
|
+
#
|
854
|
+
# @!attribute [rw] profile_name
|
855
|
+
# The name of the AWS Signer profile.
|
856
|
+
# @return [String]
|
857
|
+
#
|
858
|
+
# @!attribute [rw] signing_material
|
859
|
+
# The ACM certificate that is available for use by a signing profile.
|
860
|
+
# @return [Types::SigningMaterial]
|
861
|
+
#
|
862
|
+
# @!attribute [rw] platform_id
|
863
|
+
# The ID of a platform that is available for use by a signing profile.
|
864
|
+
# @return [String]
|
865
|
+
#
|
866
|
+
# @!attribute [rw] signing_parameters
|
867
|
+
# The parameters that are available for use by an AWS Signer user.
|
868
|
+
# @return [Hash<String,String>]
|
869
|
+
#
|
870
|
+
# @!attribute [rw] status
|
871
|
+
# The status of an AWS Signer profile.
|
872
|
+
# @return [String]
|
873
|
+
#
|
874
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/SigningProfile AWS API Documentation
|
875
|
+
#
|
876
|
+
class SigningProfile < Struct.new(
|
877
|
+
:profile_name,
|
878
|
+
:signing_material,
|
879
|
+
:platform_id,
|
880
|
+
:signing_parameters,
|
881
|
+
:status)
|
882
|
+
include Aws::Structure
|
883
|
+
end
|
884
|
+
|
885
|
+
# An `S3Source` object that contains information about the S3 bucket
|
886
|
+
# where you saved your unsigned code.
|
887
|
+
#
|
888
|
+
# @note When making an API call, you may pass Source
|
889
|
+
# data as a hash:
|
890
|
+
#
|
891
|
+
# {
|
892
|
+
# s3: {
|
893
|
+
# bucket_name: "BucketName", # required
|
894
|
+
# key: "Key", # required
|
895
|
+
# version: "Version", # required
|
896
|
+
# },
|
897
|
+
# }
|
898
|
+
#
|
899
|
+
# @!attribute [rw] s3
|
900
|
+
# The `S3Source` object.
|
901
|
+
# @return [Types::S3Source]
|
902
|
+
#
|
903
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/Source AWS API Documentation
|
904
|
+
#
|
905
|
+
class Source < Struct.new(
|
906
|
+
:s3)
|
907
|
+
include Aws::Structure
|
908
|
+
end
|
909
|
+
|
910
|
+
# @note When making an API call, you may pass StartSigningJobRequest
|
911
|
+
# data as a hash:
|
912
|
+
#
|
913
|
+
# {
|
914
|
+
# source: { # required
|
915
|
+
# s3: {
|
916
|
+
# bucket_name: "BucketName", # required
|
917
|
+
# key: "Key", # required
|
918
|
+
# version: "Version", # required
|
919
|
+
# },
|
920
|
+
# },
|
921
|
+
# destination: { # required
|
922
|
+
# s3: {
|
923
|
+
# bucket_name: "BucketName",
|
924
|
+
# prefix: "Prefix",
|
925
|
+
# },
|
926
|
+
# },
|
927
|
+
# profile_name: "ProfileName",
|
928
|
+
# client_request_token: "ClientRequestToken", # required
|
929
|
+
# }
|
930
|
+
#
|
931
|
+
# @!attribute [rw] source
|
932
|
+
# The S3 bucket that contains the object to sign or a BLOB that
|
933
|
+
# contains your raw code.
|
934
|
+
# @return [Types::Source]
|
935
|
+
#
|
936
|
+
# @!attribute [rw] destination
|
937
|
+
# The S3 bucket in which to save your signed object. The destination
|
938
|
+
# contains the name of your bucket and an optional prefix.
|
939
|
+
# @return [Types::Destination]
|
940
|
+
#
|
941
|
+
# @!attribute [rw] profile_name
|
942
|
+
# The name of the signing profile.
|
943
|
+
# @return [String]
|
944
|
+
#
|
945
|
+
# @!attribute [rw] client_request_token
|
946
|
+
# String that identifies the signing request. All calls after the
|
947
|
+
# first that use this token return the same response as the first
|
948
|
+
# call.
|
949
|
+
#
|
950
|
+
# **A suitable default value is auto-generated.** You should normally
|
951
|
+
# not need to pass this option.
|
952
|
+
# @return [String]
|
953
|
+
#
|
954
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/StartSigningJobRequest AWS API Documentation
|
955
|
+
#
|
956
|
+
class StartSigningJobRequest < Struct.new(
|
957
|
+
:source,
|
958
|
+
:destination,
|
959
|
+
:profile_name,
|
960
|
+
:client_request_token)
|
961
|
+
include Aws::Structure
|
962
|
+
end
|
963
|
+
|
964
|
+
# @!attribute [rw] job_id
|
965
|
+
# The ID of your signing job.
|
966
|
+
# @return [String]
|
967
|
+
#
|
968
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/signer-2017-08-25/StartSigningJobResponse AWS API Documentation
|
969
|
+
#
|
970
|
+
class StartSigningJobResponse < Struct.new(
|
971
|
+
:job_id)
|
972
|
+
include Aws::Structure
|
973
|
+
end
|
974
|
+
|
975
|
+
end
|
976
|
+
end
|