@aws-sdk/client-batch 3.509.0 → 3.513.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.
Files changed (33) hide show
  1. package/dist-cjs/auth/httpAuthExtensionConfiguration.js +1 -0
  2. package/dist-cjs/auth/httpAuthSchemeProvider.js +47 -0
  3. package/dist-cjs/index.js +65 -7
  4. package/dist-cjs/runtimeConfig.shared.js +10 -0
  5. package/dist-es/BatchClient.js +17 -4
  6. package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
  7. package/dist-es/auth/httpAuthSchemeProvider.js +41 -0
  8. package/dist-es/runtimeConfig.shared.js +10 -0
  9. package/dist-es/runtimeExtensions.js +3 -0
  10. package/dist-types/BatchClient.d.ts +13 -11
  11. package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
  12. package/dist-types/auth/httpAuthSchemeProvider.d.ts +61 -0
  13. package/dist-types/commands/CancelJobCommand.d.ts +1 -1
  14. package/dist-types/commands/CreateComputeEnvironmentCommand.d.ts +2 -2
  15. package/dist-types/commands/DescribeJobDefinitionsCommand.d.ts +6 -0
  16. package/dist-types/commands/DescribeJobsCommand.d.ts +6 -0
  17. package/dist-types/commands/RegisterJobDefinitionCommand.d.ts +6 -0
  18. package/dist-types/extensionConfiguration.d.ts +2 -1
  19. package/dist-types/models/models_0.d.ts +130 -69
  20. package/dist-types/runtimeConfig.browser.d.ts +5 -3
  21. package/dist-types/runtimeConfig.d.ts +4 -2
  22. package/dist-types/runtimeConfig.native.d.ts +6 -4
  23. package/dist-types/runtimeConfig.shared.d.ts +2 -0
  24. package/dist-types/ts3.4/BatchClient.d.ts +11 -9
  25. package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
  26. package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +44 -0
  27. package/dist-types/ts3.4/extensionConfiguration.d.ts +3 -1
  28. package/dist-types/ts3.4/models/models_0.d.ts +5 -0
  29. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +5 -5
  30. package/dist-types/ts3.4/runtimeConfig.d.ts +4 -4
  31. package/dist-types/ts3.4/runtimeConfig.native.d.ts +8 -8
  32. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -0
  33. package/package.json +16 -16
