/
models_0.ts
4294 lines (3726 loc) · 116 KB
/
models_0.ts
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
// smithy-typescript generated code
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
import { ECRServiceException as __BaseException } from "./ECRServiceException";
export interface BatchCheckLayerAvailabilityRequest {
/**
* <p>The Amazon Web Services 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.</p>
*/
registryId?: string;
/**
* <p>The name of the repository that is associated with the image layers to check.</p>
*/
repositoryName: string | undefined;
/**
* <p>The digests of the image layers to check.</p>
*/
layerDigests: string[] | undefined;
}
export enum LayerFailureCode {
InvalidLayerDigest = "InvalidLayerDigest",
MissingLayerDigest = "MissingLayerDigest",
}
/**
* <p>An object representing an Amazon ECR image layer failure.</p>
*/
export interface LayerFailure {
/**
* <p>The layer digest associated with the failure.</p>
*/
layerDigest?: string;
/**
* <p>The failure code associated with the failure.</p>
*/
failureCode?: LayerFailureCode | string;
/**
* <p>The reason for the failure.</p>
*/
failureReason?: string;
}
export enum LayerAvailability {
AVAILABLE = "AVAILABLE",
UNAVAILABLE = "UNAVAILABLE",
}
/**
* <p>An object representing an Amazon ECR image layer.</p>
*/
export interface Layer {
/**
* <p>The <code>sha256</code> digest of the image layer.</p>
*/
layerDigest?: string;
/**
* <p>The availability status of the image layer.</p>
*/
layerAvailability?: LayerAvailability | string;
/**
* <p>The size, in bytes, of the image layer.</p>
*/
layerSize?: number;
/**
* <p>The media type of the layer, such as
* <code>application/vnd.docker.image.rootfs.diff.tar.gzip</code> or
* <code>application/vnd.oci.image.layer.v1.tar+gzip</code>.</p>
*/
mediaType?: string;
}
export interface BatchCheckLayerAvailabilityResponse {
/**
* <p>A list of image layer objects corresponding to the image layer references in the
* request.</p>
*/
layers?: Layer[];
/**
* <p>Any failures associated with the call.</p>
*/
failures?: LayerFailure[];
}
/**
* <p>The specified parameter is invalid. Review the available parameters for the API
* request.</p>
*/
export class InvalidParameterException extends __BaseException {
readonly name: "InvalidParameterException" = "InvalidParameterException";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<InvalidParameterException, __BaseException>) {
super({
name: "InvalidParameterException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, InvalidParameterException.prototype);
}
}
/**
* <p>The specified repository could not be found. Check the spelling of the specified
* repository and ensure that you are performing operations on the correct registry.</p>
*/
export class RepositoryNotFoundException extends __BaseException {
readonly name: "RepositoryNotFoundException" = "RepositoryNotFoundException";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<RepositoryNotFoundException, __BaseException>) {
super({
name: "RepositoryNotFoundException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, RepositoryNotFoundException.prototype);
}
}
/**
* <p>These errors are usually caused by a server-side issue.</p>
*/
export class ServerException extends __BaseException {
readonly name: "ServerException" = "ServerException";
readonly $fault: "server" = "server";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<ServerException, __BaseException>) {
super({
name: "ServerException",
$fault: "server",
...opts,
});
Object.setPrototypeOf(this, ServerException.prototype);
}
}
/**
* <p>An object with identifying information for an image in an Amazon ECR repository.</p>
*/
export interface ImageIdentifier {
/**
* <p>The <code>sha256</code> digest of the image manifest.</p>
*/
imageDigest?: string;
/**
* <p>The tag used for the image.</p>
*/
imageTag?: string;
}
/**
* <p>Deletes specified images within a specified repository. Images are specified with
* either the <code>imageTag</code> or <code>imageDigest</code>.</p>
*/
export interface BatchDeleteImageRequest {
/**
* <p>The Amazon Web Services account ID associated with the registry that contains the image to delete.
* If you do not specify a registry, the default registry is assumed.</p>
*/
registryId?: string;
/**
* <p>The repository that contains the image to delete.</p>
*/
repositoryName: string | undefined;
/**
* <p>A list of image ID references that correspond to images to delete. The format of the
* <code>imageIds</code> reference is <code>imageTag=tag</code> or
* <code>imageDigest=digest</code>.</p>
*/
imageIds: ImageIdentifier[] | undefined;
}
export enum ImageFailureCode {
ImageNotFound = "ImageNotFound",
ImageReferencedByManifestList = "ImageReferencedByManifestList",
ImageTagDoesNotMatchDigest = "ImageTagDoesNotMatchDigest",
InvalidImageDigest = "InvalidImageDigest",
InvalidImageTag = "InvalidImageTag",
KmsError = "KmsError",
MissingDigestAndTag = "MissingDigestAndTag",
}
/**
* <p>An object representing an Amazon ECR image failure.</p>
*/
export interface ImageFailure {
/**
* <p>The image ID associated with the failure.</p>
*/
imageId?: ImageIdentifier;
/**
* <p>The code associated with the failure.</p>
*/
failureCode?: ImageFailureCode | string;
/**
* <p>The reason for the failure.</p>
*/
failureReason?: string;
}
export interface BatchDeleteImageResponse {
/**
* <p>The image IDs of the deleted images.</p>
*/
imageIds?: ImageIdentifier[];
/**
* <p>Any failures associated with the call.</p>
*/
failures?: ImageFailure[];
}
export interface BatchGetImageRequest {
/**
* <p>The Amazon Web Services account ID associated with the registry that contains the images to
* describe. If you do not specify a registry, the default registry is assumed.</p>
*/
registryId?: string;
/**
* <p>The repository that contains the images to describe.</p>
*/
repositoryName: string | undefined;
/**
* <p>A list of image ID references that correspond to images to describe. The format of the
* <code>imageIds</code> reference is <code>imageTag=tag</code> or
* <code>imageDigest=digest</code>.</p>
*/
imageIds: ImageIdentifier[] | undefined;
/**
* <p>The accepted media types for the request.</p>
* <p>Valid values: <code>application/vnd.docker.distribution.manifest.v1+json</code> |
* <code>application/vnd.docker.distribution.manifest.v2+json</code> |
* <code>application/vnd.oci.image.manifest.v1+json</code>
* </p>
*/
acceptedMediaTypes?: string[];
}
/**
* <p>An object representing an Amazon ECR image.</p>
*/
export interface Image {
/**
* <p>The Amazon Web Services account ID associated with the registry containing the image.</p>
*/
registryId?: string;
/**
* <p>The name of the repository associated with the image.</p>
*/
repositoryName?: string;
/**
* <p>An object containing the image tag and image digest associated with an image.</p>
*/
imageId?: ImageIdentifier;
/**
* <p>The image manifest associated with the image.</p>
*/
imageManifest?: string;
/**
* <p>The manifest media type of the image.</p>
*/
imageManifestMediaType?: string;
}
export interface BatchGetImageResponse {
/**
* <p>A list of image objects corresponding to the image references in the request.</p>
*/
images?: Image[];
/**
* <p>Any failures associated with the call.</p>
*/
failures?: ImageFailure[];
}
export interface BatchGetRepositoryScanningConfigurationRequest {
/**
* <p>One or more repository names to get the scanning configuration for.</p>
*/
repositoryNames: string[] | undefined;
}
export enum ScanningConfigurationFailureCode {
REPOSITORY_NOT_FOUND = "REPOSITORY_NOT_FOUND",
}
/**
* <p>The details about any failures associated with the scanning configuration of a
* repository.</p>
*/
export interface RepositoryScanningConfigurationFailure {
/**
* <p>The name of the repository.</p>
*/
repositoryName?: string;
/**
* <p>The failure code.</p>
*/
failureCode?: ScanningConfigurationFailureCode | string;
/**
* <p>The reason for the failure.</p>
*/
failureReason?: string;
}
export enum ScanningRepositoryFilterType {
WILDCARD = "WILDCARD",
}
/**
* <p>The details of a scanning repository filter. For more information on how to use
* filters, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning.html#image-scanning-filters">Using
* filters</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>
*/
export interface ScanningRepositoryFilter {
/**
* <p>The filter to use when scanning.</p>
*/
filter: string | undefined;
/**
* <p>The type associated with the filter.</p>
*/
filterType: ScanningRepositoryFilterType | string | undefined;
}
export enum ScanFrequency {
CONTINUOUS_SCAN = "CONTINUOUS_SCAN",
MANUAL = "MANUAL",
SCAN_ON_PUSH = "SCAN_ON_PUSH",
}
/**
* <p>The details of the scanning configuration for a repository.</p>
*/
export interface RepositoryScanningConfiguration {
/**
* <p>The ARN of the repository.</p>
*/
repositoryArn?: string;
/**
* <p>The name of the repository.</p>
*/
repositoryName?: string;
/**
* <p>Whether or not scan on push is configured for the repository.</p>
*/
scanOnPush?: boolean;
/**
* <p>The scan frequency for the repository.</p>
*/
scanFrequency?: ScanFrequency | string;
/**
* <p>The scan filters applied to the repository.</p>
*/
appliedScanFilters?: ScanningRepositoryFilter[];
}
export interface BatchGetRepositoryScanningConfigurationResponse {
/**
* <p>The scanning configuration for the requested repositories.</p>
*/
scanningConfigurations?: RepositoryScanningConfiguration[];
/**
* <p>Any failures associated with the call.</p>
*/
failures?: RepositoryScanningConfigurationFailure[];
}
/**
* <p>There was an exception validating this request.</p>
*/
export class ValidationException extends __BaseException {
readonly name: "ValidationException" = "ValidationException";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>) {
super({
name: "ValidationException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, ValidationException.prototype);
}
}
export interface CompleteLayerUploadRequest {
/**
* <p>The Amazon Web Services account ID associated with the registry to which to upload layers.
* If you do not specify a registry, the default registry is assumed.</p>
*/
registryId?: string;
/**
* <p>The name of the repository to associate with the image layer.</p>
*/
repositoryName: string | undefined;
/**
* <p>The upload ID from a previous <a>InitiateLayerUpload</a> operation to
* associate with the image layer.</p>
*/
uploadId: string | undefined;
/**
* <p>The <code>sha256</code> digest of the image layer.</p>
*/
layerDigests: string[] | undefined;
}
export interface CompleteLayerUploadResponse {
/**
* <p>The registry ID associated with the request.</p>
*/
registryId?: string;
/**
* <p>The repository name associated with the request.</p>
*/
repositoryName?: string;
/**
* <p>The upload ID associated with the layer.</p>
*/
uploadId?: string;
/**
* <p>The <code>sha256</code> digest of the image layer.</p>
*/
layerDigest?: string;
}
/**
* <p>The specified layer upload does not contain any layer parts.</p>
*/
export class EmptyUploadException extends __BaseException {
readonly name: "EmptyUploadException" = "EmptyUploadException";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<EmptyUploadException, __BaseException>) {
super({
name: "EmptyUploadException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, EmptyUploadException.prototype);
}
}
/**
* <p>The layer digest calculation performed by Amazon ECR upon receipt of the image layer does
* not match the digest specified.</p>
*/
export class InvalidLayerException extends __BaseException {
readonly name: "InvalidLayerException" = "InvalidLayerException";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<InvalidLayerException, __BaseException>) {
super({
name: "InvalidLayerException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, InvalidLayerException.prototype);
}
}
/**
* <p>The operation failed due to a KMS exception.</p>
*/
export class KmsException extends __BaseException {
readonly name: "KmsException" = "KmsException";
readonly $fault: "client" = "client";
/**
* <p>The error code returned by KMS.</p>
*/
kmsError?: string;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<KmsException, __BaseException>) {
super({
name: "KmsException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, KmsException.prototype);
this.kmsError = opts.kmsError;
}
}
/**
* <p>The image layer already exists in the associated repository.</p>
*/
export class LayerAlreadyExistsException extends __BaseException {
readonly name: "LayerAlreadyExistsException" = "LayerAlreadyExistsException";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<LayerAlreadyExistsException, __BaseException>) {
super({
name: "LayerAlreadyExistsException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, LayerAlreadyExistsException.prototype);
}
}
/**
* <p>Layer parts must be at least 5 MiB in size.</p>
*/
export class LayerPartTooSmallException extends __BaseException {
readonly name: "LayerPartTooSmallException" = "LayerPartTooSmallException";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<LayerPartTooSmallException, __BaseException>) {
super({
name: "LayerPartTooSmallException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, LayerPartTooSmallException.prototype);
}
}
/**
* <p>The upload could not be found, or the specified upload ID is not valid for this
* repository.</p>
*/
export class UploadNotFoundException extends __BaseException {
readonly name: "UploadNotFoundException" = "UploadNotFoundException";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<UploadNotFoundException, __BaseException>) {
super({
name: "UploadNotFoundException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, UploadNotFoundException.prototype);
}
}
export interface CreatePullThroughCacheRuleRequest {
/**
* <p>The repository name prefix to use when caching images from the source registry.</p>
*/
ecrRepositoryPrefix: string | undefined;
/**
* <p>The registry URL of the upstream public registry to use as the source for the pull
* through cache rule.</p>
*/
upstreamRegistryUrl: string | undefined;
/**
* <p>The Amazon Web Services account ID associated with the registry to create the pull through cache
* rule for. If you do not specify a registry, the default registry is assumed.</p>
*/
registryId?: string;
}
export interface CreatePullThroughCacheRuleResponse {
/**
* <p>The Amazon ECR repository prefix associated with the pull through cache rule.</p>
*/
ecrRepositoryPrefix?: string;
/**
* <p>The upstream registry URL associated with the pull through cache rule.</p>
*/
upstreamRegistryUrl?: string;
/**
* <p>The date and time, in JavaScript date format, when the pull through cache rule was
* created.</p>
*/
createdAt?: Date;
/**
* <p>The registry ID associated with the request.</p>
*/
registryId?: string;
}
/**
* <p>The operation did not succeed because it would have exceeded a service limit for your
* account. For more information, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/service-quotas.html">Amazon ECR service quotas</a> in
* the Amazon Elastic Container Registry User Guide.</p>
*/
export class LimitExceededException extends __BaseException {
readonly name: "LimitExceededException" = "LimitExceededException";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>) {
super({
name: "LimitExceededException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, LimitExceededException.prototype);
}
}
/**
* <p>A pull through cache rule with these settings already exists for the private
* registry.</p>
*/
export class PullThroughCacheRuleAlreadyExistsException extends __BaseException {
readonly name: "PullThroughCacheRuleAlreadyExistsException" = "PullThroughCacheRuleAlreadyExistsException";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<PullThroughCacheRuleAlreadyExistsException, __BaseException>) {
super({
name: "PullThroughCacheRuleAlreadyExistsException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, PullThroughCacheRuleAlreadyExistsException.prototype);
}
}
/**
* <p>The specified upstream registry isn't supported.</p>
*/
export class UnsupportedUpstreamRegistryException extends __BaseException {
readonly name: "UnsupportedUpstreamRegistryException" = "UnsupportedUpstreamRegistryException";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<UnsupportedUpstreamRegistryException, __BaseException>) {
super({
name: "UnsupportedUpstreamRegistryException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, UnsupportedUpstreamRegistryException.prototype);
}
}
export enum EncryptionType {
AES256 = "AES256",
KMS = "KMS",
}
/**
* <p>The encryption configuration for the repository. This determines how the contents of
* your repository are encrypted at rest.</p>
* <p>By default, when no encryption configuration is set or the <code>AES256</code>
* encryption type is used, Amazon ECR uses server-side encryption with Amazon S3-managed encryption
* keys which encrypts your data at rest using an AES-256 encryption algorithm. This does
* not require any action on your part.</p>
* <p>For more control over the encryption of the contents of your repository, you can use
* server-side encryption with Key Management Service key stored in Key Management Service (KMS) to encrypt your
* images. For more information, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html">Amazon ECR encryption at
* rest</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>
*/
export interface EncryptionConfiguration {
/**
* <p>The encryption type to use.</p>
* <p>If you use the <code>KMS</code> encryption type, the contents of the repository will
* be encrypted using server-side encryption with Key Management Service key stored in KMS. When you
* use KMS to encrypt your data, you can either use the default Amazon Web Services managed KMS key
* for Amazon ECR, or specify your own KMS key, which you already created. For more
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html">Protecting data using server-side
* encryption with an KMS key stored in Key Management Service (SSE-KMS)</a> in the
* <i>Amazon Simple Storage Service Console Developer Guide</i>.</p>
* <p>If you use the <code>AES256</code> 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html">Protecting data using
* server-side encryption with Amazon S3-managed encryption keys (SSE-S3)</a> in the
* <i>Amazon Simple Storage Service Console Developer Guide</i>.</p>
*/
encryptionType: EncryptionType | string | undefined;
/**
* <p>If you use the <code>KMS</code> encryption type, specify the KMS key to use for
* encryption. The alias, key ID, or full ARN of the KMS key can be specified. The key
* must exist in the same Region as the repository. If no key is specified, the default
* Amazon Web Services managed KMS key for Amazon ECR will be used.</p>
*/
kmsKey?: string;
}
/**
* <p>The image scanning configuration for a repository.</p>
*/
export interface ImageScanningConfiguration {
/**
* <p>The setting that determines whether images are scanned after being pushed to a
* repository. If set to <code>true</code>, images will be scanned after being pushed. If
* this parameter is not specified, it will default to <code>false</code> and images will
* not be scanned unless a scan is manually started with the <a href="https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_StartImageScan.html">API_StartImageScan</a> API.</p>
*/
scanOnPush?: boolean;
}
export enum ImageTagMutability {
IMMUTABLE = "IMMUTABLE",
MUTABLE = "MUTABLE",
}
/**
* <p>The metadata to apply to a resource to help you categorize and organize them. Each tag
* consists of a key and a 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.</p>
*/
export interface Tag {
/**
* <p>One part of a key-value pair that make up a tag. A <code>key</code> is a general label
* that acts like a category for more specific tag values.</p>
*/
Key?: string;
/**
* <p>A <code>value</code> acts as a descriptor within a tag category (key).</p>
*/
Value?: string;
}
export interface CreateRepositoryRequest {
/**
* <p>The Amazon Web Services account ID associated with the registry to create the repository.
* If you do not specify a registry, the default registry is assumed.</p>
*/
registryId?: string;
/**
* <p>The name to use for the repository. The repository name may be specified on its own
* (such as <code>nginx-web-app</code>) or it can be prepended with a namespace to group
* the repository into a category (such as <code>project-a/nginx-web-app</code>).</p>
*/
repositoryName: string | undefined;
/**
* <p>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.</p>
*/
tags?: Tag[];
/**
* <p>The tag mutability setting for the repository. If this parameter is omitted, the
* default setting of <code>MUTABLE</code> will be used which will allow image tags to be
* overwritten. If <code>IMMUTABLE</code> is specified, all image tags within the
* repository will be immutable which will prevent them from being overwritten.</p>
*/
imageTagMutability?: ImageTagMutability | string;
/**
* <p>The image scanning configuration for the repository. This determines whether images
* are scanned for known vulnerabilities after being pushed to the repository.</p>
*/
imageScanningConfiguration?: ImageScanningConfiguration;
/**
* <p>The encryption configuration for the repository. This determines how the contents of
* your repository are encrypted at rest.</p>
*/
encryptionConfiguration?: EncryptionConfiguration;
}
/**
* <p>An object representing a repository.</p>
*/
export interface Repository {
/**
* <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
* repository, Amazon Web Services account ID of the repository owner, repository namespace, and repository name.
* For example, <code>arn:aws:ecr:region:012345678910:repository/test</code>.</p>
*/
repositoryArn?: string;
/**
* <p>The Amazon Web Services account ID associated with the registry that contains the repository.</p>
*/
registryId?: string;
/**
* <p>The name of the repository.</p>
*/
repositoryName?: string;
/**
* <p>The URI for the repository. You can use this URI for container image <code>push</code>
* and <code>pull</code> operations.</p>
*/
repositoryUri?: string;
/**
* <p>The date and time, in JavaScript date format, when the repository was created.</p>
*/
createdAt?: Date;
/**
* <p>The tag mutability setting for the repository.</p>
*/
imageTagMutability?: ImageTagMutability | string;
/**
* <p>The image scanning configuration for a repository.</p>
*/
imageScanningConfiguration?: ImageScanningConfiguration;
/**
* <p>The encryption configuration for the repository. This determines how the contents of
* your repository are encrypted at rest.</p>
*/
encryptionConfiguration?: EncryptionConfiguration;
}
export interface CreateRepositoryResponse {
/**
* <p>The repository that was created.</p>
*/
repository?: Repository;
}
/**
* <p>An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters, and tag values can have
* a maximum length of 256 characters.</p>
*/
export class InvalidTagParameterException extends __BaseException {
readonly name: "InvalidTagParameterException" = "InvalidTagParameterException";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<InvalidTagParameterException, __BaseException>) {
super({
name: "InvalidTagParameterException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, InvalidTagParameterException.prototype);
}
}
/**
* <p>The specified repository already exists in the specified registry.</p>
*/
export class RepositoryAlreadyExistsException extends __BaseException {
readonly name: "RepositoryAlreadyExistsException" = "RepositoryAlreadyExistsException";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<RepositoryAlreadyExistsException, __BaseException>) {
super({
name: "RepositoryAlreadyExistsException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, RepositoryAlreadyExistsException.prototype);
}
}
/**
* <p>The list of tags on the repository is over the limit. The maximum number of tags that
* can be applied to a repository is 50.</p>
*/
export class TooManyTagsException extends __BaseException {
readonly name: "TooManyTagsException" = "TooManyTagsException";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<TooManyTagsException, __BaseException>) {
super({
name: "TooManyTagsException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, TooManyTagsException.prototype);
}
}
export interface DeleteLifecyclePolicyRequest {
/**
* <p>The Amazon Web Services account ID associated with the registry that contains the repository.
* If you do not specify a registry, the default registry is assumed.</p>
*/
registryId?: string;
/**
* <p>The name of the repository.</p>
*/
repositoryName: string | undefined;
}
export interface DeleteLifecyclePolicyResponse {
/**
* <p>The registry ID associated with the request.</p>
*/
registryId?: string;
/**
* <p>The repository name associated with the request.</p>
*/
repositoryName?: string;
/**
* <p>The JSON lifecycle policy text.</p>
*/
lifecyclePolicyText?: string;
/**
* <p>The time stamp of the last time that the lifecycle policy was run.</p>
*/
lastEvaluatedAt?: Date;
}
/**
* <p>The lifecycle policy could not be found, and no policy is set to the
* repository.</p>
*/
export class LifecyclePolicyNotFoundException extends __BaseException {
readonly name: "LifecyclePolicyNotFoundException" = "LifecyclePolicyNotFoundException";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<LifecyclePolicyNotFoundException, __BaseException>) {
super({
name: "LifecyclePolicyNotFoundException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, LifecyclePolicyNotFoundException.prototype);
}
}
export interface DeletePullThroughCacheRuleRequest {
/**
* <p>The Amazon ECR repository prefix associated with the pull through cache rule to
* delete.</p>
*/
ecrRepositoryPrefix: string | undefined;
/**
* <p>The Amazon Web Services account ID associated with the registry that contains the pull through cache
* rule. If you do not specify a registry, the default registry is assumed.</p>
*/
registryId?: string;
}