@aws-sdk/client-signer 3.379.1 → 3.385.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.
@@ -18,27 +18,33 @@ export declare class AccessDeniedException extends __BaseException {
18
18
  */
19
19
  export interface AddProfilePermissionRequest {
20
20
  /**
21
+ * @public
21
22
  * <p>The human-readable name of the signing profile.</p>
22
23
  */
23
24
  profileName: string | undefined;
24
25
  /**
26
+ * @public
25
27
  * <p>The version of the signing profile.</p>
26
28
  */
27
29
  profileVersion?: string;
28
30
  /**
31
+ * @public
29
32
  * <p>The AWS Signer action permitted as part of cross-account permissions.</p>
30
33
  */
31
34
  action: string | undefined;
32
35
  /**
36
+ * @public
33
37
  * <p>The AWS principal receiving cross-account permissions. This may be an IAM role or
34
38
  * another AWS account ID.</p>
35
39
  */
36
40
  principal: string | undefined;
37
41
  /**
42
+ * @public
38
43
  * <p>A unique identifier for the current profile revision.</p>
39
44
  */
40
45
  revisionId?: string;
41
46
  /**
47
+ * @public
42
48
  * <p>A unique identifier for the cross-account permission statement.</p>
43
49
  */
44
50
  statementId: string | undefined;
@@ -48,6 +54,7 @@ export interface AddProfilePermissionRequest {
48
54
  */
49
55
  export interface AddProfilePermissionResponse {
50
56
  /**
57
+ * @public
51
58
  * <p>A unique identifier for the current profile revision.</p>
52
59
  */
53
60
  revisionId?: string;
@@ -150,6 +157,7 @@ export declare class BadRequestException extends __BaseException {
150
157
  */
151
158
  export interface CancelSigningProfileRequest {
152
159
  /**
160
+ * @public
153
161
  * <p>The name of the signing profile to be canceled.</p>
154
162
  */
155
163
  profileName: string | undefined;
@@ -170,6 +178,7 @@ export type Category = (typeof Category)[keyof typeof Category];
170
178
  */
171
179
  export interface DescribeSigningJobRequest {
172
180
  /**
181
+ * @public
173
182
  * <p>The ID of the signing job on input.</p>
174
183
  */
175
184
  jobId: string | undefined;
@@ -205,11 +214,13 @@ export type HashAlgorithm = (typeof HashAlgorithm)[keyof typeof HashAlgorithm];
205
214
  */
206
215
  export interface SigningConfigurationOverrides {
207
216
  /**
217
+ * @public
208
218
  * <p>A specified override of the default encryption algorithm that is used in a code signing
209
219
  * job.</p>
210
220
  */
211
221
  encryptionAlgorithm?: EncryptionAlgorithm | string;
212
222
  /**
223
+ * @public
213
224
  * <p>A specified override of the default hash algorithm that is used in a code signing
214
225
  * job.</p>
215
226
  */
@@ -235,11 +246,13 @@ export type ImageFormat = (typeof ImageFormat)[keyof typeof ImageFormat];
235
246
  */
236
247
  export interface SigningPlatformOverrides {
237
248
  /**
249
+ * @public
238
250
  * <p>A signing configuration that overrides the default encryption or hash algorithm of a
239
251
  * signing job.</p>
240
252
  */
241
253
  signingConfiguration?: SigningConfigurationOverrides;
242
254
  /**
255
+ * @public
243
256
  * <p>A signed image is a JSON object. When overriding the default signing platform
244
257
  * configuration, a customer can select either of two signing formats,
245
258
  * <code>JSONEmbedded</code> or <code>JSONDetached</code>. (A third format value,
@@ -255,14 +268,17 @@ export interface SigningPlatformOverrides {
255
268
  */
256
269
  export interface SigningJobRevocationRecord {
257
270
  /**
271
+ * @public
258
272
  * <p>A caller-supplied reason for revocation.</p>
259
273
  */
260
274
  reason?: string;
261
275
  /**
276
+ * @public
262
277
  * <p>The time of revocation.</p>
263
278
  */
264
279
  revokedAt?: Date;
265
280
  /**
281
+ * @public
266
282
  * <p>The identity of the revoker.</p>
267
283
  */
268
284
  revokedBy?: string;
@@ -273,10 +289,12 @@ export interface SigningJobRevocationRecord {
273
289
  */
274
290
  export interface S3SignedObject {
275
291
  /**
292
+ * @public
276
293
  * <p>Name of the S3 bucket.</p>
277
294
  */
278
295
  bucketName?: string;
279
296
  /**
297
+ * @public
280
298
  * <p>Key name that uniquely identifies a signed code image in your bucket.</p>
281
299
  */
282
300
  key?: string;
@@ -288,6 +306,7 @@ export interface S3SignedObject {
288
306
  */
289
307
  export interface SignedObject {
290
308
  /**
309
+ * @public
291
310
  * <p>The <code>S3SignedObject</code>.</p>
292
311
  */
293
312
  s3?: S3SignedObject;
@@ -298,6 +317,7 @@ export interface SignedObject {
298
317
  */
299
318
  export interface SigningMaterial {
300
319
  /**
320
+ * @public
301
321
  * <p>The Amazon Resource Name (ARN) of the certificates that is used to sign your
302
322
  * code.</p>
303
323
  */
@@ -309,14 +329,17 @@ export interface SigningMaterial {
309
329
  */
310
330
  export interface S3Source {
311
331
  /**
332
+ * @public
312
333
  * <p>Name of the S3 bucket.</p>
313
334
  */
314
335
  bucketName: string | undefined;
315
336
  /**
337
+ * @public
316
338
  * <p>Key name of the bucket object that contains your unsigned code.</p>
317
339
  */
318
340
  key: string | undefined;
319
341
  /**
342
+ * @public
320
343
  * <p>Version of your source image in your version enabled S3 bucket.</p>
321
344
  */
322
345
  version: string | undefined;
@@ -328,6 +351,7 @@ export interface S3Source {
328
351
  */
329
352
  export interface Source {
330
353
  /**
354
+ * @public
331
355
  * <p>The <code>S3Source</code> object.</p>
332
356
  */
333
357
  s3?: S3Source;
@@ -350,81 +374,100 @@ export type SigningStatus = (typeof SigningStatus)[keyof typeof SigningStatus];
350
374
  */
351
375
  export interface DescribeSigningJobResponse {
352
376
  /**
377
+ * @public
353
378
  * <p>The ID of the signing job on output.</p>
354
379
  */
355
380
  jobId?: string;
356
381
  /**
382
+ * @public
357
383
  * <p>The object that contains the name of your S3 bucket or your raw code.</p>
358
384
  */
359
385
  source?: Source;
360
386
  /**
387
+ * @public
361
388
  * <p>The Amazon Resource Name (ARN) of your code signing certificate.</p>
362
389
  */
363
390
  signingMaterial?: SigningMaterial;
364
391
  /**
392
+ * @public
365
393
  * <p>The microcontroller platform to which your signed code image will be
366
394
  * distributed.</p>
367
395
  */
368
396
  platformId?: string;
369
397
  /**
398
+ * @public
370
399
  * <p>A human-readable name for the signing platform associated with the signing job.</p>
371
400
  */
372
401
  platformDisplayName?: string;
373
402
  /**
403
+ * @public
374
404
  * <p>The name of the profile that initiated the signing operation.</p>
375
405
  */
376
406
  profileName?: string;
377
407
  /**
408
+ * @public
378
409
  * <p>The version of the signing profile used to initiate the signing job.</p>
379
410
  */
380
411
  profileVersion?: string;
381
412
  /**
413
+ * @public
382
414
  * <p>A list of any overrides that were applied to the signing operation.</p>
383
415
  */
384
416
  overrides?: SigningPlatformOverrides;
385
417
  /**
418
+ * @public
386
419
  * <p>Map of user-assigned key-value pairs used during signing. These values contain any
387
420
  * information that you specified for use in your signing job. </p>
388
421
  */
389
422
  signingParameters?: Record<string, string>;
390
423
  /**
424
+ * @public
391
425
  * <p>Date and time that the signing job was created.</p>
392
426
  */
393
427
  createdAt?: Date;
394
428
  /**
429
+ * @public
395
430
  * <p>Date and time that the signing job was completed.</p>
396
431
  */
397
432
  completedAt?: Date;
398
433
  /**
434
+ * @public
399
435
  * <p>Thr expiration timestamp for the signature generated by the signing job.</p>
400
436
  */
401
437
  signatureExpiresAt?: Date;
402
438
  /**
439
+ * @public
403
440
  * <p>The IAM principal that requested the signing job.</p>
404
441
  */
405
442
  requestedBy?: string;
406
443
  /**
444
+ * @public
407
445
  * <p>Status of the signing job.</p>
408
446
  */
409
447
  status?: SigningStatus | string;
410
448
  /**
449
+ * @public
411
450
  * <p>String value that contains the status reason.</p>
412
451
  */
413
452
  statusReason?: string;
414
453
  /**
454
+ * @public
415
455
  * <p>A revocation record if the signature generated by the signing job has been revoked.
416
456
  * Contains a timestamp and the ID of the IAM entity that revoked the signature.</p>
417
457
  */
418
458
  revocationRecord?: SigningJobRevocationRecord;
419
459
  /**
460
+ * @public
420
461
  * <p>Name of the S3 bucket where the signed code image is saved by code signing.</p>
421
462
  */
422
463
  signedObject?: SignedObject;
423
464
  /**
465
+ * @public
424
466
  * <p>The AWS account ID of the job owner.</p>
425
467
  */
426
468
  jobOwner?: string;
427
469
  /**
470
+ * @public
428
471
  * <p>The IAM entity that initiated the signing job.</p>
429
472
  */
430
473
  jobInvoker?: string;
@@ -435,10 +478,12 @@ export interface DescribeSigningJobResponse {
435
478
  */
436
479
  export interface S3Destination {
437
480
  /**
481
+ * @public
438
482
  * <p>Name of the S3 bucket.</p>
439
483
  */
440
484
  bucketName?: string;
441
485
  /**
486
+ * @public
442
487
  * <p>An Amazon S3 prefix that you can use to limit responses to those that begin with the
443
488
  * specified prefix.</p>
444
489
  */
@@ -451,6 +496,7 @@ export interface S3Destination {
451
496
  */
452
497
  export interface Destination {
453
498
  /**
499
+ * @public
454
500
  * <p>The <code>S3Destination</code> object.</p>
455
501
  */
456
502
  s3?: S3Destination;
@@ -461,10 +507,12 @@ export interface Destination {
461
507
  */
462
508
  export interface EncryptionAlgorithmOptions {
463
509
  /**
510
+ * @public
464
511
  * <p>The set of accepted encryption algorithms that are allowed in a code signing job.</p>
465
512
  */
466
513
  allowedValues: (EncryptionAlgorithm | string)[] | undefined;
467
514
  /**
515
+ * @public
468
516
  * <p>The default encryption algorithm that is used by a code signing job.</p>
469
517
  */
470
518
  defaultValue: EncryptionAlgorithm | string | undefined;
@@ -474,22 +522,27 @@ export interface EncryptionAlgorithmOptions {
474
522
  */
475
523
  export interface GetRevocationStatusRequest {
476
524
  /**
525
+ * @public
477
526
  * <p>The timestamp of the signature that validates the profile or job.</p>
478
527
  */
479
528
  signatureTimestamp: Date | undefined;
480
529
  /**
530
+ * @public
481
531
  * <p>The ID of a signing platform. </p>
482
532
  */
483
533
  platformId: string | undefined;
484
534
  /**
535
+ * @public
485
536
  * <p>The version of a signing profile.</p>
486
537
  */
487
538
  profileVersionArn: string | undefined;
488
539
  /**
540
+ * @public
489
541
  * <p>The ARN of a signing job.</p>
490
542
  */
491
543
  jobArn: string | undefined;
492
544
  /**
545
+ * @public
493
546
  * <p>A list of composite signed hashes that identify certificates.</p>
494
547
  * <p>A certificate identifier consists of a subject certificate TBS hash (signed by the
495
548
  * parent CA) combined with a parent CA TBS hash (signed by the parent CA’s CA). Root
@@ -502,6 +555,7 @@ export interface GetRevocationStatusRequest {
502
555
  */
503
556
  export interface GetRevocationStatusResponse {
504
557
  /**
558
+ * @public
505
559
  * <p>A list of revoked entities (including one or more of the signing profile ARN, signing
506
560
  * job ID, and certificate hash) supplied as input to the API.</p>
507
561
  */
@@ -512,6 +566,7 @@ export interface GetRevocationStatusResponse {
512
566
  */
513
567
  export interface GetSigningPlatformRequest {
514
568
  /**
569
+ * @public
515
570
  * <p>The ID of the target signing platform.</p>
516
571
  */
517
572
  platformId: string | undefined;
@@ -522,10 +577,12 @@ export interface GetSigningPlatformRequest {
522
577
  */
523
578
  export interface HashAlgorithmOptions {
524
579
  /**
580
+ * @public
525
581
  * <p>The set of accepted hash algorithms allowed in a code signing job.</p>
526
582
  */
527
583
  allowedValues: (HashAlgorithm | string)[] | undefined;
528
584
  /**
585
+ * @public
529
586
  * <p>The default hash algorithm that is used in a code signing job.</p>
530
587
  */
531
588
  defaultValue: HashAlgorithm | string | undefined;
@@ -536,10 +593,12 @@ export interface HashAlgorithmOptions {
536
593
  */
537
594
  export interface SigningConfiguration {
538
595
  /**
596
+ * @public
539
597
  * <p>The encryption algorithm options that are available for a code signing job.</p>
540
598
  */
541
599
  encryptionAlgorithmOptions: EncryptionAlgorithmOptions | undefined;
542
600
  /**
601
+ * @public
543
602
  * <p>The hash algorithm options that are available for a code signing job.</p>
544
603
  */
545
604
  hashAlgorithmOptions: HashAlgorithmOptions | undefined;
@@ -550,10 +609,12 @@ export interface SigningConfiguration {
550
609
  */
551
610
  export interface SigningImageFormat {
552
611
  /**
612
+ * @public
553
613
  * <p>The supported formats of a code signing image.</p>
554
614
  */
555
615
  supportedFormats: (ImageFormat | string)[] | undefined;
556
616
  /**
617
+ * @public
557
618
  * <p>The default format of a code signing image.</p>
558
619
  */
559
620
  defaultFormat: ImageFormat | string | undefined;
@@ -563,39 +624,48 @@ export interface SigningImageFormat {
563
624
  */
564
625
  export interface GetSigningPlatformResponse {
565
626
  /**
627
+ * @public
566
628
  * <p>The ID of the target signing platform.</p>
567
629
  */
568
630
  platformId?: string;
569
631
  /**
632
+ * @public
570
633
  * <p>The display name of the target signing platform.</p>
571
634
  */
572
635
  displayName?: string;
573
636
  /**
637
+ * @public
574
638
  * <p>A list of partner entities that use the target signing platform.</p>
575
639
  */
576
640
  partner?: string;
577
641
  /**
642
+ * @public
578
643
  * <p>The validation template that is used by the target signing platform.</p>
579
644
  */
580
645
  target?: string;
581
646
  /**
647
+ * @public
582
648
  * <p>The category type of the target signing platform.</p>
583
649
  */
584
650
  category?: Category | string;
585
651
  /**
652
+ * @public
586
653
  * <p>A list of configurations applied to the target platform at signing.</p>
587
654
  */
588
655
  signingConfiguration?: SigningConfiguration;
589
656
  /**
657
+ * @public
590
658
  * <p>The format of the target platform's signing image.</p>
591
659
  */
592
660
  signingImageFormat?: SigningImageFormat;
593
661
  /**
662
+ * @public
594
663
  * <p>The maximum size (in MB) of the payload that can be signed by the target
595
664
  * platform.</p>
596
665
  */
597
666
  maxSizeInMB?: number;
598
667
  /**
668
+ * @public
599
669
  * <p>A flag indicating whether signatures generated for the signing platform can be
600
670
  * revoked.</p>
601
671
  */
@@ -606,10 +676,12 @@ export interface GetSigningPlatformResponse {
606
676
  */
607
677
  export interface GetSigningProfileRequest {
608
678
  /**
679
+ * @public
609
680
  * <p>The name of the target signing profile.</p>
610
681
  */
611
682
  profileName: string | undefined;
612
683
  /**
684
+ * @public
613
685
  * <p>The AWS account ID of the profile owner.</p>
614
686
  */
615
687
  profileOwner?: string;
@@ -620,14 +692,17 @@ export interface GetSigningProfileRequest {
620
692
  */
621
693
  export interface SigningProfileRevocationRecord {
622
694
  /**
695
+ * @public
623
696
  * <p>The time when revocation becomes effective.</p>
624
697
  */
625
698
  revocationEffectiveFrom?: Date;
626
699
  /**
700
+ * @public
627
701
  * <p>The time when the signing profile was revoked.</p>
628
702
  */
629
703
  revokedAt?: Date;
630
704
  /**
705
+ * @public
631
706
  * <p>The identity of the revoker.</p>
632
707
  */
633
708
  revokedBy?: string;
@@ -651,10 +726,12 @@ export type ValidityType = (typeof ValidityType)[keyof typeof ValidityType];
651
726
  */
652
727
  export interface SignatureValidityPeriod {
653
728
  /**
729
+ * @public
654
730
  * <p>The numerical value of the time unit for signature validity.</p>
655
731
  */
656
732
  value?: number;
657
733
  /**
734
+ * @public
658
735
  * <p>The time unit for signature validity.</p>
659
736
  */
660
737
  type?: ValidityType | string;
@@ -677,61 +754,75 @@ export type SigningProfileStatus = (typeof SigningProfileStatus)[keyof typeof Si
677
754
  */
678
755
  export interface GetSigningProfileResponse {
679
756
  /**
757
+ * @public
680
758
  * <p>The name of the target signing profile.</p>
681
759
  */
682
760
  profileName?: string;
683
761
  /**
762
+ * @public
684
763
  * <p>The current version of the signing profile.</p>
685
764
  */
686
765
  profileVersion?: string;
687
766
  /**
767
+ * @public
688
768
  * <p>The signing profile ARN, including the profile version.</p>
689
769
  */
690
770
  profileVersionArn?: string;
691
771
  /**
772
+ * @public
692
773
  * <p>Revocation information for a signing profile.</p>
693
774
  */
694
775
  revocationRecord?: SigningProfileRevocationRecord;
695
776
  /**
777
+ * @public
696
778
  * <p>The ARN of the certificate that the target profile uses for signing operations.</p>
697
779
  */
698
780
  signingMaterial?: SigningMaterial;
699
781
  /**
782
+ * @public
700
783
  * <p>The ID of the platform that is used by the target signing profile.</p>
701
784
  */
702
785
  platformId?: string;
703
786
  /**
787
+ * @public
704
788
  * <p>A human-readable name for the signing platform associated with the signing
705
789
  * profile.</p>
706
790
  */
707
791
  platformDisplayName?: string;
708
792
  /**
793
+ * @public
709
794
  * <p>The validity period for a signing job.</p>
710
795
  */
711
796
  signatureValidityPeriod?: SignatureValidityPeriod;
712
797
  /**
798
+ * @public
713
799
  * <p>A list of overrides applied by the target signing profile for signing
714
800
  * operations.</p>
715
801
  */
716
802
  overrides?: SigningPlatformOverrides;
717
803
  /**
804
+ * @public
718
805
  * <p>A map of key-value pairs for signing operations that is attached to the target signing
719
806
  * profile.</p>
720
807
  */
721
808
  signingParameters?: Record<string, string>;
722
809
  /**
810
+ * @public
723
811
  * <p>The status of the target signing profile.</p>
724
812
  */
725
813
  status?: SigningProfileStatus | string;
726
814
  /**
815
+ * @public
727
816
  * <p>Reason for the status of the target signing profile.</p>
728
817
  */
729
818
  statusReason?: string;
730
819
  /**
820
+ * @public
731
821
  * <p>The Amazon Resource Name (ARN) for the signing profile.</p>
732
822
  */
733
823
  arn?: string;
734
824
  /**
825
+ * @public
735
826
  * <p>A list of tags associated with the signing profile.</p>
736
827
  */
737
828
  tags?: Record<string, string>;
@@ -741,10 +832,12 @@ export interface GetSigningProfileResponse {
741
832
  */
742
833
  export interface ListProfilePermissionsRequest {
743
834
  /**
835
+ * @public
744
836
  * <p>Name of the signing profile containing the cross-account permissions.</p>
745
837
  */
746
838
  profileName: string | undefined;
747
839
  /**
840
+ * @public
748
841
  * <p>String for specifying the next set of paginated results.</p>
749
842
  */
750
843
  nextToken?: string;
@@ -755,18 +848,22 @@ export interface ListProfilePermissionsRequest {
755
848
  */
756
849
  export interface Permission {
757
850
  /**
851
+ * @public
758
852
  * <p>An AWS Signer action permitted as part of cross-account permissions.</p>
759
853
  */
760
854
  action?: string;
761
855
  /**
856
+ * @public
762
857
  * <p>The AWS principal that has been granted a cross-account permission.</p>
763
858
  */
764
859
  principal?: string;
765
860
  /**
861
+ * @public
766
862
  * <p>A unique identifier for a cross-account permission statement.</p>
767
863
  */
768
864
  statementId?: string;
769
865
  /**
866
+ * @public
770
867
  * <p>The signing profile version that a permission applies to.</p>
771
868
  */
772
869
  profileVersion?: string;
@@ -776,18 +873,22 @@ export interface Permission {
776
873
  */
777
874
  export interface ListProfilePermissionsResponse {
778
875
  /**
876
+ * @public
779
877
  * <p>The identifier for the current revision of profile permissions.</p>
780
878
  */
781
879
  revisionId?: string;
782
880
  /**
881
+ * @public
783
882
  * <p>Total size of the policy associated with the Signing Profile in bytes.</p>
784
883
  */
785
884
  policySizeBytes?: number;
786
885
  /**
886
+ * @public
787
887
  * <p>List of permissions associated with the Signing Profile.</p>
788
888
  */
789
889
  permissions?: Permission[];
790
890
  /**
891
+ * @public
791
892
  * <p>String for specifying the next set of paginated results.</p>
792
893
  */
793
894
  nextToken?: string;
@@ -797,19 +898,23 @@ export interface ListProfilePermissionsResponse {
797
898
  */
798
899
  export interface ListSigningJobsRequest {
799
900
  /**
901
+ * @public
800
902
  * <p>A status value with which to filter your results.</p>
801
903
  */
802
904
  status?: SigningStatus | string;
803
905
  /**
906
+ * @public
804
907
  * <p>The ID of microcontroller platform that you specified for the distribution of your
805
908
  * code image.</p>
806
909
  */
807
910
  platformId?: string;
808
911
  /**
912
+ * @public
809
913
  * <p>The IAM principal that requested the signing job.</p>
810
914
  */
811
915
  requestedBy?: string;
812
916
  /**
917
+ * @public
813
918
  * <p>Specifies the maximum number of items to return in the response. Use this parameter
814
919
  * when paginating results. If additional items exist beyond the number you specify, the
815
920
  * <code>nextToken</code> element is set in the response. Use the
@@ -818,26 +923,31 @@ export interface ListSigningJobsRequest {
818
923
  */
819
924
  maxResults?: number;
820
925
  /**
926
+ * @public
821
927
  * <p>String for specifying the next set of paginated results to return. After you receive a
822
928
  * response with truncated results, use this parameter in a subsequent request. Set it to
823
929
  * the value of <code>nextToken</code> from the response that you just received.</p>
824
930
  */
825
931
  nextToken?: string;
826
932
  /**
933
+ * @public
827
934
  * <p>Filters results to return only signing jobs with revoked signatures.</p>
828
935
  */
829
936
  isRevoked?: boolean;
830
937
  /**
938
+ * @public
831
939
  * <p>Filters results to return only signing jobs with signatures expiring before a
832
940
  * specified timestamp.</p>
833
941
  */
834
942
  signatureExpiresBefore?: Date;
835
943
  /**
944
+ * @public
836
945
  * <p>Filters results to return only signing jobs with signatures expiring after a specified
837
946
  * timestamp.</p>
838
947
  */
839
948
  signatureExpiresAfter?: Date;
840
949
  /**
950
+ * @public
841
951
  * <p>Filters results to return only signing jobs initiated by a specified IAM
842
952
  * entity.</p>
843
953
  */
@@ -849,61 +959,75 @@ export interface ListSigningJobsRequest {
849
959
  */
850
960
  export interface SigningJob {
851
961
  /**
962
+ * @public
852
963
  * <p>The ID of the signing job.</p>
853
964
  */
854
965
  jobId?: string;
855
966
  /**
967
+ * @public
856
968
  * <p>A <code>Source</code> that contains information about a signing job's code image
857
969
  * source.</p>
858
970
  */
859
971
  source?: Source;
860
972
  /**
973
+ * @public
861
974
  * <p>A <code>SignedObject</code> structure that contains information about a signing job's
862
975
  * signed code image.</p>
863
976
  */
864
977
  signedObject?: SignedObject;
865
978
  /**
979
+ * @public
866
980
  * <p>A <code>SigningMaterial</code> object that contains the Amazon Resource Name (ARN) of
867
981
  * the certificate used for the signing job.</p>
868
982
  */
869
983
  signingMaterial?: SigningMaterial;
870
984
  /**
985
+ * @public
871
986
  * <p>The date and time that the signing job was created.</p>
872
987
  */
873
988
  createdAt?: Date;
874
989
  /**
990
+ * @public
875
991
  * <p>The status of the signing job.</p>
876
992
  */
877
993
  status?: SigningStatus | string;
878
994
  /**
995
+ * @public
879
996
  * <p>Indicates whether the signing job is revoked.</p>
880
997
  */
881
998
  isRevoked?: boolean;
882
999
  /**
1000
+ * @public
883
1001
  * <p>The name of the signing profile that created a signing job.</p>
884
1002
  */
885
1003
  profileName?: string;
886
1004
  /**
1005
+ * @public
887
1006
  * <p>The version of the signing profile that created a signing job.</p>
888
1007
  */
889
1008
  profileVersion?: string;
890
1009
  /**
1010
+ * @public
891
1011
  * <p>The unique identifier for a signing platform.</p>
892
1012
  */
893
1013
  platformId?: string;
894
1014
  /**
1015
+ * @public
895
1016
  * <p>The name of a signing platform.</p>
896
1017
  */
897
1018
  platformDisplayName?: string;
898
1019
  /**
1020
+ * @public
899
1021
  * <p>The time when the signature of a signing job expires.</p>
900
1022
  */
901
1023
  signatureExpiresAt?: Date;
902
1024
  /**
1025
+ * @public
903
1026
  * <p>The AWS account ID of the job owner.</p>
904
1027
  */
905
1028
  jobOwner?: string;
906
1029
  /**
1030
+ * @public
907
1031
  * <p>The AWS account ID of the job invoker.</p>
908
1032
  */
909
1033
  jobInvoker?: string;
@@ -913,10 +1037,12 @@ export interface SigningJob {
913
1037
  */
914
1038
  export interface ListSigningJobsResponse {
915
1039
  /**
1040
+ * @public
916
1041
  * <p>A list of your signing jobs.</p>
917
1042
  */
918
1043
  jobs?: SigningJob[];
919
1044
  /**
1045
+ * @public
920
1046
  * <p>String for specifying the next set of paginated results.</p>
921
1047
  */
922
1048
  nextToken?: string;
@@ -926,22 +1052,27 @@ export interface ListSigningJobsResponse {
926
1052
  */
927
1053
  export interface ListSigningPlatformsRequest {
928
1054
  /**
1055
+ * @public
929
1056
  * <p>The category type of a signing platform.</p>
930
1057
  */
931
1058
  category?: string;
932
1059
  /**
1060
+ * @public
933
1061
  * <p>Any partner entities connected to a signing platform.</p>
934
1062
  */
935
1063
  partner?: string;
936
1064
  /**
1065
+ * @public
937
1066
  * <p>The validation template that is used by the target signing platform.</p>
938
1067
  */
939
1068
  target?: string;
940
1069
  /**
1070
+ * @public
941
1071
  * <p>The maximum number of results to be returned by this operation.</p>
942
1072
  */
943
1073
  maxResults?: number;
944
1074
  /**
1075
+ * @public
945
1076
  * <p>Value for specifying the next set of paginated results to return. After you receive a
946
1077
  * response with truncated results, use this parameter in a subsequent request. Set it to
947
1078
  * the value of <code>nextToken</code> from the response that you just received.</p>
@@ -955,39 +1086,48 @@ export interface ListSigningPlatformsRequest {
955
1086
  */
956
1087
  export interface SigningPlatform {
957
1088
  /**
1089
+ * @public
958
1090
  * <p>The ID of a code signing platform.</p>
959
1091
  */
960
1092
  platformId?: string;
961
1093
  /**
1094
+ * @public
962
1095
  * <p>The display name of a code signing platform.</p>
963
1096
  */
964
1097
  displayName?: string;
965
1098
  /**
1099
+ * @public
966
1100
  * <p>Any partner entities linked to a code signing platform.</p>
967
1101
  */
968
1102
  partner?: string;
969
1103
  /**
1104
+ * @public
970
1105
  * <p>The types of targets that can be signed by a code signing platform.</p>
971
1106
  */
972
1107
  target?: string;
973
1108
  /**
1109
+ * @public
974
1110
  * <p>The category of a code signing platform.</p>
975
1111
  */
976
1112
  category?: Category | string;
977
1113
  /**
1114
+ * @public
978
1115
  * <p>The configuration of a code signing platform. This includes the designated hash algorithm
979
1116
  * and encryption algorithm of a signing platform.</p>
980
1117
  */
981
1118
  signingConfiguration?: SigningConfiguration;
982
1119
  /**
1120
+ * @public
983
1121
  * <p>The image format of a code signing platform or profile.</p>
984
1122
  */
985
1123
  signingImageFormat?: SigningImageFormat;
986
1124
  /**
1125
+ * @public
987
1126
  * <p>The maximum size (in MB) of code that can be signed by a code signing platform.</p>
988
1127
  */
989
1128
  maxSizeInMB?: number;
990
1129
  /**
1130
+ * @public
991
1131
  * <p>Indicates whether revocation is supported for the platform.</p>
992
1132
  */
993
1133
  revocationSupported?: boolean;
@@ -997,10 +1137,12 @@ export interface SigningPlatform {
997
1137
  */
998
1138
  export interface ListSigningPlatformsResponse {
999
1139
  /**
1140
+ * @public
1000
1141
  * <p>A list of all platforms that match the request parameters.</p>
1001
1142
  */
1002
1143
  platforms?: SigningPlatform[];
1003
1144
  /**
1145
+ * @public
1004
1146
  * <p>Value for specifying the next set of paginated results to return.</p>
1005
1147
  */
1006
1148
  nextToken?: string;
@@ -1010,26 +1152,31 @@ export interface ListSigningPlatformsResponse {
1010
1152
  */
1011
1153
  export interface ListSigningProfilesRequest {
1012
1154
  /**
1155
+ * @public
1013
1156
  * <p>Designates whether to include profiles with the status of
1014
1157
  * <code>CANCELED</code>.</p>
1015
1158
  */
1016
1159
  includeCanceled?: boolean;
1017
1160
  /**
1161
+ * @public
1018
1162
  * <p>The maximum number of profiles to be returned.</p>
1019
1163
  */
1020
1164
  maxResults?: number;
1021
1165
  /**
1166
+ * @public
1022
1167
  * <p>Value for specifying the next set of paginated results to return. After you receive a
1023
1168
  * response with truncated results, use this parameter in a subsequent request. Set it to
1024
1169
  * the value of <code>nextToken</code> from the response that you just received.</p>
1025
1170
  */
1026
1171
  nextToken?: string;
1027
1172
  /**
1173
+ * @public
1028
1174
  * <p>Filters results to return only signing jobs initiated for a specified signing
1029
1175
  * platform.</p>
1030
1176
  */
1031
1177
  platformId?: string;
1032
1178
  /**
1179
+ * @public
1033
1180
  * <p>Filters results to return only signing jobs with statuses in the specified
1034
1181
  * list.</p>
1035
1182
  */
@@ -1042,46 +1189,57 @@ export interface ListSigningProfilesRequest {
1042
1189
  */
1043
1190
  export interface SigningProfile {
1044
1191
  /**
1192
+ * @public
1045
1193
  * <p>The name of the signing profile.</p>
1046
1194
  */
1047
1195
  profileName?: string;
1048
1196
  /**
1197
+ * @public
1049
1198
  * <p>The version of a signing profile.</p>
1050
1199
  */
1051
1200
  profileVersion?: string;
1052
1201
  /**
1202
+ * @public
1053
1203
  * <p>The ARN of a signing profile, including the profile version.</p>
1054
1204
  */
1055
1205
  profileVersionArn?: string;
1056
1206
  /**
1207
+ * @public
1057
1208
  * <p>The ACM certificate that is available for use by a signing profile.</p>
1058
1209
  */
1059
1210
  signingMaterial?: SigningMaterial;
1060
1211
  /**
1212
+ * @public
1061
1213
  * <p>The validity period for a signing job created using this signing profile.</p>
1062
1214
  */
1063
1215
  signatureValidityPeriod?: SignatureValidityPeriod;
1064
1216
  /**
1217
+ * @public
1065
1218
  * <p>The ID of a platform that is available for use by a signing profile.</p>
1066
1219
  */
1067
1220
  platformId?: string;
1068
1221
  /**
1222
+ * @public
1069
1223
  * <p>The name of the signing platform.</p>
1070
1224
  */
1071
1225
  platformDisplayName?: string;
1072
1226
  /**
1227
+ * @public
1073
1228
  * <p>The parameters that are available for use by a code signing user.</p>
1074
1229
  */
1075
1230
  signingParameters?: Record<string, string>;
1076
1231
  /**
1232
+ * @public
1077
1233
  * <p>The status of a code signing profile.</p>
1078
1234
  */
1079
1235
  status?: SigningProfileStatus | string;
1080
1236
  /**
1237
+ * @public
1081
1238
  * <p>The Amazon Resource Name (ARN) for the signing profile.</p>
1082
1239
  */
1083
1240
  arn?: string;
1084
1241
  /**
1242
+ * @public
1085
1243
  * <p>A list of tags associated with the signing profile.</p>
1086
1244
  */
1087
1245
  tags?: Record<string, string>;
@@ -1091,12 +1249,14 @@ export interface SigningProfile {
1091
1249
  */
1092
1250
  export interface ListSigningProfilesResponse {
1093
1251
  /**
1252
+ * @public
1094
1253
  * <p>A list of profiles that are available in the AWS account. This includes profiles with
1095
1254
  * the status of <code>CANCELED</code> if the <code>includeCanceled</code> parameter is set
1096
1255
  * to <code>true</code>.</p>
1097
1256
  */
1098
1257
  profiles?: SigningProfile[];
1099
1258
  /**
1259
+ * @public
1100
1260
  * <p>Value for specifying the next set of paginated results to return.</p>
1101
1261
  */
1102
1262
  nextToken?: string;
@@ -1106,6 +1266,7 @@ export interface ListSigningProfilesResponse {
1106
1266
  */
1107
1267
  export interface ListTagsForResourceRequest {
1108
1268
  /**
1269
+ * @public
1109
1270
  * <p>The Amazon Resource Name (ARN) for the signing profile.</p>
1110
1271
  */
1111
1272
  resourceArn: string | undefined;
@@ -1115,6 +1276,7 @@ export interface ListTagsForResourceRequest {
1115
1276
  */
1116
1277
  export interface ListTagsForResourceResponse {
1117
1278
  /**
1279
+ * @public
1118
1280
  * <p>A list of tags associated with the signing profile.</p>
1119
1281
  */
1120
1282
  tags?: Record<string, string>;
@@ -1137,35 +1299,42 @@ export declare class NotFoundException extends __BaseException {
1137
1299
  */
1138
1300
  export interface PutSigningProfileRequest {
1139
1301
  /**
1302
+ * @public
1140
1303
  * <p>The name of the signing profile to be created.</p>
1141
1304
  */
1142
1305
  profileName: string | undefined;
1143
1306
  /**
1307
+ * @public
1144
1308
  * <p>The AWS Certificate Manager certificate that will be used to sign code with the new signing
1145
1309
  * profile.</p>
1146
1310
  */
1147
1311
  signingMaterial?: SigningMaterial;
1148
1312
  /**
1313
+ * @public
1149
1314
  * <p>The default validity period override for any signature generated using this signing
1150
1315
  * profile. If unspecified, the default is 135 months.</p>
1151
1316
  */
1152
1317
  signatureValidityPeriod?: SignatureValidityPeriod;
1153
1318
  /**
1319
+ * @public
1154
1320
  * <p>The ID of the signing platform to be created.</p>
1155
1321
  */
1156
1322
  platformId: string | undefined;
1157
1323
  /**
1324
+ * @public
1158
1325
  * <p>A subfield of <code>platform</code>. This specifies any different configuration
1159
1326
  * options that you want to apply to the chosen platform (such as a different
1160
1327
  * <code>hash-algorithm</code> or <code>signing-algorithm</code>).</p>
1161
1328
  */
1162
1329
  overrides?: SigningPlatformOverrides;
1163
1330
  /**
1331
+ * @public
1164
1332
  * <p>Map of key-value pairs for signing. These can include any information that you want to
1165
1333
  * use during signing.</p>
1166
1334
  */
1167
1335
  signingParameters?: Record<string, string>;
1168
1336
  /**
1337
+ * @public
1169
1338
  * <p>Tags to be associated with the signing profile that is being created.</p>
1170
1339
  */
1171
1340
  tags?: Record<string, string>;
@@ -1175,14 +1344,17 @@ export interface PutSigningProfileRequest {
1175
1344
  */
1176
1345
  export interface PutSigningProfileResponse {
1177
1346
  /**
1347
+ * @public
1178
1348
  * <p>The Amazon Resource Name (ARN) of the signing profile created.</p>
1179
1349
  */
1180
1350
  arn?: string;
1181
1351
  /**
1352
+ * @public
1182
1353
  * <p>The version of the signing profile being created.</p>
1183
1354
  */
1184
1355
  profileVersion?: string;
1185
1356
  /**
1357
+ * @public
1186
1358
  * <p>The signing profile ARN, including the profile version.</p>
1187
1359
  */
1188
1360
  profileVersionArn?: string;
@@ -1192,14 +1364,17 @@ export interface PutSigningProfileResponse {
1192
1364
  */
1193
1365
  export interface RemoveProfilePermissionRequest {
1194
1366
  /**
1367
+ * @public
1195
1368
  * <p>A human-readable name for the signing profile with permissions to be removed.</p>
1196
1369
  */
1197
1370
  profileName: string | undefined;
1198
1371
  /**
1372
+ * @public
1199
1373
  * <p>An identifier for the current revision of the signing profile permissions.</p>
1200
1374
  */
1201
1375
  revisionId: string | undefined;
1202
1376
  /**
1377
+ * @public
1203
1378
  * <p>A unique identifier for the cross-account permissions statement.</p>
1204
1379
  */
1205
1380
  statementId: string | undefined;
@@ -1209,6 +1384,7 @@ export interface RemoveProfilePermissionRequest {
1209
1384
  */
1210
1385
  export interface RemoveProfilePermissionResponse {
1211
1386
  /**
1387
+ * @public
1212
1388
  * <p>An identifier for the current revision of the profile permissions.</p>
1213
1389
  */
1214
1390
  revisionId?: string;
@@ -1218,14 +1394,17 @@ export interface RemoveProfilePermissionResponse {
1218
1394
  */
1219
1395
  export interface RevokeSignatureRequest {
1220
1396
  /**
1397
+ * @public
1221
1398
  * <p>ID of the signing job to be revoked.</p>
1222
1399
  */
1223
1400
  jobId: string | undefined;
1224
1401
  /**
1402
+ * @public
1225
1403
  * <p>AWS account ID of the job owner.</p>
1226
1404
  */
1227
1405
  jobOwner?: string;
1228
1406
  /**
1407
+ * @public
1229
1408
  * <p>The reason for revoking the signing job.</p>
1230
1409
  */
1231
1410
  reason: string | undefined;
@@ -1235,18 +1414,22 @@ export interface RevokeSignatureRequest {
1235
1414
  */
1236
1415
  export interface RevokeSigningProfileRequest {
1237
1416
  /**
1417
+ * @public
1238
1418
  * <p>The name of the signing profile to be revoked.</p>
1239
1419
  */
1240
1420
  profileName: string | undefined;
1241
1421
  /**
1422
+ * @public
1242
1423
  * <p>The version of the signing profile to be revoked.</p>
1243
1424
  */
1244
1425
  profileVersion: string | undefined;
1245
1426
  /**
1427
+ * @public
1246
1428
  * <p>The reason for revoking a signing profile.</p>
1247
1429
  */
1248
1430
  reason: string | undefined;
1249
1431
  /**
1432
+ * @public
1250
1433
  * <p>A timestamp for when revocation of a Signing Profile should become effective.
1251
1434
  * Signatures generated using the signing profile after this timestamp are not
1252
1435
  * trusted.</p>
@@ -1258,18 +1441,22 @@ export interface RevokeSigningProfileRequest {
1258
1441
  */
1259
1442
  export interface SignPayloadRequest {
1260
1443
  /**
1444
+ * @public
1261
1445
  * <p>The name of the signing profile.</p>
1262
1446
  */
1263
1447
  profileName: string | undefined;
1264
1448
  /**
1449
+ * @public
1265
1450
  * <p>The AWS account ID of the profile owner.</p>
1266
1451
  */
1267
1452
  profileOwner?: string;
1268
1453
  /**
1454
+ * @public
1269
1455
  * <p>Specifies the object digest (hash) to sign.</p>
1270
1456
  */
1271
1457
  payload: Uint8Array | undefined;
1272
1458
  /**
1459
+ * @public
1273
1460
  * <p>Payload content type</p>
1274
1461
  */
1275
1462
  payloadFormat: string | undefined;
@@ -1279,20 +1466,24 @@ export interface SignPayloadRequest {
1279
1466
  */
1280
1467
  export interface SignPayloadResponse {
1281
1468
  /**
1469
+ * @public
1282
1470
  * <p>Unique identifier of the signing job.</p>
1283
1471
  */
1284
1472
  jobId?: string;
1285
1473
  /**
1474
+ * @public
1286
1475
  * <p>The AWS account ID of the job owner.</p>
1287
1476
  */
1288
1477
  jobOwner?: string;
1289
1478
  /**
1479
+ * @public
1290
1480
  * <p>Information including the signing profile ARN and the signing job ID. Clients use
1291
1481
  * metadata to signature records, for example, as annotations added to the signature
1292
1482
  * manifest inside an OCI registry.</p>
1293
1483
  */
1294
1484
  metadata?: Record<string, string>;
1295
1485
  /**
1486
+ * @public
1296
1487
  * <p>A cryptographic signature.</p>
1297
1488
  */
1298
1489
  signature?: Uint8Array;
@@ -1302,25 +1493,30 @@ export interface SignPayloadResponse {
1302
1493
  */
1303
1494
  export interface StartSigningJobRequest {
1304
1495
  /**
1496
+ * @public
1305
1497
  * <p>The S3 bucket that contains the object to sign or a BLOB that contains your raw
1306
1498
  * code.</p>
1307
1499
  */
1308
1500
  source: Source | undefined;
1309
1501
  /**
1502
+ * @public
1310
1503
  * <p>The S3 bucket in which to save your signed object. The destination contains the name
1311
1504
  * of your bucket and an optional prefix.</p>
1312
1505
  */
1313
1506
  destination: Destination | undefined;
1314
1507
  /**
1508
+ * @public
1315
1509
  * <p>The name of the signing profile.</p>
1316
1510
  */
1317
1511
  profileName: string | undefined;
1318
1512
  /**
1513
+ * @public
1319
1514
  * <p>String that identifies the signing request. All calls after the first that use this
1320
1515
  * token return the same response as the first call.</p>
1321
1516
  */
1322
1517
  clientRequestToken?: string;
1323
1518
  /**
1519
+ * @public
1324
1520
  * <p>The AWS account ID of the signing profile owner.</p>
1325
1521
  */
1326
1522
  profileOwner?: string;
@@ -1330,10 +1526,12 @@ export interface StartSigningJobRequest {
1330
1526
  */
1331
1527
  export interface StartSigningJobResponse {
1332
1528
  /**
1529
+ * @public
1333
1530
  * <p>The ID of your signing job.</p>
1334
1531
  */
1335
1532
  jobId?: string;
1336
1533
  /**
1534
+ * @public
1337
1535
  * <p>The AWS account ID of the signing job owner.</p>
1338
1536
  */
1339
1537
  jobOwner?: string;
@@ -1359,10 +1557,12 @@ export declare class ThrottlingException extends __BaseException {
1359
1557
  */
1360
1558
  export interface TagResourceRequest {
1361
1559
  /**
1560
+ * @public
1362
1561
  * <p>The Amazon Resource Name (ARN) for the signing profile.</p>
1363
1562
  */
1364
1563
  resourceArn: string | undefined;
1365
1564
  /**
1565
+ * @public
1366
1566
  * <p>One or more tags to be associated with the signing profile.</p>
1367
1567
  */
1368
1568
  tags: Record<string, string> | undefined;
@@ -1377,10 +1577,12 @@ export interface TagResourceResponse {
1377
1577
  */
1378
1578
  export interface UntagResourceRequest {
1379
1579
  /**
1580
+ * @public
1380
1581
  * <p>The Amazon Resource Name (ARN) for the signing profile.</p>
1381
1582
  */
1382
1583
  resourceArn: string | undefined;
1383
1584
  /**
1585
+ * @public
1384
1586
  * <p>A list of tag keys to be removed from the signing profile.</p>
1385
1587
  */
1386
1588
  tagKeys: string[] | undefined;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-signer",
3
3
  "description": "AWS SDK for JavaScript Signer Client for Node.js, Browser and React Native",
4
- "version": "3.379.1",
4
+ "version": "3.385.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.379.1",
25
- "@aws-sdk/credential-provider-node": "3.379.1",
24
+ "@aws-sdk/client-sts": "3.385.0",
25
+ "@aws-sdk/credential-provider-node": "3.385.0",
26
26
  "@aws-sdk/middleware-host-header": "3.379.1",
27
27
  "@aws-sdk/middleware-logger": "3.378.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.378.0",
29
29
  "@aws-sdk/middleware-signing": "3.379.1",
30
- "@aws-sdk/middleware-user-agent": "3.379.1",
30
+ "@aws-sdk/middleware-user-agent": "3.382.0",
31
31
  "@aws-sdk/types": "3.378.0",
32
- "@aws-sdk/util-endpoints": "3.378.0",
32
+ "@aws-sdk/util-endpoints": "3.382.0",
33
33
  "@aws-sdk/util-user-agent-browser": "3.378.0",
34
34
  "@aws-sdk/util-user-agent-node": "3.378.0",
35
35
  "@smithy/config-resolver": "^2.0.1",