@aws-sdk/client-batch 3.301.0 → 3.303.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2,11 +2,16 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-cl
2
2
  import { BatchServiceException as __BaseException } from "./BatchServiceException";
3
3
  /**
4
4
  * @public
5
+ * @enum
5
6
  */
6
- export declare enum ArrayJobDependency {
7
- N_TO_N = "N_TO_N",
8
- SEQUENTIAL = "SEQUENTIAL"
9
- }
7
+ export declare const ArrayJobDependency: {
8
+ readonly N_TO_N: "N_TO_N";
9
+ readonly SEQUENTIAL: "SEQUENTIAL";
10
+ };
11
+ /**
12
+ * @public
13
+ */
14
+ export type ArrayJobDependency = (typeof ArrayJobDependency)[keyof typeof ArrayJobDependency];
10
15
  /**
11
16
  * @public
12
17
  * <p>An object that represents an Batch array job.</p>
@@ -54,11 +59,16 @@ export interface ArrayPropertiesSummary {
54
59
  }
55
60
  /**
56
61
  * @public
62
+ * @enum
57
63
  */
58
- export declare enum AssignPublicIp {
59
- DISABLED = "DISABLED",
60
- ENABLED = "ENABLED"
61
- }
64
+ export declare const AssignPublicIp: {
65
+ readonly DISABLED: "DISABLED";
66
+ readonly ENABLED: "ENABLED";
67
+ };
68
+ /**
69
+ * @public
70
+ */
71
+ export type AssignPublicIp = (typeof AssignPublicIp)[keyof typeof AssignPublicIp];
62
72
  /**
63
73
  * @public
64
74
  * <p>An object that represents the elastic network interface for a multi-node parallel job
@@ -187,12 +197,17 @@ export declare class ServerException extends __BaseException {
187
197
  }
188
198
  /**
189
199
  * @public
200
+ * @enum
190
201
  */
191
- export declare enum CRAllocationStrategy {
192
- BEST_FIT = "BEST_FIT",
193
- BEST_FIT_PROGRESSIVE = "BEST_FIT_PROGRESSIVE",
194
- SPOT_CAPACITY_OPTIMIZED = "SPOT_CAPACITY_OPTIMIZED"
195
- }
202
+ export declare const CRAllocationStrategy: {
203
+ readonly BEST_FIT: "BEST_FIT";
204
+ readonly BEST_FIT_PROGRESSIVE: "BEST_FIT_PROGRESSIVE";
205
+ readonly SPOT_CAPACITY_OPTIMIZED: "SPOT_CAPACITY_OPTIMIZED";
206
+ };
207
+ /**
208
+ * @public
209
+ */
210
+ export type CRAllocationStrategy = (typeof CRAllocationStrategy)[keyof typeof CRAllocationStrategy];
196
211
  /**
197
212
  * @public
198
213
  * <p>Provides information used to select Amazon Machine Images (AMIs) for instances in the
@@ -326,13 +341,18 @@ export interface LaunchTemplateSpecification {
326
341
  }
327
342
  /**
328
343
  * @public
344
+ * @enum
329
345
  */
330
- export declare enum CRType {
331
- EC2 = "EC2",
332
- FARGATE = "FARGATE",
333
- FARGATE_SPOT = "FARGATE_SPOT",
334
- SPOT = "SPOT"
335
- }
346
+ export declare const CRType: {
347
+ readonly EC2: "EC2";
348
+ readonly FARGATE: "FARGATE";
349
+ readonly FARGATE_SPOT: "FARGATE_SPOT";
350
+ readonly SPOT: "SPOT";
351
+ };
352
+ /**
353
+ * @public
354
+ */
355
+ export type CRType = (typeof CRType)[keyof typeof CRType];
336
356
  /**
337
357
  * @public
338
358
  * <p>An object that represents an Batch compute resource. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html">Compute environments</a> in
@@ -607,18 +627,28 @@ export interface EksConfiguration {
607
627
  }
608
628
  /**
609
629
  * @public
630
+ * @enum
610
631
  */
611
- export declare enum CEState {
612
- DISABLED = "DISABLED",
613
- ENABLED = "ENABLED"
614
- }
632
+ export declare const CEState: {
633
+ readonly DISABLED: "DISABLED";
634
+ readonly ENABLED: "ENABLED";
635
+ };
615
636
  /**
616
637
  * @public
617
638
  */