@@ -265,6 +265,15 @@ export interface Ec2Configuration {
265
265
  * (GPU)</a>: Default for all GPU instance families (for example <code>P4</code> and
266
266
  * <code>G4</code>) and can be used for all non Amazon Web Services Graviton-based instance types.</p>
267
267
  * </dd>
268
+ * <dt>ECS_AL2023</dt>
269
+ * <dd>
270
+ * <p>
271
+ * <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html">Amazon Linux 2023</a>: Batch
272
+ * supports Amazon Linux 2023.</p>
273
+ * <note>
274
+ * <p>Amazon Linux 2023 does not support <code>A1</code> instances.</p>
275
+ * </note>
276
+ * </dd>
268
277
  * <dt>ECS_AL1</dt>
269
278
  * <dd>
270
279
  * <p>
@@ -356,7 +365,7 @@ export interface LaunchTemplateSpecification {
356
365
  * isn't changed when the compute environment is updated. It's only changed if the
357
366
  * <code>updateToLatestImageVersion</code> parameter for the compute environment is set to
358
367
  * <code>true</code>. During an infrastructure update, if either <code>$Latest</code> or
359
- * <code>$Default</code> is specified, Batch re-evaluates the launch template version, and it
368
+ * <code>$Default</code> is specified, Batch re-evaluates the launch template version, and it
360
369
  * might use a different version of the launch template. This is the case even if the launch
361
370
  * template isn't specified in the update. When updating a compute environment, changing the launch
362
371
  * template requires an infrastructure update of the compute environment. For more information, see
@@ -442,10 +451,12 @@ export interface ComputeResource {
442
451
  * resources.</p>
443
452
  * </dd>
444
453
  * </dl>
445
- * <p>With <code>BEST_FIT_PROGRESSIVE</code>,<code>SPOT_CAPACITY_OPTIMIZED</code> and <code>SPOT_PRICE_CAPACITY_OPTIMIZED</code>
446
- * strategies using On-Demand or Spot Instances, and the <code>BEST_FIT</code> strategy using Spot
447
- * Instances, Batch might need to exceed <code>maxvCpus</code> to meet your capacity requirements.
448
- * In this event, Batch never exceeds <code>maxvCpus</code> by more than a single instance.</p>
454
+ * <p>With <code>BEST_FIT_PROGRESSIVE</code>,<code>SPOT_CAPACITY_OPTIMIZED</code> and
455
+ * <code>SPOT_PRICE_CAPACITY_OPTIMIZED</code>
456
+ * (recommended) strategies using On-Demand or Spot Instances, and the
457
+ * <code>BEST_FIT</code> strategy using Spot Instances, Batch might need to exceed
458
+ * <code>maxvCpus</code> to meet your capacity requirements. In this event, Batch never exceeds
459
+ * <code>maxvCpus</code> by more than a single instance.</p>
449
460
  */
450
461
  allocationStrategy?: CRAllocationStrategy;
451
462
  /**
@@ -467,12 +478,12 @@ export interface ComputeResource {
467
478
  * compute environment can
468
479
  * support.</p>
469
480
  * <note>
470
- * <p>With <code>BEST_FIT_PROGRESSIVE</code>, <code>SPOT_CAPACITY_OPTIMIZED</code> and <code>SPOT_PRICE_CAPACITY_OPTIMIZED</code>
471
- * allocation strategies using On-Demand or Spot Instances, and the <code>BEST_FIT</code> strategy
472
- * using Spot Instances, Batch might need to exceed <code>maxvCpus</code> to meet your capacity
473
- * requirements. In this event, Batch never exceeds <code>maxvCpus</code> by more than a single
474
- * instance. For example, no more than a single instance from among those specified in your compute
475
- * environment is allocated.</p>
481
+ * <p>With <code>BEST_FIT_PROGRESSIVE</code>,<code>SPOT_CAPACITY_OPTIMIZED</code> and
482
+ * <code>SPOT_PRICE_CAPACITY_OPTIMIZED</code>
483
+ * (recommended) strategies using On-Demand or Spot Instances, and the
484
+ * <code>BEST_FIT</code> strategy using Spot Instances, Batch might need to exceed
485
+ * <code>maxvCpus</code> to meet your capacity requirements. In this event, Batch never exceeds
486
+ * <code>maxvCpus</code> by more than a single instance.</p>
476
487
  * </note>
477
488
  */
478
489
  maxvCpus: number | undefined;
@@ -567,8 +578,8 @@ export interface ComputeResource {
567
578
  ec2KeyPair?: string;
568
579
  /**
569
580
  * @public
570
- * <p>The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can
571
- * specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example,
581
+ * <p>The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. This parameter is required
582
+ * for Amazon EC2 instances types. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example,
572
583
  * <code>
573
584
  * <i>ecsInstanceRole</i>
574
585
  * </code> or
@@ -588,7 +599,7 @@ export interface ComputeResource {
588
599
  * <code>\{ "Name": "Batch Instance - C4OnDemand" \}</code>. This is helpful for recognizing your
589
600
  * Batch instances in the Amazon EC2 console. Updating these tags requires an infrastructure update to
590
601
  * the compute environment. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute environments</a> in the
591
- * <i>Batch User Guide</i>. These tags aren't seen when using the Batch
602
+ * <i>Batch User Guide</i>. These tags aren't seen when using the Batch
592
603
  * <code>ListTagsForResource</code> API operation.</p>
593
604
  * <note>
594
605
  * <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.</p>
@@ -773,12 +784,12 @@ export interface CreateComputeEnvironmentRequest {
773
784
  /**
774
785
  * @public
775
786
  * <p>The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf. For
776
- * more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html">Batch service IAM
787
+ * more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html">Batch service IAM
777
788
  * role</a> in the <i>Batch User Guide</i>.</p>
778
789
  * <important>
779
790
  * <p>If your account already created the Batch service-linked role, that role is used by default for your compute
780
- * environment unless you specify a different role here. If the Batch service-linked role doesn't exist in your
781
- * account, and no role is specified here, the service attempts to create the Batch service-linked role in your
791
+ * environment unless you specify a different role here. If the Batch service-linked role doesn't exist in your
792
+ * account, and no role is specified here, the service attempts to create the Batch service-linked role in your
782
793
  * account.</p>
783
794
  * </important>
784
795
  * <p>If your specified role has a path other than <code>/</code>, then you must specify either the full role ARN
@@ -787,7 +798,7 @@ export interface CreateComputeEnvironmentRequest {
787
798
  * and paths</a> in the <i>IAM User Guide</i>.</p>
788
799
  * <note>
789
800
  * <p>Depending on how you created your Batch service role, its ARN might contain the <code>service-role</code>
790
- * path prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn't use the
801
+ * path prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn't use the
791
802
  * <code>service-role</code> path prefix. Because of this, we recommend that you specify the full ARN of your service
792
803
  * role when you create compute environments.</p>
793
804
  * </note>
@@ -993,7 +1004,7 @@ export interface FairsharePolicy {
993
1004
  * <i>ActiveFairShares</i>
994
1005
  * </code> is the number of active fair share
995
1006
  * identifiers.</p>
996
- * <p>For example, a <code>computeReservation</code> value of 50 indicates that Batchreserves
1007
+ * <p>For example, a <code>computeReservation</code> value of 50 indicates that Batch reserves
997
1008
  * 50% of the maximum available vCPU if there's only one fair share identifier. It reserves 25% if
998
1009
  * there are two fair share identifiers. It reserves 12.5% if there are three fair share
999
1010
  * identifiers. A <code>computeReservation</code> value of 25 indicates that Batch should reserve
@@ -1335,9 +1346,10 @@ export interface DescribeComputeEnvironmentsResponse {
1335
1346
  export interface DescribeJobDefinitionsRequest {
1336
1347
  /**
1337
1348
  * @public
1338
- * <p>A list of up to 100 job definitions. Each entry in the list can either be an ARN in the format
1339
- * <code>arn:aws:batch:$\{Region\}:$\{Account\}:job-definition/$\{JobDefinitionName\}:$\{Revision\}</code> or a short version
1340
- * using the form <code>$\{JobDefinitionName\}:$\{Revision\}</code>.</p>
1349
+ * <p>A list of up to 100 job definitions. Each entry in the list can either be an ARN in the
1350
+ * format
1351
+ * <code>arn:aws:batch:$\{Region\}:$\{Account\}:job-definition/$\{JobDefinitionName\}:$\{Revision\}</code>
1352
+ * or a short version using the form <code>$\{JobDefinitionName\}:$\{Revision\}</code>. This parameter can't be used with other parameters.</p>
1341
1353
  */
1342
1354
  jobDefinitions?: string[];
1343
1355
  /**
@@ -1750,7 +1762,7 @@ export interface LogConfiguration {
1750
1762
  /**
1751
1763
  * @public
1752
1764
  * <p>Details for a Docker volume mount point that's used in a job's container properties. This
1753
- * parameter maps to <code>Volumes</code> in the <a href="https://docs.docker.com/engine/reference/api/docker_remote_api_v1.19/#create-a-container">Create a container</a> section of the <i>Docker Remote API</i> and the
1765
+ * parameter maps to <code>Volumes</code> in the <a href="https://docs.docker.com/engine/api/v1.43/#tag/Container/operation/ContainerCreate">Create a container</a> section of the <i>Docker Remote API</i> and the
1754
1766
  * <code>--volume</code> option to docker run.</p>
1755
1767
  */
1756
1768
  export interface MountPoint {
@@ -1787,6 +1799,17 @@ export interface NetworkConfiguration {
1787
1799
  */
1788
1800
  assignPublicIp?: AssignPublicIp;
1789
1801
  }
1802
+ /**
1803
+ * @public
1804
+ * <p>The repository credentials for private registry authentication.</p>
1805
+ */
1806
+ export interface RepositoryCredentials {
1807
+ /**
1808
+ * @public
1809
+ * <p>The Amazon Resource Name (ARN) of the secret containing the private repository credentials.</p>
1810
+ */
1811
+ credentialsParameter: string | undefined;
1812
+ }
1790
1813
  /**
1791
1814
  * @public
1792
1815
  * @enum
@@ -1979,53 +2002,70 @@ export interface ResourceRequirement {
1979
2002
  }
1980
2003
  /**
1981
2004
  * @public
1982
- * <p>An object that represents the compute environment architecture for Batch jobs on Fargate.</p>
2005
+ * <p>
2006
+ * An object that represents the compute environment architecture for Batch jobs on Fargate.
2007
+ * </p>
1983
2008
  */
1984
2009
  export interface RuntimePlatform {
1985
2010
  /**
1986
2011
  * @public
1987
2012
  * <p>The operating system for the compute environment.
1988
2013
  * Valid values are:
1989
- * <code>LINUX</code> (default), <code>WINDOWS_SERVER_2019_CORE</code>,
1990
- * <code>WINDOWS_SERVER_2019_FULL</code>, <code>WINDOWS_SERVER_2022_CORE</code>, and
1991
- * <code>WINDOWS_SERVER_2022_FULL</code>.</p>
2014
+ * <code>LINUX</code> (default), <code>WINDOWS_SERVER_2019_CORE</code>,
2015
+ * <code>WINDOWS_SERVER_2019_FULL</code>, <code>WINDOWS_SERVER_2022_CORE</code>, and
2016
+ * <code>WINDOWS_SERVER_2022_FULL</code>.</p>
1992
2017
  * <note>
1993
2018
  * <p>The following parameters can’t be set for Windows containers: <code>linuxParameters</code>,
1994
- * <code>privileged</code>, <code>user</code>, <code>ulimits</code>,
1995
- * <code>readonlyRootFilesystem</code>,
1996
- * and <code>efsVolumeConfiguration</code>.</p>
2019
+ * <code>privileged</code>, <code>user</code>, <code>ulimits</code>,
2020
+ * <code>readonlyRootFilesystem</code>,
2021
+ * and <code>efsVolumeConfiguration</code>.</p>
1997
2022
  * </note>
1998
2023
  * <note>
1999
- * <p>The Batch Scheduler checks before registering a task definition with Fargate. If the job
2000
- * requires a Windows container and the first compute environment is <code>LINUX</code>, the
2001
- * compute environment is skipped and the next is checked until a Windows-based compute environment
2002
- * is found.</p>
2024
+ * <p>The Batch Scheduler checks
2025
+ * the compute environments
2026
+ * that are attached to the job queue before registering a task definition with
2027
+ * Fargate. In this
2028
+ * scenario, the job queue is where the job is submitted. If the job requires a
2029
+ * Windows container and the first compute environment is <code>LINUX</code>, the compute
2030
+ * environment is skipped and the next compute environment is checked until a Windows-based compute
2031
+ * environment is found.</p>
2003
2032
  * </note>
2004
2033
  * <note>
2005
- * <p>Fargate Spot is not supported for Windows-based containers on Fargate. A job
2006
- * queue will be blocked if a Fargate Windows job is submitted to a job queue with only Fargate
2007
- * Spot compute environments.
2008
- * However, you can attach both <code>FARGATE</code> and <code>FARGATE_SPOT</code>
2009
- * compute environments to the same job
2010
- * queue.</p>
2034
+ * <p>Fargate Spot is not supported for
2035
+ * <code>ARM64</code> and
2036
+ * Windows-based containers on Fargate. A job queue will be blocked if a
2037
+ * Fargate
2038
+ * <code>ARM64</code> or
2039
+ * Windows job is submitted to a job queue with only Fargate Spot compute environments.
2040
+ * However, you can attach both <code>FARGATE</code> and
2041
+ * <code>FARGATE_SPOT</code> compute environments to the same job queue.</p>
2011
2042
  * </note>
2012
2043
  */
2013
2044
  operatingSystemFamily?: string;
2014
2045
  /**
2015
2046
  * @public
2016
- * <p>The vCPU architecture. The default value is <code>X86_64</code>. Valid values are
2017
- * <code>X86_64</code> and <code>ARM64</code>.</p>
2047
+ * <p>
2048
+ * The vCPU architecture. The default value is <code>X86_64</code>. Valid values are
2049
+ * <code>X86_64</code> and <code>ARM64</code>.</p>
2018
2050
  * <note>
2019
2051
  * <p>This parameter must be set to
2020
2052
  * <code>X86_64</code>
2021
2053
  * for Windows containers.</p>
2022
2054
  * </note>
2055
+ * <note>
2056
+ * <p>Fargate Spot is not supported for <code>ARM64</code> and Windows-based containers on
2057
+ * Fargate. A job queue will be blocked if a Fargate <code>ARM64</code> or Windows job is
2058
+ * submitted to a job queue with only Fargate Spot compute environments. However, you can attach
2059
+ * both <code>FARGATE</code> and <code>FARGATE_SPOT</code> compute environments to the same job
2060
+ * queue.</p>
2061
+ * </note>
2023
2062
  */
2024
2063
  cpuArchitecture?: string;
2025
2064
  }
2026
2065
  /**
2027
2066
  * @public
2028
- * <p>The <code>ulimit</code> settings to pass to the container.</p>
2067
+ * <p>The <code>ulimit</code> settings to pass to the container. For more information, see
2068
+ * <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Ulimit.html">Ulimit</a>.</p>
2029
2069
  * <note>
2030
2070
  * <p>This object isn't applicable to jobs that are running on Fargate resources.</p>
2031
2071
  * </note>
@@ -2033,12 +2073,15 @@ export interface RuntimePlatform {
2033
2073
  export interface Ulimit {
2034
2074
  /**
2035
2075
  * @public
2036
- * <p>The hard limit for the <code>ulimit</code> type.</p>
2076
+ * <p>The hard limit for the <code>ulimit</code> type. </p>
2037
2077
  */
2038
2078
  hardLimit: number | undefined;
2039
2079
  /**
2040
2080
  * @public
2041
- * <p>The <code>type</code> of the <code>ulimit</code>.</p>
2081
+ * <p>The <code>type</code> of the <code>ulimit</code>. Valid values are: <code>core</code> | <code>cpu</code> |
2082
+ * <code>data</code> | <code>fsize</code> | <code>locks</code> | <code>memlock</code> | <code>msgqueue</code> |
2083
+ * <code>nice</code> | <code>nofile</code> | <code>nproc</code> | <code>rss</code> | <code>rtprio</code> |
2084
+ * <code>rttime</code> | <code>sigpending</code> | <code>stack</code>.</p>
2042
2085
  */
2043
2086
  name: string | undefined;
2044
2087
  /**
@@ -2210,8 +2253,10 @@ export interface Volume {
2210
2253
  export interface ContainerProperties {
2211
2254
  /**
2212
2255
  * @public
2213
- * <p>The image used to start a container. This string is passed directly to the Docker daemon.
2214
- * Images in the Docker Hub registry are available by default. Other repositories are specified with
2256
+ * <p>Required.
2257
+ * The image used to start a container. This string is passed directly to the
2258
+ * Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are
2259
+ * specified with
2215
2260
  * <code>
2216
2261
  * <i>repository-url</i>/<i>image</i>:<i>tag</i>
2217
2262
  * </code>.
@@ -2445,6 +2490,11 @@ export interface ContainerProperties {
2445
2490
  * <p>An object that represents the compute environment architecture for Batch jobs on Fargate.</p>
2446
2491
  */
2447
2492
  runtimePlatform?: RuntimePlatform;
2493
+ /**
2494
+ * @public
2495
+ * <p>The private repository authentication credentials to use.</p>
2496
+ */
2497
+ repositoryCredentials?: RepositoryCredentials;
2448
2498
  }
2449
2499
  /**
2450
2500
  * @public
@@ -3046,7 +3096,7 @@ export interface JobTimeout {
3046
3096
  /**
3047
3097
  * @public
3048
3098
  * <p>The job timeout time (in seconds) that's measured from the job attempt's
3049
- * <code>startedAt</code> timestamp. After this time passes, Batch terminates your jobs if they
3099
+ * <code>startedAt</code> timestamp. After this time passes, Batch terminates your jobs if they
3050
3100
  * aren't finished. The minimum value for the timeout is 60 seconds.</p>
3051
3101
  * <p>For array jobs, the timeout applies to the child jobs, not to the parent array job.</p>
3052
3102
  * <p>For multi-node parallel (MNP) jobs, the timeout applies to the whole job, not to the
@@ -3555,6 +3605,11 @@ export interface ContainerDetail {
3555
3605
  * <p>An object that represents the compute environment architecture for Batch jobs on Fargate.</p>
3556
3606
  */
3557
3607
  runtimePlatform?: RuntimePlatform;
3608
+ /**
3609
+ * @public
3610
+ * <p>The private repository authentication credentials to use.</p>
3611
+ */
3612
+ repositoryCredentials?: RepositoryCredentials;
3558
3613
  }
3559
3614
  /**
3560
3615
  * @public
@@ -3785,7 +3840,7 @@ export interface EksPodPropertiesDetail {
3785
3840
  * <p>Describes and uniquely identifies Kubernetes resources. For example, the compute environment
3786
3841
  * that a pod runs in or the <code>jobID</code> for a job running in the pod. For more information,
3787
3842
  * see <a href="https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/">Understanding Kubernetes Objects</a> in the <i>Kubernetes
3788
- * documentation</i>.</p>
3843
+ * documentation</i>.</p>
3789
3844
  */
3790
3845
  metadata?: EksMetadata;
3791
3846
  }
@@ -3909,7 +3964,7 @@ export interface JobDetail {
3909
3964
  * @public
3910
3965
  * <p>The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's
3911
3966
  * when the job transitioned from the <code>STARTING</code> state to the <code>RUNNING</code> state.
3912
- * This parameter isn't provided for child jobs of array jobs or multi-node parallel jobs.</p>
3967
+ * </p>
3913
3968
  */
3914
3969
  startedAt: number | undefined;
3915
3970
  /**
@@ -4770,9 +4825,12 @@ export interface SubmitJobRequest {
4770
4825
  shareIdentifier?: string;
4771
4826
  /**
4772
4827
  * @public
4773
- * <p>The scheduling priority for the job. This only affects jobs in job queues with a fair share policy. Jobs with a
4774
- * higher scheduling priority are scheduled before jobs with a lower scheduling priority. This overrides any scheduling
4775
- * priority in the job definition.</p>
4828
+ * <p>The scheduling priority for the job. This only affects jobs in job queues with a fair share
4829
+ * policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower
4830
+ * scheduling priority.
4831
+ * This
4832
+ * overrides any scheduling priority in the job definition and works only within a single share
4833
+ * identifier.</p>
4776
4834
  * <p>The minimum supported value is 0 and the maximum supported value is 9999.</p>
4777
4835
  */
4778
4836
  schedulingPriorityOverride?: number;
@@ -4848,7 +4906,7 @@ export interface SubmitJobRequest {
4848
4906
  /**
4849
4907
  * @public
4850
4908
  * <p>The timeout configuration for this <a>SubmitJob</a> operation. You can specify a timeout duration
4851
- * after which Batch terminates your jobs if they haven't finished. If a job is terminated due to a timeout, it isn't
4909
+ * after which Batch terminates your jobs if they haven't finished. If a job is terminated due to a timeout, it isn't
4852
4910
  * retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration
4853
4911
  * specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job.
4854
4912
  * For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/job_timeouts.html">Job
@@ -4992,12 +5050,12 @@ export interface ComputeResourceUpdate {
4992
5050
  * @public
4993
5051
  * <p>The maximum number of Amazon EC2 vCPUs that an environment can reach.</p>
4994
5052
  * <note>
4995
- * <p>With <code>BEST_FIT_PROGRESSIVE</code>, <code>SPOT_CAPACITY_OPTIMIZED</code>, and <code>SPOT_PRICE_CAPACITY_OPTIMIZED</code>
4996
- * allocation strategies using On-Demand or Spot Instances, and the <code>BEST_FIT</code> strategy
4997
- * using Spot Instances, Batch might need to exceed <code>maxvCpus</code> to meet your capacity
4998
- * requirements. In this event, Batch never exceeds <code>maxvCpus</code> by more than a single
4999
- * instance. That is, no more than a single instance from among those specified in your compute
5000
- * environment.</p>
5053
+ * <p>With <code>BEST_FIT_PROGRESSIVE</code>,<code>SPOT_CAPACITY_OPTIMIZED</code> and
5054
+ * <code>SPOT_PRICE_CAPACITY_OPTIMIZED</code>
5055
+ * (recommended) strategies using On-Demand or Spot Instances, and the
5056
+ * <code>BEST_FIT</code> strategy using Spot Instances, Batch might need to exceed
5057
+ * <code>maxvCpus</code> to meet your capacity requirements. In this event, Batch never exceeds
5058
+ * <code>maxvCpus</code> by more than a single instance.</p>
5001
5059
  * </note>
5002
5060
  */
5003
5061
  maxvCpus?: number;
@@ -5092,10 +5150,12 @@ export interface ComputeResourceUpdate {
5092
5150
  * resources.</p>
5093
5151
  * </dd>
5094
5152
  * </dl>
5095
- * <p>With both <code>BEST_FIT_PROGRESSIVE</code>, <code>SPOT_CAPACITY_OPTIMIZED</code>, and <code>SPOT_PRICE_CAPACITY_OPTIMIZED</code>
5096
- * strategies using On-Demand or Spot Instances, and the <code>BEST_FIT</code> strategy using Spot
5097
- * Instances, Batch might need to exceed <code>maxvCpus</code> to meet your capacity requirements.
5098
- * In this event, Batch never exceeds <code>maxvCpus</code> by more than a single instance.</p>
5153
+ * <p>With <code>BEST_FIT_PROGRESSIVE</code>,<code>SPOT_CAPACITY_OPTIMIZED</code> and
5154
+ * <code>SPOT_PRICE_CAPACITY_OPTIMIZED</code>
5155
+ * (recommended) strategies using On-Demand or Spot Instances, and the
5156
+ * <code>BEST_FIT</code> strategy using Spot Instances, Batch might need to exceed
5157
+ * <code>maxvCpus</code> to meet your capacity requirements. In this event, Batch never exceeds
5158
+ * <code>maxvCpus</code> by more than a single instance.</p>
5099
5159
  */
5100
5160
  allocationStrategy?: CRUpdateAllocationStrategy;
5101
5161
  /**
@@ -5138,9 +5198,10 @@ export interface ComputeResourceUpdate {
5138
5198
  ec2KeyPair?: string;
5139
5199
  /**
5140
5200
  * @public
5141
- * <p>The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can
5142
- * specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example,
5143
- * <code>
5201
+ * <p>The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment.
5202
+ * Required for Amazon EC2
5203
+ * instances. You can specify the short name or full Amazon Resource Name (ARN) of an instance
5204
+ * profile. For example, <code>
5144
5205
  * <i>ecsInstanceRole</i>
5145
5206
  * </code> or
5146
5207
  * <code>arn:aws:iam::<i><aws_account_id></i>:instance-profile/<i>ecsInstanceRole</i>
@@ -5343,7 +5404,7 @@ export interface UpdateComputeEnvironmentRequest {
5343
5404
  /**
5344
5405
  * @public
5345
5406
  * <p>The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf.
5346
- * For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html">Batch service IAM
5407
+ * For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html">Batch service IAM
5347
5408
  * role</a> in the <i>Batch User Guide</i>.</p>
5348
5409
  * <important>
5349
5410
  * <p>If the compute environment has a service-linked role, it can't be changed to use a regular IAM role.
@@ -5356,7 +5417,7 @@ export interface UpdateComputeEnvironmentRequest {
5356
5417
  * (recommended) or prefix the role name with the path.</p>
5357
5418
  * <note>
5358
5419
  * <p>Depending on how you created your Batch service role, its ARN might contain the <code>service-role</code>
5359
- * path prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn't use the
5420
+ * path prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn't use the
5360
5421
  * <code>service-role</code> path prefix. Because of this, we recommend that you specify the full ARN of your service
5361
5422
  * role when you create compute environments.</p>
5362
5423
  * </note>
@@ -7,7 +7,7 @@ export declare const getRuntimeConfig: (config: BatchClientConfig) => {
7
7
  runtime: string;
8
8
  defaultsMode: import("@smithy/types").Provider<import("@smithy/smithy-client").ResolvedDefaultsMode>;
9
9
  bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
10
- credentialDefaultProvider: (input: any) => import("@smithy/types").Provider<import("@aws-sdk/types").Credentials>;
10
+ credentialDefaultProvider: (input: any) => import("@smithy/types").AwsCredentialIdentityProvider;
11
11
  defaultUserAgentProvider: import("@smithy/types").Provider<import("@smithy/types").UserAgent>;
12
12
  maxAttempts: number | import("@smithy/types").Provider<number>;
13
13
  region: string | import("@smithy/types").Provider<any>;
@@ -36,11 +36,13 @@ export declare const getRuntimeConfig: (config: BatchClientConfig) => {
36
36
  }) => import("@smithy/types").EndpointV2;
37
37
  tls?: boolean | undefined;
38
38
  retryStrategy?: import("@smithy/types").RetryStrategy | import("@smithy/types").RetryStrategyV2 | undefined;
39
- credentials?: import("@smithy/types").AwsCredentialIdentity | import("@smithy/types").Provider<import("@smithy/types").AwsCredentialIdentity> | undefined;
39
+ customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
40
+ httpAuthSchemes: import("@smithy/types").HttpAuthScheme[];
41
+ httpAuthSchemeProvider: import("./auth/httpAuthSchemeProvider").BatchHttpAuthSchemeProvider;
42
+ credentials?: import("@smithy/types").AwsCredentialIdentity | import("@smithy/types").AwsCredentialIdentityProvider | undefined;
40
43
  signer?: import("@smithy/types").RequestSigner | ((authScheme?: import("@smithy/types").AuthScheme | undefined) => Promise<import("@smithy/types").RequestSigner>) | undefined;
41
44
  signingEscapePath?: boolean | undefined;
42
45
  systemClockOffset?: number | undefined;
43
46
  signingRegion?: string | undefined;
44
47
  signerConstructor?: (new (options: import("@smithy/signature-v4").SignatureV4Init & import("@smithy/signature-v4").SignatureV4CryptoInit) => import("@smithy/types").RequestSigner) | undefined;
45
- customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
46
48
  };
@@ -36,11 +36,13 @@ export declare const getRuntimeConfig: (config: BatchClientConfig) => {
36
36
  }) => import("@smithy/types").EndpointV2;
37
37
  tls?: boolean | undefined;
38
38
  retryStrategy?: import("@smithy/types").RetryStrategy | import("@smithy/types").RetryStrategyV2 | undefined;
39
- credentials?: import("@smithy/types").AwsCredentialIdentity | import("@smithy/types").Provider<import("@smithy/types").AwsCredentialIdentity> | undefined;
39
+ customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
40
+ httpAuthSchemes: import("@smithy/types").HttpAuthScheme[];
41
+ httpAuthSchemeProvider: import("./auth/httpAuthSchemeProvider").BatchHttpAuthSchemeProvider;
42
+ credentials?: import("@smithy/types").AwsCredentialIdentity | import("@smithy/types").AwsCredentialIdentityProvider | undefined;
40
43
  signer?: import("@smithy/types").RequestSigner | ((authScheme?: import("@smithy/types").AuthScheme | undefined) => Promise<import("@smithy/types").RequestSigner>) | undefined;
41
44
  signingEscapePath?: boolean | undefined;
42
45
  systemClockOffset?: number | undefined;
43
46
  signingRegion?: string | undefined;
44
47
  signerConstructor?: (new (options: import("@smithy/signature-v4").SignatureV4Init & import("@smithy/signature-v4").SignatureV4CryptoInit) => import("@smithy/types").RequestSigner) | undefined;
45
- customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
46
48
  };
@@ -21,9 +21,9 @@ export declare const getRuntimeConfig: (config: BatchClientConfig) => {
21
21
  serviceId: string;
22
22
  useDualstackEndpoint: boolean | import("@smithy/types").Provider<boolean>;
23
23
  useFipsEndpoint: boolean | import("@smithy/types").Provider<boolean>;
24
- region: string | import("@smithy/types").Provider<any>;
25
- credentialDefaultProvider: (input: any) => import("@smithy/types").Provider<import("@aws-sdk/types").Credentials>;
26
24
  defaultUserAgentProvider: import("@smithy/types").Provider<import("@smithy/types").UserAgent>;
25
+ region: string | import("@smithy/types").Provider<any>;
26
+ credentialDefaultProvider: (input: any) => import("@smithy/types").AwsCredentialIdentityProvider;
27
27
  maxAttempts: number | import("@smithy/types").Provider<number>;
28
28
  retryMode: string | import("@smithy/types").Provider<string>;
29
29
  logger: import("@smithy/types").Logger;
@@ -35,11 +35,13 @@ export declare const getRuntimeConfig: (config: BatchClientConfig) => {
35
35
  }) => import("@smithy/types").EndpointV2;
36
36
  tls?: boolean | undefined;
37
37
  retryStrategy?: import("@smithy/types").RetryStrategy | import("@smithy/types").RetryStrategyV2 | undefined;
38
- credentials?: import("@smithy/types").AwsCredentialIdentity | import("@smithy/types").Provider<import("@smithy/types").AwsCredentialIdentity> | undefined;
38
+ customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
39
+ httpAuthSchemes: import("@smithy/types").HttpAuthScheme[];
40
+ httpAuthSchemeProvider: import("./auth/httpAuthSchemeProvider").BatchHttpAuthSchemeProvider;
41
+ credentials?: import("@smithy/types").AwsCredentialIdentity | import("@smithy/types").AwsCredentialIdentityProvider | undefined;
39
42
  signer?: import("@smithy/types").RequestSigner | ((authScheme?: import("@smithy/types").AuthScheme | undefined) => Promise<import("@smithy/types").RequestSigner>) | undefined;
40
43
  signingEscapePath?: boolean | undefined;
41
44
  systemClockOffset?: number | undefined;
42
45
  signingRegion?: string | undefined;
43
46
  signerConstructor?: (new (options: import("@smithy/signature-v4").SignatureV4Init & import("@smithy/signature-v4").SignatureV4CryptoInit) => import("@smithy/types").RequestSigner) | undefined;
44
- customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
45
47
  };
@@ -11,6 +11,8 @@ export declare const getRuntimeConfig: (config: BatchClientConfig) => {
11
11
  logger?: import("@smithy/types").Logger | undefined;
12
12
  }) => import("@smithy/types").EndpointV2;
13
13
  extensions: import("./runtimeExtensions").RuntimeExtension[];
14
+ httpAuthSchemeProvider: import("./auth/httpAuthSchemeProvider").BatchHttpAuthSchemeProvider;
15
+ httpAuthSchemes: import("@smithy/types").HttpAuthScheme[];
14
16
  logger: import("@smithy/types").Logger;
15
17
  serviceId: string;
16
18
  urlParser: import("@smithy/types").UrlParser;
@@ -2,15 +2,10 @@ import {
2
2
  HostHeaderInputConfig,
3
3
  HostHeaderResolvedConfig,
4
4
  } from "@aws-sdk/middleware-host-header";
5
- import {
6
- AwsAuthInputConfig,
7
- AwsAuthResolvedConfig,
8
- } from "@aws-sdk/middleware-signing";
9
5
  import {
10
6
  UserAgentInputConfig,
11
7
  UserAgentResolvedConfig,
12
8
  } from "@aws-sdk/middleware-user-agent";
13
- import { Credentials as __Credentials } from "@aws-sdk/types";
14
9
  import {
15
10
  RegionInputConfig,
16
11
  RegionResolvedConfig,
@@ -31,6 +26,7 @@ import {
31
26
  SmithyResolvedConfiguration as __SmithyResolvedConfiguration,
32
27
  } from "@smithy/smithy-client";
33
28
  import {
29
+ AwsCredentialIdentityProvider,
34
30
  BodyLengthCalculator as __BodyLengthCalculator,
35
31
  CheckOptionalClientConfig as __CheckOptionalClientConfig,
36
32
  ChecksumConstructor as __ChecksumConstructor,
@@ -45,6 +41,10 @@ import {
45
41
  UrlParser as __UrlParser,
46
42
  UserAgent as __UserAgent,
47
43
  } from "@smithy/types";
44
+ import {
45
+ HttpAuthSchemeInputConfig,
46
+ HttpAuthSchemeResolvedConfig,
47
+ } from "./auth/httpAuthSchemeProvider";
48
48
  import {
49
49
  CancelJobCommandInput,
50
50
  CancelJobCommandOutput,
@@ -214,9 +214,9 @@ export interface ClientDefaults
214
214
  serviceId?: string;
215
215
  useDualstackEndpoint?: boolean | __Provider<boolean>;
216
216
  useFipsEndpoint?: boolean | __Provider<boolean>;
217
- region?: string | __Provider<string>;
218
- credentialDefaultProvider?: (input: any) => __Provider<__Credentials>;
219
217
  defaultUserAgentProvider?: Provider<__UserAgent>;
218
+ region?: string | __Provider<string>;
219
+ credentialDefaultProvider?: (input: any) => AwsCredentialIdentityProvider;
220
220
  maxAttempts?: number | __Provider<number>;
221
221
  retryMode?: string | __Provider<string>;
222
222
  logger?: __Logger;
@@ -231,8 +231,8 @@ export type BatchClientConfigType = Partial<
231
231
  EndpointInputConfig<EndpointParameters> &
232
232
  RetryInputConfig &
233
233
  HostHeaderInputConfig &
234
- AwsAuthInputConfig &
235
234
  UserAgentInputConfig &
235
+ HttpAuthSchemeInputConfig &
236
236
  ClientInputEndpointParameters;
237
237
  export interface BatchClientConfig extends BatchClientConfigType {}
238
238
  export type BatchClientResolvedConfigType =
@@ -243,8 +243,8 @@ export type BatchClientResolvedConfigType =
243
243
  EndpointResolvedConfig<EndpointParameters> &
244
244
  RetryResolvedConfig &
245
245
  HostHeaderResolvedConfig &
246
- AwsAuthResolvedConfig &
247
246
  UserAgentResolvedConfig &
247
+ HttpAuthSchemeResolvedConfig &
248
248
  ClientResolvedEndpointParameters;
249
249
  export interface BatchClientResolvedConfig
250
250
  extends BatchClientResolvedConfigType {}
@@ -259,4 +259,6 @@ export declare class BatchClient extends __Client<
259
259
  ...[configuration]: __CheckOptionalClientConfig<BatchClientConfig>
260
260
  );
261
261
  destroy(): void;
262
+ private getDefaultHttpAuthSchemeParametersProvider;
263
+ private getIdentityProviderConfigProvider;
262
264
  }
@@ -0,0 +1,32 @@
1
+ import {
2
+ AwsCredentialIdentity,
3
+ AwsCredentialIdentityProvider,
4
+ HttpAuthScheme,
5
+ } from "@smithy/types";
6
+ import { BatchHttpAuthSchemeProvider } from "./httpAuthSchemeProvider";
7
+ export interface HttpAuthExtensionConfiguration {
8
+ setHttpAuthScheme(httpAuthScheme: HttpAuthScheme): void;
9
+ httpAuthSchemes(): HttpAuthScheme[];
10
+ setHttpAuthSchemeProvider(
11
+ httpAuthSchemeProvider: BatchHttpAuthSchemeProvider
12
+ ): void;
13
+ httpAuthSchemeProvider(): BatchHttpAuthSchemeProvider;
14
+ setCredentials(
15
+ credentials: AwsCredentialIdentity | AwsCredentialIdentityProvider
16
+ ): void;
17
+ credentials():
18
+ | AwsCredentialIdentity
19
+ | AwsCredentialIdentityProvider
20
+ | undefined;
21
+ }
22
+ export type HttpAuthRuntimeConfig = Partial<{
23
+ httpAuthSchemes: HttpAuthScheme[];
24
+ httpAuthSchemeProvider: BatchHttpAuthSchemeProvider;
25
+ credentials: AwsCredentialIdentity | AwsCredentialIdentityProvider;
26
+ }>;
27
+ export declare const getHttpAuthExtensionConfiguration: (
28
+ runtimeConfig: HttpAuthRuntimeConfig
29
+ ) => HttpAuthExtensionConfiguration;
30
+ export declare const resolveHttpAuthRuntimeConfig: (
31
+ config: HttpAuthExtensionConfiguration
32
+ ) => HttpAuthRuntimeConfig;