Skip to content

BatchClient#

Index > Batch > BatchClient

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

BatchClient#

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

# BatchClient usage example

from boto3.session import Session
from mypy_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 mypy_boto3_batch.client import Exceptions

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

Methods#

can_paginate#

Check if an operation can be paginated.

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:
    ...

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: CancelJobRequestRequestTypeDef = {  # (1)
    "jobId": ...,
    "reason": ...,
}

parent.cancel_job(**kwargs)
  1. See CancelJobRequestRequestTypeDef

close#

Closes underlying endpoint connections.

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

# close method definition

def close(
    self,
) -> None:
    ...

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: ComputeResourceTypeDef = ...,  # (3)
    serviceRole: str = ...,
    tags: Mapping[str, str] = ...,
    eksConfiguration: EksConfigurationTypeDef = ...,  # (4)
    context: str = ...,
) -> CreateComputeEnvironmentResponseTypeDef:  # (5)
    ...
  1. See CETypeType
  2. See CEStateType
  3. See ComputeResourceTypeDef
  4. See EksConfigurationTypeDef
  5. See CreateComputeEnvironmentResponseTypeDef 
# create_compute_environment method usage example with argument unpacking

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

parent.create_compute_environment(**kwargs)
  1. See CreateComputeEnvironmentRequestRequestTypeDef

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,
    computeEnvironmentOrder: Sequence[ComputeEnvironmentOrderTypeDef],  # (1)
    state: JQStateType = ...,  # (2)
    schedulingPolicyArn: str = ...,
    tags: Mapping[str, str] = ...,
    jobStateTimeLimitActions: Sequence[JobStateTimeLimitActionTypeDef] = ...,  # (3)
) -> CreateJobQueueResponseTypeDef:  # (4)
    ...
  1. See ComputeEnvironmentOrderTypeDef
  2. See JQStateType
  3. See JobStateTimeLimitActionTypeDef
  4. See CreateJobQueueResponseTypeDef 
# create_job_queue method usage example with argument unpacking

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

parent.create_job_queue(**kwargs)
  1. See CreateJobQueueRequestRequestTypeDef

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: FairsharePolicyTypeDef = ...,  # (1)
    tags: Mapping[str, str] = ...,
) -> CreateSchedulingPolicyResponseTypeDef:  # (2)
    ...
  1. See FairsharePolicyTypeDef
  2. See CreateSchedulingPolicyResponseTypeDef 
# create_scheduling_policy method usage example with argument unpacking

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

parent.create_scheduling_policy(**kwargs)
  1. See CreateSchedulingPolicyRequestRequestTypeDef

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: DeleteComputeEnvironmentRequestRequestTypeDef = {  # (1)
    "computeEnvironment": ...,
}

parent.delete_compute_environment(**kwargs)
  1. See DeleteComputeEnvironmentRequestRequestTypeDef

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: DeleteJobQueueRequestRequestTypeDef = {  # (1)
    "jobQueue": ...,
}

parent.delete_job_queue(**kwargs)
  1. See DeleteJobQueueRequestRequestTypeDef

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: DeleteSchedulingPolicyRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.delete_scheduling_policy(**kwargs)
  1. See DeleteSchedulingPolicyRequestRequestTypeDef

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: DeregisterJobDefinitionRequestRequestTypeDef = {  # (1)
    "jobDefinition": ...,
}

parent.deregister_job_definition(**kwargs)
  1. See DeregisterJobDefinitionRequestRequestTypeDef

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: DescribeComputeEnvironmentsRequestRequestTypeDef = {  # (1)
    "computeEnvironments": ...,
}

parent.describe_compute_environments(**kwargs)
  1. See DescribeComputeEnvironmentsRequestRequestTypeDef

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: DescribeJobDefinitionsRequestRequestTypeDef = {  # (1)
    "jobDefinitions": ...,
}

parent.describe_job_definitions(**kwargs)
  1. See DescribeJobDefinitionsRequestRequestTypeDef

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: DescribeJobQueuesRequestRequestTypeDef = {  # (1)
    "jobQueues": ...,
}

parent.describe_job_queues(**kwargs)
  1. See DescribeJobQueuesRequestRequestTypeDef

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: DescribeJobsRequestRequestTypeDef = {  # (1)
    "jobs": ...,
}

parent.describe_jobs(**kwargs)
  1. See DescribeJobsRequestRequestTypeDef

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: DescribeSchedulingPoliciesRequestRequestTypeDef = {  # (1)
    "arns": ...,
}