618
- export declare enum CEType {
619
- MANAGED = "MANAGED",
620
- UNMANAGED = "UNMANAGED"
621
- }
639
+ export type CEState = (typeof CEState)[keyof typeof CEState];
640
+ /**
641
+ * @public
642
+ * @enum
643
+ */
644
+ export declare const CEType: {
645
+ readonly MANAGED: "MANAGED";
646
+ readonly UNMANAGED: "UNMANAGED";
647
+ };
648
+ /**
649
+ * @public
650
+ */
651
+ export type CEType = (typeof CEType)[keyof typeof CEType];
622
652
  /**
623
653
  * @public
624
654
  * <p>Contains the parameters for <code>CreateComputeEnvironment</code>.</p>
@@ -751,11 +781,16 @@ export interface ComputeEnvironmentOrder {
751
781
  }
752
782
  /**
753
783
  * @public
784
+ * @enum
754
785
  */
755
- export declare enum JQState {
756
- DISABLED = "DISABLED",
757
- ENABLED = "ENABLED"
758
- }
786
+ export declare const JQState: {
787
+ readonly DISABLED: "DISABLED";
788
+ readonly ENABLED: "ENABLED";
789
+ };
790
+ /**
791
+ * @public
792
+ */
793
+ export type JQState = (typeof JQState)[keyof typeof JQState];
759
794
  /**
760
795
  * @public
761
796
  * <p>Contains the parameters for <code>CreateJobQueue</code>.</p>
@@ -1019,22 +1054,32 @@ export interface DescribeComputeEnvironmentsRequest {
1019
1054
  }
1020
1055
  /**
1021
1056
  * @public
1057
+ * @enum
1022
1058
  */
1023
- export declare enum OrchestrationType {
1024
- ECS = "ECS",
1025
- EKS = "EKS"
1026
- }
1059
+ export declare const OrchestrationType: {
1060
+ readonly ECS: "ECS";
1061
+ readonly EKS: "EKS";
1062
+ };
1027
1063
  /**
1028
1064
  * @public
1029
1065
  */
1030
- export declare enum CEStatus {
1031
- CREATING = "CREATING",
1032
- DELETED = "DELETED",
1033
- DELETING = "DELETING",
1034
- INVALID = "INVALID",
1035
- UPDATING = "UPDATING",
1036
- VALID = "VALID"
1037
- }
1066
+ export type OrchestrationType = (typeof OrchestrationType)[keyof typeof OrchestrationType];
1067
+ /**
1068
+ * @public
1069
+ * @enum
1070
+ */
1071
+ export declare const CEStatus: {
1072
+ readonly CREATING: "CREATING";
1073
+ readonly DELETED: "DELETED";
1074
+ readonly DELETING: "DELETING";
1075
+ readonly INVALID: "INVALID";
1076
+ readonly UPDATING: "UPDATING";
1077
+ readonly VALID: "VALID";
1078
+ };
1079
+ /**
1080
+ * @public
1081
+ */
1082
+ export type CEStatus = (typeof CEStatus)[keyof typeof CEStatus];
1038
1083
  /**
1039
1084
  * @public
1040
1085
  * <p>Specifies the infrastructure update policy for the compute environment. For more information
@@ -1252,12 +1297,17 @@ export interface FargatePlatformConfiguration {
1252
1297
  }
1253
1298
  /**
1254
1299
  * @public
1300
+ * @enum
1255
1301
  */
1256
- export declare enum DeviceCgroupPermission {
1257
- MKNOD = "MKNOD",
1258
- READ = "READ",
1259
- WRITE = "WRITE"
1260
- }
1302
+ export declare const DeviceCgroupPermission: {
1303
+ readonly MKNOD: "MKNOD";
1304
+ readonly READ: "READ";
1305
+ readonly WRITE: "WRITE";
1306
+ };
1307
+ /**
1308
+ * @public
1309
+ */
1310
+ export type DeviceCgroupPermission = (typeof DeviceCgroupPermission)[keyof typeof DeviceCgroupPermission];
1261
1311
  /**
1262
1312
  * @public
1263
1313
  * <p>An object that represents a container instance host device.</p>
@@ -1420,16 +1470,21 @@ export interface LinuxParameters {
1420
1470
  }
1421
1471
  /**
1422
1472
  * @public
1473
+ * @enum
1423
1474
  */
