ecr.d.ts
74.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {WaiterConfiguration} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class ECR extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: ECR.Types.ClientConfiguration)
config: Config & ECR.Types.ClientConfiguration;
/**
* Checks the availability of one or more image layers in a repository. When an image is pushed to a repository, each image layer is checked to verify if it has been uploaded before. If it has been uploaded, then the image layer is skipped. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
*/
batchCheckLayerAvailability(params: ECR.Types.BatchCheckLayerAvailabilityRequest, callback?: (err: AWSError, data: ECR.Types.BatchCheckLayerAvailabilityResponse) => void): Request<ECR.Types.BatchCheckLayerAvailabilityResponse, AWSError>;
/**
* Checks the availability of one or more image layers in a repository. When an image is pushed to a repository, each image layer is checked to verify if it has been uploaded before. If it has been uploaded, then the image layer is skipped. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
*/
batchCheckLayerAvailability(callback?: (err: AWSError, data: ECR.Types.BatchCheckLayerAvailabilityResponse) => void): Request<ECR.Types.BatchCheckLayerAvailabilityResponse, AWSError>;
/**
* Deletes a list of specified images within a repository. Images are specified with either an imageTag or imageDigest. You can remove a tag from an image by specifying the image's tag in your request. When you remove the last tag from an image, the image is deleted from your repository. You can completely delete an image (and all of its tags) by specifying the image's digest in your request.
*/
batchDeleteImage(params: ECR.Types.BatchDeleteImageRequest, callback?: (err: AWSError, data: ECR.Types.BatchDeleteImageResponse) => void): Request<ECR.Types.BatchDeleteImageResponse, AWSError>;
/**
* Deletes a list of specified images within a repository. Images are specified with either an imageTag or imageDigest. You can remove a tag from an image by specifying the image's tag in your request. When you remove the last tag from an image, the image is deleted from your repository. You can completely delete an image (and all of its tags) by specifying the image's digest in your request.
*/
batchDeleteImage(callback?: (err: AWSError, data: ECR.Types.BatchDeleteImageResponse) => void): Request<ECR.Types.BatchDeleteImageResponse, AWSError>;
/**
* Gets detailed information for an image. Images are specified with either an imageTag or imageDigest. When an image is pulled, the BatchGetImage API is called once to retrieve the image manifest.
*/
batchGetImage(params: ECR.Types.BatchGetImageRequest, callback?: (err: AWSError, data: ECR.Types.BatchGetImageResponse) => void): Request<ECR.Types.BatchGetImageResponse, AWSError>;
/**
* Gets detailed information for an image. Images are specified with either an imageTag or imageDigest. When an image is pulled, the BatchGetImage API is called once to retrieve the image manifest.
*/
batchGetImage(callback?: (err: AWSError, data: ECR.Types.BatchGetImageResponse) => void): Request<ECR.Types.BatchGetImageResponse, AWSError>;
/**
* Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and upload ID. You can optionally provide a sha256 digest of the image layer for data validation purposes. When an image is pushed, the CompleteLayerUpload API is called once per each new image layer to verify that the upload has completed. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
*/
completeLayerUpload(params: ECR.Types.CompleteLayerUploadRequest, callback?: (err: AWSError, data: ECR.Types.CompleteLayerUploadResponse) => void): Request<ECR.Types.CompleteLayerUploadResponse, AWSError>;
/**
* Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and upload ID. You can optionally provide a sha256 digest of the image layer for data validation purposes. When an image is pushed, the CompleteLayerUpload API is called once per each new image layer to verify that the upload has completed. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
*/
completeLayerUpload(callback?: (err: AWSError, data: ECR.Types.CompleteLayerUploadResponse) => void): Request<ECR.Types.CompleteLayerUploadResponse, AWSError>;
/**
* Creates a repository. For more information, see Amazon ECR Repositories in the Amazon Elastic Container Registry User Guide.
*/
createRepository(params: ECR.Types.CreateRepositoryRequest, callback?: (err: AWSError, data: ECR.Types.CreateRepositoryResponse) => void): Request<ECR.Types.CreateRepositoryResponse, AWSError>;
/**
* Creates a repository. For more information, see Amazon ECR Repositories in the Amazon Elastic Container Registry User Guide.
*/
createRepository(callback?: (err: AWSError, data: ECR.Types.CreateRepositoryResponse) => void): Request<ECR.Types.CreateRepositoryResponse, AWSError>;
/**
* Deletes the lifecycle policy associated with the specified repository.
*/
deleteLifecyclePolicy(params: ECR.Types.DeleteLifecyclePolicyRequest, callback?: (err: AWSError, data: ECR.Types.DeleteLifecyclePolicyResponse) => void): Request<ECR.Types.DeleteLifecyclePolicyResponse, AWSError>;
/**
* Deletes the lifecycle policy associated with the specified repository.
*/
deleteLifecyclePolicy(callback?: (err: AWSError, data: ECR.Types.DeleteLifecyclePolicyResponse) => void): Request<ECR.Types.DeleteLifecyclePolicyResponse, AWSError>;
/**
* Deletes a repository. If the repository contains images, you must either delete all images in the repository or use the force option to delete the repository.
*/
deleteRepository(params: ECR.Types.DeleteRepositoryRequest, callback?: (err: AWSError, data: ECR.Types.DeleteRepositoryResponse) => void): Request<ECR.Types.DeleteRepositoryResponse, AWSError>;
/**
* Deletes a repository. If the repository contains images, you must either delete all images in the repository or use the force option to delete the repository.
*/
deleteRepository(callback?: (err: AWSError, data: ECR.Types.DeleteRepositoryResponse) => void): Request<ECR.Types.DeleteRepositoryResponse, AWSError>;
/**
* Deletes the repository policy associated with the specified repository.
*/
deleteRepositoryPolicy(params: ECR.Types.DeleteRepositoryPolicyRequest, callback?: (err: AWSError, data: ECR.Types.DeleteRepositoryPolicyResponse) => void): Request<ECR.Types.DeleteRepositoryPolicyResponse, AWSError>;
/**
* Deletes the repository policy associated with the specified repository.
*/
deleteRepositoryPolicy(callback?: (err: AWSError, data: ECR.Types.DeleteRepositoryPolicyResponse) => void): Request<ECR.Types.DeleteRepositoryPolicyResponse, AWSError>;
/**
* Returns the scan findings for the specified image.
*/
describeImageScanFindings(params: ECR.Types.DescribeImageScanFindingsRequest, callback?: (err: AWSError, data: ECR.Types.DescribeImageScanFindingsResponse) => void): Request<ECR.Types.DescribeImageScanFindingsResponse, AWSError>;
/**
* Returns the scan findings for the specified image.
*/
describeImageScanFindings(callback?: (err: AWSError, data: ECR.Types.DescribeImageScanFindingsResponse) => void): Request<ECR.Types.DescribeImageScanFindingsResponse, AWSError>;
/**
* Returns metadata about the images in a repository. Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by DescribeImages.
*/
describeImages(params: ECR.Types.DescribeImagesRequest, callback?: (err: AWSError, data: ECR.Types.DescribeImagesResponse) => void): Request<ECR.Types.DescribeImagesResponse, AWSError>;
/**
* Returns metadata about the images in a repository. Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by DescribeImages.
*/
describeImages(callback?: (err: AWSError, data: ECR.Types.DescribeImagesResponse) => void): Request<ECR.Types.DescribeImagesResponse, AWSError>;
/**
* Describes image repositories in a registry.
*/
describeRepositories(params: ECR.Types.DescribeRepositoriesRequest, callback?: (err: AWSError, data: ECR.Types.DescribeRepositoriesResponse) => void): Request<ECR.Types.DescribeRepositoriesResponse, AWSError>;
/**
* Describes image repositories in a registry.
*/
describeRepositories(callback?: (err: AWSError, data: ECR.Types.DescribeRepositoriesResponse) => void): Request<ECR.Types.DescribeRepositoriesResponse, AWSError>;
/**
* Retrieves an authorization token. An authorization token represents your IAM authentication credentials and can be used to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid for 12 hours. The authorizationToken returned is a base64 encoded string that can be decoded and used in a docker login command to authenticate to a registry. The AWS CLI offers an get-login-password command that simplifies the login process. For more information, see Registry Authentication in the Amazon Elastic Container Registry User Guide.
*/
getAuthorizationToken(params: ECR.Types.GetAuthorizationTokenRequest, callback?: (err: AWSError, data: ECR.Types.GetAuthorizationTokenResponse) => void): Request<ECR.Types.GetAuthorizationTokenResponse, AWSError>;
/**
* Retrieves an authorization token. An authorization token represents your IAM authentication credentials and can be used to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid for 12 hours. The authorizationToken returned is a base64 encoded string that can be decoded and used in a docker login command to authenticate to a registry. The AWS CLI offers an get-login-password command that simplifies the login process. For more information, see Registry Authentication in the Amazon Elastic Container Registry User Guide.
*/
getAuthorizationToken(callback?: (err: AWSError, data: ECR.Types.GetAuthorizationTokenResponse) => void): Request<ECR.Types.GetAuthorizationTokenResponse, AWSError>;
/**
* Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can only get URLs for image layers that are referenced in an image. When an image is pulled, the GetDownloadUrlForLayer API is called once per image layer that is not already cached. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
*/
getDownloadUrlForLayer(params: ECR.Types.GetDownloadUrlForLayerRequest, callback?: (err: AWSError, data: ECR.Types.GetDownloadUrlForLayerResponse) => void): Request<ECR.Types.GetDownloadUrlForLayerResponse, AWSError>;
/**
* Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can only get URLs for image layers that are referenced in an image. When an image is pulled, the GetDownloadUrlForLayer API is called once per image layer that is not already cached. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
*/
getDownloadUrlForLayer(callback?: (err: AWSError, data: ECR.Types.GetDownloadUrlForLayerResponse) => void): Request<ECR.Types.GetDownloadUrlForLayerResponse, AWSError>;
/**
* Retrieves the lifecycle policy for the specified repository.
*/
getLifecyclePolicy(params: ECR.Types.GetLifecyclePolicyRequest, callback?: (err: AWSError, data: ECR.Types.GetLifecyclePolicyResponse) => void): Request<ECR.Types.GetLifecyclePolicyResponse, AWSError>;
/**
* Retrieves the lifecycle policy for the specified repository.
*/
getLifecyclePolicy(callback?: (err: AWSError, data: ECR.Types.GetLifecyclePolicyResponse) => void): Request<ECR.Types.GetLifecyclePolicyResponse, AWSError>;
/**
* Retrieves the results of the lifecycle policy preview request for the specified repository.
*/
getLifecyclePolicyPreview(params: ECR.Types.GetLifecyclePolicyPreviewRequest, callback?: (err: AWSError, data: ECR.Types.GetLifecyclePolicyPreviewResponse) => void): Request<ECR.Types.GetLifecyclePolicyPreviewResponse, AWSError>;
/**
* Retrieves the results of the lifecycle policy preview request for the specified repository.
*/
getLifecyclePolicyPreview(callback?: (err: AWSError, data: ECR.Types.GetLifecyclePolicyPreviewResponse) => void): Request<ECR.Types.GetLifecyclePolicyPreviewResponse, AWSError>;
/**
* Retrieves the repository policy for the specified repository.
*/
getRepositoryPolicy(params: ECR.Types.GetRepositoryPolicyRequest, callback?: (err: AWSError, data: ECR.Types.GetRepositoryPolicyResponse) => void): Request<ECR.Types.GetRepositoryPolicyResponse, AWSError>;
/**
* Retrieves the repository policy for the specified repository.
*/
getRepositoryPolicy(callback?: (err: AWSError, data: ECR.Types.GetRepositoryPolicyResponse) => void): Request<ECR.Types.GetRepositoryPolicyResponse, AWSError>;
/**
* Notifies Amazon ECR that you intend to upload an image layer. When an image is pushed, the InitiateLayerUpload API is called once per image layer that has not already been uploaded. Whether or not an image layer has been uploaded is determined by the BatchCheckLayerAvailability API action. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
*/
initiateLayerUpload(params: ECR.Types.InitiateLayerUploadRequest, callback?: (err: AWSError, data: ECR.Types.InitiateLayerUploadResponse) => void): Request<ECR.Types.InitiateLayerUploadResponse, AWSError>;
/**
* Notifies Amazon ECR that you intend to upload an image layer. When an image is pushed, the InitiateLayerUpload API is called once per image layer that has not already been uploaded. Whether or not an image layer has been uploaded is determined by the BatchCheckLayerAvailability API action. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
*/
initiateLayerUpload(callback?: (err: AWSError, data: ECR.Types.InitiateLayerUploadResponse) => void): Request<ECR.Types.InitiateLayerUploadResponse, AWSError>;
/**
* Lists all the image IDs for the specified repository. You can filter images based on whether or not they are tagged by using the tagStatus filter and specifying either TAGGED, UNTAGGED or ANY. For example, you can filter your results to return only UNTAGGED images and then pipe that result to a BatchDeleteImage operation to delete them. Or, you can filter your results to return only TAGGED images to list all of the tags in your repository.
*/
listImages(params: ECR.Types.ListImagesRequest, callback?: (err: AWSError, data: ECR.Types.ListImagesResponse) => void): Request<ECR.Types.ListImagesResponse, AWSError>;
/**
* Lists all the image IDs for the specified repository. You can filter images based on whether or not they are tagged by using the tagStatus filter and specifying either TAGGED, UNTAGGED or ANY. For example, you can filter your results to return only UNTAGGED images and then pipe that result to a BatchDeleteImage operation to delete them. Or, you can filter your results to return only TAGGED images to list all of the tags in your repository.
*/
listImages(callback?: (err: AWSError, data: ECR.Types.ListImagesResponse) => void): Request<ECR.Types.ListImagesResponse, AWSError>;
/**
* List the tags for an Amazon ECR resource.
*/
listTagsForResource(params: ECR.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: ECR.Types.ListTagsForResourceResponse) => void): Request<ECR.Types.ListTagsForResourceResponse, AWSError>;
/**
* List the tags for an Amazon ECR resource.
*/
listTagsForResource(callback?: (err: AWSError, data: ECR.Types.ListTagsForResourceResponse) => void): Request<ECR.Types.ListTagsForResourceResponse, AWSError>;
/**
* Creates or updates the image manifest and tags associated with an image. When an image is pushed and all new image layers have been uploaded, the PutImage API is called once to create or update the image manifest and the tags associated with the image. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
*/
putImage(params: ECR.Types.PutImageRequest, callback?: (err: AWSError, data: ECR.Types.PutImageResponse) => void): Request<ECR.Types.PutImageResponse, AWSError>;
/**
* Creates or updates the image manifest and tags associated with an image. When an image is pushed and all new image layers have been uploaded, the PutImage API is called once to create or update the image manifest and the tags associated with the image. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
*/
putImage(callback?: (err: AWSError, data: ECR.Types.PutImageResponse) => void): Request<ECR.Types.PutImageResponse, AWSError>;
/**
* Updates the image scanning configuration for the specified repository.
*/
putImageScanningConfiguration(params: ECR.Types.PutImageScanningConfigurationRequest, callback?: (err: AWSError, data: ECR.Types.PutImageScanningConfigurationResponse) => void): Request<ECR.Types.PutImageScanningConfigurationResponse, AWSError>;
/**
* Updates the image scanning configuration for the specified repository.
*/
putImageScanningConfiguration(callback?: (err: AWSError, data: ECR.Types.PutImageScanningConfigurationResponse) => void): Request<ECR.Types.PutImageScanningConfigurationResponse, AWSError>;
/**
* Updates the image tag mutability settings for the specified repository. For more information, see Image Tag Mutability in the Amazon Elastic Container Registry User Guide.
*/
putImageTagMutability(params: ECR.Types.PutImageTagMutabilityRequest, callback?: (err: AWSError, data: ECR.Types.PutImageTagMutabilityResponse) => void): Request<ECR.Types.PutImageTagMutabilityResponse, AWSError>;
/**
* Updates the image tag mutability settings for the specified repository. For more information, see Image Tag Mutability in the Amazon Elastic Container Registry User Guide.
*/
putImageTagMutability(callback?: (err: AWSError, data: ECR.Types.PutImageTagMutabilityResponse) => void): Request<ECR.Types.PutImageTagMutabilityResponse, AWSError>;
/**
* Creates or updates the lifecycle policy for the specified repository. For more information, see Lifecycle Policy Template.
*/
putLifecyclePolicy(params: ECR.Types.PutLifecyclePolicyRequest, callback?: (err: AWSError, data: ECR.Types.PutLifecyclePolicyResponse) => void): Request<ECR.Types.PutLifecyclePolicyResponse, AWSError>;
/**
* Creates or updates the lifecycle policy for the specified repository. For more information, see Lifecycle Policy Template.
*/
putLifecyclePolicy(callback?: (err: AWSError, data: ECR.Types.PutLifecyclePolicyResponse) => void): Request<ECR.Types.PutLifecyclePolicyResponse, AWSError>;
/**
* Applies a repository policy to the specified repository to control access permissions. For more information, see Amazon ECR Repository Policies in the Amazon Elastic Container Registry User Guide.
*/
setRepositoryPolicy(params: ECR.Types.SetRepositoryPolicyRequest, callback?: (err: AWSError, data: ECR.Types.SetRepositoryPolicyResponse) => void): Request<ECR.Types.SetRepositoryPolicyResponse, AWSError>;
/**
* Applies a repository policy to the specified repository to control access permissions. For more information, see Amazon ECR Repository Policies in the Amazon Elastic Container Registry User Guide.
*/
setRepositoryPolicy(callback?: (err: AWSError, data: ECR.Types.SetRepositoryPolicyResponse) => void): Request<ECR.Types.SetRepositoryPolicyResponse, AWSError>;
/**
* Starts an image vulnerability scan. An image scan can only be started once per day on an individual image. This limit includes if an image was scanned on initial push. For more information, see Image Scanning in the Amazon Elastic Container Registry User Guide.
*/
startImageScan(params: ECR.Types.StartImageScanRequest, callback?: (err: AWSError, data: ECR.Types.StartImageScanResponse) => void): Request<ECR.Types.StartImageScanResponse, AWSError>;
/**
* Starts an image vulnerability scan. An image scan can only be started once per day on an individual image. This limit includes if an image was scanned on initial push. For more information, see Image Scanning in the Amazon Elastic Container Registry User Guide.
*/
startImageScan(callback?: (err: AWSError, data: ECR.Types.StartImageScanResponse) => void): Request<ECR.Types.StartImageScanResponse, AWSError>;
/**
* Starts a preview of a lifecycle policy for the specified repository. This allows you to see the results before associating the lifecycle policy with the repository.
*/
startLifecyclePolicyPreview(params: ECR.Types.StartLifecyclePolicyPreviewRequest, callback?: (err: AWSError, data: ECR.Types.StartLifecyclePolicyPreviewResponse) => void): Request<ECR.Types.StartLifecyclePolicyPreviewResponse, AWSError>;
/**
* Starts a preview of a lifecycle policy for the specified repository. This allows you to see the results before associating the lifecycle policy with the repository.
*/
startLifecyclePolicyPreview(callback?: (err: AWSError, data: ECR.Types.StartLifecyclePolicyPreviewResponse) => void): Request<ECR.Types.StartLifecyclePolicyPreviewResponse, AWSError>;
/**
* Adds specified tags to a resource with the specified ARN. Existing tags on a resource are not changed if they are not specified in the request parameters.
*/
tagResource(params: ECR.Types.TagResourceRequest, callback?: (err: AWSError, data: ECR.Types.TagResourceResponse) => void): Request<ECR.Types.TagResourceResponse, AWSError>;
/**
* Adds specified tags to a resource with the specified ARN. Existing tags on a resource are not changed if they are not specified in the request parameters.
*/
tagResource(callback?: (err: AWSError, data: ECR.Types.TagResourceResponse) => void): Request<ECR.Types.TagResourceResponse, AWSError>;
/**
* Deletes specified tags from a resource.
*/
untagResource(params: ECR.Types.UntagResourceRequest, callback?: (err: AWSError, data: ECR.Types.UntagResourceResponse) => void): Request<ECR.Types.UntagResourceResponse, AWSError>;
/**
* Deletes specified tags from a resource.
*/
untagResource(callback?: (err: AWSError, data: ECR.Types.UntagResourceResponse) => void): Request<ECR.Types.UntagResourceResponse, AWSError>;
/**
* Uploads an image layer part to Amazon ECR. When an image is pushed, each new image layer is uploaded in parts. The maximum size of each image layer part can be 20971520 bytes (or about 20MB). The UploadLayerPart API is called once per each new image layer part. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
*/
uploadLayerPart(params: ECR.Types.UploadLayerPartRequest, callback?: (err: AWSError, data: ECR.Types.UploadLayerPartResponse) => void): Request<ECR.Types.UploadLayerPartResponse, AWSError>;
/**
* Uploads an image layer part to Amazon ECR. When an image is pushed, each new image layer is uploaded in parts. The maximum size of each image layer part can be 20971520 bytes (or about 20MB). The UploadLayerPart API is called once per each new image layer part. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
*/
uploadLayerPart(callback?: (err: AWSError, data: ECR.Types.UploadLayerPartResponse) => void): Request<ECR.Types.UploadLayerPartResponse, AWSError>;
/**
* Waits for the imageScanComplete state by periodically calling the underlying ECR.describeImageScanFindingsoperation every 5 seconds (at most 60 times). Wait until an image scan is complete and findings can be accessed
*/
waitFor(state: "imageScanComplete", params: ECR.Types.DescribeImageScanFindingsRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ECR.Types.DescribeImageScanFindingsResponse) => void): Request<ECR.Types.DescribeImageScanFindingsResponse, AWSError>;
/**
* Waits for the imageScanComplete state by periodically calling the underlying ECR.describeImageScanFindingsoperation every 5 seconds (at most 60 times). Wait until an image scan is complete and findings can be accessed
*/
waitFor(state: "imageScanComplete", callback?: (err: AWSError, data: ECR.Types.DescribeImageScanFindingsResponse) => void): Request<ECR.Types.DescribeImageScanFindingsResponse, AWSError>;
/**
* Waits for the lifecyclePolicyPreviewComplete state by periodically calling the underlying ECR.getLifecyclePolicyPreviewoperation every 5 seconds (at most 20 times). Wait until a lifecycle policy preview request is complete and results can be accessed
*/
waitFor(state: "lifecyclePolicyPreviewComplete", params: ECR.Types.GetLifecyclePolicyPreviewRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: ECR.Types.GetLifecyclePolicyPreviewResponse) => void): Request<ECR.Types.GetLifecyclePolicyPreviewResponse, AWSError>;
/**
* Waits for the lifecyclePolicyPreviewComplete state by periodically calling the underlying ECR.getLifecyclePolicyPreviewoperation every 5 seconds (at most 20 times). Wait until a lifecycle policy preview request is complete and results can be accessed
*/
waitFor(state: "lifecyclePolicyPreviewComplete", callback?: (err: AWSError, data: ECR.Types.GetLifecyclePolicyPreviewResponse) => void): Request<ECR.Types.GetLifecyclePolicyPreviewResponse, AWSError>;
}
declare namespace ECR {
export type Arn = string;
export interface Attribute {
/**
* The attribute key.
*/
key: AttributeKey;
/**
* The value assigned to the attribute key.
*/
value?: AttributeValue;
}
export type AttributeKey = string;
export type AttributeList = Attribute[];
export type AttributeValue = string;
export interface AuthorizationData {
/**
* A base64-encoded string that contains authorization data for the specified Amazon ECR registry. When the string is decoded, it is presented in the format user:password for private registry authentication using docker login.
*/
authorizationToken?: Base64;
/**
* The Unix time in seconds and milliseconds when the authorization token expires. Authorization tokens are valid for 12 hours.
*/
expiresAt?: ExpirationTimestamp;
/**
* The registry URL to use for this authorization token in a docker login command. The Amazon ECR registry URL format is https://aws_account_id.dkr.ecr.region.amazonaws.com. For example, https://012345678910.dkr.ecr.us-east-1.amazonaws.com..
*/
proxyEndpoint?: ProxyEndpoint;
}
export type AuthorizationDataList = AuthorizationData[];
export type Base64 = string;
export interface BatchCheckLayerAvailabilityRequest {
/**
* The AWS account ID associated with the registry that contains the image layers to check. If you do not specify a registry, the default registry is assumed.
*/
registryId?: RegistryId;
/**
* The name of the repository that is associated with the image layers to check.
*/
repositoryName: RepositoryName;
/**
* The digests of the image layers to check.
*/
layerDigests: BatchedOperationLayerDigestList;
}
export interface BatchCheckLayerAvailabilityResponse {
/**
* A list of image layer objects corresponding to the image layer references in the request.
*/
layers?: LayerList;
/**
* Any failures associated with the call.
*/
failures?: LayerFailureList;
}
export interface BatchDeleteImageRequest {
/**
* The AWS account ID associated with the registry that contains the image to delete. If you do not specify a registry, the default registry is assumed.
*/
registryId?: RegistryId;
/**
* The repository that contains the image to delete.
*/
repositoryName: RepositoryName;
/**
* A list of image ID references that correspond to images to delete. The format of the imageIds reference is imageTag=tag or imageDigest=digest.
*/
imageIds: ImageIdentifierList;
}
export interface BatchDeleteImageResponse {
/**
* The image IDs of the deleted images.
*/
imageIds?: ImageIdentifierList;
/**
* Any failures associated with the call.
*/
failures?: ImageFailureList;
}
export interface BatchGetImageRequest {
/**
* The AWS account ID associated with the registry that contains the images to describe. If you do not specify a registry, the default registry is assumed.
*/
registryId?: RegistryId;
/**
* The repository that contains the images to describe.
*/
repositoryName: RepositoryName;
/**
* A list of image ID references that correspond to images to describe. The format of the imageIds reference is imageTag=tag or imageDigest=digest.
*/
imageIds: ImageIdentifierList;
/**
* The accepted media types for the request. Valid values: application/vnd.docker.distribution.manifest.v1+json | application/vnd.docker.distribution.manifest.v2+json | application/vnd.oci.image.manifest.v1+json
*/
acceptedMediaTypes?: MediaTypeList;
}
export interface BatchGetImageResponse {
/**
* A list of image objects corresponding to the image references in the request.
*/
images?: ImageList;
/**
* Any failures associated with the call.
*/
failures?: ImageFailureList;
}
export type BatchedOperationLayerDigest = string;
export type BatchedOperationLayerDigestList = BatchedOperationLayerDigest[];
export interface CompleteLayerUploadRequest {
/**
* The AWS account ID associated with the registry to which to upload layers. If you do not specify a registry, the default registry is assumed.
*/
registryId?: RegistryId;
/**
* The name of the repository to associate with the image layer.
*/
repositoryName: RepositoryName;
/**
* The upload ID from a previous InitiateLayerUpload operation to associate with the image layer.
*/
uploadId: UploadId;
/**
* The sha256 digest of the image layer.
*/
layerDigests: LayerDigestList;
}
export interface CompleteLayerUploadResponse {
/**
* The registry ID associated with the request.
*/
registryId?: RegistryId;
/**
* The repository name associated with the request.
*/
repositoryName?: RepositoryName;
/**
* The upload ID associated with the layer.
*/
uploadId?: UploadId;
/**
* The sha256 digest of the image layer.
*/
layerDigest?: LayerDigest;
}
export interface CreateRepositoryRequest {
/**
* The name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app).
*/
repositoryName: RepositoryName;
/**
* The metadata that you apply to the repository to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
*/
tags?: TagList;
/**
* The tag mutability setting for the repository. If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten. If IMMUTABLE is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.
*/
imageTagMutability?: ImageTagMutability;
/**
* The image scanning configuration for the repository. This determines whether images are scanned for known vulnerabilities after being pushed to the repository.
*/
imageScanningConfiguration?: ImageScanningConfiguration;
/**
* The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.
*/
encryptionConfiguration?: EncryptionConfiguration;
}
export interface CreateRepositoryResponse {
/**
* The repository that was created.
*/
repository?: Repository;
}
export type CreationTimestamp = Date;
export interface DeleteLifecyclePolicyRequest {
/**
* The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
*/
registryId?: RegistryId;
/**
* The name of the repository.
*/
repositoryName: RepositoryName;
}
export interface DeleteLifecyclePolicyResponse {
/**
* The registry ID associated with the request.
*/
registryId?: RegistryId;
/**
* The repository name associated with the request.
*/
repositoryName?: RepositoryName;
/**
* The JSON lifecycle policy text.
*/
lifecyclePolicyText?: LifecyclePolicyText;
/**
* The time stamp of the last time that the lifecycle policy was run.
*/
lastEvaluatedAt?: EvaluationTimestamp;
}
export interface DeleteRepositoryPolicyRequest {
/**
* The AWS account ID associated with the registry that contains the repository policy to delete. If you do not specify a registry, the default registry is assumed.
*/
registryId?: RegistryId;
/**
* The name of the repository that is associated with the repository policy to delete.
*/
repositoryName: RepositoryName;
}
export interface DeleteRepositoryPolicyResponse {
/**
* The registry ID associated with the request.
*/
registryId?: RegistryId;
/**
* The repository name associated with the request.
*/
repositoryName?: RepositoryName;
/**
* The JSON repository policy that was deleted from the repository.
*/
policyText?: RepositoryPolicyText;
}
export interface DeleteRepositoryRequest {
/**
* The AWS account ID associated with the registry that contains the repository to delete. If you do not specify a registry, the default registry is assumed.
*/
registryId?: RegistryId;
/**
* The name of the repository to delete.
*/
repositoryName: RepositoryName;
/**
* If a repository contains images, forces the deletion.
*/
force?: ForceFlag;
}
export interface DeleteRepositoryResponse {
/**
* The repository that was deleted.
*/
repository?: Repository;
}
export interface DescribeImageScanFindingsRequest {
/**
* The AWS account ID associated with the registry that contains the repository in which to describe the image scan findings for. If you do not specify a registry, the default registry is assumed.
*/
registryId?: RegistryId;
/**
* The repository for the image for which to describe the scan findings.
*/
repositoryName: RepositoryName;
imageId: ImageIdentifier;
/**
* The nextToken value returned from a previous paginated DescribeImageScanFindings request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
*/
nextToken?: NextToken;
/**
* The maximum number of image scan results returned by DescribeImageScanFindings in paginated output. When this parameter is used, DescribeImageScanFindings only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeImageScanFindings request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeImageScanFindings returns up to 100 results and a nextToken value, if applicable.
*/
maxResults?: MaxResults;
}
export interface DescribeImageScanFindingsResponse {
/**
* The registry ID associated with the request.
*/
registryId?: RegistryId;
/**
* The repository name associated with the request.
*/
repositoryName?: RepositoryName;
imageId?: ImageIdentifier;
/**
* The current state of the scan.
*/
imageScanStatus?: ImageScanStatus;
/**
* The information contained in the image scan findings.
*/
imageScanFindings?: ImageScanFindings;
/**
* The nextToken value to include in a future DescribeImageScanFindings request. When the results of a DescribeImageScanFindings request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
*/
nextToken?: NextToken;
}
export interface DescribeImagesFilter {
/**
* The tag status with which to filter your DescribeImages results. You can filter results based on whether they are TAGGED or UNTAGGED.
*/
tagStatus?: TagStatus;
}
export interface DescribeImagesRequest {
/**
* The AWS account ID associated with the registry that contains the repository in which to describe images. If you do not specify a registry, the default registry is assumed.
*/
registryId?: RegistryId;
/**
* The repository that contains the images to describe.
*/
repositoryName: RepositoryName;
/**
* The list of image IDs for the requested repository.
*/
imageIds?: ImageIdentifierList;
/**
* The nextToken value returned from a previous paginated DescribeImages request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return. This option cannot be used when you specify images with imageIds.
*/
nextToken?: NextToken;
/**
* The maximum number of repository results returned by DescribeImages in paginated output. When this parameter is used, DescribeImages only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeImages request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeImages returns up to 100 results and a nextToken value, if applicable. This option cannot be used when you specify images with imageIds.
*/
maxResults?: MaxResults;
/**
* The filter key and value with which to filter your DescribeImages results.
*/
filter?: DescribeImagesFilter;
}
export interface DescribeImagesResponse {
/**
* A list of ImageDetail objects that contain data about the image.
*/
imageDetails?: ImageDetailList;
/**
* The nextToken value to include in a future DescribeImages request. When the results of a DescribeImages request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
*/
nextToken?: NextToken;
}
export interface DescribeRepositoriesRequest {
/**
* The AWS account ID associated with the registry that contains the repositories to be described. If you do not specify a registry, the default registry is assumed.
*/
registryId?: RegistryId;
/**
* A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.
*/
repositoryNames?: RepositoryNameList;
/**
* The nextToken value returned from a previous paginated DescribeRepositories request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return. This option cannot be used when you specify repositories with repositoryNames. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
*/
nextToken?: NextToken;
/**
* The maximum number of repository results returned by DescribeRepositories in paginated output. When this parameter is used, DescribeRepositories only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeRepositories request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeRepositories returns up to 100 results and a nextToken value, if applicable. This option cannot be used when you specify repositories with repositoryNames.
*/
maxResults?: MaxResults;
}
export interface DescribeRepositoriesResponse {
/**
* A list of repository objects corresponding to valid repositories.
*/
repositories?: RepositoryList;
/**
* The nextToken value to include in a future DescribeRepositories request. When the results of a DescribeRepositories request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
*/
nextToken?: NextToken;
}
export interface EncryptionConfiguration {
/**
* The encryption type to use. If you use the KMS encryption type, the contents of the repository will be encrypted using server-side encryption with customer master keys (CMKs) stored in AWS KMS. When you use AWS KMS to encrypt your data, you can either use the default AWS managed CMK for Amazon ECR, or specify your own CMK, which you already created. For more information, see Protecting Data Using Server-Side Encryption with CMKs Stored in AWS Key Management Service (SSE-KMS) in the Amazon Simple Storage Service Console Developer Guide.. If you use the AES256 encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts the images in the repository using an AES-256 encryption algorithm. For more information, see Protecting Data Using Server-Side Encryption with Amazon S3-Managed Encryption Keys (SSE-S3) in the Amazon Simple Storage Service Console Developer Guide..
*/
encryptionType: EncryptionType;
/**
* If you use the KMS encryption type, specify the CMK to use for encryption. The alias, key ID, or full ARN of the CMK can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed CMK for Amazon ECR will be used.
*/
kmsKey?: KmsKey;
}
export type EncryptionType = "AES256"|"KMS"|string;
export type EvaluationTimestamp = Date;
export type ExpirationTimestamp = Date;
export type FindingDescription = string;
export type FindingName = string;
export type FindingSeverity = "INFORMATIONAL"|"LOW"|"MEDIUM"|"HIGH"|"CRITICAL"|"UNDEFINED"|string;
export type FindingSeverityCounts = {[key: string]: SeverityCount};
export type ForceFlag = boolean;
export type GetAuthorizationTokenRegistryIdList = RegistryId[];
export interface GetAuthorizationTokenRequest {
/**
* A list of AWS account IDs that are associated with the registries for which to get AuthorizationData objects. If you do not specify a registry, the default registry is assumed.
*/
registryIds?: GetAuthorizationTokenRegistryIdList;
}
export interface GetAuthorizationTokenResponse {
/**
* A list of authorization token data objects that correspond to the registryIds values in the request.
*/
authorizationData?: AuthorizationDataList;
}
export interface GetDownloadUrlForLayerRequest {
/**
* The AWS account ID associated with the registry that contains the image layer to download. If you do not specify a registry, the default registry is assumed.
*/
registryId?: RegistryId;
/**
* The name of the repository that is associated with the image layer to download.
*/
repositoryName: RepositoryName;
/**
* The digest of the image layer to download.
*/
layerDigest: LayerDigest;
}
export interface GetDownloadUrlForLayerResponse {
/**
* The pre-signed Amazon S3 download URL for the requested layer.
*/
downloadUrl?: Url;
/**
* The digest of the image layer to download.
*/
layerDigest?: LayerDigest;
}
export interface GetLifecyclePolicyPreviewRequest {
/**
* The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
*/
registryId?: RegistryId;
/**
* The name of the repository.
*/
repositoryName: RepositoryName;
/**
* The list of imageIDs to be included.
*/
imageIds?: ImageIdentifierList;
/**
* The nextToken value returned from a previous paginated
 GetLifecyclePolicyPreviewRequest request where maxResults was used and the
 results exceeded the value of that parameter. Pagination continues from the end of the
 previous results that returned the nextToken value. This value is
 null when there are no more results to return. This option cannot be used when you specify images with imageIds.
*/
nextToken?: NextToken;
/**
* The maximum number of repository results returned by GetLifecyclePolicyPreviewRequest in
 paginated output. When this parameter is used, GetLifecyclePolicyPreviewRequest only returns
 maxResults results in a single page along with a nextToken
 response element. The remaining results of the initial request can be seen by sending
 another GetLifecyclePolicyPreviewRequest request with the returned nextToken
 value. This value can be between 1 and 1000. If this
 parameter is not used, then GetLifecyclePolicyPreviewRequest returns up to
 100 results and a nextToken value, if
 applicable. This option cannot be used when you specify images with imageIds.
*/
maxResults?: LifecyclePreviewMaxResults;
/**
* An optional parameter that filters results based on image tag status and all tags, if tagged.
*/
filter?: LifecyclePolicyPreviewFilter;
}
export interface GetLifecyclePolicyPreviewResponse {
/**
* The registry ID associated with the request.
*/
registryId?: RegistryId;
/**
* The repository name associated with the request.
*/
repositoryName?: RepositoryName;
/**
* The JSON lifecycle policy text.
*/
lifecyclePolicyText?: LifecyclePolicyText;
/**
* The status of the lifecycle policy preview request.
*/
status?: LifecyclePolicyPreviewStatus;
/**
* The nextToken value to include in a future GetLifecyclePolicyPreview request. When the results of a GetLifecyclePolicyPreview request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
*/
nextToken?: NextToken;
/**
* The results of the lifecycle policy preview request.
*/
previewResults?: LifecyclePolicyPreviewResultList;
/**
* The list of images that is returned as a result of the action.
*/
summary?: LifecyclePolicyPreviewSummary;
}
export interface GetLifecyclePolicyRequest {
/**
* The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
*/
registryId?: RegistryId;
/**
* The name of the repository.
*/
repositoryName: RepositoryName;
}
export interface GetLifecyclePolicyResponse {
/**
* The registry ID associated with the request.
*/
registryId?: RegistryId;
/**
* The repository name associated with the request.
*/
repositoryName?: RepositoryName;
/**
* The JSON lifecycle policy text.
*/
lifecyclePolicyText?: LifecyclePolicyText;
/**
* The time stamp of the last time that the lifecycle policy was run.
*/
lastEvaluatedAt?: EvaluationTimestamp;
}
export interface GetRepositoryPolicyRequest {
/**
* The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
*/
registryId?: RegistryId;
/**
* The name of the repository with the policy to retrieve.
*/
repositoryName: RepositoryName;
}
export interface GetRepositoryPolicyResponse {
/**
* The registry ID associated with the request.
*/
registryId?: RegistryId;
/**
* The repository name associated with the request.
*/
repositoryName?: RepositoryName;
/**
* The JSON repository policy text associated with the repository.
*/
policyText?: RepositoryPolicyText;
}
export interface Image {
/**
* The AWS account ID associated with the registry containing the image.
*/
registryId?: RegistryId;
/**
* The name of the repository associated with the image.
*/
repositoryName?: RepositoryName;
/**
* An object containing the image tag and image digest associated with an image.
*/
imageId?: ImageIdentifier;
/**
* The image manifest associated with the image.
*/
imageManifest?: ImageManifest;
/**
* The manifest media type of the image.
*/
imageManifestMediaType?: MediaType;
}
export type ImageActionType = "EXPIRE"|string;
export type ImageCount = number;
export interface ImageDetail {
/**
* The AWS account ID associated with the registry to which this image belongs.
*/
registryId?: RegistryId;
/**
* The name of the repository to which this image belongs.
*/
repositoryName?: RepositoryName;
/**
* The sha256 digest of the image manifest.
*/
imageDigest?: ImageDigest;
/**
* The list of tags associated with this image.
*/
imageTags?: ImageTagList;
/**
* The size, in bytes, of the image in the repository. If the image is a manifest list, this will be the max size of all manifests in the list. Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by DescribeImages.
*/
imageSizeInBytes?: ImageSizeInBytes;
/**
* The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository.
*/
imagePushedAt?: PushTimestamp;
/**
* The current state of the scan.
*/
imageScanStatus?: ImageScanStatus;
/**
* A summary of the last completed image scan.
*/
imageScanFindingsSummary?: ImageScanFindingsSummary;
/**
* The media type of the image manifest.
*/
imageManifestMediaType?: MediaType;
/**
* The artifact media type of the image.
*/
artifactMediaType?: MediaType;
}
export type ImageDetailList = ImageDetail[];
export type ImageDigest = string;
export interface ImageFailure {
/**
* The image ID associated with the failure.
*/
imageId?: ImageIdentifier;
/**
* The code associated with the failure.
*/
failureCode?: ImageFailureCode;
/**
* The reason for the failure.
*/
failureReason?: ImageFailureReason;
}
export type ImageFailureCode = "InvalidImageDigest"|"InvalidImageTag"|"ImageTagDoesNotMatchDigest"|"ImageNotFound"|"MissingDigestAndTag"|"ImageReferencedByManifestList"|"KmsError"|string;
export type ImageFailureList = ImageFailure[];
export type ImageFailureReason = string;
export interface ImageIdentifier {
/**
* The sha256 digest of the image manifest.
*/
imageDigest?: ImageDigest;
/**
* The tag used for the image.
*/
imageTag?: ImageTag;
}
export type ImageIdentifierList = ImageIdentifier[];
export type ImageList = Image[];
export type ImageManifest = string;
export interface ImageScanFinding {
/**
* The name associated with the finding, usually a CVE number.
*/
name?: FindingName;
/**
* The description of the finding.
*/
description?: FindingDescription;
/**
* A link containing additional details about the security vulnerability.
*/
uri?: Url;
/**
* The finding severity.
*/
severity?: FindingSeverity;
/**
* A collection of attributes of the host from which the finding is generated.
*/
attributes?: AttributeList;
}
export type ImageScanFindingList = ImageScanFinding[];
export interface ImageScanFindings {
/**
* The time of the last completed image scan.
*/
imageScanCompletedAt?: ScanTimestamp;
/**
* The time when the vulnerability data was last scanned.
*/
vulnerabilitySourceUpdatedAt?: VulnerabilitySourceUpdateTimestamp;
/**
* The findings from the image scan.
*/
findings?: ImageScanFindingList;
/**
* The image vulnerability counts, sorted by severity.
*/
findingSeverityCounts?: FindingSeverityCounts;
}
export interface ImageScanFindingsSummary {
/**
* The time of the last completed image scan.
*/
imageScanCompletedAt?: ScanTimestamp;
/**
* The time when the vulnerability data was last scanned.
*/
vulnerabilitySourceUpdatedAt?: VulnerabilitySourceUpdateTimestamp;
/**
* The image vulnerability counts, sorted by severity.
*/
findingSeverityCounts?: FindingSeverityCounts;
}
export interface ImageScanStatus {
/**
* The current state of an image scan.
*/
status?: ScanStatus;
/**
* The description of the image scan status.
*/
description?: ScanStatusDescription;
}
export interface ImageScanningConfiguration {
/**
* The setting that determines whether images are scanned after being pushed to a repository. If set to true, images will be scanned after being pushed. If this parameter is not specified, it will default to false and images will not be scanned unless a scan is manually started with the StartImageScan API.
*/
scanOnPush?: ScanOnPushFlag;
}
export type ImageSizeInBytes = number;
export type ImageTag = string;
export type ImageTagList = ImageTag[];
export type ImageTagMutability = "MUTABLE"|"IMMUTABLE"|string;
export interface InitiateLayerUploadRequest {
/**
* The AWS account ID associated with the registry to which you intend to upload layers. If you do not specify a registry, the default registry is assumed.
*/
registryId?: RegistryId;
/**
* The name of the repository to which you intend to upload layers.
*/
repositoryName: RepositoryName;
}
export interface InitiateLayerUploadResponse {
/**
* The upload ID for the layer upload. This parameter is passed to further UploadLayerPart and CompleteLayerUpload operations.
*/
uploadId?: UploadId;
/**
* The size, in bytes, that Amazon ECR expects future layer part uploads to be.
*/
partSize?: PartSize;
}
export type KmsKey = string;
export interface Layer {
/**
* The sha256 digest of the image layer.
*/
layerDigest?: LayerDigest;
/**
* The availability status of the image layer.
*/
layerAvailability?: LayerAvailability;
/**
* The size, in bytes, of the image layer.
*/
layerSize?: LayerSizeInBytes;
/**
* The media type of the layer, such as application/vnd.docker.image.rootfs.diff.tar.gzip or application/vnd.oci.image.layer.v1.tar+gzip.
*/
mediaType?: MediaType;
}
export type LayerAvailability = "AVAILABLE"|"UNAVAILABLE"|string;
export type LayerDigest = string;
export type LayerDigestList = LayerDigest[];
export interface LayerFailure {
/**
* The layer digest associated with the failure.
*/
layerDigest?: BatchedOperationLayerDigest;
/**
* The failure code associated with the failure.
*/
failureCode?: LayerFailureCode;
/**
* The reason for the failure.
*/
failureReason?: LayerFailureReason;
}
export type LayerFailureCode = "InvalidLayerDigest"|"MissingLayerDigest"|string;
export type LayerFailureList = LayerFailure[];
export type LayerFailureReason = string;
export type LayerList = Layer[];
export type LayerPartBlob = Buffer|Uint8Array|Blob|string;
export type LayerSizeInBytes = number;
export interface LifecyclePolicyPreviewFilter {
/**
* The tag status of the image.
*/
tagStatus?: TagStatus;
}
export interface LifecyclePolicyPreviewResult {
/**
* The list of tags associated with this image.
*/
imageTags?: ImageTagList;
/**
* The sha256 digest of the image manifest.
*/
imageDigest?: ImageDigest;
/**
* The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository.
*/
imagePushedAt?: PushTimestamp;
/**
* The type of action to be taken.
*/
action?: LifecyclePolicyRuleAction;
/**
* The priority of the applied rule.
*/
appliedRulePriority?: LifecyclePolicyRulePriority;
}
export type LifecyclePolicyPreviewResultList = LifecyclePolicyPreviewResult[];
export type LifecyclePolicyPreviewStatus = "IN_PROGRESS"|"COMPLETE"|"EXPIRED"|"FAILED"|string;
export interface LifecyclePolicyPreviewSummary {
/**
* The number of expiring images.
*/
expiringImageTotalCount?: ImageCount;
}
export interface LifecyclePolicyRuleAction {
/**
* The type of action to be taken.
*/
type?: ImageActionType;
}
export type LifecyclePolicyRulePriority = number;
export type LifecyclePolicyText = string;
export type LifecyclePreviewMaxResults = number;
export interface ListImagesFilter {
/**
* The tag status with which to filter your ListImages results. You can filter results based on whether they are TAGGED or UNTAGGED.
*/
tagStatus?: TagStatus;
}
export interface ListImagesRequest {
/**
* The AWS account ID associated with the registry that contains the repository in which to list images. If you do not specify a registry, the default registry is assumed.
*/
registryId?: RegistryId;
/**
* The repository with image IDs to be listed.
*/
repositoryName: RepositoryName;
/**
* The nextToken value returned from a previous paginated ListImages request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
*/
nextToken?: NextToken;
/**
* The maximum number of image results returned by ListImages in paginated output. When this parameter is used, ListImages only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListImages request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then ListImages returns up to 100 results and a nextToken value, if applicable.
*/
maxResults?: MaxResults;
/**
* The filter key and value with which to filter your ListImages results.
*/
filter?: ListImagesFilter;
}
export interface ListImagesResponse {
/**
* The list of image IDs for the requested repository.
*/
imageIds?: ImageIdentifierList;
/**
* The nextToken value to include in a future ListImages request. When the results of a ListImages request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
*/
nextToken?: NextToken;
}
export interface ListTagsForResourceRequest {
/**
* The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the only supported resource is an Amazon ECR repository.
*/
resourceArn: Arn;
}
export interface ListTagsForResourceResponse {
/**
* The tags for the resource.
*/
tags?: TagList;
}
export type MaxResults = number;
export type MediaType = string;
export type MediaTypeList = MediaType[];
export type NextToken = string;
export type PartSize = number;
export type ProxyEndpoint = string;
export type PushTimestamp = Date;
export interface PutImageRequest {
/**
* The AWS account ID associated with the registry that contains the repository in which to put the image. If you do not specify a registry, the default registry is assumed.
*/
registryId?: RegistryId;
/**
* The name of the repository in which to put the image.
*/
repositoryName: RepositoryName;
/**
* The image manifest corresponding to the image to be uploaded.
*/
imageManifest: ImageManifest;
/**
* The media type of the image manifest. If you push an image manifest that does not contain the mediaType field, you must specify the imageManifestMediaType in the request.
*/
imageManifestMediaType?: MediaType;
/**
* The tag to associate with the image. This parameter is required for images that use the Docker Image Manifest V2 Schema 2 or Open Container Initiative (OCI) formats.
*/
imageTag?: ImageTag;
/**
* The image digest of the image manifest corresponding to the image.
*/
imageDigest?: ImageDigest;
}
export interface PutImageResponse {
/**
* Details of the image uploaded.
*/
image?: Image;
}
export interface PutImageScanningConfigurationRequest {
/**
* The AWS account ID associated with the registry that contains the repository in which to update the image scanning configuration setting. If you do not specify a registry, the default registry is assumed.
*/
registryId?: RegistryId;
/**
* The name of the repository in which to update the image scanning configuration setting.
*/
repositoryName: RepositoryName;
/**
* The image scanning configuration for the repository. This setting determines whether images are scanned for known vulnerabilities after being pushed to the repository.
*/
imageScanningConfiguration: ImageScanningConfiguration;
}
export interface PutImageScanningConfigurationResponse {
/**
* The registry ID associated with the request.
*/
registryId?: RegistryId;
/**
* The repository name associated with the request.
*/
repositoryName?: RepositoryName;
/**
* The image scanning configuration setting for the repository.
*/
imageScanningConfiguration?: ImageScanningConfiguration;
}
export interface PutImageTagMutabilityRequest {
/**
* The AWS account ID associated with the registry that contains the repository in which to update the image tag mutability settings. If you do not specify a registry, the default registry is assumed.
*/
registryId?: RegistryId;
/**
* The name of the repository in which to update the image tag mutability settings.
*/
repositoryName: RepositoryName;
/**
* The tag mutability setting for the repository. If MUTABLE is specified, image tags can be overwritten. If IMMUTABLE is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.
*/
imageTagMutability: ImageTagMutability;
}
export interface PutImageTagMutabilityResponse {
/**
* The registry ID associated with the request.
*/
registryId?: RegistryId;
/**
* The repository name associated with the request.
*/
repositoryName?: RepositoryName;
/**
* The image tag mutability setting for the repository.
*/
imageTagMutability?: ImageTagMutability;
}
export interface PutLifecyclePolicyRequest {
/**
* The AWS account ID associated with the registry that contains the repository. If you do
 not specify a registry, the default registry is assumed.
*/
registryId?: RegistryId;
/**
* The name of the repository to receive the policy.
*/
repositoryName: RepositoryName;
/**
* The JSON repository policy text to apply to the repository.
*/
lifecyclePolicyText: LifecyclePolicyText;
}
export interface PutLifecyclePolicyResponse {
/**
* The registry ID associated with the request.
*/
registryId?: RegistryId;
/**
* The repository name associated with the request.
*/
repositoryName?: RepositoryName;
/**
* The JSON repository policy text.
*/
lifecyclePolicyText?: LifecyclePolicyText;
}
export type RegistryId = string;
export interface Repository {
/**
* The Amazon Resource Name (ARN) that identifies the repository. The ARN contains the arn:aws:ecr namespace, followed by the region of the repository, AWS account ID of the repository owner, repository namespace, and repository name. For example, arn:aws:ecr:region:012345678910:repository/test.
*/
repositoryArn?: Arn;
/**
* The AWS account ID associated with the registry that contains the repository.
*/
registryId?: RegistryId;
/**
* The name of the repository.
*/
repositoryName?: RepositoryName;
/**
* The URI for the repository. You can use this URI for container image push and pull operations.
*/
repositoryUri?: Url;
/**
* The date and time, in JavaScript date format, when the repository was created.
*/
createdAt?: CreationTimestamp;
/**
* The tag mutability setting for the repository.
*/
imageTagMutability?: ImageTagMutability;
imageScanningConfiguration?: ImageScanningConfiguration;
/**
* The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.
*/
encryptionConfiguration?: EncryptionConfiguration;
}
export type RepositoryList = Repository[];
export type RepositoryName = string;
export type RepositoryNameList = RepositoryName[];
export type RepositoryPolicyText = string;
export type ScanOnPushFlag = boolean;
export type ScanStatus = "IN_PROGRESS"|"COMPLETE"|"FAILED"|string;
export type ScanStatusDescription = string;
export type ScanTimestamp = Date;
export interface SetRepositoryPolicyRequest {
/**
* The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
*/
registryId?: RegistryId;
/**
* The name of the repository to receive the policy.
*/
repositoryName: RepositoryName;
/**
* The JSON repository policy text to apply to the repository. For more information, see Amazon ECR Repository Policies in the Amazon Elastic Container Registry User Guide.
*/
policyText: RepositoryPolicyText;
/**
* If the policy you are attempting to set on a repository policy would prevent you from setting another policy in the future, you must force the SetRepositoryPolicy operation. This is intended to prevent accidental repository lock outs.
*/
force?: ForceFlag;
}
export interface SetRepositoryPolicyResponse {
/**
* The registry ID associated with the request.
*/
registryId?: RegistryId;
/**
* The repository name associated with the request.
*/
repositoryName?: RepositoryName;
/**
* The JSON repository policy text applied to the repository.
*/
policyText?: RepositoryPolicyText;
}
export type SeverityCount = number;
export interface StartImageScanRequest {
/**
* The AWS account ID associated with the registry that contains the repository in which to start an image scan request. If you do not specify a registry, the default registry is assumed.
*/
registryId?: RegistryId;
/**
* The name of the repository that contains the images to scan.
*/
repositoryName: RepositoryName;
imageId: ImageIdentifier;
}
export interface StartImageScanResponse {
/**
* The registry ID associated with the request.
*/
registryId?: RegistryId;
/**
* The repository name associated with the request.
*/
repositoryName?: RepositoryName;
imageId?: ImageIdentifier;
/**
* The current state of the scan.
*/
imageScanStatus?: ImageScanStatus;
}
export interface StartLifecyclePolicyPreviewRequest {
/**
* The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
*/
registryId?: RegistryId;
/**
* The name of the repository to be evaluated.
*/
repositoryName: RepositoryName;
/**
* The policy to be evaluated against. If you do not specify a policy, the current policy for the repository is used.
*/
lifecyclePolicyText?: LifecyclePolicyText;
}
export interface StartLifecyclePolicyPreviewResponse {
/**
* The registry ID associated with the request.
*/
registryId?: RegistryId;
/**
* The repository name associated with the request.
*/
repositoryName?: RepositoryName;
/**
* The JSON repository policy text.
*/
lifecyclePolicyText?: LifecyclePolicyText;
/**
* The status of the lifecycle policy preview request.
*/
status?: LifecyclePolicyPreviewStatus;
}
export interface Tag {
/**
* One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
*/
Key?: TagKey;
/**
* The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
*/
Value?: TagValue;
}
export type TagKey = string;
export type TagKeyList = TagKey[];
export type TagList = Tag[];
export interface TagResourceRequest {
/**
* The Amazon Resource Name (ARN) of the the resource to which to add tags. Currently, the only supported resource is an Amazon ECR repository.
*/
resourceArn: Arn;
/**
* The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
*/
tags: TagList;
}
export interface TagResourceResponse {
}
export type TagStatus = "TAGGED"|"UNTAGGED"|"ANY"|string;
export type TagValue = string;
export interface UntagResourceRequest {
/**
* The Amazon Resource Name (ARN) of the resource from which to remove tags. Currently, the only supported resource is an Amazon ECR repository.
*/
resourceArn: Arn;
/**
* The keys of the tags to be removed.
*/
tagKeys: TagKeyList;
}
export interface UntagResourceResponse {
}
export type UploadId = string;
export interface UploadLayerPartRequest {
/**
* The AWS account ID associated with the registry to which you are uploading layer parts. If you do not specify a registry, the default registry is assumed.
*/
registryId?: RegistryId;
/**
* The name of the repository to which you are uploading layer parts.
*/
repositoryName: RepositoryName;
/**
* The upload ID from a previous InitiateLayerUpload operation to associate with the layer part upload.
*/
uploadId: UploadId;
/**
* The position of the first byte of the layer part witin the overall image layer.
*/
partFirstByte: PartSize;
/**
* The position of the last byte of the layer part within the overall image layer.
*/
partLastByte: PartSize;
/**
* The base64-encoded layer part payload.
*/
layerPartBlob: LayerPartBlob;
}
export interface UploadLayerPartResponse {
/**
* The registry ID associated with the request.
*/
registryId?: RegistryId;
/**
* The repository name associated with the request.
*/
repositoryName?: RepositoryName;
/**
* The upload ID associated with the request.
*/
uploadId?: UploadId;
/**
* The integer value of the last byte received in the request.
*/
lastByteReceived?: PartSize;
}
export type Url = string;
export type VulnerabilitySourceUpdateTimestamp = Date;
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2015-09-21"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the ECR client.
*/
export import Types = ECR;
}
export = ECR;