BatchClient

Index > Batch > BatchClient

Auto-generated documentation for Batch type annotations stubs module types-boto3-batch.

BatchClient

Type annotations and code completion for boto3.client("batch"). boto3 documentation

# BatchClient usage example

from boto3.session import Session
from types_boto3_batch.client import BatchClient

def get_batch_client() -> BatchClient:
    return Session().client("batch")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("batch").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("batch")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.ClientException,
    client.exceptions.ServerException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from types_boto3_batch.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods

can_paginate

Type annotations and code completion for boto3.client("batch").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url

Type annotations and code completion for boto3.client("batch").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

cancel_job

Cancels a job in an Batch job queue.

Type annotations and code completion for boto3.client("batch").cancel_job method. boto3 documentation

# cancel_job method definition

def cancel_job(
    self,
    *,
    jobId: str,
    reason: str,
) -> Dict[str, Any]:
    ...

# cancel_job method usage example with argument unpacking

kwargs: CancelJobRequestTypeDef = {  # (1)
    "jobId": ...,
    "reason": ...,
}

parent.cancel_job(**kwargs)

1. See CancelJobRequestTypeDef

create_compute_environment

Creates an Batch compute environment.

Type annotations and code completion for boto3.client("batch").create_compute_environment method. boto3 documentation

# create_compute_environment method definition

def create_compute_environment(
    self,
    *,
    computeEnvironmentName: str,
    type: CETypeType,  # (1)
    state: CEStateType = ...,  # (2)
    unmanagedvCpus: int = ...,
    computeResources: ComputeResourceUnionTypeDef = ...,  # (3)
    serviceRole: str = ...,
    tags: Mapping[str, str] = ...,
    eksConfiguration: EksConfigurationTypeDef = ...,  # (4)
    context: str = ...,
) -> CreateComputeEnvironmentResponseTypeDef:  # (5)
    ...

1. See CETypeType
2. See CEStateType
3. See ComputeResourceUnionTypeDef
4. See EksConfigurationTypeDef
5. See CreateComputeEnvironmentResponseTypeDef

# create_compute_environment method usage example with argument unpacking

kwargs: CreateComputeEnvironmentRequestTypeDef = {  # (1)
    "computeEnvironmentName": ...,
    "type": ...,
}

parent.create_compute_environment(**kwargs)

1. See CreateComputeEnvironmentRequestTypeDef

create_consumable_resource

Creates an Batch consumable resource.

Type annotations and code completion for boto3.client("batch").create_consumable_resource method. boto3 documentation

# create_consumable_resource method definition