1424
- export declare enum LogDriver {
1425
- AWSLOGS = "awslogs",
1426
- FLUENTD = "fluentd",
1427
- GELF = "gelf",
1428
- JOURNALD = "journald",
1429
- JSON_FILE = "json-file",
1430
- SPLUNK = "splunk",
1431
- SYSLOG = "syslog"
1432
- }
1475
+ export declare const LogDriver: {
1476
+ readonly AWSLOGS: "awslogs";
1477
+ readonly FLUENTD: "fluentd";
1478
+ readonly GELF: "gelf";
1479
+ readonly JOURNALD: "journald";
1480
+ readonly JSON_FILE: "json-file";
1481
+ readonly SPLUNK: "splunk";
1482
+ readonly SYSLOG: "syslog";
1483
+ };
1484
+ /**
1485
+ * @public
1486
+ */
1487
+ export type LogDriver = (typeof LogDriver)[keyof typeof LogDriver];
1433
1488
  /**
1434
1489
  * @public
1435
1490
  * <p>An object that represents the secret to expose to your container. Secrets can be exposed to
@@ -1586,12 +1641,17 @@ export interface NetworkConfiguration {
1586
1641
  }
1587
1642
  /**
1588
1643
  * @public
1644
+ * @enum
1589
1645
  */
1590
- export declare enum ResourceType {
1591
- GPU = "GPU",
1592
- MEMORY = "MEMORY",
1593
- VCPU = "VCPU"
1594
- }
1646
+ export declare const ResourceType: {
1647
+ readonly GPU: "GPU";
1648
+ readonly MEMORY: "MEMORY";
1649
+ readonly VCPU: "VCPU";
1650
+ };
1651
+ /**
1652
+ * @public
1653
+ */
1654
+ export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
1595
1655
  /**
1596
1656
  * @public
1597
1657
  * <p>The type and amount of a resource to assign to a container. The supported resources include
@@ -1790,11 +1850,16 @@ export interface Ulimit {
1790
1850
  }
1791
1851
  /**
1792
1852
  * @public
1853
+ * @enum
1793
1854
  */
1794
- export declare enum EFSAuthorizationConfigIAM {
1795
- DISABLED = "DISABLED",
1796
- ENABLED = "ENABLED"
1797
- }
1855
+ export declare const EFSAuthorizationConfigIAM: {
1856
+ readonly DISABLED: "DISABLED";
1857
+ readonly ENABLED: "ENABLED";
1858
+ };
1859
+ /**
1860
+ * @public
1861
+ */
1862
+ export type EFSAuthorizationConfigIAM = (typeof EFSAuthorizationConfigIAM)[keyof typeof EFSAuthorizationConfigIAM];
1798
1863
  /**
1799
1864
  * @public
1800
1865
  * <p>The authorization configuration details for the Amazon EFS file system.</p>
@@ -1822,11 +1887,16 @@ export interface EFSAuthorizationConfig {
1822
1887
  }
1823
1888
  /**
1824
1889
  * @public
1890
+ * @enum
1825
1891
  */
1826
- export declare enum EFSTransitEncryption {
1827
- DISABLED = "DISABLED",
1828
- ENABLED = "ENABLED"
1829
- }
1892
+ export declare const EFSTransitEncryption: {
1893
+ readonly DISABLED: "DISABLED";
1894
+ readonly ENABLED: "ENABLED";
1895
+ };
1896
+ /**
1897
+ * @public
1898
+ */
1899
+ export type EFSTransitEncryption = (typeof EFSTransitEncryption)[keyof typeof EFSTransitEncryption];
1830
1900
  /**
1831
1901
  * @public
1832
1902
  * <p>This is used when you're using an Amazon Elastic File System file system for job storage. For more
@@ -2390,8 +2460,18 @@ export interface EksContainer {
2390
2460
  }
2391
2461
  /**
2392
2462
  * @public
2463
+ * <p>Describes and uniquely identifies Kubernetes resources. For example, the compute environment
2464
+ * that a pod runs in or the <code>jobID</code> for a job running in the pod. For more information,
2465
+ * see <a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/">Understanding Kubernetes Objects</a> in the <i>Kubernetes
2466
+ * documentation</i>.</p>
2393
2467
  */
