@aws-sdk/client-ecr 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.
@@ -5,15 +5,18 @@ import { ECRServiceException as __BaseException } from "./ECRServiceException";
5
5
  */
6
6
  export interface BatchCheckLayerAvailabilityRequest {
7
7
  /**
8
+ * @public
8
9
  * <p>The Amazon Web Services account ID associated with the registry that contains the image layers to
9
10
  * check. If you do not specify a registry, the default registry is assumed.</p>
10
11
  */
11
12
  registryId?: string;
12
13
  /**
14
+ * @public
13
15
  * <p>The name of the repository that is associated with the image layers to check.</p>
14
16
  */
15
17
  repositoryName: string | undefined;
16
18
  /**
19
+ * @public
17
20
  * <p>The digests of the image layers to check.</p>
18
21
  */
19
22
  layerDigests: string[] | undefined;
@@ -36,14 +39,17 @@ export type LayerFailureCode = (typeof LayerFailureCode)[keyof typeof LayerFailu
36
39
  */
37
40
  export interface LayerFailure {
38
41
  /**
42
+ * @public
39
43
  * <p>The layer digest associated with the failure.</p>
40
44
  */
41
45
  layerDigest?: string;
42
46
  /**
47
+ * @public
43
48
  * <p>The failure code associated with the failure.</p>
44
49
  */
45
50
  failureCode?: LayerFailureCode | string;
46
51
  /**
52
+ * @public
47
53
  * <p>The reason for the failure.</p>
48
54
  */
49
55
  failureReason?: string;
@@ -66,18 +72,22 @@ export type LayerAvailability = (typeof LayerAvailability)[keyof typeof LayerAva
66
72
  */
67
73
  export interface Layer {
68
74
  /**
75
+ * @public
69
76
  * <p>The <code>sha256</code> digest of the image layer.</p>
70
77
  */
71
78
  layerDigest?: string;
72
79
  /**
80
+ * @public
73
81
  * <p>The availability status of the image layer.</p>
74
82
  */
75
83
  layerAvailability?: LayerAvailability | string;
76
84
  /**
85
+ * @public
77
86
  * <p>The size, in bytes, of the image layer.</p>
78
87
  */
79
88
  layerSize?: number;
80
89
  /**
90
+ * @public
81
91
  * <p>The media type of the layer, such as
82
92
  * <code>application/vnd.docker.image.rootfs.diff.tar.gzip</code> or
83
93
  * <code>application/vnd.oci.image.layer.v1.tar+gzip</code>.</p>
@@ -89,11 +99,13 @@ export interface Layer {
89
99
  */
90
100
  export interface BatchCheckLayerAvailabilityResponse {
91
101
  /**
102
+ * @public
92
103
  * <p>A list of image layer objects corresponding to the image layer references in the
93
104
  * request.</p>
94
105
  */
95
106
  layers?: Layer[];
96
107
  /**
108
+ * @public
97
109
  * <p>Any failures associated with the call.</p>
98
110
  */
99
111
  failures?: LayerFailure[];
@@ -142,10 +154,12 @@ export declare class ServerException extends __BaseException {
142
154
  */
143
155
  export interface ImageIdentifier {
144
156
  /**
157
+ * @public
145
158
  * <p>The <code>sha256</code> digest of the image manifest.</p>
146
159
  */
147
160
  imageDigest?: string;
148
161
  /**
162
+ * @public
149
163
  * <p>The tag used for the image.</p>
150
164
  */
151
165
  imageTag?: string;
@@ -157,15 +171,18 @@ export interface ImageIdentifier {
157
171
  */
158
172
  export interface BatchDeleteImageRequest {
159
173
  /**
174
+ * @public
160
175
  * <p>The Amazon Web Services account ID associated with the registry that contains the image to delete.
161
176
  * If you do not specify a registry, the default registry is assumed.</p>
162
177
  */
163
178
  registryId?: string;
164
179
  /**
180
+ * @public
165
181
  * <p>The repository that contains the image to delete.</p>
166
182
  */
167
183
  repositoryName: string | undefined;
168
184
  /**
185
+ * @public
169
186
  * <p>A list of image ID references that correspond to images to delete. The format of the
170
187
  * <code>imageIds</code> reference is <code>imageTag=tag</code> or
171
188
  * <code>imageDigest=digest</code>.</p>
@@ -195,14 +212,17 @@ export type ImageFailureCode = (typeof ImageFailureCode)[keyof typeof ImageFailu
195
212
  */
196
213
  export interface ImageFailure {
197
214
  /**
215
+ * @public
198
216
  * <p>The image ID associated with the failure.</p>
199
217
  */
200
218
  imageId?: ImageIdentifier;
201
219
  /**
220
+ * @public
202
221
  * <p>The code associated with the failure.</p>
203
222
  */
204
223
  failureCode?: ImageFailureCode | string;
205
224
  /**
225
+ * @public
206
226
  * <p>The reason for the failure.</p>
207
227
  */
208
228
  failureReason?: string;
@@ -212,10 +232,12 @@ export interface ImageFailure {
212
232
  */
213
233
  export interface BatchDeleteImageResponse {
214
234
  /**
235
+ * @public
215
236
  * <p>The image IDs of the deleted images.</p>
216
237
  */
217
238
  imageIds?: ImageIdentifier[];
218
239
  /**
240
+ * @public
219
241
  * <p>Any failures associated with the call.</p>
220
242
  */
221
243
  failures?: ImageFailure[];
@@ -225,21 +247,25 @@ export interface BatchDeleteImageResponse {
225
247
  */
226
248
  export interface BatchGetImageRequest {
227
249
  /**
250
+ * @public
228
251
  * <p>The Amazon Web Services account ID associated with the registry that contains the images to
229
252
  * describe. If you do not specify a registry, the default registry is assumed.</p>
230
253
  */
231
254
  registryId?: string;
232
255
  /**
256
+ * @public
233
257
  * <p>The repository that contains the images to describe.</p>
234
258
  */
235
259
  repositoryName: string | undefined;
236
260
  /**
261
+ * @public
237
262
  * <p>A list of image ID references that correspond to images to describe. The format of the
238
263
  * <code>imageIds</code> reference is <code>imageTag=tag</code> or
239
264
  * <code>imageDigest=digest</code>.</p>
240
265
  */
241
266
  imageIds: ImageIdentifier[] | undefined;
242
267
  /**
268
+ * @public
243
269
  * <p>The accepted media types for the request.</p>
244
270
  * <p>Valid values: <code>application/vnd.docker.distribution.manifest.v1+json</code> |
245
271
  * <code>application/vnd.docker.distribution.manifest.v2+json</code> |
@@ -254,22 +280,27 @@ export interface BatchGetImageRequest {
254
280
  */
255
281
  export interface Image {
256
282
  /**
283
+ * @public
257
284
  * <p>The Amazon Web Services account ID associated with the registry containing the image.</p>
258
285
  */
259
286
  registryId?: string;
260
287
  /**
288
+ * @public
261
289
  * <p>The name of the repository associated with the image.</p>
262
290
  */
263
291
  repositoryName?: string;
264
292
  /**
293
+ * @public
265
294
  * <p>An object containing the image tag and image digest associated with an image.</p>
266
295
  */
267
296
  imageId?: ImageIdentifier;
268
297
  /**
298
+ * @public
269
299
  * <p>The image manifest associated with the image.</p>
270
300
  */
271
301
  imageManifest?: string;
272
302
  /**
303
+ * @public
273
304
  * <p>The manifest media type of the image.</p>
274
305
  */
275
306
  imageManifestMediaType?: string;
@@ -279,10 +310,12 @@ export interface Image {
279
310
  */
280
311
  export interface BatchGetImageResponse {
281
312
  /**
313
+ * @public
282
314
  * <p>A list of image objects corresponding to the image references in the request.</p>
283
315
  */
284
316
  images?: Image[];
285
317
  /**
318
+ * @public
286
319
  * <p>Any failures associated with the call.</p>
287
320
  */
288
321
  failures?: ImageFailure[];
@@ -292,6 +325,7 @@ export interface BatchGetImageResponse {
292
325
  */
293
326
  export interface BatchGetRepositoryScanningConfigurationRequest {
294
327
  /**
328
+ * @public
295
329
  * <p>One or more repository names to get the scanning configuration for.</p>
296
330
  */
297
331
  repositoryNames: string[] | undefined;
@@ -314,14 +348,17 @@ export type ScanningConfigurationFailureCode = (typeof ScanningConfigurationFail
314
348
  */
315
349
  export interface RepositoryScanningConfigurationFailure {
316
350
  /**
351
+ * @public
317
352
  * <p>The name of the repository.</p>
318
353
  */
319
354
  repositoryName?: string;
320
355
  /**
356
+ * @public
321
357
  * <p>The failure code.</p>
322
358
  */
323
359
  failureCode?: ScanningConfigurationFailureCode | string;
324
360
  /**
361
+ * @public
325
362
  * <p>The reason for the failure.</p>
326
363
  */
327
364
  failureReason?: string;
@@ -345,10 +382,12 @@ export type ScanningRepositoryFilterType = (typeof ScanningRepositoryFilterType)
345
382
  */
346
383
  export interface ScanningRepositoryFilter {
347
384
  /**
385
+ * @public
348
386
  * <p>The filter to use when scanning.</p>
349
387
  */
350
388
  filter: string | undefined;
351
389
  /**
390
+ * @public
352
391
  * <p>The type associated with the filter.</p>
353
392
  */
354
393
  filterType: ScanningRepositoryFilterType | string | undefined;
@@ -372,22 +411,27 @@ export type ScanFrequency = (typeof ScanFrequency)[keyof typeof ScanFrequency];
372
411
  */
373
412
  export interface RepositoryScanningConfiguration {
374
413
  /**
414
+ * @public
375
415
  * <p>The ARN of the repository.</p>
376
416
  */
377
417
  repositoryArn?: string;
378
418
  /**
419
+ * @public
379
420
  * <p>The name of the repository.</p>
380
421
  */
381
422
  repositoryName?: string;
382
423
  /**
424
+ * @public
383
425
  * <p>Whether or not scan on push is configured for the repository.</p>
384
426
  */
385
427
  scanOnPush?: boolean;
386
428
  /**
429
+ * @public
387
430
  * <p>The scan frequency for the repository.</p>
388
431
  */
389
432
  scanFrequency?: ScanFrequency | string;
390
433
  /**
434
+ * @public
391
435
  * <p>The scan filters applied to the repository.</p>
392
436
  */
393
437
  appliedScanFilters?: ScanningRepositoryFilter[];
@@ -397,10 +441,12 @@ export interface RepositoryScanningConfiguration {
397
441
  */
398
442
  export interface BatchGetRepositoryScanningConfigurationResponse {
399
443
  /**
444
+ * @public
400
445
  * <p>The scanning configuration for the requested repositories.</p>
401
446
  */
402
447
  scanningConfigurations?: RepositoryScanningConfiguration[];
403
448
  /**
449
+ * @public
404
450
  * <p>Any failures associated with the call.</p>
405
451
  */
406
452
  failures?: RepositoryScanningConfigurationFailure[];
@@ -422,20 +468,24 @@ export declare class ValidationException extends __BaseException {
422
468
  */
423
469
  export interface CompleteLayerUploadRequest {
424
470
  /**
471
+ * @public
425
472
  * <p>The Amazon Web Services account ID associated with the registry to which to upload layers.
426
473
  * If you do not specify a registry, the default registry is assumed.</p>
427
474
  */
428
475
  registryId?: string;
429
476
  /**
477
+ * @public
430
478
  * <p>The name of the repository to associate with the image layer.</p>
431
479
  */
432
480
  repositoryName: string | undefined;
433
481
  /**
482
+ * @public
434
483
  * <p>The upload ID from a previous <a>InitiateLayerUpload</a> operation to
435
484
  * associate with the image layer.</p>
436
485
  */
437
486
  uploadId: string | undefined;
438
487
  /**
488
+ * @public
439
489
  * <p>The <code>sha256</code> digest of the image layer.</p>
440
490
  */
441
491
  layerDigests: string[] | undefined;
@@ -445,18 +495,22 @@ export interface CompleteLayerUploadRequest {
445
495
  */
446
496
  export interface CompleteLayerUploadResponse {
447
497
  /**
498
+ * @public
448
499
  * <p>The registry ID associated with the request.</p>
449
500
  */
450
501
  registryId?: string;
451
502
  /**
503
+ * @public
452
504
  * <p>The repository name associated with the request.</p>
453
505
  */
454
506
  repositoryName?: string;
455
507
  /**
508
+ * @public
456
509
  * <p>The upload ID associated with the layer.</p>
457
510
  */
458
511
  uploadId?: string;
459
512
  /**
513
+ * @public
460
514
  * <p>The <code>sha256</code> digest of the image layer.</p>
461
515
  */
462
516
  layerDigest?: string;
@@ -494,6 +548,7 @@ export declare class KmsException extends __BaseException {
494
548
  readonly name: "KmsException";
495
549
  readonly $fault: "client";
496
550
  /**
551
+ * @public
497
552
  * <p>The error code returned by KMS.</p>
498
553
  */
499
554
  kmsError?: string;
@@ -544,15 +599,18 @@ export declare class UploadNotFoundException extends __BaseException {
544
599
  */
545
600
  export interface CreatePullThroughCacheRuleRequest {
546
601
  /**
602
+ * @public
547
603
  * <p>The repository name prefix to use when caching images from the source registry.</p>
548
604
  */
549
605
  ecrRepositoryPrefix: string | undefined;
550
606
  /**
607
+ * @public
551
608
  * <p>The registry URL of the upstream public registry to use as the source for the pull
552
609
  * through cache rule.</p>
553
610
  */
554
611
  upstreamRegistryUrl: string | undefined;
555
612
  /**
613
+ * @public
556
614
  * <p>The Amazon Web Services account ID associated with the registry to create the pull through cache
557
615
  * rule for. If you do not specify a registry, the default registry is assumed.</p>
558
616
  */
@@ -563,19 +621,23 @@ export interface CreatePullThroughCacheRuleRequest {
563
621
  */
564
622
  export interface CreatePullThroughCacheRuleResponse {
565
623
  /**
624
+ * @public
566
625
  * <p>The Amazon ECR repository prefix associated with the pull through cache rule.</p>
567
626
  */
568
627
  ecrRepositoryPrefix?: string;
569
628
  /**
629
+ * @public
570
630
  * <p>The upstream registry URL associated with the pull through cache rule.</p>
571
631
  */
572
632
  upstreamRegistryUrl?: string;
573
633
  /**
634
+ * @public
574
635
  * <p>The date and time, in JavaScript date format, when the pull through cache rule was
575
636
  * created.</p>
576
637
  */
577
638
  createdAt?: Date;
578
639
  /**
640
+ * @public
579
641
  * <p>The registry ID associated with the request.</p>
580
642
  */
581
643
  registryId?: string;
@@ -646,6 +708,7 @@ export type EncryptionType = (typeof EncryptionType)[keyof typeof EncryptionType
646
708
  */
647
709
  export interface EncryptionConfiguration {
648
710
  /**
711
+ * @public
649
712
  * <p>The encryption type to use.</p>
650
713
  * <p>If you use the <code>KMS</code> encryption type, the contents of the repository will
651
714
  * be encrypted using server-side encryption with Key Management Service key stored in KMS. When you
@@ -662,6 +725,7 @@ export interface EncryptionConfiguration {
662
725
  */
663
726
  encryptionType: EncryptionType | string | undefined;
664
727
  /**
728
+ * @public
665
729
  * <p>If you use the <code>KMS</code> encryption type, specify the KMS key to use for
666
730
  * encryption. The alias, key ID, or full ARN of the KMS key can be specified. The key
667
731
  * must exist in the same Region as the repository. If no key is specified, the default
@@ -675,6 +739,7 @@ export interface EncryptionConfiguration {
675
739
  */
676
740
  export interface ImageScanningConfiguration {
677
741
  /**
742
+ * @public
678
743
  * <p>The setting that determines whether images are scanned after being pushed to a
679
744
  * repository. If set to <code>true</code>, images will be scanned after being pushed. If
680
745
  * this parameter is not specified, it will default to <code>false</code> and images will
@@ -702,11 +767,13 @@ export type ImageTagMutability = (typeof ImageTagMutability)[keyof typeof ImageT
702
767
  */
703
768
  export interface Tag {
704
769
  /**
770
+ * @public
705
771
  * <p>One part of a key-value pair that make up a tag. A <code>key</code> is a general label
706
772
  * that acts like a category for more specific tag values.</p>
707
773
  */
708
774
  Key?: string;
709
775
  /**
776
+ * @public
710
777
  * <p>A <code>value</code> acts as a descriptor within a tag category (key).</p>
711
778
  */
712
779
  Value?: string;
@@ -716,17 +783,20 @@ export interface Tag {
716
783
  */
717
784
  export interface CreateRepositoryRequest {
718
785
  /**
786
+ * @public
719
787
  * <p>The Amazon Web Services account ID associated with the registry to create the repository.
720
788
  * If you do not specify a registry, the default registry is assumed.</p>
721
789
  */
722
790
  registryId?: string;
723
791
  /**
792
+ * @public
724
793
  * <p>The name to use for the repository. The repository name may be specified on its own
725
794
  * (such as <code>nginx-web-app</code>) or it can be prepended with a namespace to group
726
795
  * the repository into a category (such as <code>project-a/nginx-web-app</code>).</p>
727
796
  */
728
797
  repositoryName: string | undefined;
729
798
  /**
799
+ * @public
730
800
  * <p>The metadata that you apply to the repository to help you categorize and organize
731
801
  * them. Each tag consists of a key and an optional value, both of which you define.
732
802
  * Tag keys can have a maximum character length of 128 characters, and tag values can have
@@ -734,6 +804,7 @@ export interface CreateRepositoryRequest {
734
804
  */
735
805
  tags?: Tag[];
736
806
  /**
807
+ * @public
737
808
  * <p>The tag mutability setting for the repository. If this parameter is omitted, the
738
809
  * default setting of <code>MUTABLE</code> will be used which will allow image tags to be
739
810
  * overwritten. If <code>IMMUTABLE</code> is specified, all image tags within the
@@ -741,11 +812,13 @@ export interface CreateRepositoryRequest {
741
812
  */
742
813
  imageTagMutability?: ImageTagMutability | string;
743
814
  /**
815
+ * @public
744
816
  * <p>The image scanning configuration for the repository. This determines whether images
745
817
  * are scanned for known vulnerabilities after being pushed to the repository.</p>
746
818
  */
747
819
  imageScanningConfiguration?: ImageScanningConfiguration;
748
820
  /**
821
+ * @public
749
822
  * <p>The encryption configuration for the repository. This determines how the contents of
750
823
  * your repository are encrypted at rest.</p>
751
824
  */
@@ -757,37 +830,45 @@ export interface CreateRepositoryRequest {
757
830
  */
758
831
  export interface Repository {
759
832
  /**
833
+ * @public
760
834
  * <p>The Amazon Resource Name (ARN) that identifies the repository. The ARN contains the <code>arn:aws:ecr</code> namespace, followed by the region of the
761
835
  * repository, Amazon Web Services account ID of the repository owner, repository namespace, and repository name.
762
836
  * For example, <code>arn:aws:ecr:region:012345678910:repository/test</code>.</p>
763
837
  */
764
838
  repositoryArn?: string;
765
839
  /**
840
+ * @public
766
841
  * <p>The Amazon Web Services account ID associated with the registry that contains the repository.</p>
767
842
  */
768
843
  registryId?: string;
769
844
  /**
845
+ * @public
770
846
  * <p>The name of the repository.</p>
771
847
  */
772
848
  repositoryName?: string;
773
849
  /**
850
+ * @public
774
851
  * <p>The URI for the repository. You can use this URI for container image <code>push</code>
775
852
  * and <code>pull</code> operations.</p>
776
853
  */
777
854
  repositoryUri?: string;
778
855
  /**
856
+ * @public
779
857
  * <p>The date and time, in JavaScript date format, when the repository was created.</p>
780
858
  */
781
859
  createdAt?: Date;
782
860
  /**
861
+ * @public
783
862
  * <p>The tag mutability setting for the repository.</p>
784
863
  */
785
864
  imageTagMutability?: ImageTagMutability | string;
786
865
  /**
866
+ * @public
787
867
  * <p>The image scanning configuration for a repository.</p>
788
868
  */
789
869
  imageScanningConfiguration?: ImageScanningConfiguration;
790
870
  /**
871
+ * @public
791
872
  * <p>The encryption configuration for the repository. This determines how the contents of
792
873
  * your repository are encrypted at rest.</p>
793
874
  */
@@ -798,6 +879,7 @@ export interface Repository {
798
879
  */
799
880
  export interface CreateRepositoryResponse {
800
881
  /**
882
+ * @public
801
883
  * <p>The repository that was created.</p>
802
884
  */
803
885
  repository?: Repository;
@@ -845,11 +927,13 @@ export declare class TooManyTagsException extends __BaseException {
845
927
  */
846
928
  export interface DeleteLifecyclePolicyRequest {
847
929
  /**
930
+ * @public
848
931
  * <p>The Amazon Web Services account ID associated with the registry that contains the repository.
849
932
  * If you do not specify a registry, the default registry is assumed.</p>
850
933
  */
851
934
  registryId?: string;
852
935
  /**
936
+ * @public
853
937
  * <p>The name of the repository.</p>
854
938
  */
855
939
  repositoryName: string | undefined;
@@ -859,18 +943,22 @@ export interface DeleteLifecyclePolicyRequest {
859
943
  */
860
944
  export interface DeleteLifecyclePolicyResponse {
861
945
  /**
946
+ * @public
862
947
  * <p>The registry ID associated with the request.</p>
863
948
  */
864
949
  registryId?: string;
865
950
  /**
951
+ * @public
866
952
  * <p>The repository name associated with the request.</p>
867
953
  */
868
954
  repositoryName?: string;
869
955
  /**
956
+ * @public
870
957
  * <p>The JSON lifecycle policy text.</p>
871
958
  */
872
959
  lifecyclePolicyText?: string;
873
960
  /**
961
+ * @public
874
962
  * <p>The time stamp of the last time that the lifecycle policy was run.</p>
875
963
  */
876
964
  lastEvaluatedAt?: Date;
@@ -893,11 +981,13 @@ export declare class LifecyclePolicyNotFoundException extends __BaseException {
893
981
  */
894
982
  export interface DeletePullThroughCacheRuleRequest {
895
983
  /**
984
+ * @public
896
985
  * <p>The Amazon ECR repository prefix associated with the pull through cache rule to
897
986
  * delete.</p>
898
987
  */
899
988
  ecrRepositoryPrefix: string | undefined;
900
989
  /**
990
+ * @public
901
991
  * <p>The Amazon Web Services account ID associated with the registry that contains the pull through cache
902
992
  * rule. If you do not specify a registry, the default registry is assumed.</p>
903
993
  */
@@ -908,18 +998,22 @@ export interface DeletePullThroughCacheRuleRequest {
908
998
  */
909
999
  export interface DeletePullThroughCacheRuleResponse {
910
1000
  /**
1001
+ * @public
911
1002
  * <p>The Amazon ECR repository prefix associated with the request.</p>
912
1003
  */
913
1004
  ecrRepositoryPrefix?: string;
914
1005
  /**
1006
+ * @public
915
1007
  * <p>The upstream registry URL associated with the pull through cache rule.</p>
916
1008
  */
917
1009
  upstreamRegistryUrl?: string;
918
1010
  /**
1011
+ * @public
919
1012
  * <p>The timestamp associated with the pull through cache rule.</p>
920
1013
  */
921
1014
  createdAt?: Date;
922
1015
  /**
1016
+ * @public
923
1017
  * <p>The registry ID associated with the request.</p>
924
1018
  */
925
1019
  registryId?: string;
@@ -947,10 +1041,12 @@ export interface DeleteRegistryPolicyRequest {
947
1041
  */
948
1042
  export interface DeleteRegistryPolicyResponse {
949
1043
  /**
1044
+ * @public
950
1045
  * <p>The registry ID associated with the request.</p>
951
1046
  */
952
1047
  registryId?: string;
953
1048
  /**
1049
+ * @public
954
1050
  * <p>The contents of the registry permissions policy that was deleted.</p>
955
1051
  */
956
1052
  policyText?: string;
@@ -972,15 +1068,18 @@ export declare class RegistryPolicyNotFoundException extends __BaseException {
972
1068
  */
973
1069
  export interface DeleteRepositoryRequest {
974
1070
  /**
1071
+ * @public
975
1072
  * <p>The Amazon Web Services account ID associated with the registry that contains the repository to
976
1073
  * delete. If you do not specify a registry, the default registry is assumed.</p>
977
1074
  */
978
1075
  registryId?: string;
979
1076
  /**
1077
+ * @public
980
1078
  * <p>The name of the repository to delete.</p>
981
1079
  */
982
1080
  repositoryName: string | undefined;
983
1081
  /**
1082
+ * @public
984
1083
  * <p> If a repository contains images, forces the deletion.</p>
985
1084
  */
986
1085
  force?: boolean;
@@ -990,6 +1089,7 @@ export interface DeleteRepositoryRequest {
990
1089
  */
991
1090
  export interface DeleteRepositoryResponse {
992
1091
  /**
1092
+ * @public
993
1093
  * <p>The repository that was deleted.</p>
994
1094
  */
995
1095
  repository?: Repository;
@@ -1012,11 +1112,13 @@ export declare class RepositoryNotEmptyException extends __BaseException {
1012
1112
  */
1013
1113
  export interface DeleteRepositoryPolicyRequest {
1014
1114
  /**
1115
+ * @public
1015
1116
  * <p>The Amazon Web Services account ID associated with the registry that contains the repository policy
1016
1117
  * to delete. If you do not specify a registry, the default registry is assumed.</p>
1017
1118
  */
1018
1119
  registryId?: string;
1019
1120
  /**
1121
+ * @public
1020
1122
  * <p>The name of the repository that is associated with the repository policy to
1021
1123
  * delete.</p>
1022
1124
  */
@@ -1027,14 +1129,17 @@ export interface DeleteRepositoryPolicyRequest {
1027
1129
  */
1028
1130
  export interface DeleteRepositoryPolicyResponse {
1029
1131
  /**
1132
+ * @public
1030
1133
  * <p>The registry ID associated with the request.</p>
1031
1134
  */
1032
1135
  registryId?: string;
1033
1136
  /**
1137
+ * @public
1034
1138
  * <p>The repository name associated with the request.</p>
1035
1139
  */
1036
1140
  repositoryName?: string;
1037
1141
  /**
1142
+ * @public
1038
1143
  * <p>The JSON repository policy that was deleted from the repository.</p>
1039
1144
  */
1040
1145
  policyText?: string;
@@ -1057,14 +1162,17 @@ export declare class RepositoryPolicyNotFoundException extends __BaseException {
1057
1162
  */
1058
1163
  export interface DescribeImageReplicationStatusRequest {
1059
1164
  /**
1165
+ * @public
1060
1166
  * <p>The name of the repository that the image is in.</p>
1061
1167
  */
1062
1168
  repositoryName: string | undefined;
1063
1169
  /**
1170
+ * @public
1064
1171
  * <p>An object with identifying information for an image in an Amazon ECR repository.</p>
1065
1172
  */
1066
1173
  imageId: ImageIdentifier | undefined;
1067
1174
  /**
1175
+ * @public
1068
1176
  * <p>The Amazon Web Services account ID associated with the registry. If you do not specify a registry, the default registry is assumed.</p>
1069
1177
  */
1070
1178
  registryId?: string;
@@ -1088,18 +1196,22 @@ export type ReplicationStatus = (typeof ReplicationStatus)[keyof typeof Replicat
1088
1196
  */
1089
1197
  export interface ImageReplicationStatus {
1090
1198
  /**
1199
+ * @public
1091
1200
  * <p>The destination Region for the image replication.</p>
1092
1201
  */
1093
1202
  region?: string;
1094
1203
  /**
1204
+ * @public
1095
1205
  * <p>The Amazon Web Services account ID associated with the registry to which the image belongs.</p>
1096
1206
  */
1097
1207
  registryId?: string;
1098
1208
  /**
1209
+ * @public
1099
1210
  * <p>The image replication status.</p>
1100
1211
  */
1101
1212
  status?: ReplicationStatus | string;
1102
1213
  /**
1214
+ * @public
1103
1215
  * <p>The failure code for a replication that has failed.</p>
1104
1216
  */
1105
1217
  failureCode?: string;
@@ -1109,14 +1221,17 @@ export interface ImageReplicationStatus {
1109
1221
  */
1110
1222
  export interface DescribeImageReplicationStatusResponse {
1111
1223
  /**
1224
+ * @public
1112
1225
  * <p>The repository name associated with the request.</p>
1113
1226
  */
1114
1227
  repositoryName?: string;
1115
1228
  /**
1229
+ * @public
1116
1230
  * <p>An object with identifying information for an image in an Amazon ECR repository.</p>
1117
1231
  */
1118
1232
  imageId?: ImageIdentifier;
1119
1233
  /**
1234
+ * @public
1120
1235
  * <p>The replication status details for the images in the specified repository.</p>
1121
1236
  */
1122
1237
  replicationStatuses?: ImageReplicationStatus[];
@@ -1153,6 +1268,7 @@ export type TagStatus = (typeof TagStatus)[keyof typeof TagStatus];
1153
1268
  */
1154
1269
  export interface DescribeImagesFilter {
1155
1270
  /**
1271
+ * @public
1156
1272
  * <p>The tag status with which to filter your <a>DescribeImages</a> results. You
1157
1273
  * can filter results based on whether they are <code>TAGGED</code> or
1158
1274
  * <code>UNTAGGED</code>.</p>
@@ -1164,19 +1280,23 @@ export interface DescribeImagesFilter {
1164
1280
  */
1165
1281
  export interface DescribeImagesRequest {
1166
1282
  /**
1283
+ * @public
1167
1284
  * <p>The Amazon Web Services account ID associated with the registry that contains the repository in
1168
1285
  * which to describe images. If you do not specify a registry, the default registry is assumed.</p>
1169
1286
  */
1170
1287
  registryId?: string;
1171
1288
  /**
1289
+ * @public
1172
1290
  * <p>The repository that contains the images to describe.</p>
1173
1291
  */
1174
1292
  repositoryName: string | undefined;
1175
1293
  /**
1294
+ * @public
1176
1295
  * <p>The list of image IDs for the requested repository.</p>
1177
1296
  */
1178
1297
  imageIds?: ImageIdentifier[];
1179
1298
  /**
1299
+ * @public
1180
1300
  * <p>The <code>nextToken</code> value returned from a previous paginated
1181
1301
  * <code>DescribeImages</code> request where <code>maxResults</code> was used and the
1182
1302
  * results exceeded the value of that parameter. Pagination continues from the end of the
@@ -1186,6 +1306,7 @@ export interface DescribeImagesRequest {
1186
1306
  */
1187
1307
  nextToken?: string;
1188
1308
  /**
1309
+ * @public
1189
1310
  * <p>The maximum number of repository results returned by <code>DescribeImages</code> in
1190
1311
  * paginated output. When this parameter is used, <code>DescribeImages</code> only returns
1191
1312
  * <code>maxResults</code> results in a single page along with a <code>nextToken</code>
@@ -1198,6 +1319,7 @@ export interface DescribeImagesRequest {
1198
1319
  */
1199
1320
  maxResults?: number;
1200
1321
  /**
1322
+ * @public
1201
1323
  * <p>The filter key and value with which to filter your <code>DescribeImages</code>
1202
1324
  * results.</p>
1203
1325
  */
@@ -1225,14 +1347,17 @@ export type FindingSeverity = (typeof FindingSeverity)[keyof typeof FindingSever
1225
1347
  */
1226
1348
  export interface ImageScanFindingsSummary {
1227
1349
  /**
1350
+ * @public
1228
1351
  * <p>The time of the last completed image scan.</p>
1229
1352
  */
1230
1353
  imageScanCompletedAt?: Date;
1231
1354
  /**
1355
+ * @public
1232
1356
  * <p>The time when the vulnerability data was last scanned.</p>
1233
1357
  */
1234
1358
  vulnerabilitySourceUpdatedAt?: Date;
1235
1359
  /**
1360
+ * @public
1236
1361
  * <p>The image vulnerability counts, sorted by severity.</p>
1237
1362
  */
1238
1363
  findingSeverityCounts?: Record<string, number>;
@@ -1261,10 +1386,12 @@ export type ScanStatus = (typeof ScanStatus)[keyof typeof ScanStatus];
1261
1386
  */
1262
1387
  export interface ImageScanStatus {
1263
1388
  /**
1389
+ * @public
1264
1390
  * <p>The current state of an image scan.</p>
1265
1391
  */
1266
1392
  status?: ScanStatus | string;
1267
1393
  /**
1394
+ * @public
1268
1395
  * <p>The description of the image scan status.</p>
1269
1396
  */
1270
1397
  description?: string;
@@ -1276,22 +1403,27 @@ export interface ImageScanStatus {
1276
1403
  */
1277
1404
  export interface ImageDetail {
1278
1405
  /**
1406
+ * @public
1279
1407
  * <p>The Amazon Web Services account ID associated with the registry to which this image belongs.</p>
1280
1408
  */
1281
1409
  registryId?: string;
1282
1410
  /**
1411
+ * @public
1283
1412
  * <p>The name of the repository to which this image belongs.</p>
1284
1413
  */
1285
1414
  repositoryName?: string;
1286
1415
  /**
1416
+ * @public
1287
1417
  * <p>The <code>sha256</code> digest of the image manifest.</p>
1288
1418
  */
1289
1419
  imageDigest?: string;
1290
1420
  /**
1421
+ * @public
1291
1422
  * <p>The list of tags associated with this image.</p>
1292
1423
  */
1293
1424
  imageTags?: string[];
1294
1425
  /**
1426
+ * @public
1295
1427
  * <p>The size, in bytes, of the image in the repository.</p>
1296
1428
  * <p>If the image is a manifest list, this will be the max size of all manifests in the
1297
1429
  * list.</p>
@@ -1304,27 +1436,33 @@ export interface ImageDetail {
1304
1436
  */
1305
1437
  imageSizeInBytes?: number;
1306
1438
  /**
1439
+ * @public
1307
1440
  * <p>The date and time, expressed in standard JavaScript date format, at which the current
1308
1441
  * image was pushed to the repository. </p>
1309
1442
  */
1310
1443
  imagePushedAt?: Date;
1311
1444
  /**
1445
+ * @public
1312
1446
  * <p>The current state of the scan.</p>
1313
1447
  */
1314
1448
  imageScanStatus?: ImageScanStatus;
1315
1449
  /**
1450
+ * @public
1316
1451
  * <p>A summary of the last completed image scan.</p>
1317
1452
  */
1318
1453
  imageScanFindingsSummary?: ImageScanFindingsSummary;
1319
1454
  /**
1455
+ * @public
1320
1456
  * <p>The media type of the image manifest.</p>
1321
1457
  */
1322
1458
  imageManifestMediaType?: string;
1323
1459
  /**
1460
+ * @public
1324
1461
  * <p>The artifact media type of the image.</p>
1325
1462
  */
1326
1463
  artifactMediaType?: string;
1327
1464
  /**
1465
+ * @public
1328
1466
  * <p>The date and time, expressed in standard JavaScript date format, when Amazon ECR recorded
1329
1467
  * the last image pull.</p>
1330
1468
  * <note>
@@ -1343,11 +1481,13 @@ export interface ImageDetail {
1343
1481
  */
1344
1482
  export interface DescribeImagesResponse {
1345
1483
  /**
1484
+ * @public
1346
1485
  * <p>A list of <a>ImageDetail</a> objects that contain data about the
1347
1486
  * image.</p>
1348
1487
  */
1349
1488
  imageDetails?: ImageDetail[];
1350
1489
  /**
1490
+ * @public
1351
1491
  * <p>The <code>nextToken</code> value to include in a future <code>DescribeImages</code>
1352
1492
  * request. When the results of a <code>DescribeImages</code> request exceed
1353
1493
  * <code>maxResults</code>, this value can be used to retrieve the next page of
@@ -1361,19 +1501,23 @@ export interface DescribeImagesResponse {
1361
1501
  */
1362
1502
  export interface DescribeImageScanFindingsRequest {
1363
1503
  /**
1504
+ * @public
1364
1505
  * <p>The Amazon Web Services account ID associated with the registry that contains the repository in
1365
1506
  * which to describe the image scan findings for. If you do not specify a registry, the default registry is assumed.</p>
1366
1507
  */
1367
1508
  registryId?: string;
1368
1509
  /**
1510
+ * @public
1369
1511
  * <p>The repository for the image for which to describe the scan findings.</p>
1370
1512
  */
1371
1513
  repositoryName: string | undefined;
1372
1514
  /**
1515
+ * @public
1373
1516
  * <p>An object with identifying information for an image in an Amazon ECR repository.</p>
1374
1517
  */
1375
1518
  imageId: ImageIdentifier | undefined;
1376
1519
  /**
1520
+ * @public
1377
1521
  * <p>The <code>nextToken</code> value returned from a previous paginated
1378
1522
  * <code>DescribeImageScanFindings</code> request where <code>maxResults</code> was
1379
1523
  * used and the results exceeded the value of that parameter. Pagination continues from the
@@ -1382,6 +1526,7 @@ export interface DescribeImageScanFindingsRequest {
1382
1526
  */
1383
1527
  nextToken?: string;
1384
1528
  /**
1529
+ * @public
1385
1530
  * <p>The maximum number of image scan results returned by
1386
1531
  * <code>DescribeImageScanFindings</code> in paginated output. When this parameter is
1387
1532
  * used, <code>DescribeImageScanFindings</code> only returns <code>maxResults</code>
@@ -1400,18 +1545,22 @@ export interface DescribeImageScanFindingsRequest {
1400
1545
  */
1401
1546
  export interface CvssScore {
1402
1547
  /**
1548
+ * @public
1403
1549
  * <p>The base CVSS score used for the finding.</p>
1404
1550
  */
1405
1551
  baseScore?: number;
1406
1552
  /**
1553
+ * @public
1407
1554
  * <p>The vector string of the CVSS score.</p>
1408
1555
  */
1409
1556
  scoringVector?: string;
1410
1557
  /**
1558
+ * @public
1411
1559
  * <p>The source of the CVSS score.</p>
1412
1560
  */
1413
1561
  source?: string;
1414
1562
  /**
1563
+ * @public
1415
1564
  * <p>The version of CVSS used for the score.</p>
1416
1565
  */
1417
1566
  version?: string;
@@ -1422,34 +1571,42 @@ export interface CvssScore {
1422
1571
  */
1423
1572
  export interface VulnerablePackage {
1424
1573
  /**
1574
+ * @public
1425
1575
  * <p>The architecture of the vulnerable package.</p>
1426
1576
  */
1427
1577
  arch?: string;
1428
1578
  /**
1579
+ * @public
1429
1580
  * <p>The epoch of the vulnerable package.</p>
1430
1581
  */
1431
1582
  epoch?: number;
1432
1583
  /**
1584
+ * @public
1433
1585
  * <p>The file path of the vulnerable package.</p>
1434
1586
  */
1435
1587
  filePath?: string;
1436
1588
  /**
1589
+ * @public
1437
1590
  * <p>The name of the vulnerable package.</p>
1438
1591
  */
1439
1592
  name?: string;
1440
1593
  /**
1594
+ * @public
1441
1595
  * <p>The package manager of the vulnerable package.</p>
1442
1596
  */
1443
1597
  packageManager?: string;
1444
1598
  /**
1599
+ * @public
1445
1600
  * <p>The release of the vulnerable package.</p>
1446
1601
  */
1447
1602
  release?: string;
1448
1603
  /**
1604
+ * @public
1449
1605
  * <p>The source layer hash of the vulnerable package.</p>
1450
1606
  */
1451
1607
  sourceLayerHash?: string;
1452
1608
  /**
1609
+ * @public
1453
1610
  * <p>The version of the vulnerable package.</p>
1454
1611
  */
1455
1612
  version?: string;
@@ -1460,43 +1617,53 @@ export interface VulnerablePackage {
1460
1617
  */
1461
1618
  export interface PackageVulnerabilityDetails {
1462
1619
  /**
1620
+ * @public
1463
1621
  * <p>An object that contains details about the CVSS score of a finding.</p>
1464
1622
  */
1465
1623
  cvss?: CvssScore[];
1466
1624
  /**
1625
+ * @public
1467
1626
  * <p>One or more URLs that contain details about this vulnerability type.</p>
1468
1627
  */
1469
1628
  referenceUrls?: string[];
1470
1629
  /**
1630
+ * @public
1471
1631
  * <p>One or more vulnerabilities related to the one identified in this finding.</p>
1472
1632
  */
1473
1633
  relatedVulnerabilities?: string[];
1474
1634
  /**
1635
+ * @public
1475
1636
  * <p>The source of the vulnerability information.</p>
1476
1637
  */
1477
1638
  source?: string;
1478
1639
  /**
1640
+ * @public
1479
1641
  * <p>A URL to the source of the vulnerability information.</p>
1480
1642
  */
1481
1643
  sourceUrl?: string;
1482
1644
  /**
1645
+ * @public
1483
1646
  * <p>The date and time that this vulnerability was first added to the vendor's
1484
1647
  * database.</p>
1485
1648
  */
1486
1649
  vendorCreatedAt?: Date;
1487
1650
  /**
1651
+ * @public
1488
1652
  * <p>The severity the vendor has given to this vulnerability type.</p>
1489
1653
  */
1490
1654
  vendorSeverity?: string;
1491
1655
  /**
1656
+ * @public
1492
1657
  * <p>The date and time the vendor last updated this vulnerability in their database.</p>
1493
1658
  */
1494
1659
  vendorUpdatedAt?: Date;
1495
1660
  /**
1661
+ * @public
1496
1662
  * <p>The ID given to this vulnerability.</p>
1497
1663
  */
1498
1664
  vulnerabilityId?: string;
1499
1665
  /**
1666
+ * @public
1500
1667
  * <p>The packages impacted by this vulnerability.</p>
1501
1668
  */
1502
1669
  vulnerablePackages?: VulnerablePackage[];
@@ -1507,10 +1674,12 @@ export interface PackageVulnerabilityDetails {
1507
1674
  */
1508
1675
  export interface Recommendation {
1509
1676
  /**
1677
+ * @public
1510
1678
  * <p>The URL address to the CVE remediation recommendations.</p>
1511
1679
  */
1512
1680
  url?: string;
1513
1681
  /**
1682
+ * @public
1514
1683
  * <p>The recommended course of action to remediate the finding.</p>
1515
1684
  */
1516
1685
  text?: string;
@@ -1521,6 +1690,7 @@ export interface Recommendation {
1521
1690
  */
1522
1691
  export interface Remediation {
1523
1692
  /**
1693
+ * @public
1524
1694
  * <p>An object that contains information about the recommended course of action to
1525
1695
  * remediate the finding.</p>
1526
1696
  */
@@ -1532,34 +1702,42 @@ export interface Remediation {
1532
1702
  */
1533
1703
  export interface AwsEcrContainerImageDetails {
1534
1704
  /**
1705
+ * @public
1535
1706
  * <p>The architecture of the Amazon ECR container image.</p>
1536
1707
  */
1537
1708
  architecture?: string;
1538
1709
  /**
1710
+ * @public
1539
1711
  * <p>The image author of the Amazon ECR container image.</p>
1540
1712
  */
1541
1713
  author?: string;
1542
1714
  /**
1715
+ * @public
1543
1716
  * <p>The image hash of the Amazon ECR container image.</p>
1544
1717
  */
1545
1718
  imageHash?: string;
1546
1719
  /**
1720
+ * @public
1547
1721
  * <p>The image tags attached to the Amazon ECR container image.</p>
1548
1722
  */
1549
1723
  imageTags?: string[];
1550
1724
  /**
1725
+ * @public
1551
1726
  * <p>The platform of the Amazon ECR container image.</p>
1552
1727
  */
1553
1728
  platform?: string;
1554
1729
  /**
1730
+ * @public
1555
1731
  * <p>The date and time the Amazon ECR container image was pushed.</p>
1556
1732
  */
1557
1733
  pushedAt?: Date;
1558
1734
  /**
1735
+ * @public
1559
1736
  * <p>The registry the Amazon ECR container image belongs to.</p>
1560
1737
  */
1561
1738
  registry?: string;
1562
1739
  /**
1740
+ * @public
1563
1741
  * <p>The name of the repository the Amazon ECR container image resides in.</p>
1564
1742
  */
1565
1743
  repositoryName?: string;
@@ -1570,6 +1748,7 @@ export interface AwsEcrContainerImageDetails {
1570
1748
  */
1571
1749
  export interface ResourceDetails {
1572
1750
  /**
1751
+ * @public
1573
1752
  * <p>An object that contains details about the Amazon ECR container image involved in the
1574
1753
  * finding.</p>
1575
1754
  */
@@ -1581,18 +1760,22 @@ export interface ResourceDetails {
1581
1760
  */
1582
1761
  export interface Resource {
1583
1762
  /**
1763
+ * @public
1584
1764
  * <p>An object that contains details about the resource involved in a finding.</p>
1585
1765
  */
1586
1766
  details?: ResourceDetails;
1587
1767
  /**
1768
+ * @public
1588
1769
  * <p>The ID of the resource.</p>
1589
1770
  */
1590
1771
  id?: string;
1591
1772
  /**
1773
+ * @public
1592
1774
  * <p>The tags attached to the resource.</p>
1593
1775
  */
1594
1776
  tags?: Record<string, string>;
1595
1777
  /**
1778
+ * @public
1596
1779
  * <p>The type of resource.</p>
1597
1780
  */
1598
1781
  type?: string;
@@ -1603,10 +1786,12 @@ export interface Resource {
1603
1786
  */
1604
1787
  export interface CvssScoreAdjustment {
1605
1788
  /**
1789
+ * @public
1606
1790
  * <p>The metric used to adjust the CVSS score.</p>
1607
1791
  */
1608
1792
  metric?: string;
1609
1793
  /**
1794
+ * @public
1610
1795
  * <p>The reason the CVSS score has been adjustment.</p>
1611
1796
  */
1612
1797
  reason?: string;
@@ -1617,22 +1802,27 @@ export interface CvssScoreAdjustment {
1617
1802
  */
1618
1803
  export interface CvssScoreDetails {
1619
1804
  /**
1805
+ * @public
1620
1806
  * <p>An object that contains details about adjustment Amazon Inspector made to the CVSS score.</p>
1621
1807
  */
1622
1808
  adjustments?: CvssScoreAdjustment[];
1623
1809
  /**
1810
+ * @public
1624
1811
  * <p>The CVSS score.</p>
1625
1812
  */
1626
1813
  score?: number;
1627
1814
  /**
1815
+ * @public
1628
1816
  * <p>The source for the CVSS score.</p>
1629
1817
  */
1630
1818
  scoreSource?: string;
1631
1819
  /**
1820
+ * @public
1632
1821
  * <p>The vector for the CVSS score.</p>
1633
1822
  */
1634
1823
  scoringVector?: string;
1635
1824
  /**
1825
+ * @public
1636
1826
  * <p>The CVSS version used in scoring.</p>
1637
1827
  */
1638
1828
  version?: string;
@@ -1643,6 +1833,7 @@ export interface CvssScoreDetails {
1643
1833
  */
1644
1834
  export interface ScoreDetails {
1645
1835
  /**
1836
+ * @public
1646
1837
  * <p>An object that contains details about the CVSS score given to a finding.</p>
1647
1838
  */
1648
1839
  cvss?: CvssScoreDetails;
@@ -1654,62 +1845,77 @@ export interface ScoreDetails {
1654
1845
  */
1655
1846
  export interface EnhancedImageScanFinding {
1656
1847
  /**
1848
+ * @public
1657
1849
  * <p>The Amazon Web Services account ID associated with the image.</p>
1658
1850
  */
1659
1851
  awsAccountId?: string;
1660
1852
  /**
1853
+ * @public
1661
1854
  * <p>The description of the finding.</p>
1662
1855
  */
1663
1856
  description?: string;
1664
1857
  /**
1858
+ * @public
1665
1859
  * <p>The Amazon Resource Number (ARN) of the finding.</p>
1666
1860
  */
1667
1861
  findingArn?: string;
1668
1862
  /**
1863
+ * @public
1669
1864
  * <p>The date and time that the finding was first observed.</p>
1670
1865
  */
1671
1866
  firstObservedAt?: Date;
1672
1867
  /**
1868
+ * @public
1673
1869
  * <p>The date and time that the finding was last observed.</p>
1674
1870
  */
1675
1871
  lastObservedAt?: Date;
1676
1872
  /**
1873
+ * @public
1677
1874
  * <p>An object that contains the details of a package vulnerability finding.</p>
1678
1875
  */
1679
1876
  packageVulnerabilityDetails?: PackageVulnerabilityDetails;
1680
1877
  /**
1878
+ * @public
1681
1879
  * <p>An object that contains the details about how to remediate a finding.</p>
1682
1880
  */
1683
1881
  remediation?: Remediation;
1684
1882
  /**
1883
+ * @public
1685
1884
  * <p>Contains information on the resources involved in a finding.</p>
1686
1885
  */
1687
1886
  resources?: Resource[];
1688
1887
  /**
1888
+ * @public
1689
1889
  * <p>The Amazon Inspector score given to the finding.</p>
1690
1890
  */
1691
1891
  score?: number;
1692
1892
  /**
1893
+ * @public
1693
1894
  * <p>An object that contains details of the Amazon Inspector score.</p>
1694
1895
  */
1695
1896
  scoreDetails?: ScoreDetails;
1696
1897
  /**
1898
+ * @public
1697
1899
  * <p>The severity of the finding.</p>
1698
1900
  */
1699
1901
  severity?: string;
1700
1902
  /**
1903
+ * @public
1701
1904
  * <p>The status of the finding.</p>
1702
1905
  */
1703
1906
  status?: string;
1704
1907
  /**
1908
+ * @public
1705
1909
  * <p>The title of the finding.</p>
1706
1910
  */
1707
1911
  title?: string;
1708
1912
  /**
1913
+ * @public
1709
1914
  * <p>The type of the finding.</p>
1710
1915
  */
1711
1916
  type?: string;
1712
1917
  /**
1918
+ * @public
1713
1919
  * <p>The date and time the finding was last updated at.</p>
1714
1920
  */
1715
1921
  updatedAt?: Date;
@@ -1720,10 +1926,12 @@ export interface EnhancedImageScanFinding {
1720
1926
  */
1721
1927
  export interface Attribute {
1722
1928
  /**
1929
+ * @public
1723
1930
  * <p>The attribute key.</p>
1724
1931
  */
1725
1932
  key: string | undefined;
1726
1933
  /**
1934
+ * @public
1727
1935
  * <p>The value assigned to the attribute key.</p>
1728
1936
  */
1729
1937
  value?: string;
@@ -1734,22 +1942,27 @@ export interface Attribute {
1734
1942
  */
1735
1943
  export interface ImageScanFinding {
1736
1944
  /**
1945
+ * @public
1737
1946
  * <p>The name associated with the finding, usually a CVE number.</p>
1738
1947
  */
1739
1948
  name?: string;
1740
1949
  /**
1950
+ * @public
1741
1951
  * <p>The description of the finding.</p>
1742
1952
  */
1743
1953
  description?: string;
1744
1954
  /**
1955
+ * @public
1745
1956
  * <p>A link containing additional details about the security vulnerability.</p>
1746
1957
  */
1747
1958
  uri?: string;
1748
1959
  /**
1960
+ * @public
1749
1961
  * <p>The finding severity.</p>
1750
1962
  */
1751
1963
  severity?: FindingSeverity | string;
1752
1964
  /**
1965
+ * @public
1753
1966
  * <p>A collection of attributes of the host from which the finding is generated.</p>
1754
1967
  */
1755
1968
  attributes?: Attribute[];
@@ -1760,22 +1973,27 @@ export interface ImageScanFinding {
1760
1973
  */
1761
1974
  export interface ImageScanFindings {
1762
1975
  /**
1976
+ * @public
1763
1977
  * <p>The time of the last completed image scan.</p>
1764
1978
  */
1765
1979
  imageScanCompletedAt?: Date;
1766
1980
  /**
1981
+ * @public
1767
1982
  * <p>The time when the vulnerability data was last scanned.</p>
1768
1983
  */
1769
1984
  vulnerabilitySourceUpdatedAt?: Date;
1770
1985
  /**
1986
+ * @public
1771
1987
  * <p>The image vulnerability counts, sorted by severity.</p>
1772
1988
  */
1773
1989
  findingSeverityCounts?: Record<string, number>;
1774
1990
  /**
1991
+ * @public
1775
1992
  * <p>The findings from the image scan.</p>
1776
1993
  */
1777
1994
  findings?: ImageScanFinding[];
1778
1995
  /**
1996
+ * @public
1779
1997
  * <p>Details about the enhanced scan findings from Amazon Inspector.</p>
1780
1998
  */
1781
1999
  enhancedFindings?: EnhancedImageScanFinding[];
@@ -1785,26 +2003,32 @@ export interface ImageScanFindings {
1785
2003
  */
1786
2004
  export interface DescribeImageScanFindingsResponse {
1787
2005
  /**
2006
+ * @public
1788
2007
  * <p>The registry ID associated with the request.</p>
1789
2008
  */
1790
2009
  registryId?: string;
1791
2010
  /**
2011
+ * @public
1792
2012
  * <p>The repository name associated with the request.</p>
1793
2013
  */
1794
2014
  repositoryName?: string;
1795
2015
  /**
2016
+ * @public
1796
2017
  * <p>An object with identifying information for an image in an Amazon ECR repository.</p>
1797
2018
  */
1798
2019
  imageId?: ImageIdentifier;
1799
2020
  /**
2021
+ * @public
1800
2022
  * <p>The current state of the scan.</p>
1801
2023
  */
1802
2024
  imageScanStatus?: ImageScanStatus;
1803
2025
  /**
2026
+ * @public
1804
2027
  * <p>The information contained in the image scan findings.</p>
1805
2028
  */
1806
2029
  imageScanFindings?: ImageScanFindings;
1807
2030
  /**
2031
+ * @public
1808
2032
  * <p>The <code>nextToken</code> value to include in a future
1809
2033
  * <code>DescribeImageScanFindings</code> request. When the results of a
1810
2034
  * <code>DescribeImageScanFindings</code> request exceed <code>maxResults</code>, this
@@ -1831,17 +2055,20 @@ export declare class ScanNotFoundException extends __BaseException {
1831
2055
  */
1832
2056
  export interface DescribePullThroughCacheRulesRequest {
1833
2057
  /**
2058
+ * @public
1834
2059
  * <p>The Amazon Web Services account ID associated with the registry to return the pull through cache
1835
2060
  * rules for. If you do not specify a registry, the default registry is assumed.</p>
1836
2061
  */
1837
2062
  registryId?: string;
1838
2063
  /**
2064
+ * @public
1839
2065
  * <p>The Amazon ECR repository prefixes associated with the pull through cache rules to return.
1840
2066
  * If no repository prefix value is specified, all pull through cache rules are
1841
2067
  * returned.</p>
1842
2068
  */
1843
2069
  ecrRepositoryPrefixes?: string[];
1844
2070
  /**
2071
+ * @public
1845
2072
  * <p>The <code>nextToken</code> value returned from a previous paginated
1846
2073
  * <code>DescribePullThroughCacheRulesRequest</code> request where
1847
2074
  * <code>maxResults</code> was used and the results exceeded the value of that
@@ -1851,6 +2078,7 @@ export interface DescribePullThroughCacheRulesRequest {
1851
2078
  */
1852
2079
  nextToken?: string;
1853
2080
  /**
2081
+ * @public
1854
2082
  * <p>The maximum number of pull through cache rules returned by
1855
2083
  * <code>DescribePullThroughCacheRulesRequest</code> in paginated output. When this
1856
2084
  * parameter is used, <code>DescribePullThroughCacheRulesRequest</code> only returns
@@ -1869,18 +2097,22 @@ export interface DescribePullThroughCacheRulesRequest {
1869
2097
  */
1870
2098
  export interface PullThroughCacheRule {
1871
2099
  /**
2100
+ * @public
1872
2101
  * <p>The Amazon ECR repository prefix associated with the pull through cache rule.</p>
1873
2102
  */
1874
2103
  ecrRepositoryPrefix?: string;
1875
2104
  /**
2105
+ * @public
1876
2106
  * <p>The upstream registry URL associated with the pull through cache rule.</p>
1877
2107
  */
1878
2108
  upstreamRegistryUrl?: string;
1879
2109
  /**
2110
+ * @public
1880
2111
  * <p>The date and time the pull through cache was created.</p>
1881
2112
  */
1882
2113
  createdAt?: Date;
1883
2114
  /**
2115
+ * @public
1884
2116
  * <p>The Amazon Web Services account ID associated with the registry the pull through cache rule is
1885
2117
  * associated with.</p>
1886
2118
  */
@@ -1891,10 +2123,12 @@ export interface PullThroughCacheRule {
1891
2123
  */
1892
2124
  export interface DescribePullThroughCacheRulesResponse {
1893
2125
  /**
2126
+ * @public
1894
2127
  * <p>The details of the pull through cache rules.</p>
1895
2128
  */
1896
2129
  pullThroughCacheRules?: PullThroughCacheRule[];
1897
2130
  /**
2131
+ * @public
1898
2132
  * <p>The <code>nextToken</code> value to include in a future
1899
2133
  * <code>DescribePullThroughCacheRulesRequest</code> request. When the results of a
1900
2134
  * <code>DescribePullThroughCacheRulesRequest</code> request exceed
@@ -1914,10 +2148,12 @@ export interface DescribeRegistryRequest {
1914
2148
  */
1915
2149
  export interface ReplicationDestination {
1916
2150
  /**
2151
+ * @public
1917
2152
  * <p>The Region to replicate to.</p>
1918
2153
  */
1919
2154
  region: string | undefined;
1920
2155
  /**
2156
+ * @public
1921
2157
  * <p>The Amazon Web Services account ID of the Amazon ECR private registry to replicate to. When configuring
1922
2158
  * cross-Region replication within your own registry, specify your own account ID.</p>
1923
2159
  */
@@ -1943,12 +2179,14 @@ export type RepositoryFilterType = (typeof RepositoryFilterType)[keyof typeof Re
1943
2179
  */
1944
2180
  export interface RepositoryFilter {
1945
2181
  /**
2182
+ * @public
1946
2183
  * <p>The repository filter details. When the <code>PREFIX_MATCH</code> filter type is
1947
2184
  * specified, this value is required and should be the repository name prefix to configure
1948
2185
  * replication for.</p>
1949
2186
  */
1950
2187
  filter: string | undefined;
1951
2188
  /**
2189
+ * @public
1952
2190
  * <p>The repository filter type. The only supported value is <code>PREFIX_MATCH</code>,
1953
2191
  * which is a repository name prefix specified with the <code>filter</code>
1954
2192
  * parameter.</p>
@@ -1962,10 +2200,12 @@ export interface RepositoryFilter {
1962
2200
  */
1963
2201
  export interface ReplicationRule {
1964
2202
  /**
2203
+ * @public
1965
2204
  * <p>An array of objects representing the destination for a replication rule.</p>
1966
2205
  */
1967
2206
  destinations: ReplicationDestination[] | undefined;
1968
2207
  /**
2208
+ * @public
1969
2209
  * <p>An array of objects representing the filters for a replication rule. Specifying a
1970
2210
  * repository filter for a replication rule provides a method for controlling which
1971
2211
  * repositories in a private registry are replicated.</p>
@@ -1978,6 +2218,7 @@ export interface ReplicationRule {
1978
2218
  */
1979
2219
  export interface ReplicationConfiguration {
1980
2220
  /**
2221
+ * @public
1981
2222
  * <p>An array of objects representing the replication destinations and repository filters
1982
2223
  * for a replication configuration.</p>
1983
2224
  */
@@ -1988,10 +2229,12 @@ export interface ReplicationConfiguration {
1988
2229
  */
1989
2230
  export interface DescribeRegistryResponse {
1990
2231
  /**
2232
+ * @public
1991
2233
  * <p>The ID of the registry.</p>
1992
2234
  */
1993
2235
  registryId?: string;
1994
2236
  /**
2237
+ * @public
1995
2238
  * <p>The replication configuration for the registry.</p>
1996
2239
  */
1997
2240
  replicationConfiguration?: ReplicationConfiguration;
@@ -2001,16 +2244,19 @@ export interface DescribeRegistryResponse {
2001
2244
  */
2002
2245
  export interface DescribeRepositoriesRequest {
2003
2246
  /**
2247
+ * @public
2004
2248
  * <p>The Amazon Web Services account ID associated with the registry that contains the repositories to be
2005
2249
  * described. If you do not specify a registry, the default registry is assumed.</p>
2006
2250
  */
2007
2251
  registryId?: string;
2008
2252
  /**
2253
+ * @public
2009
2254
  * <p>A list of repositories to describe. If this parameter is omitted, then all
2010
2255
  * repositories in a registry are described.</p>
2011
2256
  */
2012
2257
  repositoryNames?: string[];
2013
2258
  /**
2259
+ * @public
2014
2260
  * <p>The <code>nextToken</code> value returned from a previous paginated
2015
2261
  * <code>DescribeRepositories</code> request where <code>maxResults</code> was used and
2016
2262
  * the results exceeded the value of that parameter. Pagination continues from the end of
@@ -2024,6 +2270,7 @@ export interface DescribeRepositoriesRequest {
2024
2270
  */
2025
2271
  nextToken?: string;
2026
2272
  /**
2273
+ * @public
2027
2274
  * <p>The maximum number of repository results returned by <code>DescribeRepositories</code>
2028
2275
  * in paginated output. When this parameter is used, <code>DescribeRepositories</code> only
2029
2276
  * returns <code>maxResults</code> results in a single page along with a
@@ -2042,10 +2289,12 @@ export interface DescribeRepositoriesRequest {
2042
2289
  */
2043
2290
  export interface DescribeRepositoriesResponse {
2044
2291
  /**
2292
+ * @public
2045
2293
  * <p>A list of repository objects corresponding to valid repositories.</p>
2046
2294
  */
2047
2295
  repositories?: Repository[];
2048
2296
  /**
2297
+ * @public
2049
2298
  * <p>The <code>nextToken</code> value to include in a future
2050
2299
  * <code>DescribeRepositories</code> request. When the results of a
2051
2300
  * <code>DescribeRepositories</code> request exceed <code>maxResults</code>, this value
@@ -2059,6 +2308,7 @@ export interface DescribeRepositoriesResponse {
2059
2308
  */
2060
2309
  export interface GetAuthorizationTokenRequest {
2061
2310
  /**
2311
+ * @public
2062
2312
  * @deprecated
2063
2313
  *
2064
2314
  * <p>A list of Amazon Web Services account IDs that are associated with the registries for which to get
@@ -2072,6 +2322,7 @@ export interface GetAuthorizationTokenRequest {
2072
2322
  */
2073
2323
  export interface AuthorizationData {
2074
2324
  /**
2325
+ * @public
2075
2326
  * <p>A base64-encoded string that contains authorization data for the specified Amazon ECR
2076
2327
  * registry. When the string is decoded, it is presented in the format
2077
2328
  * <code>user:password</code> for private registry authentication using <code>docker
@@ -2079,11 +2330,13 @@ export interface AuthorizationData {
2079
2330
  */
2080
2331
  authorizationToken?: string;
2081
2332
  /**
2333
+ * @public
2082
2334
  * <p>The Unix time in seconds and milliseconds when the authorization token expires.
2083
2335
  * Authorization tokens are valid for 12 hours.</p>
2084
2336
  */
2085
2337
  expiresAt?: Date;
2086
2338
  /**
2339
+ * @public
2087
2340
  * <p>The registry URL to use for this authorization token in a <code>docker login</code>
2088
2341
  * command. The Amazon ECR registry URL format is
2089
2342
  * <code>https://aws_account_id.dkr.ecr.region.amazonaws.com</code>. For example,
@@ -2096,6 +2349,7 @@ export interface AuthorizationData {
2096
2349
  */
2097
2350
  export interface GetAuthorizationTokenResponse {
2098
2351
  /**
2352
+ * @public
2099
2353
  * <p>A list of authorization token data objects that correspond to the
2100
2354
  * <code>registryIds</code> values in the request.</p>
2101
2355
  */
@@ -2106,15 +2360,18 @@ export interface GetAuthorizationTokenResponse {
2106
2360
  */
2107
2361
  export interface GetDownloadUrlForLayerRequest {
2108
2362
  /**
2363
+ * @public
2109
2364
  * <p>The Amazon Web Services account ID associated with the registry that contains the image layer to
2110
2365
  * download. If you do not specify a registry, the default registry is assumed.</p>
2111
2366
  */
2112
2367
  registryId?: string;
2113
2368
  /**
2369
+ * @public
2114
2370
  * <p>The name of the repository that is associated with the image layer to download.</p>
2115
2371
  */
2116
2372
  repositoryName: string | undefined;
2117
2373
  /**
2374
+ * @public
2118
2375
  * <p>The digest of the image layer to download.</p>
2119
2376
  */
2120
2377
  layerDigest: string | undefined;
@@ -2124,10 +2381,12 @@ export interface GetDownloadUrlForLayerRequest {
2124
2381
  */
2125
2382
  export interface GetDownloadUrlForLayerResponse {
2126
2383
  /**
2384
+ * @public
2127
2385
  * <p>The pre-signed Amazon S3 download URL for the requested layer.</p>
2128
2386
  */
2129
2387
  downloadUrl?: string;
2130
2388
  /**
2389
+ * @public
2131
2390
  * <p>The digest of the image layer to download.</p>
2132
2391
  */
2133
2392
  layerDigest?: string;
@@ -2163,11 +2422,13 @@ export declare class LayersNotFoundException extends __BaseException {
2163
2422
  */
2164
2423
  export interface GetLifecyclePolicyRequest {
2165
2424
  /**
2425
+ * @public
2166
2426
  * <p>The Amazon Web Services account ID associated with the registry that contains the repository.
2167
2427
  * If you do not specify a registry, the default registry is assumed.</p>
2168
2428
  */
2169
2429
  registryId?: string;
2170
2430
  /**
2431
+ * @public
2171
2432
  * <p>The name of the repository.</p>
2172
2433
  */
2173
2434
  repositoryName: string | undefined;
@@ -2177,18 +2438,22 @@ export interface GetLifecyclePolicyRequest {
2177
2438
  */
2178
2439
  export interface GetLifecyclePolicyResponse {
2179
2440
  /**
2441
+ * @public
2180
2442
  * <p>The registry ID associated with the request.</p>
2181
2443
  */
2182
2444
  registryId?: string;
2183
2445
  /**
2446
+ * @public
2184
2447
  * <p>The repository name associated with the request.</p>
2185
2448
  */
2186
2449
  repositoryName?: string;
2187
2450
  /**
2451
+ * @public
2188
2452
  * <p>The JSON lifecycle policy text.</p>
2189
2453
  */
2190
2454
  lifecyclePolicyText?: string;
2191
2455
  /**
2456
+ * @public
2192
2457
  * <p>The time stamp of the last time that the lifecycle policy was run.</p>
2193
2458
  */
2194
2459
  lastEvaluatedAt?: Date;
@@ -2199,6 +2464,7 @@ export interface GetLifecyclePolicyResponse {
2199
2464
  */
2200
2465
  export interface LifecyclePolicyPreviewFilter {
2201
2466
  /**
2467
+ * @public
2202
2468
  * <p>The tag status of the image.</p>
2203
2469
  */
2204
2470
  tagStatus?: TagStatus | string;
@@ -2208,19 +2474,23 @@ export interface LifecyclePolicyPreviewFilter {
2208
2474
  */
2209
2475
  export interface GetLifecyclePolicyPreviewRequest {
2210
2476
  /**
2477
+ * @public
2211
2478
  * <p>The Amazon Web Services account ID associated with the registry that contains the repository.
2212
2479
  * If you do not specify a registry, the default registry is assumed.</p>
2213
2480
  */
2214
2481
  registryId?: string;
2215
2482
  /**
2483
+ * @public
2216
2484
  * <p>The name of the repository.</p>
2217
2485
  */
2218
2486
  repositoryName: string | undefined;
2219
2487
  /**
2488
+ * @public
2220
2489
  * <p>The list of imageIDs to be included.</p>
2221
2490
  */
2222
2491
  imageIds?: ImageIdentifier[];
2223
2492
  /**
2493
+ * @public
2224
2494
  * <p>The <code>nextToken</code> value returned from a previous paginated
2225
2495
  * <code>GetLifecyclePolicyPreviewRequest</code> request where <code>maxResults</code>
2226
2496
  * was used and the
@@ -2233,6 +2503,7 @@ export interface GetLifecyclePolicyPreviewRequest {
2233
2503
  */
2234
2504
  nextToken?: string;
2235
2505
  /**
2506
+ * @public
2236
2507
  * <p>The maximum number of repository results returned by
2237
2508
  * <code>GetLifecyclePolicyPreviewRequest</code> in
2238
2509
  paginated output. When this
@@ -2254,6 +2525,7 @@ export interface GetLifecyclePolicyPreviewRequest {
2254
2525
  */
2255
2526
  maxResults?: number;
2256
2527
  /**
2528
+ * @public
2257
2529
  * <p>An optional parameter that filters results based on image tag status and all tags, if
2258
2530
  * tagged.</p>
2259
2531
  */
@@ -2276,6 +2548,7 @@ export type ImageActionType = (typeof ImageActionType)[keyof typeof ImageActionT
2276
2548
  */
2277
2549
  export interface LifecyclePolicyRuleAction {
2278
2550
  /**
2551
+ * @public
2279
2552
  * <p>The type of action to be taken.</p>
2280
2553
  */
2281
2554
  type?: ImageActionType | string;
@@ -2286,23 +2559,28 @@ export interface LifecyclePolicyRuleAction {
2286
2559
  */
2287
2560
  export interface LifecyclePolicyPreviewResult {
2288
2561
  /**
2562
+ * @public
2289
2563
  * <p>The list of tags associated with this image.</p>
2290
2564
  */
2291
2565
  imageTags?: string[];
2292
2566
  /**
2567
+ * @public
2293
2568
  * <p>The <code>sha256</code> digest of the image manifest.</p>
2294
2569
  */
2295
2570
  imageDigest?: string;
2296
2571
  /**
2572
+ * @public
2297
2573
  * <p>The date and time, expressed in standard JavaScript date format, at which the current
2298
2574
  * image was pushed to the repository.</p>
2299
2575
  */
2300
2576
  imagePushedAt?: Date;
2301
2577
  /**
2578
+ * @public
2302
2579
  * <p>The type of action to be taken.</p>
2303
2580
  */
2304
2581
  action?: LifecyclePolicyRuleAction;
2305
2582
  /**
2583
+ * @public
2306
2584
  * <p>The priority of the applied rule.</p>
2307
2585
  */
2308
2586
  appliedRulePriority?: number;
@@ -2327,6 +2605,7 @@ export type LifecyclePolicyPreviewStatus = (typeof LifecyclePolicyPreviewStatus)
2327
2605
  */
2328
2606
  export interface LifecyclePolicyPreviewSummary {
2329
2607
  /**
2608
+ * @public
2330
2609
  * <p>The number of expiring images.</p>
2331
2610
  */
2332
2611
  expiringImageTotalCount?: number;
@@ -2336,22 +2615,27 @@ export interface LifecyclePolicyPreviewSummary {
2336
2615
  */
2337
2616
  export interface GetLifecyclePolicyPreviewResponse {
2338
2617
  /**
2618
+ * @public
2339
2619
  * <p>The registry ID associated with the request.</p>
2340
2620
  */
2341
2621
  registryId?: string;
2342
2622
  /**
2623
+ * @public
2343
2624
  * <p>The repository name associated with the request.</p>
2344
2625
  */
2345
2626
  repositoryName?: string;
2346
2627
  /**
2628
+ * @public
2347
2629
  * <p>The JSON lifecycle policy text.</p>
2348
2630
  */
2349
2631
  lifecyclePolicyText?: string;
2350
2632
  /**
2633
+ * @public
2351
2634
  * <p>The status of the lifecycle policy preview request.</p>
2352
2635
  */
2353
2636
  status?: LifecyclePolicyPreviewStatus | string;
2354
2637
  /**
2638
+ * @public
2355
2639
  * <p>The <code>nextToken</code> value to include in a future
2356
2640
  * <code>GetLifecyclePolicyPreview</code> request. When the results of a
2357
2641
  * <code>GetLifecyclePolicyPreview</code> request exceed <code>maxResults</code>, this
@@ -2360,10 +2644,12 @@ export interface GetLifecyclePolicyPreviewResponse {
2360
2644
  */
2361
2645
  nextToken?: string;
2362
2646
  /**
2647
+ * @public
2363
2648
  * <p>The results of the lifecycle policy preview request.</p>
2364
2649
  */
2365
2650
  previewResults?: LifecyclePolicyPreviewResult[];
2366
2651
  /**
2652
+ * @public
2367
2653
  * <p>The list of images that is returned as a result of the action.</p>
2368
2654
  */
2369
2655
  summary?: LifecyclePolicyPreviewSummary;
@@ -2390,10 +2676,12 @@ export interface GetRegistryPolicyRequest {
2390
2676
  */
2391
2677
  export interface GetRegistryPolicyResponse {
2392
2678
  /**
2679
+ * @public
2393
2680
  * <p>The ID of the registry.</p>
2394
2681
  */
2395
2682
  registryId?: string;
2396
2683
  /**
2684
+ * @public
2397
2685
  * <p>The JSON text of the permissions policy for a registry.</p>
2398
2686
  */
2399
2687
  policyText?: string;
@@ -2409,6 +2697,7 @@ export interface GetRegistryScanningConfigurationRequest {
2409
2697
  */
2410
2698
  export interface RegistryScanningRule {
2411
2699
  /**
2700
+ * @public
2412
2701
  * <p>The frequency that scans are performed at for a private registry. When the
2413
2702
  * <code>ENHANCED</code> scan type is specified, the supported scan frequencies are
2414
2703
  * <code>CONTINUOUS_SCAN</code> and <code>SCAN_ON_PUSH</code>. When the
@@ -2417,6 +2706,7 @@ export interface RegistryScanningRule {
2417
2706
  */
2418
2707
  scanFrequency: ScanFrequency | string | undefined;
2419
2708
  /**
2709
+ * @public
2420
2710
  * <p>The repository filters associated with the scanning configuration for a private
2421
2711
  * registry.</p>
2422
2712
  */
@@ -2440,10 +2730,12 @@ export type ScanType = (typeof ScanType)[keyof typeof ScanType];
2440
2730
  */
2441
2731
  export interface RegistryScanningConfiguration {
2442
2732
  /**
2733
+ * @public
2443
2734
  * <p>The type of scanning configured for the registry.</p>
2444
2735
  */
2445
2736
  scanType?: ScanType | string;
2446
2737
  /**
2738
+ * @public
2447
2739
  * <p>The scanning rules associated with the registry.</p>
2448
2740
  */
2449
2741
  rules?: RegistryScanningRule[];
@@ -2453,10 +2745,12 @@ export interface RegistryScanningConfiguration {
2453
2745
  */
2454
2746
  export interface GetRegistryScanningConfigurationResponse {
2455
2747
  /**
2748
+ * @public
2456
2749
  * <p>The ID of the registry.</p>
2457
2750
  */
2458
2751
  registryId?: string;
2459
2752
  /**
2753
+ * @public
2460
2754
  * <p>The scanning configuration for the registry.</p>
2461
2755
  */
2462
2756
  scanningConfiguration?: RegistryScanningConfiguration;
@@ -2466,11 +2760,13 @@ export interface GetRegistryScanningConfigurationResponse {
2466
2760
  */
2467
2761
  export interface GetRepositoryPolicyRequest {
2468
2762
  /**
2763
+ * @public
2469
2764
  * <p>The Amazon Web Services account ID associated with the registry that contains the repository.
2470
2765
  * If you do not specify a registry, the default registry is assumed.</p>
2471
2766
  */
2472
2767
  registryId?: string;
2473
2768
  /**
2769
+ * @public
2474
2770
  * <p>The name of the repository with the policy to retrieve.</p>
2475
2771
  */
2476
2772
  repositoryName: string | undefined;
@@ -2480,14 +2776,17 @@ export interface GetRepositoryPolicyRequest {
2480
2776
  */
2481
2777
  export interface GetRepositoryPolicyResponse {
2482
2778
  /**
2779
+ * @public
2483
2780
  * <p>The registry ID associated with the request.</p>
2484
2781
  */
2485
2782
  registryId?: string;
2486
2783
  /**
2784
+ * @public
2487
2785
  * <p>The repository name associated with the request.</p>
2488
2786
  */
2489
2787
  repositoryName?: string;
2490
2788
  /**
2789
+ * @public
2491
2790
  * <p>The JSON repository policy text associated with the repository.</p>
2492
2791
  */
2493
2792
  policyText?: string;
@@ -2497,11 +2796,13 @@ export interface GetRepositoryPolicyResponse {
2497
2796
  */
2498
2797
  export interface InitiateLayerUploadRequest {
2499
2798
  /**
2799
+ * @public
2500
2800
  * <p>The Amazon Web Services account ID associated with the registry to which you intend to upload
2501
2801
  * layers. If you do not specify a registry, the default registry is assumed.</p>
2502
2802
  */
2503
2803
  registryId?: string;
2504
2804
  /**
2805
+ * @public
2505
2806
  * <p>The name of the repository to which you intend to upload layers.</p>
2506
2807
  */
2507
2808
  repositoryName: string | undefined;
@@ -2511,11 +2812,13 @@ export interface InitiateLayerUploadRequest {
2511
2812
  */
2512
2813
  export interface InitiateLayerUploadResponse {
2513
2814
  /**
2815
+ * @public
2514
2816
  * <p>The upload ID for the layer upload. This parameter is passed to further <a>UploadLayerPart</a> and <a>CompleteLayerUpload</a>
2515
2817
  * operations.</p>
2516
2818
  */
2517
2819
  uploadId?: string;
2518
2820
  /**
2821
+ * @public
2519
2822
  * <p>The size, in bytes, that Amazon ECR expects future layer part uploads to be.</p>
2520
2823
  */
2521
2824
  partSize?: number;
@@ -2526,6 +2829,7 @@ export interface InitiateLayerUploadResponse {
2526
2829
  */
2527
2830
  export interface ListImagesFilter {
2528
2831
  /**
2832
+ * @public
2529
2833
  * <p>The tag status with which to filter your <a>ListImages</a> results. You can
2530
2834
  * filter results based on whether they are <code>TAGGED</code> or
2531
2835
  * <code>UNTAGGED</code>.</p>
@@ -2537,15 +2841,18 @@ export interface ListImagesFilter {
2537
2841
  */
2538
2842
  export interface ListImagesRequest {
2539
2843
  /**
2844
+ * @public
2540
2845
  * <p>The Amazon Web Services account ID associated with the registry that contains the repository in
2541
2846
  * which to list images. If you do not specify a registry, the default registry is assumed.</p>
2542
2847
  */
2543
2848
  registryId?: string;
2544
2849
  /**
2850
+ * @public
2545
2851
  * <p>The repository with image IDs to be listed.</p>
2546
2852
  */
2547
2853
  repositoryName: string | undefined;
2548
2854
  /**
2855
+ * @public
2549
2856
  * <p>The <code>nextToken</code> value returned from a previous paginated
2550
2857
  * <code>ListImages</code> request where <code>maxResults</code> was used and the
2551
2858
  * results exceeded the value of that parameter. Pagination continues from the end of the
@@ -2558,6 +2865,7 @@ export interface ListImagesRequest {
2558
2865
  */
2559
2866
  nextToken?: string;
2560
2867
  /**
2868
+ * @public
2561
2869
  * <p>The maximum number of image results returned by <code>ListImages</code> in paginated
2562
2870
  * output. When this parameter is used, <code>ListImages</code> only returns
2563
2871
  * <code>maxResults</code> results in a single page along with a <code>nextToken</code>
@@ -2569,6 +2877,7 @@ export interface ListImagesRequest {
2569
2877
  */
2570
2878
  maxResults?: number;
2571
2879
  /**
2880
+ * @public
2572
2881
  * <p>The filter key and value with which to filter your <code>ListImages</code>
2573
2882
  * results.</p>
2574
2883
  */
@@ -2579,10 +2888,12 @@ export interface ListImagesRequest {
2579
2888
  */
2580
2889
  export interface ListImagesResponse {
2581
2890
  /**
2891
+ * @public
2582
2892
  * <p>The list of image IDs for the requested repository.</p>
2583
2893
  */
2584
2894
  imageIds?: ImageIdentifier[];
2585
2895
  /**
2896
+ * @public
2586
2897
  * <p>The <code>nextToken</code> value to include in a future <code>ListImages</code>
2587
2898
  * request. When the results of a <code>ListImages</code> request exceed
2588
2899
  * <code>maxResults</code>, this value can be used to retrieve the next page of
@@ -2596,6 +2907,7 @@ export interface ListImagesResponse {
2596
2907
  */
2597
2908
  export interface ListTagsForResourceRequest {
2598
2909
  /**
2910
+ * @public
2599
2911
  * <p>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the
2600
2912
  * only supported resource is an Amazon ECR repository.</p>
2601
2913
  */
@@ -2606,6 +2918,7 @@ export interface ListTagsForResourceRequest {
2606
2918
  */
2607
2919
  export interface ListTagsForResourceResponse {
2608
2920
  /**
2921
+ * @public
2609
2922
  * <p>The tags for the resource.</p>
2610
2923
  */
2611
2924
  tags?: Tag[];
@@ -2654,30 +2967,36 @@ export declare class ImageTagAlreadyExistsException extends __BaseException {
2654
2967
  */
2655
2968
  export interface PutImageRequest {
2656
2969
  /**
2970
+ * @public
2657
2971
  * <p>The Amazon Web Services account ID associated with the registry that contains the repository in
2658
2972
  * which to put the image. If you do not specify a registry, the default registry is assumed.</p>
2659
2973
  */
2660
2974
  registryId?: string;
2661
2975
  /**
2976
+ * @public
2662
2977
  * <p>The name of the repository in which to put the image.</p>
2663
2978
  */
2664
2979
  repositoryName: string | undefined;
2665
2980
  /**
2981
+ * @public
2666
2982
  * <p>The image manifest corresponding to the image to be uploaded.</p>
2667
2983
  */
2668
2984
  imageManifest: string | undefined;
2669
2985
  /**
2986
+ * @public
2670
2987
  * <p>The media type of the image manifest. If you push an image manifest that does not
2671
2988
  * contain the <code>mediaType</code> field, you must specify the
2672
2989
  * <code>imageManifestMediaType</code> in the request.</p>
2673
2990
  */
2674
2991
  imageManifestMediaType?: string;
2675
2992
  /**
2993
+ * @public
2676
2994
  * <p>The tag to associate with the image. This parameter is required for images that use
2677
2995
  * the Docker Image Manifest V2 Schema 2 or Open Container Initiative (OCI) formats.</p>
2678
2996
  */
2679
2997
  imageTag?: string;
2680
2998
  /**
2999
+ * @public
2681
3000
  * <p>The image digest of the image manifest corresponding to the image.</p>
2682
3001
  */
2683
3002
  imageDigest?: string;
@@ -2687,6 +3006,7 @@ export interface PutImageRequest {
2687
3006
  */
2688
3007
  export interface PutImageResponse {
2689
3008
  /**
3009
+ * @public
2690
3010
  * <p>Details of the image uploaded.</p>
2691
3011
  */
2692
3012
  image?: Image;
@@ -2708,17 +3028,20 @@ export declare class ReferencedImagesNotFoundException extends __BaseException {
2708
3028
  */
2709
3029
  export interface PutImageScanningConfigurationRequest {
2710
3030
  /**
3031
+ * @public
2711
3032
  * <p>The Amazon Web Services account ID associated with the registry that contains the repository in
2712
3033
  * which to update the image scanning configuration setting.
2713
3034
  * If you do not specify a registry, the default registry is assumed.</p>
2714
3035
  */
2715
3036
  registryId?: string;
2716
3037
  /**
3038
+ * @public
2717
3039
  * <p>The name of the repository in which to update the image scanning configuration
2718
3040
  * setting.</p>
2719
3041
  */
2720
3042
  repositoryName: string | undefined;
2721
3043
  /**
3044
+ * @public
2722
3045
  * <p>The image scanning configuration for the repository. This setting determines whether
2723
3046
  * images are scanned for known vulnerabilities after being pushed to the
2724
3047
  * repository.</p>
@@ -2730,14 +3053,17 @@ export interface PutImageScanningConfigurationRequest {
2730
3053
  */
2731
3054
  export interface PutImageScanningConfigurationResponse {
2732
3055
  /**
3056
+ * @public
2733
3057
  * <p>The registry ID associated with the request.</p>
2734
3058
  */
2735
3059
  registryId?: string;
2736
3060
  /**
3061
+ * @public
2737
3062
  * <p>The repository name associated with the request.</p>
2738
3063
  */
2739
3064
  repositoryName?: string;
2740
3065
  /**
3066
+ * @public
2741
3067
  * <p>The image scanning configuration setting for the repository.</p>
2742
3068
  */
2743
3069
  imageScanningConfiguration?: ImageScanningConfiguration;
@@ -2747,16 +3073,19 @@ export interface PutImageScanningConfigurationResponse {
2747
3073
  */
2748
3074
  export interface PutImageTagMutabilityRequest {
2749
3075
  /**
3076
+ * @public
2750
3077
  * <p>The Amazon Web Services account ID associated with the registry that contains the repository in
2751
3078
  * which to update the image tag mutability settings. If you do not specify a registry, the default registry is assumed.</p>
2752
3079
  */
2753
3080
  registryId?: string;
2754
3081
  /**
3082
+ * @public
2755
3083
  * <p>The name of the repository in which to update the image tag mutability
2756
3084
  * settings.</p>
2757
3085
  */
2758
3086
  repositoryName: string | undefined;
2759
3087
  /**
3088
+ * @public
2760
3089
  * <p>The tag mutability setting for the repository. If <code>MUTABLE</code> is specified,
2761
3090
  * image tags can be overwritten. If <code>IMMUTABLE</code> is specified, all image tags
2762
3091
  * within the repository will be immutable which will prevent them from being
@@ -2769,14 +3098,17 @@ export interface PutImageTagMutabilityRequest {
2769
3098
  */
2770
3099
  export interface PutImageTagMutabilityResponse {
2771
3100
  /**
3101
+ * @public
2772
3102
  * <p>The registry ID associated with the request.</p>
2773
3103
  */
2774
3104
  registryId?: string;
2775
3105
  /**
3106
+ * @public
2776
3107
  * <p>The repository name associated with the request.</p>
2777
3108
  */
2778
3109
  repositoryName?: string;
2779
3110
  /**
3111
+ * @public
2780
3112
  * <p>The image tag mutability setting for the repository.</p>
2781
3113
  */
2782
3114
  imageTagMutability?: ImageTagMutability | string;
@@ -2786,16 +3118,19 @@ export interface PutImageTagMutabilityResponse {
2786
3118
  */
2787
3119
  export interface PutLifecyclePolicyRequest {
2788
3120
  /**
3121
+ * @public
2789
3122
  * <p>The Amazon Web Services account ID associated with the registry that contains the repository. If you
2790
3123
  * do
2791
3124
  not specify a registry, the default registry is assumed.</p>
2792
3125
  */
2793
3126
  registryId?: string;
2794
3127
  /**
3128
+ * @public
2795
3129
  * <p>The name of the repository to receive the policy.</p>
2796
3130
  */
2797
3131
  repositoryName: string | undefined;
2798
3132
  /**
3133
+ * @public
2799
3134
  * <p>The JSON repository policy text to apply to the repository.</p>
2800
3135
  */
2801
3136
  lifecyclePolicyText: string | undefined;
@@ -2805,14 +3140,17 @@ export interface PutLifecyclePolicyRequest {
2805
3140
  */
2806
3141
  export interface PutLifecyclePolicyResponse {
2807
3142
  /**
3143
+ * @public
2808
3144
  * <p>The registry ID associated with the request.</p>
2809
3145
  */
2810
3146
  registryId?: string;
2811
3147
  /**
3148
+ * @public
2812
3149
  * <p>The repository name associated with the request.</p>
2813
3150
  */
2814
3151
  repositoryName?: string;
2815
3152
  /**
3153
+ * @public
2816
3154
  * <p>The JSON repository policy text.</p>
2817
3155
  */
2818
3156
  lifecyclePolicyText?: string;
@@ -2822,6 +3160,7 @@ export interface PutLifecyclePolicyResponse {
2822
3160
  */
2823
3161
  export interface PutRegistryPolicyRequest {
2824
3162
  /**
3163
+ * @public
2825
3164
  * <p>The JSON policy text to apply to your registry. The policy text follows the same
2826
3165
  * format as IAM policy text. For more information, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry-permissions.html">Registry
2827
3166
  * permissions</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>
@@ -2833,10 +3172,12 @@ export interface PutRegistryPolicyRequest {
2833
3172
  */
2834
3173
  export interface PutRegistryPolicyResponse {
2835
3174
  /**
3175
+ * @public
2836
3176
  * <p>The registry ID.</p>
2837
3177
  */
2838
3178
  registryId?: string;
2839
3179
  /**
3180
+ * @public
2840
3181
  * <p>The JSON policy text for your registry.</p>
2841
3182
  */
2842
3183
  policyText?: string;
@@ -2846,6 +3187,7 @@ export interface PutRegistryPolicyResponse {
2846
3187
  */
2847
3188
  export interface PutRegistryScanningConfigurationRequest {
2848
3189
  /**
3190
+ * @public
2849
3191
  * <p>The scanning type to set for the registry.</p>
2850
3192
  * <p>When a registry scanning configuration is not defined, by default the
2851
3193
  * <code>BASIC</code> scan type is used. When basic scanning is used, you may specify
@@ -2859,6 +3201,7 @@ export interface PutRegistryScanningConfigurationRequest {
2859
3201
  */
2860
3202
  scanType?: ScanType | string;
2861
3203
  /**
3204
+ * @public
2862
3205
  * <p>The scanning rules to use for the registry. A scanning rule is used to determine which
2863
3206
  * repository filters are used and at what frequency scanning will occur.</p>
2864
3207
  */
@@ -2869,6 +3212,7 @@ export interface PutRegistryScanningConfigurationRequest {
2869
3212
  */
2870
3213
  export interface PutRegistryScanningConfigurationResponse {
2871
3214
  /**
3215
+ * @public
2872
3216
  * <p>The scanning configuration for your registry.</p>
2873
3217
  */
2874
3218
  registryScanningConfiguration?: RegistryScanningConfiguration;
@@ -2878,6 +3222,7 @@ export interface PutRegistryScanningConfigurationResponse {
2878
3222
  */
2879
3223
  export interface PutReplicationConfigurationRequest {
2880
3224
  /**
3225
+ * @public
2881
3226
  * <p>An object representing the replication configuration for a registry.</p>
2882
3227
  */
2883
3228
  replicationConfiguration: ReplicationConfiguration | undefined;
@@ -2887,6 +3232,7 @@ export interface PutReplicationConfigurationRequest {
2887
3232
  */
2888
3233
  export interface PutReplicationConfigurationResponse {
2889
3234
  /**
3235
+ * @public
2890
3236
  * <p>The contents of the replication configuration for the registry.</p>
2891
3237
  */
2892
3238
  replicationConfiguration?: ReplicationConfiguration;
@@ -2896,21 +3242,25 @@ export interface PutReplicationConfigurationResponse {
2896
3242
  */
2897
3243
  export interface SetRepositoryPolicyRequest {
2898
3244
  /**
3245
+ * @public
2899
3246
  * <p>The Amazon Web Services account ID associated with the registry that contains the repository.
2900
3247
  * If you do not specify a registry, the default registry is assumed.</p>
2901
3248
  */
2902
3249
  registryId?: string;
2903
3250
  /**
3251
+ * @public
2904
3252
  * <p>The name of the repository to receive the policy.</p>
2905
3253
  */
2906
3254
  repositoryName: string | undefined;
2907
3255
  /**
3256
+ * @public
2908
3257
  * <p>The JSON repository policy text to apply to the repository. For more information, see
2909
3258
  * <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html">Amazon ECR repository
2910
3259
  * policies</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>
2911
3260
  */
2912
3261
  policyText: string | undefined;
2913
3262
  /**
3263
+ * @public
2914
3264
  * <p>If the policy you are attempting to set on a repository policy would prevent you from
2915
3265
  * setting another policy in the future, you must force the <a>SetRepositoryPolicy</a> operation. This is intended to prevent accidental
2916
3266
  * repository lock outs.</p>
@@ -2922,14 +3272,17 @@ export interface SetRepositoryPolicyRequest {
2922
3272
  */
2923
3273
  export interface SetRepositoryPolicyResponse {
2924
3274
  /**
3275
+ * @public
2925
3276
  * <p>The registry ID associated with the request.</p>
2926
3277
  */
2927
3278
  registryId?: string;
2928
3279
  /**
3280
+ * @public
2929
3281
  * <p>The repository name associated with the request.</p>
2930
3282
  */
2931
3283
  repositoryName?: string;
2932
3284
  /**
3285
+ * @public
2933
3286
  * <p>The JSON repository policy text applied to the repository.</p>
2934
3287
  */
2935
3288
  policyText?: string;
@@ -2939,15 +3292,18 @@ export interface SetRepositoryPolicyResponse {
2939
3292
  */
2940
3293
  export interface StartImageScanRequest {
2941
3294
  /**
3295
+ * @public
2942
3296
  * <p>The Amazon Web Services account ID associated with the registry that contains the repository in
2943
3297
  * which to start an image scan request. If you do not specify a registry, the default registry is assumed.</p>
2944
3298
  */
2945
3299
  registryId?: string;
2946
3300
  /**
3301
+ * @public
2947
3302
  * <p>The name of the repository that contains the images to scan.</p>
2948
3303
  */
2949
3304
  repositoryName: string | undefined;
2950
3305
  /**
3306
+ * @public
2951
3307
  * <p>An object with identifying information for an image in an Amazon ECR repository.</p>
2952
3308
  */
2953
3309
  imageId: ImageIdentifier | undefined;
@@ -2957,18 +3313,22 @@ export interface StartImageScanRequest {
2957
3313
  */
2958
3314
  export interface StartImageScanResponse {
2959
3315
  /**
3316
+ * @public
2960
3317
  * <p>The registry ID associated with the request.</p>
2961
3318
  */
2962
3319
  registryId?: string;
2963
3320
  /**
3321
+ * @public
2964
3322
  * <p>The repository name associated with the request.</p>
2965
3323
  */
2966
3324
  repositoryName?: string;
2967
3325
  /**
3326
+ * @public
2968
3327
  * <p>An object with identifying information for an image in an Amazon ECR repository.</p>
2969
3328
  */
2970
3329
  imageId?: ImageIdentifier;
2971
3330
  /**
3331
+ * @public
2972
3332
  * <p>The current state of the scan.</p>
2973
3333
  */
2974
3334
  imageScanStatus?: ImageScanStatus;
@@ -3003,15 +3363,18 @@ export declare class LifecyclePolicyPreviewInProgressException extends __BaseExc
3003
3363
  */
3004
3364
  export interface StartLifecyclePolicyPreviewRequest {
3005
3365
  /**
3366
+ * @public
3006
3367
  * <p>The Amazon Web Services account ID associated with the registry that contains the repository.
3007
3368
  * If you do not specify a registry, the default registry is assumed.</p>
3008
3369
  */
3009
3370
  registryId?: string;
3010
3371
  /**
3372
+ * @public
3011
3373
  * <p>The name of the repository to be evaluated.</p>
3012
3374
  */
3013
3375
  repositoryName: string | undefined;
3014
3376
  /**
3377
+ * @public
3015
3378
  * <p>The policy to be evaluated against. If you do not specify a policy, the current policy
3016
3379
  * for the repository is used.</p>
3017
3380
  */
@@ -3022,18 +3385,22 @@ export interface StartLifecyclePolicyPreviewRequest {
3022
3385
  */
3023
3386
  export interface StartLifecyclePolicyPreviewResponse {
3024
3387
  /**
3388
+ * @public
3025
3389
  * <p>The registry ID associated with the request.</p>
3026
3390
  */
3027
3391
  registryId?: string;
3028
3392
  /**
3393
+ * @public
3029
3394
  * <p>The repository name associated with the request.</p>
3030
3395
  */
3031
3396
  repositoryName?: string;
3032
3397
  /**
3398
+ * @public
3033
3399
  * <p>The JSON repository policy text.</p>
3034
3400
  */
3035
3401
  lifecyclePolicyText?: string;
3036
3402
  /**
3403
+ * @public
3037
3404
  * <p>The status of the lifecycle policy preview request.</p>
3038
3405
  */
3039
3406
  status?: LifecyclePolicyPreviewStatus | string;
@@ -3043,11 +3410,13 @@ export interface StartLifecyclePolicyPreviewResponse {
3043
3410
  */
3044
3411
  export interface TagResourceRequest {
3045
3412
  /**
3413
+ * @public
3046
3414
  * <p>The Amazon Resource Name (ARN) of the the resource to which to add tags. Currently, the only supported
3047
3415
  * resource is an Amazon ECR repository.</p>
3048
3416
  */
3049
3417
  resourceArn: string | undefined;
3050
3418
  /**
3419
+ * @public
3051
3420
  * <p>The tags to add to the resource. A tag is an array of key-value pairs.
3052
3421
  * Tag keys can have a maximum character length of 128 characters, and tag values can have
3053
3422
  * a maximum length of 256 characters.</p>
@@ -3064,11 +3433,13 @@ export interface TagResourceResponse {
3064
3433
  */
3065
3434
  export interface UntagResourceRequest {
3066
3435
  /**
3436
+ * @public
3067
3437
  * <p>The Amazon Resource Name (ARN) of the resource from which to remove tags. Currently, the only supported
3068
3438
  * resource is an Amazon ECR repository.</p>
3069
3439
  */
3070
3440
  resourceArn: string | undefined;
3071
3441
  /**
3442
+ * @public
3072
3443
  * <p>The keys of the tags to be removed.</p>
3073
3444
  */
3074
3445
  tagKeys: string[] | undefined;
@@ -3087,18 +3458,22 @@ export declare class InvalidLayerPartException extends __BaseException {
3087
3458
  readonly name: "InvalidLayerPartException";
3088
3459
  readonly $fault: "client";
3089
3460
  /**
3461
+ * @public
3090
3462
  * <p>The registry ID associated with the exception.</p>
3091
3463
  */
3092
3464
  registryId?: string;
3093
3465
  /**
3466
+ * @public
3094
3467
  * <p>The repository name associated with the exception.</p>
3095
3468
  */
3096
3469
  repositoryName?: string;
3097
3470
  /**
3471
+ * @public
3098
3472
  * <p>The upload ID associated with the exception.</p>
3099
3473
  */
3100
3474
  uploadId?: string;
3101
3475
  /**
3476
+ * @public
3102
3477
  * <p>The last valid byte received from the layer part upload that is associated with the
3103
3478
  * exception.</p>
3104
3479
  */
@@ -3113,28 +3488,34 @@ export declare class InvalidLayerPartException extends __BaseException {
3113
3488
  */
3114
3489
  export interface UploadLayerPartRequest {
3115
3490
  /**
3491
+ * @public
3116
3492
  * <p>The Amazon Web Services account ID associated with the registry to which you are uploading layer
3117
3493
  * parts. If you do not specify a registry, the default registry is assumed.</p>
3118
3494
  */
3119
3495
  registryId?: string;
3120
3496
  /**
3497
+ * @public
3121
3498
  * <p>The name of the repository to which you are uploading layer parts.</p>
3122
3499
  */
3123
3500
  repositoryName: string | undefined;
3124
3501
  /**
3502
+ * @public
3125
3503
  * <p>The upload ID from a previous <a>InitiateLayerUpload</a> operation to
3126
3504
  * associate with the layer part upload.</p>
3127
3505
  */
3128
3506
  uploadId: string | undefined;
3129
3507
  /**
3508
+ * @public
3130
3509
  * <p>The position of the first byte of the layer part witin the overall image layer.</p>
3131
3510
  */
3132
3511
  partFirstByte: number | undefined;
3133
3512
  /**
3513
+ * @public
3134
3514
  * <p>The position of the last byte of the layer part within the overall image layer.</p>
3135
3515
  */
3136
3516
  partLastByte: number | undefined;
3137
3517
  /**
3518
+ * @public
3138
3519
  * <p>The base64-encoded layer part payload.</p>
3139
3520
  */
3140
3521
  layerPartBlob: Uint8Array | undefined;
@@ -3144,18 +3525,22 @@ export interface UploadLayerPartRequest {
3144
3525
  */
3145
3526
  export interface UploadLayerPartResponse {
3146
3527
  /**
3528
+ * @public
3147
3529
  * <p>The registry ID associated with the request.</p>
3148
3530
  */
3149
3531
  registryId?: string;
3150
3532
  /**
3533
+ * @public
3151
3534
  * <p>The repository name associated with the request.</p>
3152
3535
  */
3153
3536
  repositoryName?: string;
3154
3537
  /**
3538
+ * @public
3155
3539
  * <p>The upload ID associated with the request.</p>
3156
3540
  */
3157
3541
  uploadId?: string;
3158
3542
  /**
3543
+ * @public
3159
3544
  * <p>The integer value of the last byte received in the request.</p>
3160
3545
  */
3161
3546
  lastByteReceived?: number;