def create_consumable_resource(
    self,
    *,
    consumableResourceName: str,
    totalQuantity: int = ...,
    resourceType: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateConsumableResourceResponseTypeDef:  # (1)
    ...

1. See CreateConsumableResourceResponseTypeDef

# create_consumable_resource method usage example with argument unpacking

kwargs: CreateConsumableResourceRequestTypeDef = {  # (1)
    "consumableResourceName": ...,
}

parent.create_consumable_resource(**kwargs)

1. See CreateConsumableResourceRequestTypeDef

create_job_queue

Creates an Batch job queue.

Type annotations and code completion for boto3.client("batch").create_job_queue method. boto3 documentation

# create_job_queue method definition

def create_job_queue(
    self,
    *,
    jobQueueName: str,
    priority: int,
    state: JQStateType = ...,  # (1)
    schedulingPolicyArn: str = ...,
    computeEnvironmentOrder: Sequence[ComputeEnvironmentOrderTypeDef] = ...,  # (2)
    serviceEnvironmentOrder: Sequence[ServiceEnvironmentOrderTypeDef] = ...,  # (3)
    jobQueueType: JobQueueTypeType = ...,  # (4)
    tags: Mapping[str, str] = ...,
    jobStateTimeLimitActions: Sequence[JobStateTimeLimitActionTypeDef] = ...,  # (5)
) -> CreateJobQueueResponseTypeDef:  # (6)
    ...

1. See JQStateType
2. See Sequence[ComputeEnvironmentOrderTypeDef]
3. See Sequence[ServiceEnvironmentOrderTypeDef]
4. See JobQueueTypeType
5. See Sequence[JobStateTimeLimitActionTypeDef]
6. See CreateJobQueueResponseTypeDef

# create_job_queue method usage example with argument unpacking

kwargs: CreateJobQueueRequestTypeDef = {  # (1)
    "jobQueueName": ...,
    "priority": ...,
}

parent.create_job_queue(**kwargs)

1. See CreateJobQueueRequestTypeDef

create_scheduling_policy

Creates an Batch scheduling policy.

Type annotations and code completion for boto3.client("batch").create_scheduling_policy method. boto3 documentation

# create_scheduling_policy method definition

def create_scheduling_policy(
    self,
    *,
    name: str,
    fairsharePolicy: FairsharePolicyUnionTypeDef = ...,  # (1)
    tags: Mapping[str, str] = ...,
) -> CreateSchedulingPolicyResponseTypeDef:  # (2)
    ...

1. See FairsharePolicyUnionTypeDef
2. See CreateSchedulingPolicyResponseTypeDef

# create_scheduling_policy method usage example with argument unpacking

kwargs: CreateSchedulingPolicyRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_scheduling_policy(**kwargs)

1. See CreateSchedulingPolicyRequestTypeDef

create_service_environment

Creates a service environment for running service jobs.

Type annotations and code completion for boto3.client("batch").create_service_environment method. boto3 documentation

# create_service_environment method definition

def create_service_environment(
    self,
    *,
    serviceEnvironmentName: str,
    serviceEnvironmentType: ServiceEnvironmentTypeType,  # (1)
    capacityLimits: Sequence[CapacityLimitTypeDef],  # (2)
    state: ServiceEnvironmentStateType = ...,  # (3)
    tags: Mapping[str, str] = ...,
) -> CreateServiceEnvironmentResponseTypeDef:  # (4)
    ...

1. See ServiceEnvironmentTypeType
2. See Sequence[CapacityLimitTypeDef]
3. See ServiceEnvironmentStateType
4. See CreateServiceEnvironmentResponseTypeDef

# create_service_environment method usage example with argument unpacking

kwargs: CreateServiceEnvironmentRequestTypeDef = {  # (1)
    "serviceEnvironmentName": ...,
    "serviceEnvironmentType": ...,
    "capacityLimits": ...,
}

parent.create_service_environment(**kwargs)

1. See CreateServiceEnvironmentRequestTypeDef

delete_compute_environment

Deletes an Batch compute environment.

Type annotations and code completion for boto3.client("batch").delete_compute_environment method. boto3 documentation

# delete_compute_environment method definition

def delete_compute_environment(
    self,
    *,
    computeEnvironment: str,
) -> Dict[str, Any]:
    ...

# delete_compute_environment method usage example with argument unpacking

kwargs: DeleteComputeEnvironmentRequestTypeDef = {  # (1)
    "computeEnvironment": ...,
}

parent.delete_compute_environment(**kwargs)

1. See DeleteComputeEnvironmentRequestTypeDef

delete_consumable_resource

Deletes the specified consumable resource.

Type annotations and code completion for boto3.client("batch").delete_consumable_resource method. boto3 documentation

# delete_consumable_resource method definition

def delete_consumable_resource(
    self,
    *,
    consumableResource: str,
) -> Dict[str, Any]:
    ...

# delete_consumable_resource method usage example with argument unpacking

kwargs: DeleteConsumableResourceRequestTypeDef = {  # (1)
    "consumableResource": ...,
}

parent.delete_consumable_resource(**kwargs)

1. See DeleteConsumableResourceRequestTypeDef

delete_job_queue

Deletes the specified job queue.

Type annotations and code completion for boto3.client("batch").delete_job_queue method. boto3 documentation

# delete_job_queue method definition

def delete_job_queue(
    self,
    *,
    jobQueue: str,
) -> Dict[str, Any]:
    ...

# delete_job_queue method usage example with argument unpacking

kwargs: DeleteJobQueueRequestTypeDef = {  # (1)
    "jobQueue": ...,
}

parent.delete_job_queue(**kwargs)

1. See DeleteJobQueueRequestTypeDef

delete_scheduling_policy

Deletes the specified scheduling policy.

Type annotations and code completion for boto3.client("batch").delete_scheduling_policy method. boto3 documentation

# delete_scheduling_policy method definition

def delete_scheduling_policy(
    self,
    *,
    arn: str,
) -> Dict[str, Any]:
    ...

# delete_scheduling_policy method usage example with argument unpacking

kwargs: DeleteSchedulingPolicyRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.delete_scheduling_policy(**kwargs)

1. See DeleteSchedulingPolicyRequestTypeDef

delete_service_environment

Deletes a Service environment.

Type annotations and code completion for boto3.client("batch").delete_service_environment method. boto3 documentation

# delete_service_environment method definition

def delete_service_environment(
    self,
    *,
    serviceEnvironment: str,
) -> Dict[str, Any]:
    ...

# delete_service_environment method usage example with argument unpacking

kwargs: DeleteServiceEnvironmentRequestTypeDef = {  # (1)
    "serviceEnvironment": ...,
}

parent.delete_service_environment(**kwargs)

1. See DeleteServiceEnvironmentRequestTypeDef

deregister_job_definition

Deregisters an Batch job definition.

Type annotations and code completion for boto3.client("batch").deregister_job_definition method. boto3 documentation

# deregister_job_definition method definition

def deregister_job_definition(
    self,
    *,
    jobDefinition: str,
) -> Dict[str, Any]:
    ...

# deregister_job_definition method usage example with argument unpacking

kwargs: DeregisterJobDefinitionRequestTypeDef = {  # (1)
    "jobDefinition": ...,
}

parent.deregister_job_definition(**kwargs)

1. See DeregisterJobDefinitionRequestTypeDef

describe_compute_environments

Describes one or more of your compute environments.

Type annotations and code completion for boto3.client("batch").describe_compute_environments method. boto3 documentation

# describe_compute_environments method definition

def describe_compute_environments(
    self,
    *,
    computeEnvironments: Sequence[str] = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> DescribeComputeEnvironmentsResponseTypeDef:  # (1)
    ...

1. See DescribeComputeEnvironmentsResponseTypeDef

# describe_compute_environments method usage example with argument unpacking

kwargs: DescribeComputeEnvironmentsRequestTypeDef = {  # (1)
    "computeEnvironments": ...,
}

parent.describe_compute_environments(**kwargs)

1. See DescribeComputeEnvironmentsRequestTypeDef

describe_consumable_resource

Returns a description of the specified consumable resource.

Type annotations and code completion for boto3.client("batch").describe_consumable_resource method. boto3 documentation

# describe_consumable_resource method definition

def describe_consumable_resource(
    self,
    *,
    consumableResource: str,
) -> DescribeConsumableResourceResponseTypeDef:  # (1)
    ...

1. See DescribeConsumableResourceResponseTypeDef

# describe_consumable_resource method usage example with argument unpacking

kwargs: DescribeConsumableResourceRequestTypeDef = {  # (1)
    "consumableResource": ...,
}

parent.describe_consumable_resource(**kwargs)

1. See DescribeConsumableResourceRequestTypeDef

describe_job_definitions

Describes a list of job definitions.

Type annotations and code completion for boto3.client("batch").describe_job_definitions method. boto3 documentation

# describe_job_definitions method definition

def describe_job_definitions(
    self,
    *,
    jobDefinitions: Sequence[str] = ...,
    maxResults: int = ...,
    jobDefinitionName: str = ...,
    status: str = ...,
    nextToken: str = ...,
) -> DescribeJobDefinitionsResponseTypeDef:  # (1)
    ...

1. See DescribeJobDefinitionsResponseTypeDef

# describe_job_definitions method usage example with argument unpacking

kwargs: DescribeJobDefinitionsRequestTypeDef = {  # (1)
    "jobDefinitions": ...,
}

parent.describe_job_definitions(**kwargs)

1. See DescribeJobDefinitionsRequestTypeDef

describe_job_queues

Describes one or more of your job queues.

Type annotations and code completion for boto3.client("batch").describe_job_queues method. boto3 documentation

# describe_job_queues method definition

def describe_job_queues(
    self,
    *,
    jobQueues: Sequence[str] = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> DescribeJobQueuesResponseTypeDef:  # (1)
    ...

1. See DescribeJobQueuesResponseTypeDef

# describe_job_queues method usage example with argument unpacking

kwargs: DescribeJobQueuesRequestTypeDef = {  # (1)
    "jobQueues": ...,
}

parent.describe_job_queues(**kwargs)

1. See DescribeJobQueuesRequestTypeDef

describe_jobs

Describes a list of Batch jobs.

Type annotations and code completion for boto3.client("batch").describe_jobs method. boto3 documentation

# describe_jobs method definition

def describe_jobs(
    self,
    *,
    jobs: Sequence[str],
) -> DescribeJobsResponseTypeDef:  # (1)
    ...

1. See DescribeJobsResponseTypeDef

# describe_jobs method usage example with argument unpacking

kwargs: DescribeJobsRequestTypeDef = {  # (1)
    "jobs": ...,
}

parent.describe_jobs(**kwargs)

1. See DescribeJobsRequestTypeDef

describe_scheduling_policies

Describes one or more of your scheduling policies.

Type annotations and code completion for boto3.client("batch").describe_scheduling_policies method. boto3 documentation

# describe_scheduling_policies method definition

def describe_scheduling_policies(
    self,
    *,
    arns: Sequence[str],
) -> DescribeSchedulingPoliciesResponseTypeDef:  # (1)
    ...

1. See DescribeSchedulingPoliciesResponseTypeDef

# describe_scheduling_policies method usage example with argument unpacking

kwargs: DescribeSchedulingPoliciesRequestTypeDef = {  # (1)
    "arns": ...,
}

parent.describe_scheduling_policies(**kwargs)

1. See DescribeSchedulingPoliciesRequestTypeDef

describe_service_environments

Describes one or more of your service environments.

Type annotations and code completion for boto3.client("batch").describe_service_environments method. boto3 documentation

# describe_service_environments method definition

def describe_service_environments(
    self,
    *,
    serviceEnvironments: Sequence[str] = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> DescribeServiceEnvironmentsResponseTypeDef:  # (1)
    ...

1. See DescribeServiceEnvironmentsResponseTypeDef

# describe_service_environments method usage example with argument unpacking

kwargs: DescribeServiceEnvironmentsRequestTypeDef = {  # (1)
    "serviceEnvironments": ...,
}

parent.describe_service_environments(**kwargs)

1. See DescribeServiceEnvironmentsRequestTypeDef

describe_service_job

The details of a service job.

Type annotations and code completion for boto3.client("batch").describe_service_job method. boto3 documentation

# describe_service_job method definition

def describe_service_job(
    self,
    *,
    jobId: str,
) -> DescribeServiceJobResponseTypeDef:  # (1)
    ...

1. See DescribeServiceJobResponseTypeDef

# describe_service_job method usage example with argument unpacking

kwargs: DescribeServiceJobRequestTypeDef = {  # (1)
    "jobId": ...,
}

parent.describe_service_job(**kwargs)

1. See DescribeServiceJobRequestTypeDef

get_job_queue_snapshot

Provides a list of the first 100 RUNNABLE jobs associated to a single job queue.

Type annotations and code completion for boto3.client("batch").get_job_queue_snapshot method. boto3 documentation

# get_job_queue_snapshot method definition

def get_job_queue_snapshot(
    self,
    *,
    jobQueue: str,
) -> GetJobQueueSnapshotResponseTypeDef:  # (1)
    ...

1. See GetJobQueueSnapshotResponseTypeDef

# get_job_queue_snapshot method usage example with argument unpacking

kwargs: GetJobQueueSnapshotRequestTypeDef = {  # (1)
    "jobQueue": ...,
}

parent.get_job_queue_snapshot(**kwargs)

1. See GetJobQueueSnapshotRequestTypeDef

list_consumable_resources

Returns a list of Batch consumable resources.

Type annotations and code completion for boto3.client("batch").list_consumable_resources method. boto3 documentation

# list_consumable_resources method definition

def list_consumable_resources(
    self,
    *,
    filters: Sequence[KeyValuesPairTypeDef] = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListConsumableResourcesResponseTypeDef:  # (2)
    ...

1. See Sequence[KeyValuesPairTypeDef]
2. See ListConsumableResourcesResponseTypeDef

# list_consumable_resources method usage example with argument unpacking

kwargs: ListConsumableResourcesRequestTypeDef = {  # (1)
    "filters": ...,
}

parent.list_consumable_resources(**kwargs)

1. See ListConsumableResourcesRequestTypeDef

list_jobs

Returns a list of Batch jobs.

Type annotations and code completion for boto3.client("batch").list_jobs method. boto3 documentation

# list_jobs method definition

def list_jobs(
    self,
    *,
    jobQueue: str = ...,
    arrayJobId: str = ...,
    multiNodeJobId: str = ...,
    jobStatus: JobStatusType = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
    filters: Sequence[KeyValuesPairTypeDef] = ...,  # (2)
) -> ListJobsResponseTypeDef:  # (3)
    ...

1. See JobStatusType
2. See Sequence[KeyValuesPairTypeDef]
3. See ListJobsResponseTypeDef

# list_jobs method usage example with argument unpacking

kwargs: ListJobsRequestTypeDef = {  # (1)
    "jobQueue": ...,
}

parent.list_jobs(**kwargs)

1. See ListJobsRequestTypeDef

list_jobs_by_consumable_resource

Returns a list of Batch jobs that require a specific consumable resource.

Type annotations and code completion for boto3.client("batch").list_jobs_by_consumable_resource method. boto3 documentation

# list_jobs_by_consumable_resource method definition

def list_jobs_by_consumable_resource(
    self,
    *,
    consumableResource: str,
    filters: Sequence[KeyValuesPairTypeDef] = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListJobsByConsumableResourceResponseTypeDef:  # (2)
    ...

1. See Sequence[KeyValuesPairTypeDef]
2. See ListJobsByConsumableResourceResponseTypeDef

# list_jobs_by_consumable_resource method usage example with argument unpacking

kwargs: ListJobsByConsumableResourceRequestTypeDef = {  # (1)
    "consumableResource": ...,
}

parent.list_jobs_by_consumable_resource(**kwargs)

1. See ListJobsByConsumableResourceRequestTypeDef

list_scheduling_policies

Returns a list of Batch scheduling policies.

Type annotations and code completion for boto3.client("batch").list_scheduling_policies method. boto3 documentation

# list_scheduling_policies method definition

def list_scheduling_policies(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListSchedulingPoliciesResponseTypeDef:  # (1)
    ...

1. See ListSchedulingPoliciesResponseTypeDef

# list_scheduling_policies method usage example with argument unpacking

kwargs: ListSchedulingPoliciesRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_scheduling_policies(**kwargs)

1. See ListSchedulingPoliciesRequestTypeDef

list_service_jobs

Returns a list of service jobs for a specified job queue.

Type annotations and code completion for boto3.client("batch").list_service_jobs method. boto3 documentation

# list_service_jobs method definition

def list_service_jobs(
    self,
    *,
    jobQueue: str = ...,
    jobStatus: ServiceJobStatusType = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
    filters: Sequence[KeyValuesPairTypeDef] = ...,  # (2)
) -> ListServiceJobsResponseTypeDef:  # (3)
    ...

1. See ServiceJobStatusType
2. See Sequence[KeyValuesPairTypeDef]
3. See ListServiceJobsResponseTypeDef

# list_service_jobs method usage example with argument unpacking

kwargs: ListServiceJobsRequestTypeDef = {  # (1)
    "jobQueue": ...,
}

parent.list_service_jobs(**kwargs)

1. See ListServiceJobsRequestTypeDef

list_tags_for_resource

Lists the tags for an Batch resource.

Type annotations and code completion for boto3.client("batch").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestTypeDef

register_job_definition

Registers an Batch job definition.

Type annotations and code completion for boto3.client("batch").register_job_definition method. boto3 documentation

# register_job_definition method definition

def register_job_definition(
    self,
    *,
    jobDefinitionName: str,
    type: JobDefinitionTypeType,  # (1)
    parameters: Mapping[str, str] = ...,
    schedulingPriority: int = ...,
    containerProperties: ContainerPropertiesUnionTypeDef = ...,  # (2)
    nodeProperties: NodePropertiesUnionTypeDef = ...,  # (3)
    retryStrategy: RetryStrategyUnionTypeDef = ...,  # (4)
    propagateTags: bool = ...,
    timeout: JobTimeoutTypeDef = ...,  # (5)
    tags: Mapping[str, str] = ...,
    platformCapabilities: Sequence[PlatformCapabilityType] = ...,  # (6)
    eksProperties: EksPropertiesUnionTypeDef = ...,  # (7)
    ecsProperties: EcsPropertiesUnionTypeDef = ...,  # (8)
    consumableResourceProperties: ConsumableResourcePropertiesUnionTypeDef = ...,  # (9)
) -> RegisterJobDefinitionResponseTypeDef:  # (10)
    ...

1. See JobDefinitionTypeType
2. See ContainerPropertiesUnionTypeDef
3. See NodePropertiesUnionTypeDef
4. See RetryStrategyUnionTypeDef
5. See JobTimeoutTypeDef
6. See Sequence[PlatformCapabilityType]
7. See EksPropertiesUnionTypeDef
8. See EcsPropertiesUnionTypeDef
9. See ConsumableResourcePropertiesUnionTypeDef
10. See RegisterJobDefinitionResponseTypeDef

# register_job_definition method usage example with argument unpacking

kwargs: RegisterJobDefinitionRequestTypeDef = {  # (1)
    "jobDefinitionName": ...,
    "type": ...,
}

parent.register_job_definition(**kwargs)

1. See RegisterJobDefinitionRequestTypeDef

submit_job

Submits an Batch job from a job definition.

Type annotations and code completion for boto3.client("batch").submit_job method. boto3 documentation

# submit_job method definition

def submit_job(
    self,
    *,
    jobName: str,
    jobQueue: str,
    jobDefinition: str,
    shareIdentifier: str = ...,
    schedulingPriorityOverride: int = ...,
    arrayProperties: ArrayPropertiesTypeDef = ...,  # (1)
    dependsOn: Sequence[JobDependencyTypeDef] = ...,  # (2)
    parameters: Mapping[str, str] = ...,
    containerOverrides: ContainerOverridesTypeDef = ...,  # (3)
    nodeOverrides: NodeOverridesTypeDef = ...,  # (4)
    retryStrategy: RetryStrategyUnionTypeDef = ...,  # (5)
    propagateTags: bool = ...,
    timeout: JobTimeoutTypeDef = ...,  # (6)
    tags: Mapping[str, str] = ...,
    eksPropertiesOverride: EksPropertiesOverrideTypeDef = ...,  # (7)
    ecsPropertiesOverride: EcsPropertiesOverrideTypeDef = ...,  # (8)
    consumableResourcePropertiesOverride: ConsumableResourcePropertiesUnionTypeDef = ...,  # (9)
) -> SubmitJobResponseTypeDef:  # (10)
    ...

1. See ArrayPropertiesTypeDef
2. See Sequence[JobDependencyTypeDef]
3. See ContainerOverridesTypeDef
4. See NodeOverridesTypeDef
5. See RetryStrategyUnionTypeDef
6. See JobTimeoutTypeDef
7. See EksPropertiesOverrideTypeDef
8. See EcsPropertiesOverrideTypeDef
9. See ConsumableResourcePropertiesUnionTypeDef
10. See SubmitJobResponseTypeDef

# submit_job method usage example with argument unpacking

kwargs: SubmitJobRequestTypeDef = {  # (1)
    "jobName": ...,
    "jobQueue": ...,
    "jobDefinition": ...,
}

parent.submit_job(**kwargs)

1. See SubmitJobRequestTypeDef

submit_service_job

Submits a service job to a specified job queue to run on SageMaker AI.

Type annotations and code completion for boto3.client("batch").submit_service_job method. boto3 documentation

# submit_service_job method definition

def submit_service_job(
    self,
    *,
    jobName: str,
    jobQueue: str,
    serviceRequestPayload: str,
    serviceJobType: ServiceJobTypeType,  # (1)
    retryStrategy: ServiceJobRetryStrategyUnionTypeDef = ...,  # (2)
    schedulingPriority: int = ...,
    shareIdentifier: str = ...,
    timeoutConfig: ServiceJobTimeoutTypeDef = ...,  # (3)
    tags: Mapping[str, str] = ...,
    clientToken: str = ...,
) -> SubmitServiceJobResponseTypeDef:  # (4)
    ...

1. See ServiceJobTypeType
2. See ServiceJobRetryStrategyUnionTypeDef
3. See ServiceJobTimeoutTypeDef
4. See SubmitServiceJobResponseTypeDef

# submit_service_job method usage example with argument unpacking

kwargs: SubmitServiceJobRequestTypeDef = {  # (1)
    "jobName": ...,
    "jobQueue": ...,
    "serviceRequestPayload": ...,
    "serviceJobType": ...,
}

parent.submit_service_job(**kwargs)

1. See SubmitServiceJobRequestTypeDef

tag_resource

Associates the specified tags to a resource with the specified resourceArn.

Type annotations and code completion for boto3.client("batch").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

terminate_job

Terminates a job in a job queue.

Type annotations and code completion for boto3.client("batch").terminate_job method. boto3 documentation

# terminate_job method definition

def terminate_job(
    self,
    *,
    jobId: str,
    reason: str,
) -> Dict[str, Any]:
    ...

# terminate_job method usage example with argument unpacking

kwargs: TerminateJobRequestTypeDef = {  # (1)
    "jobId": ...,
    "reason": ...,
}

parent.terminate_job(**kwargs)

1. See TerminateJobRequestTypeDef

terminate_service_job

Terminates a service job in a job queue.

Type annotations and code completion for boto3.client("batch").terminate_service_job method. boto3 documentation

# terminate_service_job method definition

def terminate_service_job(
    self,
    *,
    jobId: str,
    reason: str,
) -> Dict[str, Any]:
    ...

# terminate_service_job method usage example with argument unpacking

kwargs: TerminateServiceJobRequestTypeDef = {  # (1)
    "jobId": ...,
    "reason": ...,
}

parent.terminate_service_job(**kwargs)

1. See TerminateServiceJobRequestTypeDef

untag_resource

Deletes specified tags from an Batch resource.

Type annotations and code completion for boto3.client("batch").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

update_compute_environment

Updates an Batch compute environment.

Type annotations and code completion for boto3.client("batch").update_compute_environment method. boto3 documentation

# update_compute_environment method definition

def update_compute_environment(
    self,
    *,
    computeEnvironment: str,
    state: CEStateType = ...,  # (1)
    unmanagedvCpus: int = ...,
    computeResources: ComputeResourceUpdateTypeDef = ...,  # (2)
    serviceRole: str = ...,
    updatePolicy: UpdatePolicyTypeDef = ...,  # (3)
    context: str = ...,
) -> UpdateComputeEnvironmentResponseTypeDef:  # (4)
    ...

1. See CEStateType
2. See ComputeResourceUpdateTypeDef
3. See UpdatePolicyTypeDef
4. See UpdateComputeEnvironmentResponseTypeDef

# update_compute_environment method usage example with argument unpacking

kwargs: UpdateComputeEnvironmentRequestTypeDef = {  # (1)
    "computeEnvironment": ...,
}

parent.update_compute_environment(**kwargs)

1. See UpdateComputeEnvironmentRequestTypeDef

update_consumable_resource

Updates a consumable resource.

Type annotations and code completion for boto3.client("batch").update_consumable_resource method. boto3 documentation

# update_consumable_resource method definition

def update_consumable_resource(
    self,
    *,
    consumableResource: str,
    operation: str = ...,
    quantity: int = ...,
    clientToken: str = ...,
) -> UpdateConsumableResourceResponseTypeDef:  # (1)
    ...

1. See UpdateConsumableResourceResponseTypeDef

# update_consumable_resource method usage example with argument unpacking

kwargs: UpdateConsumableResourceRequestTypeDef = {  # (1)
    "consumableResource": ...,
}

parent.update_consumable_resource(**kwargs)

1. See UpdateConsumableResourceRequestTypeDef

update_job_queue

Updates a job queue.

Type annotations and code completion for boto3.client("batch").update_job_queue method. boto3 documentation

# update_job_queue method definition

def update_job_queue(
    self,
    *,
    jobQueue: str,
    state: JQStateType = ...,  # (1)
    schedulingPolicyArn: str = ...,
    priority: int = ...,
    computeEnvironmentOrder: Sequence[ComputeEnvironmentOrderTypeDef] = ...,  # (2)
    serviceEnvironmentOrder: Sequence[ServiceEnvironmentOrderTypeDef] = ...,  # (3)
    jobStateTimeLimitActions: Sequence[JobStateTimeLimitActionTypeDef] = ...,  # (4)
) -> UpdateJobQueueResponseTypeDef:  # (5)
    ...

1. See JQStateType
2. See Sequence[ComputeEnvironmentOrderTypeDef]
3. See Sequence[ServiceEnvironmentOrderTypeDef]
4. See Sequence[JobStateTimeLimitActionTypeDef]
5. See UpdateJobQueueResponseTypeDef

# update_job_queue method usage example with argument unpacking

kwargs: UpdateJobQueueRequestTypeDef = {  # (1)
    "jobQueue": ...,
}

parent.update_job_queue(**kwargs)

1. See UpdateJobQueueRequestTypeDef

update_scheduling_policy

Updates a scheduling policy.

Type annotations and code completion for boto3.client("batch").update_scheduling_policy method. boto3 documentation

# update_scheduling_policy method definition

def update_scheduling_policy(
    self,
    *,
    arn: str,
    fairsharePolicy: FairsharePolicyUnionTypeDef = ...,  # (1)
) -> Dict[str, Any]:
    ...

1. See FairsharePolicyUnionTypeDef

# update_scheduling_policy method usage example with argument unpacking

kwargs: UpdateSchedulingPolicyRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.update_scheduling_policy(**kwargs)

1. See UpdateSchedulingPolicyRequestTypeDef

update_service_environment

Updates a service environment.

Type annotations and code completion for boto3.client("batch").update_service_environment method. boto3 documentation

# update_service_environment method definition

def update_service_environment(
    self,
    *,
    serviceEnvironment: str,
    state: ServiceEnvironmentStateType = ...,  # (1)
    capacityLimits: Sequence[CapacityLimitTypeDef] = ...,  # (2)
) -> UpdateServiceEnvironmentResponseTypeDef:  # (3)
    ...

1. See ServiceEnvironmentStateType
2. See Sequence[CapacityLimitTypeDef]
3. See UpdateServiceEnvironmentResponseTypeDef

# update_service_environment method usage example with argument unpacking

kwargs: UpdateServiceEnvironmentRequestTypeDef = {  # (1)
    "serviceEnvironment": ...,
}

parent.update_service_environment(**kwargs)

1. See UpdateServiceEnvironmentRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("batch").get_paginator method with overloads.

• client.get_paginator("describe_compute_environments") -> DescribeComputeEnvironmentsPaginator
• client.get_paginator("describe_job_definitions") -> DescribeJobDefinitionsPaginator
• client.get_paginator("describe_job_queues") -> DescribeJobQueuesPaginator
• client.get_paginator("describe_service_environments") -> DescribeServiceEnvironmentsPaginator
• client.get_paginator("list_consumable_resources") -> ListConsumableResourcesPaginator
• client.get_paginator("list_jobs_by_consumable_resource") -> ListJobsByConsumableResourcePaginator
• client.get_paginator("list_jobs") -> ListJobsPaginator
• client.get_paginator("list_scheduling_policies") -> ListSchedulingPoliciesPaginator
• client.get_paginator("list_service_jobs") -> ListServiceJobsPaginator