2394
2468
  export interface EksMetadata {
2469
+ /**
2470
+ * <p>Key-value pairs used to identify, sort, and organize cube resources. Can contain up to 63
2471
+ * uppercase letters, lowercase letters, numbers, hyphens (-), and underscores (_). Labels can be
2472
+ * added or modified at any time. Each resource can have multiple labels, but each key must be
2473
+ * unique for a given object.</p>
2474
+ */
2395
2475
  labels?: Record<string, string>;
2396
2476
  }
2397
2477
  /**
@@ -2528,6 +2608,13 @@ export interface EksPodProperties {
2528
2608
  * <p>Specifies the volumes for a job definition that uses Amazon EKS resources.</p>
2529
2609
  */
2530
2610
  volumes?: EksVolume[];
2611
+ /**
2612
+ * <p>Metadata about the
2613
+ * Kubernetes
2614
+ * pod. For
2615
+ * more information, see <a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/">Understanding Kubernetes Objects</a> in the <i>Kubernetes
2616
+ * documentation</i>.</p>
2617
+ */
2531
2618
  metadata?: EksMetadata;
2532
2619
  }
2533
2620
  /**
@@ -2586,18 +2673,28 @@ export interface NodeProperties {
2586
2673
  }
2587
2674
  /**
2588
2675
  * @public
2676
+ * @enum
2589
2677
  */
2590
- export declare enum PlatformCapability {
2591
- EC2 = "EC2",
2592
- FARGATE = "FARGATE"
2593
- }
2678
+ export declare const PlatformCapability: {
2679
+ readonly EC2: "EC2";
2680
+ readonly FARGATE: "FARGATE";
2681
+ };
2594
2682
  /**
2595
2683
  * @public
2596
2684
  */
2597
- export declare enum RetryAction {
2598
- EXIT = "EXIT",
2599
- RETRY = "RETRY"
2600
- }
2685
+ export type PlatformCapability = (typeof PlatformCapability)[keyof typeof PlatformCapability];
2686
+ /**
2687
+ * @public
2688
+ * @enum
2689
+ */
2690
+ export declare const RetryAction: {
2691
+ readonly EXIT: "EXIT";
2692
+ readonly RETRY: "RETRY";
2693
+ };
2694
+ /**
2695
+ * @public
2696
+ */
2697
+ export type RetryAction = (typeof RetryAction)[keyof typeof RetryAction];
2601
2698
  /**
2602
2699
  * @public
2603
2700
  * <p>Specifies an array of up to 5 conditions to be met, and an action to take
@@ -2816,15 +2913,20 @@ export interface DescribeJobQueuesRequest {
2816
2913
  }
2817
2914
  /**
2818
2915
  * @public
2916
+ * @enum
2819
2917
  */
2820
- export declare enum JQStatus {
2821
- CREATING = "CREATING",
2822
- DELETED = "DELETED",
2823
- DELETING = "DELETING",
2824
- INVALID = "INVALID",
2825
- UPDATING = "UPDATING",
2826
- VALID = "VALID"
2827
- }
2918
+ export declare const JQStatus: {
2919
+ readonly CREATING: "CREATING";
2920
+ readonly DELETED: "DELETED";
2921
+ readonly DELETING: "DELETING";
2922
+ readonly INVALID: "INVALID";
2923
+ readonly UPDATING: "UPDATING";
2924
+ readonly VALID: "VALID";
2925
+ };
2926
+ /**
2927
+ * @public
2928
+ */
2929
+ export type JQStatus = (typeof JQStatus)[keyof typeof JQStatus];
2828
2930
  /**
2829
2931
  * @public
2830
2932
  * <p>An object that represents the details for an Batch job queue.</p>
@@ -3097,8 +3199,8 @@ export interface ContainerDetail {
3097
3199
  */
3098
3200
  fargatePlatformConfiguration?: FargatePlatformConfiguration;
3099
3201
  /**
3100
- * <p>The amount of ephemeral storage to allocate for the task. This parameter is used to expand
3101
- * the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on
3202
+ * <p>The amount of ephemeral storage allocated for the task. This parameter is used to expand the
3203
+ * total amount of ephemeral storage available, beyond the default amount, for tasks hosted on
3102
3204
  * Fargate.</p>
3103
3205
  */
3104
3206
  ephemeralStorage?: EphemeralStorage;