parent.describe_scheduling_policies(**kwargs)
  1. See DescribeSchedulingPoliciesRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

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:
    ...

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: GetJobQueueSnapshotRequestRequestTypeDef = {  # (1)
    "jobQueue": ...,
}

parent.get_job_queue_snapshot(**kwargs)
  1. See GetJobQueueSnapshotRequestRequestTypeDef

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 KeyValuesPairTypeDef
  3. See ListJobsResponseTypeDef 
# list_jobs method usage example with argument unpacking

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

parent.list_jobs(**kwargs)
  1. See ListJobsRequestRequestTypeDef

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: ListSchedulingPoliciesRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_scheduling_policies(**kwargs)
  1. See ListSchedulingPoliciesRequestRequestTypeDef

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: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

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: ContainerPropertiesTypeDef = ...,  # (2)
    nodeProperties: NodePropertiesTypeDef = ...,  # (3)
    retryStrategy: RetryStrategyTypeDef = ...,  # (4)
    propagateTags: bool = ...,
    timeout: JobTimeoutTypeDef = ...,  # (5)
    tags: Mapping[str, str] = ...,
    platformCapabilities: Sequence[PlatformCapabilityType] = ...,  # (6)
    eksProperties: EksPropertiesTypeDef = ...,  # (7)
    ecsProperties: EcsPropertiesTypeDef = ...,  # (8)
) -> RegisterJobDefinitionResponseTypeDef:  # (9)
    ...
  1. See JobDefinitionTypeType
  2. See ContainerPropertiesTypeDef
  3. See NodePropertiesTypeDef
  4. See RetryStrategyTypeDef
  5. See JobTimeoutTypeDef
  6. See PlatformCapabilityType
  7. See EksPropertiesTypeDef
  8. See EcsPropertiesTypeDef
  9. See RegisterJobDefinitionResponseTypeDef 
# register_job_definition method usage example with argument unpacking

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

parent.register_job_definition(**kwargs)
  1. See RegisterJobDefinitionRequestRequestTypeDef

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: RetryStrategyTypeDef = ...,  # (5)
    propagateTags: bool = ...,
    timeout: JobTimeoutTypeDef = ...,  # (6)
    tags: Mapping[str, str] = ...,
    eksPropertiesOverride: EksPropertiesOverrideTypeDef = ...,  # (7)
    ecsPropertiesOverride: EcsPropertiesOverrideTypeDef = ...,  # (8)
) -> SubmitJobResponseTypeDef:  # (9)
    ...
  1. See ArrayPropertiesTypeDef
  2. See JobDependencyTypeDef
  3. See ContainerOverridesTypeDef
  4. See NodeOverridesTypeDef
  5. See RetryStrategyTypeDef
  6. See JobTimeoutTypeDef
  7. See EksPropertiesOverrideTypeDef
  8. See EcsPropertiesOverrideTypeDef
  9. See SubmitJobResponseTypeDef 
# submit_job method usage example with argument unpacking

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

parent.submit_job(**kwargs)
  1. See SubmitJobRequestRequestTypeDef

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: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

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: TerminateJobRequestRequestTypeDef = {  # (1)
    "jobId": ...,
    "reason": ...,
}

parent.terminate_job(**kwargs)
  1. See TerminateJobRequestRequestTypeDef

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: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

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: UpdateComputeEnvironmentRequestRequestTypeDef = {  # (1)
    "computeEnvironment": ...,
}

parent.update_compute_environment(**kwargs)
  1. See UpdateComputeEnvironmentRequestRequestTypeDef

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)
    jobStateTimeLimitActions: Sequence[JobStateTimeLimitActionTypeDef] = ...,  # (3)
) -> UpdateJobQueueResponseTypeDef:  # (4)
    ...
  1. See JQStateType
  2. See ComputeEnvironmentOrderTypeDef
  3. See JobStateTimeLimitActionTypeDef
  4. See UpdateJobQueueResponseTypeDef 
# update_job_queue method usage example with argument unpacking

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

parent.update_job_queue(**kwargs)
  1. See UpdateJobQueueRequestRequestTypeDef

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: FairsharePolicyTypeDef = ...,  # (1)
) -> Dict[str, Any]:
    ...
  1. See FairsharePolicyTypeDef 
# update_scheduling_policy method usage example with argument unpacking

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

parent.update_scheduling_policy(**kwargs)
  1. See UpdateSchedulingPolicyRequestRequestTypeDef

get_paginator#

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