@aws-sdk/client-batch 3.295.0 → 3.297.0

package/dist-types/models/models_0.d.ts

@@ -1,10 +1,14 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { BatchServiceException as __BaseException } from "./BatchServiceException";
+/**
+ * @public
+ */
 export declare enum ArrayJobDependency {
     N_TO_N = "N_TO_N",
     SEQUENTIAL = "SEQUENTIAL"
 }
 /**
+ * @public
  * <p>An object that represents an Batch array job.</p>
  */
 export interface ArrayProperties {
@@ -14,6 +18,7 @@ export interface ArrayProperties {
     size?: number;
 }
 /**
+ * @public
  * <p>An object that represents the array properties of a job.</p>
  */
 export interface ArrayPropertiesDetail {
@@ -33,6 +38,7 @@ export interface ArrayPropertiesDetail {
     index?: number;
 }
 /**
+ * @public
  * <p>An object that represents the array properties of a job.</p>
  */
 export interface ArrayPropertiesSummary {
@@ -46,11 +52,15 @@ export interface ArrayPropertiesSummary {
      */
     index?: number;
 }
+/**
+ * @public
+ */
 export declare enum AssignPublicIp {
     DISABLED = "DISABLED",
     ENABLED = "ENABLED"
 }
 /**
+ * @public
  * <p>An object that represents the elastic network interface for a multi-node parallel job node.</p>
  */
 export interface NetworkInterface {
@@ -68,6 +78,7 @@ export interface NetworkInterface {
     privateIpv4Address?: string;
 }
 /**
+ * @public
  * <p>An object that represents the details of a container that's part of a job attempt.</p>
  */
 export interface AttemptContainerDetail {
@@ -101,6 +112,7 @@ export interface AttemptContainerDetail {
     networkInterfaces?: NetworkInterface[];
 }
 /**
+ * @public
  * <p>An object that represents a job attempt.</p>
  */
 export interface AttemptDetail {
@@ -124,6 +136,7 @@ export interface AttemptDetail {
     statusReason?: string;
 }
 /**
+ * @public
  * <p>Contains the parameters for <code>CancelJob</code>.</p>
  */
 export interface CancelJobRequest {
@@ -138,9 +151,13 @@ export interface CancelJobRequest {
      */
     reason: string | undefined;
 }
+/**
+ * @public
+ */
 export interface CancelJobResponse {
 }
 /**
+ * @public
  * <p>These errors are usually caused by a client action. One example cause is using an action or resource on behalf
  *    of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier
  *    that's not valid.</p>
@@ -154,6 +171,7 @@ export declare class ClientException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ClientException, __BaseException>);
 }
 /**
+ * @public
  * <p>These errors are usually caused by a server issue.</p>
  */
 export declare class ServerException extends __BaseException {
@@ -164,12 +182,16 @@ export declare class ServerException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ServerException, __BaseException>);
 }
+/**
+ * @public
+ */
 export declare enum CRAllocationStrategy {
     BEST_FIT = "BEST_FIT",
     BEST_FIT_PROGRESSIVE = "BEST_FIT_PROGRESSIVE",
     SPOT_CAPACITY_OPTIMIZED = "SPOT_CAPACITY_OPTIMIZED"
 }
 /**
+ * @public
  * <p>Provides information used to select Amazon Machine Images (AMIs) for instances in the compute environment. If
  *    <code>Ec2Configuration</code> isn't specified, the default is <code>ECS_AL2</code> (<a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami">Amazon Linux 2</a>).</p>
  *          <note>
@@ -253,6 +275,7 @@ export interface Ec2Configuration {
     imageKubernetesVersion?: string;
 }
 /**
+ * @public
  * <p>An object that represents a launch template that's associated with a compute resource. You must specify either
  *    the launch template ID or launch template name in the request, but not both.</p>
  *          <p>If security groups are specified using both the <code>securityGroupIds</code> parameter of
@@ -289,6 +312,9 @@ export interface LaunchTemplateSpecification {
      */
     version?: string;
 }
+/**
+ * @public
+ */
 export declare enum CRType {
     EC2 = "EC2",
     FARGATE = "FARGATE",
@@ -296,6 +322,7 @@ export declare enum CRType {
     SPOT = "SPOT"
 }
 /**
+ * @public
  * <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 the
  *    <i>Batch User Guide</i>.</p>
  */
@@ -460,7 +487,7 @@ export interface ComputeResource {
     /**
      * <p>Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For Batch,
      *    these take the form of <code>"String1": "String2"</code>, where <code>String1</code> is the tag key and
-     *    <code>String2</code> is the tag value-for example, <code>{ "Name": "Batch Instance - C4OnDemand" }</code>. This is
+     *    <code>String2</code> is the tag value-for example, <code>\{ "Name": "Batch Instance - C4OnDemand" \}</code>. This is
      *    helpful for recognizing your Batch instances in the Amazon EC2 console. Updating these tags requires an infrastructure
      *    update to 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
      *    <i>Batch User Guide</i>. These tags aren't seen when using the Batch <code>ListTagsForResource</code>
@@ -530,6 +557,7 @@ export interface ComputeResource {
     ec2Configuration?: Ec2Configuration[];
 }
 /**
+ * @public
  * <p>Configuration for the Amazon EKS cluster that supports the Batch compute environment. The cluster must exist before
  *    the compute environment can be created.</p>
  */
@@ -549,15 +577,22 @@ export interface EksConfiguration {
      */
     kubernetesNamespace: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum CEState {
     DISABLED = "DISABLED",
     ENABLED = "ENABLED"
 }
+/**
+ * @public
+ */
 export declare enum CEType {
     MANAGED = "MANAGED",
     UNMANAGED = "UNMANAGED"
 }
 /**
+ * @public
  * <p>Contains the parameters for <code>CreateComputeEnvironment</code>.</p>
  */
 export interface CreateComputeEnvironmentRequest {
@@ -633,6 +668,9 @@ export interface CreateComputeEnvironmentRequest {
      */
     eksConfiguration?: EksConfiguration;
 }
+/**
+ * @public
+ */
 export interface CreateComputeEnvironmentResponse {
     /**
      * <p>The name of the compute environment. It can be up to 128 characters long. It can contain uppercase and
@@ -645,6 +683,7 @@ export interface CreateComputeEnvironmentResponse {
     computeEnvironmentArn?: string;
 }
 /**
+ * @public
  * <p>The order that compute environments are tried in for job placement within a queue. Compute environments are
  *    tried in ascending order. For example, if two compute environments are associated with a job queue, the compute
  *    environment with a lower order integer value is tried for job placement first. Compute environments must be in the
@@ -668,11 +707,15 @@ export interface ComputeEnvironmentOrder {
      */
     computeEnvironment: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum JQState {
     DISABLED = "DISABLED",
     ENABLED = "ENABLED"
 }
 /**
+ * @public
  * <p>Contains the parameters for <code>CreateJobQueue</code>.</p>
  */
 export interface CreateJobQueueRequest {
@@ -726,6 +769,9 @@ export interface CreateJobQueueRequest {
      */
     tags?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface CreateJobQueueResponse {
     /**
      * <p>The name of the job queue.</p>
@@ -737,6 +783,7 @@ export interface CreateJobQueueResponse {
     jobQueueArn: string | undefined;
 }
 /**
+ * @public
  * <p>Specifies the weights for the fair share identifiers for the fair share policy. Fair share identifiers that
  *    aren't included have a default weight of <code>1.0</code>.</p>
  */
@@ -760,6 +807,7 @@ export interface ShareAttributes {
     weightFactor?: number;
 }
 /**
+ * @public
  * <p>The fair share policy for a scheduling policy.</p>
  */
 export interface FairsharePolicy {
@@ -793,6 +841,7 @@ export interface FairsharePolicy {
     shareDistribution?: ShareAttributes[];
 }
 /**
+ * @public
  * <p>Contains the parameters for <code>CreateSchedulingPolicy</code>.</p>
  */
 export interface CreateSchedulingPolicyRequest {
@@ -813,6 +862,9 @@ export interface CreateSchedulingPolicyRequest {
      */
     tags?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface CreateSchedulingPolicyResponse {
     /**
      * <p>The name of the scheduling policy.</p>
@@ -828,6 +880,7 @@ export interface CreateSchedulingPolicyResponse {
     arn: string | undefined;
 }
 /**
+ * @public
  * <p>Contains the parameters for <code>DeleteComputeEnvironment</code>.</p>
  */
 export interface DeleteComputeEnvironmentRequest {
@@ -836,9 +889,13 @@ export interface DeleteComputeEnvironmentRequest {
      */
     computeEnvironment: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteComputeEnvironmentResponse {
 }
 /**
+ * @public
  * <p>Contains the parameters for <code>DeleteJobQueue</code>.</p>
  */
 export interface DeleteJobQueueRequest {
@@ -847,9 +904,13 @@ export interface DeleteJobQueueRequest {
      */
     jobQueue: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteJobQueueResponse {
 }
 /**
+ * @public
  * <p>Contains the parameters for <code>DeleteSchedulingPolicy</code>.</p>
  */
 export interface DeleteSchedulingPolicyRequest {
@@ -858,17 +919,27 @@ export interface DeleteSchedulingPolicyRequest {
      */
     arn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteSchedulingPolicyResponse {
 }
+/**
+ * @public
+ */
 export interface DeregisterJobDefinitionRequest {
     /**
      * <p>The name and revision (<code>name:revision</code>) or full Amazon Resource Name (ARN) of the job definition to deregister.</p>
      */
     jobDefinition: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeregisterJobDefinitionResponse {
 }
 /**
+ * @public
  * <p>Contains the parameters for <code>DescribeComputeEnvironments</code>.</p>
  */
 export interface DescribeComputeEnvironmentsRequest {
@@ -898,10 +969,16 @@ export interface DescribeComputeEnvironmentsRequest {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export declare enum OrchestrationType {
     ECS = "ECS",
     EKS = "EKS"
 }
+/**
+ * @public
+ */
 export declare enum CEStatus {
     CREATING = "CREATING",
     DELETED = "DELETED",
@@ -911,6 +988,7 @@ export declare enum CEStatus {
     VALID = "VALID"
 }
 /**
+ * @public
  * <p>Specifies the infrastructure update policy for the compute environment. For more information about
  *    infrastructure updates, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating
  *     compute environments</a> in the <i>Batch User Guide</i>.</p>
@@ -928,6 +1006,7 @@ export interface UpdatePolicy {
     jobExecutionTimeoutMinutes?: number;
 }
 /**
+ * @public
  * <p>An object that represents an Batch compute environment.</p>
  */
 export interface ComputeEnvironmentDetail {
@@ -1010,6 +1089,9 @@ export interface ComputeEnvironmentDetail {
      */
     uuid?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeComputeEnvironmentsResponse {
     /**
      * <p>The list of compute environments.</p>
@@ -1024,13 +1106,14 @@ export interface DescribeComputeEnvironmentsResponse {
     nextToken?: string;
 }
 /**
+ * @public
  * <p>Contains the parameters for <code>DescribeJobDefinitions</code>.</p>
  */
 export interface DescribeJobDefinitionsRequest {
     /**
      * <p>A list of up to 100 job definitions. Each entry in the list can either be an ARN in the format
-     *     <code>arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}</code> or a short version
-     *    using the form <code>${JobDefinitionName}:${Revision}</code>.</p>
+     *     <code>arn:aws:batch:$\{Region\}:$\{Account\}:job-definition/$\{JobDefinitionName\}:$\{Revision\}</code> or a short version
+     *    using the form <code>$\{JobDefinitionName\}:$\{Revision\}</code>.</p>
      */
     jobDefinitions?: string[];
     /**
@@ -1064,6 +1147,7 @@ export interface DescribeJobDefinitionsRequest {
     nextToken?: string;
 }
 /**
+ * @public
  * <p>A key-value pair object.</p>
  */
 export interface KeyValuePair {
@@ -1078,6 +1162,7 @@ export interface KeyValuePair {
     value?: string;
 }
 /**
+ * @public
  * <p>The platform configuration for jobs that are running on Fargate resources. Jobs that run on EC2 resources must
  *    not specify this parameter.</p>
  */
@@ -1090,12 +1175,16 @@ export interface FargatePlatformConfiguration {
      */
     platformVersion?: string;
 }
+/**
+ * @public
+ */
 export declare enum DeviceCgroupPermission {
     MKNOD = "MKNOD",
     READ = "READ",
     WRITE = "WRITE"
 }
 /**
+ * @public
  * <p>An object that represents a container instance host device.</p>
  *          <note>
  *             <p>This object isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.</p>
@@ -1118,6 +1207,7 @@ export interface Device {
     permissions?: (DeviceCgroupPermission | string)[];
 }
 /**
+ * @public
  * <p>The container path, mount options, and size of the <code>tmpfs</code> mount.</p>
  *          <note>
  *             <p>This object isn't applicable to jobs that are running on Fargate resources.</p>
@@ -1146,6 +1236,7 @@ export interface Tmpfs {
     mountOptions?: string[];
 }
 /**
+ * @public
  * <p>Linux-specific modifications that are applied to the container, such as details for device mappings.</p>
  */
 export interface LinuxParameters {
@@ -1236,6 +1327,9 @@ export interface LinuxParameters {
      */
     swappiness?: number;
 }
+/**
+ * @public
+ */
 export declare enum LogDriver {
     AWSLOGS = "awslogs",
     FLUENTD = "fluentd",
@@ -1246,6 +1340,7 @@ export declare enum LogDriver {
     SYSLOG = "syslog"
 }
 /**
+ * @public
  * <p>An object that represents the secret to expose to your container. Secrets can be exposed to a container in the
  *    following ways:</p>
  *          <ul>
@@ -1278,6 +1373,7 @@ export interface Secret {
     valueFrom: string | undefined;
 }
 /**
+ * @public
  * <p>Log configuration options to send to a custom log driver for the container.</p>
  */
 export interface LogConfiguration {
@@ -1356,6 +1452,7 @@ export interface LogConfiguration {
     secretOptions?: Secret[];
 }
 /**
+ * @public
  * <p>Details for a Docker volume mount point that's used in a job's container properties. This 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 <code>--volume</code> option to
@@ -1377,6 +1474,7 @@ export interface MountPoint {
     sourceVolume?: string;
 }
 /**
+ * @public
  * <p>The network configuration for jobs that are running on Fargate resources. Jobs that are running on EC2
  *    resources must not specify this parameter.</p>
  */
@@ -1389,12 +1487,16 @@ export interface NetworkConfiguration {
      */
     assignPublicIp?: AssignPublicIp | string;
 }
+/**
+ * @public
+ */
 export declare enum ResourceType {
     GPU = "GPU",
     MEMORY = "MEMORY",
     VCPU = "VCPU"
 }
 /**
+ * @public
  * <p>The type and amount of a resource to assign to a container. The supported resources include <code>GPU</code>,
  *    <code>MEMORY</code>, and <code>VCPU</code>.</p>
  */
@@ -1566,6 +1668,7 @@ export interface ResourceRequirement {
     type: ResourceType | string | undefined;
 }
 /**
+ * @public
  * <p>The <code>ulimit</code> settings to pass to the container.</p>
  *          <note>
  *             <p>This object isn't applicable to jobs that are running on Fargate resources.</p>
@@ -1585,11 +1688,15 @@ export interface Ulimit {
      */
     softLimit: number | undefined;
 }
+/**
+ * @public
+ */
 export declare enum EFSAuthorizationConfigIAM {
     DISABLED = "DISABLED",
     ENABLED = "ENABLED"
 }
 /**
+ * @public
  * <p>The authorization configuration details for the Amazon EFS file system.</p>
  */
 export interface EFSAuthorizationConfig {
@@ -1610,11 +1717,15 @@ export interface EFSAuthorizationConfig {
      */
     iam?: EFSAuthorizationConfigIAM | string;
 }
+/**
+ * @public
+ */
 export declare enum EFSTransitEncryption {
     DISABLED = "DISABLED",
     ENABLED = "ENABLED"
 }
 /**
+ * @public
  * <p>This is used when you're using an Amazon Elastic File System file system for job storage. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/efs-volumes.html">Amazon EFS Volumes</a> in the
  *    <i>Batch User Guide</i>.</p>
  */
@@ -1652,6 +1763,7 @@ export interface EFSVolumeConfiguration {
     authorizationConfig?: EFSAuthorizationConfig;
 }
 /**
+ * @public
  * <p>Determine whether your data volume persists on the host container instance and where it's stored. If this
  *    parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't
  *    guaranteed to persist after the containers that are associated with it stop running.</p>
@@ -1671,6 +1783,7 @@ export interface Host {
     sourcePath?: string;
 }
 /**
+ * @public
  * <p>A data volume that's used in a job's container properties.</p>
  */
 export interface Volume {
@@ -1698,6 +1811,7 @@ export interface Volume {
     efsVolumeConfiguration?: EFSVolumeConfiguration;
 }
 /**
+ * @public
  * <p>Container properties are used
  *    for
  *    Amazon ECS based job definitions. These properties to describe the container that's launched as part of
@@ -1896,6 +2010,7 @@ export interface ContainerProperties {
     fargatePlatformConfiguration?: FargatePlatformConfiguration;
 }
 /**
+ * @public
  * <p>An environment variable.</p>
  */
 export interface EksContainerEnvironmentVariable {
@@ -1909,6 +2024,7 @@ export interface EksContainerEnvironmentVariable {
     value?: string;
 }
 /**
+ * @public
  * <p>The type and amount of resources to assign to a container. The supported resources include <code>memory</code>,
  *    <code>cpu</code>, and <code>nvidia.com/gpu</code>. For more information, see <a href="https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/">Resource management for pods
  *    and containers</a> in the <i>Kubernetes documentation</i>.</p>
@@ -1986,6 +2102,7 @@ export interface EksContainerResourceRequirements {
     requests?: Record<string, string>;
 }
 /**
+ * @public
  * <p>The security context for a job. For more information, see <a href="https://kubernetes.io/docs/tasks/configure-pod-container/security-context/">Configure a security context for a
  *    pod or container</a> in the <i>Kubernetes documentation</i>.</p>
  */
@@ -2026,6 +2143,7 @@ export interface EksContainerSecurityContext {
     runAsNonRoot?: boolean;
 }
 /**
+ * @public
  * <p>The volume mounts for a container for an Amazon EKS job. For more information about volumes and volume mounts in
  *    Kubernetes, see <a href="https://kubernetes.io/docs/concepts/storage/volumes/">Volumes</a> in the <i>Kubernetes
  *    documentation</i>.</p>
@@ -2046,6 +2164,7 @@ export interface EksContainerVolumeMount {
     readOnly?: boolean;
 }
 /**
+ * @public
  * <p>EKS container properties are used in job definitions for Amazon EKS based job definitions to describe the properties
  *    for a container node in the pod that's launched as part of a job. This can't be specified for Amazon ECS based job
  *    definitions.</p>
@@ -2122,6 +2241,7 @@ export interface EksContainer {
     securityContext?: EksContainerSecurityContext;
 }
 /**
+ * @public
  * <p>Specifies the configuration of a Kubernetes <code>emptyDir</code> volume. An <code>emptyDir</code> volume is first
  *    created when a pod is assigned to a node. It exists as long as that pod is running on that node. The
  *    <code>emptyDir</code> volume is initially empty. All containers in the pod can read and write the files in the
@@ -2153,6 +2273,7 @@ export interface EksEmptyDir {
     sizeLimit?: string;
 }
 /**
+ * @public
  * <p>Specifies the configuration of a Kubernetes <code>hostPath</code> volume. A <code>hostPath</code> volume mounts an
  *    existing file or directory from the host node's filesystem into your pod. For more information, see <a href="https://kubernetes.io/docs/concepts/storage/volumes/#hostpath">hostPath</a> in the <i>Kubernetes
  *    documentation</i>.</p>
@@ -2164,6 +2285,7 @@ export interface EksHostPath {
     path?: string;
 }
 /**
+ * @public
  * <p>Specifies the configuration of a Kubernetes <code>secret</code> volume. For more information, see <a href="https://kubernetes.io/docs/concepts/storage/volumes/#secret">secret</a> in the <i>Kubernetes
  *    documentation</i>.</p>
  */
@@ -2179,6 +2301,7 @@ export interface EksSecret {
     optional?: boolean;
 }
 /**
+ * @public
  * <p>Specifies an Amazon EKS volume for a job definition.</p>
  */
 export interface EksVolume {
@@ -2204,6 +2327,7 @@ export interface EksVolume {
     secret?: EksSecret;
 }
 /**
+ * @public
  * <p>The properties for the pod.</p>
  */
 export interface EksPodProperties {
@@ -2241,6 +2365,7 @@ export interface EksPodProperties {
     volumes?: EksVolume[];
 }
 /**
+ * @public
  * <p>An object that contains the properties for the Kubernetes resources of a job.</p>
  */
 export interface EksProperties {
@@ -2250,6 +2375,7 @@ export interface EksProperties {
     podProperties?: EksPodProperties;
 }
 /**
+ * @public
  * <p>An object that represents the properties of the node range for a multi-node parallel job.</p>
  */
 export interface NodeRangeProperty {
@@ -2268,6 +2394,7 @@ export interface NodeRangeProperty {
     container?: ContainerProperties;
 }
 /**
+ * @public
  * <p>An object that represents the node properties of a multi-node parallel job.</p>
  *          <note>
  *             <p>Node properties can't be specified for Amazon EKS based job definitions.</p>
@@ -2288,15 +2415,22 @@ export interface NodeProperties {
      */
     nodeRangeProperties: NodeRangeProperty[] | undefined;
 }
+/**
+ * @public
+ */
 export declare enum PlatformCapability {
     EC2 = "EC2",
     FARGATE = "FARGATE"
 }
+/**
+ * @public
+ */
 export declare enum RetryAction {
     EXIT = "EXIT",
     RETRY = "RETRY"
 }
 /**
+ * @public
  * <p>Specifies an array of up to 5 conditions to be met, and an action to take (<code>RETRY</code> or
  *    <code>EXIT</code>) if all conditions are met. If none of the <code>EvaluateOnExit</code> conditions in a
  *    <code>RetryStrategy</code> match, then the job is retried.</p>
@@ -2330,6 +2464,7 @@ export interface EvaluateOnExit {
     action: RetryAction | string | undefined;
 }
 /**
+ * @public
  * <p>The retry strategy that's associated with a job. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/job_retries.html">Automated job retries</a> in the <i>Batch User Guide</i>.</p>
  */
 export interface RetryStrategy {
@@ -2347,6 +2482,7 @@ export interface RetryStrategy {
     evaluateOnExit?: EvaluateOnExit[];
 }
 /**
+ * @public
  * <p>An object that represents a job timeout configuration.</p>
  */
 export interface JobTimeout {
@@ -2360,6 +2496,7 @@ export interface JobTimeout {
     attemptDurationSeconds?: number;
 }
 /**
+ * @public
  * <p>An object that represents an Batch job definition.</p>
  */
 export interface JobDefinition {
@@ -2451,6 +2588,9 @@ export interface JobDefinition {
      */
     containerOrchestrationType?: OrchestrationType | string;
 }
+/**
+ * @public
+ */
 export interface DescribeJobDefinitionsResponse {
     /**
      * <p>The list of job definitions.</p>
@@ -2464,6 +2604,7 @@ export interface DescribeJobDefinitionsResponse {
     nextToken?: string;
 }
 /**
+ * @public
  * <p>Contains the parameters for <code>DescribeJobQueues</code>.</p>
  */
 export interface DescribeJobQueuesRequest {
@@ -2492,6 +2633,9 @@ export interface DescribeJobQueuesRequest {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export declare enum JQStatus {
     CREATING = "CREATING",
     DELETED = "DELETED",
@@ -2501,6 +2645,7 @@ export declare enum JQStatus {
     VALID = "VALID"
 }
 /**
+ * @public
  * <p>An object that represents the details for an Batch job queue.</p>
  */
 export interface JobQueueDetail {
@@ -2554,6 +2699,9 @@ export interface JobQueueDetail {
      */
     tags?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface DescribeJobQueuesResponse {
     /**
      * <p>The list of job queues.</p>
@@ -2567,6 +2715,7 @@ export interface DescribeJobQueuesResponse {
     nextToken?: string;
 }
 /**
+ * @public
  * <p>Contains the parameters for <code>DescribeJobs</code>.</p>
  */
 export interface DescribeJobsRequest {
@@ -2576,6 +2725,7 @@ export interface DescribeJobsRequest {
     jobs: string[] | undefined;
 }
 /**
+ * @public
  * <p>An object that represents the details of a container that's part of a job.</p>
  */
 export interface ContainerDetail {
@@ -2751,6 +2901,7 @@ export interface ContainerDetail {
     fargatePlatformConfiguration?: FargatePlatformConfiguration;
 }
 /**
+ * @public
  * <p>An object that represents an Batch job dependency.</p>
  */
 export interface JobDependency {
@@ -2764,6 +2915,7 @@ export interface JobDependency {
     type?: ArrayJobDependency | string;
 }
 /**
+ * @public
  * <p>An object that represents the details for an attempt for a job attempt that an Amazon EKS container runs.</p>
  */
 export interface EksAttemptContainerDetail {
@@ -2778,6 +2930,7 @@ export interface EksAttemptContainerDetail {
     reason?: string;
 }
 /**
+ * @public
  * <p>An object that represents the details of a job attempt for a job attempt by an Amazon EKS container.</p>
  */
 export interface EksAttemptDetail {
@@ -2810,6 +2963,7 @@ export interface EksAttemptDetail {
     statusReason?: string;
 }
 /**
+ * @public
  * <p>The details for container properties that are returned by <code>DescribeJobs</code> for jobs that use
  *    Amazon EKS.</p>
  */
@@ -2884,6 +3038,7 @@ export interface EksContainerDetail {
     securityContext?: EksContainerSecurityContext;
 }
 /**
+ * @public
  * <p>The details for the pod.</p>
  */
 export interface EksPodPropertiesDetail {
@@ -2932,6 +3087,7 @@ export interface EksPodPropertiesDetail {
     nodeName?: string;
 }
 /**
+ * @public
  * <p>An object that contains the details for the Kubernetes resources of a job.</p>
  */
 export interface EksPropertiesDetail {
@@ -2941,6 +3097,7 @@ export interface EksPropertiesDetail {
     podProperties?: EksPodPropertiesDetail;
 }
 /**
+ * @public
  * <p>An object that represents the details of a multi-node parallel job node.</p>
  */
 export interface NodeDetails {
@@ -2954,6 +3111,9 @@ export interface NodeDetails {
      */
     isMainNode?: boolean;
 }
+/**
+ * @public
+ */
 export declare enum JobStatus {
     FAILED = "FAILED",
     PENDING = "PENDING",
@@ -2964,6 +3124,7 @@ export declare enum JobStatus {
     SUCCEEDED = "SUCCEEDED"
 }
 /**
+ * @public
  * <p>An object that represents an Batch job.</p>
  */
 export interface JobDetail {
@@ -3100,6 +3261,9 @@ export interface JobDetail {
      */
     isTerminated?: boolean;
 }
+/**
+ * @public
+ */
 export interface DescribeJobsResponse {
     /**
      * <p>The list of jobs.</p>
@@ -3107,6 +3271,7 @@ export interface DescribeJobsResponse {
     jobs?: JobDetail[];
 }
 /**
+ * @public
  * <p>Contains the parameters for <code>DescribeSchedulingPolicies</code>.</p>
  */
 export interface DescribeSchedulingPoliciesRequest {
@@ -3116,6 +3281,7 @@ export interface DescribeSchedulingPoliciesRequest {
     arns: string[] | undefined;
 }
 /**
+ * @public
  * <p>An object that represents a scheduling policy.</p>
  */
 export interface SchedulingPolicyDetail {
@@ -3140,6 +3306,9 @@ export interface SchedulingPolicyDetail {
      */
     tags?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface DescribeSchedulingPoliciesResponse {
     /**
      * <p>The list of scheduling policies.</p>
@@ -3147,6 +3316,7 @@ export interface DescribeSchedulingPoliciesResponse {
     schedulingPolicies?: SchedulingPolicyDetail[];
 }
 /**
+ * @public
  * <p>A filter name and value pair that's used to return a more specific list of results from a <code>ListJobs</code>
  *    API operation.</p>
  */
@@ -3161,6 +3331,7 @@ export interface KeyValuesPair {
     values?: string[];
 }
 /**
+ * @public
  * <p>Contains the parameters for <code>ListJobs</code>.</p>
  */
 export interface ListJobsRequest {
@@ -3226,7 +3397,7 @@ export interface ListJobsRequest {
      *       example, <code>jd1</code> matches only <code>jd1</code>, and <code>jd1*</code> matches both <code>jd1</code> and
      *       <code>jd1A</code>. The version of the job definition that's used doesn't affect the sort order. When the
      *       <code>JOB_DEFINITION</code> filter is used and the ARN is used (which is in the form
-     *       <code>arn:${Partition}:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}</code>), the
+     *       <code>arn:$\{Partition\}:batch:$\{Region\}:$\{Account\}:job-definition/$\{JobDefinitionName\}:$\{Revision\}</code>), the
      *       results include jobs that used the specified revision of the job definition. Asterisk (*) isn't supported when the
      *       ARN is used.</p>
      *             </dd>
@@ -3247,6 +3418,7 @@ export interface ListJobsRequest {
     filters?: KeyValuesPair[];
 }
 /**
+ * @public
  * <p>An object that represents summary details of a container within a job.</p>
  */
 export interface ContainerSummary {
@@ -3261,6 +3433,7 @@ export interface ContainerSummary {
     reason?: string;
 }
 /**
+ * @public
  * <p>An object that represents the properties of a node that's associated with a multi-node parallel job.</p>
  */
 export interface NodePropertiesSummary {
@@ -3279,6 +3452,7 @@ export interface NodePropertiesSummary {
     nodeIndex?: number;
 }
 /**
+ * @public
  * <p>An object that represents summary details of a job.</p>
  */
 export interface JobSummary {
@@ -3339,6 +3513,9 @@ export interface JobSummary {
      */
     jobDefinition?: string;
 }
+/**
+ * @public
+ */
 export interface ListJobsResponse {
     /**
      * <p>A list of job summaries that match the request.</p>
@@ -3352,6 +3529,7 @@ export interface ListJobsResponse {
     nextToken?: string;
 }
 /**
+ * @public
  * <p>Contains the parameters for <code>ListSchedulingPolicies</code>.</p>
  */
 export interface ListSchedulingPoliciesRequest {
@@ -3379,6 +3557,7 @@ export interface ListSchedulingPoliciesRequest {
     nextToken?: string;
 }
 /**
+ * @public
  * <p>An object that contains the details of a scheduling policy that's returned in a
  *    <code>ListSchedulingPolicy</code> action.</p>
  */
@@ -3388,6 +3567,9 @@ export interface SchedulingPolicyListingDetail {
      */
     arn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListSchedulingPoliciesResponse {
     /**
      * <p>A list of scheduling policies that match the request.</p>
@@ -3401,6 +3583,7 @@ export interface ListSchedulingPoliciesResponse {
     nextToken?: string;
 }
 /**
+ * @public
  * <p>Contains the parameters for <code>ListTagsForResource</code>.</p>
  */
 export interface ListTagsForResourceRequest {
@@ -3410,17 +3593,24 @@ export interface ListTagsForResourceRequest {
      */
     resourceArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceResponse {
     /**
      * <p>The tags for the resource.</p>
      */
     tags?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export declare enum JobDefinitionType {
     Container = "container",
     Multinode = "multinode"
 }
 /**
+ * @public
  * <p>Contains the parameters for <code>RegisterJobDefinition</code>.</p>
  */
 export interface RegisterJobDefinitionRequest {
@@ -3517,6 +3707,9 @@ export interface RegisterJobDefinitionRequest {
      */
     eksProperties?: EksProperties;
 }
+/**
+ * @public
+ */
 export interface RegisterJobDefinitionResponse {
     /**
      * <p>The name of the job definition.</p>
@@ -3532,6 +3725,7 @@ export interface RegisterJobDefinitionResponse {
     revision: number | undefined;
 }
 /**
+ * @public
  * <p>The overrides that should be sent to a container.</p>
  */
 export interface ContainerOverrides {
@@ -3591,6 +3785,7 @@ export interface ContainerOverrides {
     resourceRequirements?: ResourceRequirement[];
 }
 /**
+ * @public
  * <p>Object representing any Kubernetes overrides to a job definition that's used in a <a>SubmitJob</a> API
  *    operation.</p>
  */
@@ -3630,6 +3825,7 @@ export interface EksContainerOverride {
     resources?: EksContainerResourceRequirements;
 }
 /**
+ * @public
  * <p>An object that contains overrides for the Kubernetes pod properties of a job.</p>
  */
 export interface EksPodPropertiesOverride {
@@ -3639,6 +3835,7 @@ export interface EksPodPropertiesOverride {
     containers?: EksContainerOverride[];
 }
 /**
+ * @public
  * <p>An object that contains overrides for the Kubernetes resources of a job.</p>
  */
 export interface EksPropertiesOverride {
@@ -3648,6 +3845,7 @@ export interface EksPropertiesOverride {
     podProperties?: EksPodPropertiesOverride;
 }
 /**
+ * @public
  * <p>The object that represents any node overrides to a job definition that's used in a <a>SubmitJob</a>
  *    API operation.</p>
  */
@@ -3665,6 +3863,7 @@ export interface NodePropertyOverride {
     containerOverrides?: ContainerOverrides;
 }
 /**
+ * @public
  * <p>An object that represents any node overrides to a job definition that's used in a <a>SubmitJob</a>
  *    API operation.</p>
  *          <note>
@@ -3698,6 +3897,7 @@ export interface NodeOverrides {
     nodePropertyOverrides?: NodePropertyOverride[];
 }
 /**
+ * @public
  * <p>Contains the parameters for <code>SubmitJob</code>.</p>
  */
 export interface SubmitJobRequest {
@@ -3799,6 +3999,9 @@ export interface SubmitJobRequest {
      */
     eksPropertiesOverride?: EksPropertiesOverride;
 }
+/**
+ * @public
+ */
 export interface SubmitJobResponse {
     /**
      * <p>The Amazon Resource Name (ARN) for the job.</p>
@@ -3814,6 +4017,7 @@ export interface SubmitJobResponse {
     jobId: string | undefined;
 }
 /**
+ * @public
  * <p>Contains the parameters for <code>TagResource</code>.</p>
  */
 export interface TagResourceRequest {
@@ -3829,9 +4033,13 @@ export interface TagResourceRequest {
      */
     tags: Record<string, string> | undefined;
 }
+/**
+ * @public
+ */
 export interface TagResourceResponse {
 }
 /**
+ * @public
  * <p>Contains the parameters for <code>TerminateJob</code>.</p>
  */
 export interface TerminateJobRequest {
@@ -3846,9 +4054,13 @@ export interface TerminateJobRequest {
      */
     reason: string | undefined;
 }
+/**
+ * @public
+ */
 export interface TerminateJobResponse {
 }
 /**
+ * @public
  * <p>Contains the parameters for <code>UntagResource</code>.</p>
  */
 export interface UntagResourceRequest {
@@ -3862,13 +4074,20 @@ export interface UntagResourceRequest {
      */
     tagKeys: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface UntagResourceResponse {
 }
+/**
+ * @public
+ */
 export declare enum CRUpdateAllocationStrategy {
     BEST_FIT_PROGRESSIVE = "BEST_FIT_PROGRESSIVE",
     SPOT_CAPACITY_OPTIMIZED = "SPOT_CAPACITY_OPTIMIZED"
 }
 /**
+ * @public
  * <p>An object that represents the attributes of a compute environment that can be updated. For more information, see
  *    <a href="https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html">Updating compute environments</a>
  *    in the <i>Batch User Guide</i>.</p>
@@ -4018,7 +4237,7 @@ export interface ComputeResourceUpdate {
     /**
      * <p>Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For Batch,
      *    these take the form of <code>"String1": "String2"</code>, where <code>String1</code> is the tag key and
-     *    <code>String2</code> is the tag value-for example, <code>{ "Name": "Batch Instance - C4OnDemand" }</code>. This is
+     *    <code>String2</code> is the tag value-for example, <code>\{ "Name": "Batch Instance - C4OnDemand" \}</code>. This is
      *    helpful for recognizing your Batch instances in the Amazon EC2 console. These tags aren't seen when using the Batch
      *    <code>ListTagsForResource</code> API operation.</p>
      *          <p>When updating a compute environment, changing this setting requires an infrastructure update of the compute
@@ -4131,6 +4350,7 @@ export interface ComputeResourceUpdate {
     imageId?: string;
 }
 /**
+ * @public
  * <p>Contains the parameters for <code>UpdateComputeEnvironment</code>.</p>
  */
 export interface UpdateComputeEnvironmentRequest {
@@ -4191,6 +4411,9 @@ export interface UpdateComputeEnvironmentRequest {
      */
     updatePolicy?: UpdatePolicy;
 }
+/**
+ * @public
+ */
 export interface UpdateComputeEnvironmentResponse {
     /**
      * <p>The name of the compute environment. It can be up to 128 characters long. It can contain uppercase and
@@ -4203,6 +4426,7 @@ export interface UpdateComputeEnvironmentResponse {
     computeEnvironmentArn?: string;
 }
 /**
+ * @public
  * <p>Contains the parameters for <code>UpdateJobQueue</code>.</p>
  */
 export interface UpdateJobQueueRequest {
@@ -4247,6 +4471,9 @@ export interface UpdateJobQueueRequest {
      */
     computeEnvironmentOrder?: ComputeEnvironmentOrder[];
 }
+/**
+ * @public
+ */
 export interface UpdateJobQueueResponse {
     /**
      * <p>The name of the job queue.</p>
@@ -4258,6 +4485,7 @@ export interface UpdateJobQueueResponse {
     jobQueueArn?: string;
 }
 /**
+ * @public
  * <p>Contains the parameters for <code>UpdateSchedulingPolicy</code>.</p>
  */
 export interface UpdateSchedulingPolicyRequest {
@@ -4270,6 +4498,9 @@ export interface UpdateSchedulingPolicyRequest {
      */
     fairsharePolicy?: FairsharePolicy;
 }
+/**
+ * @public
+ */
 export interface UpdateSchedulingPolicyResponse {
 }
 /**