@@ -3299,6 +3401,13 @@ export interface EksPodPropertiesDetail {
3299
3401
  * <p>The name of the node for this job.</p>
3300
3402
  */
3301
3403
  nodeName?: string;
3404
+ /**
3405
+ * <p>Describes and uniquely identifies Kubernetes resources. For example, the compute environment
3406
+ * that a pod runs in or the <code>jobID</code> for a job running in the pod. For more information,
3407
+ * see <a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/">Understanding Kubernetes Objects</a> in the <i>Kubernetes
3408
+ * documentation</i>.</p>
3409
+ */
3410
+ metadata?: EksMetadata;
3302
3411
  }
3303
3412
  /**
3304
3413
  * @public
@@ -3327,16 +3436,21 @@ export interface NodeDetails {
3327
3436
  }
3328
3437
  /**
3329
3438
  * @public
3439
+ * @enum
3330
3440
  */
3331
- export declare enum JobStatus {
3332
- FAILED = "FAILED",
3333
- PENDING = "PENDING",
3334
- RUNNABLE = "RUNNABLE",
3335
- RUNNING = "RUNNING",
3336
- STARTING = "STARTING",
3337
- SUBMITTED = "SUBMITTED",
3338
- SUCCEEDED = "SUCCEEDED"
3339
- }
3441
+ export declare const JobStatus: {
3442
+ readonly FAILED: "FAILED";
3443
+ readonly PENDING: "PENDING";
3444
+ readonly RUNNABLE: "RUNNABLE";
3445
+ readonly RUNNING: "RUNNING";
3446
+ readonly STARTING: "STARTING";
3447
+ readonly SUBMITTED: "SUBMITTED";
3448
+ readonly SUCCEEDED: "SUCCEEDED";
3449
+ };
3450
+ /**
3451
+ * @public
3452
+ */
3453
+ export type JobStatus = (typeof JobStatus)[keyof typeof JobStatus];
3340
3454
  /**
3341
3455
  * @public
3342
3456
  * <p>An object that represents an Batch job.</p>
@@ -3831,11 +3945,16 @@ export interface ListTagsForResourceResponse {
3831
3945
  }
3832
3946
  /**
3833
3947
  * @public
3948
+ * @enum
3834
3949
  */
3835
- export declare enum JobDefinitionType {
3836
- Container = "container",
3837
- Multinode = "multinode"
3838
- }
3950
+ export declare const JobDefinitionType: {
3951
+ readonly Container: "container";
3952
+ readonly Multinode: "multinode";
3953
+ };
3954
+ /**
3955
+ * @public
3956
+ */
3957
+ export type JobDefinitionType = (typeof JobDefinitionType)[keyof typeof JobDefinitionType];
3839
3958
  /**
3840
3959
  * @public
3841
3960
  * <p>Contains the parameters for <code>RegisterJobDefinition</code>.</p>
@@ -4065,6 +4184,10 @@ export interface EksPodPropertiesOverride {
4065
4184
  * <p>The overrides for the container that's used on the Amazon EKS pod.</p>
4066
4185
  */
4067
4186
  containers?: EksContainerOverride[];
4187
+ /**
4188
+ * <p>Metadata about the
4189
+ * overrides for the container that's used on the Amazon EKS pod.</p>
4190
+ */
4068
4191
  metadata?: EksMetadata;
4069
4192
  }
4070
4193
  /**
@@ -4319,11 +4442,16 @@ export interface UntagResourceResponse {
4319
4442
  }
4320
4443
  /**
4321
4444
  * @public
4445
+ * @enum
4322
4446
  */
4323
- export declare enum CRUpdateAllocationStrategy {
4324
- BEST_FIT_PROGRESSIVE = "BEST_FIT_PROGRESSIVE",
4325
- SPOT_CAPACITY_OPTIMIZED = "SPOT_CAPACITY_OPTIMIZED"
4326
- }
4447
+ export declare const CRUpdateAllocationStrategy: {
4448
+ readonly BEST_FIT_PROGRESSIVE: "BEST_FIT_PROGRESSIVE";
4449
+ readonly SPOT_CAPACITY_OPTIMIZED: "SPOT_CAPACITY_OPTIMIZED";
4450
+ };
4451
+ /**
4452
+ * @public
4453
+ */
4454
+ export type CRUpdateAllocationStrategy = (typeof CRUpdateAllocationStrategy)[keyof typeof CRUpdateAllocationStrategy];
4327
4455
  /**
4328
4456
  * @public
4329
4457
  * <p>An object that represents the attributes of a compute environment that can be updated. For