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)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)
) -> CreateComputeEnvironmentResponseTypeDef: # (5)
...- See CETypeType
- See CEStateType
- See ComputeResourceTypeDef
- See EksConfigurationTypeDef
- See CreateComputeEnvironmentResponseTypeDef
# create_compute_environment method usage example with argument unpacking
kwargs: CreateComputeEnvironmentRequestRequestTypeDef = { # (1)
"computeEnvironmentName": ...,
"type": ...,
}
parent.create_compute_environment(**kwargs)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] = ...,
) -> CreateJobQueueResponseTypeDef: # (3)
...# create_job_queue method usage example with argument unpacking
kwargs: CreateJobQueueRequestRequestTypeDef = { # (1)
"jobQueueName": ...,
"priority": ...,
"computeEnvironmentOrder": ...,
}
parent.create_job_queue(**kwargs)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)
...# create_scheduling_policy method usage example with argument unpacking
kwargs: CreateSchedulingPolicyRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.create_scheduling_policy(**kwargs)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)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)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)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)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)
...# describe_compute_environments method usage example with argument unpacking
kwargs: DescribeComputeEnvironmentsRequestRequestTypeDef = { # (1)
"computeEnvironments": ...,
}
parent.describe_compute_environments(**kwargs)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)
...# describe_job_definitions method usage example with argument unpacking
kwargs: DescribeJobDefinitionsRequestRequestTypeDef = { # (1)
"jobDefinitions": ...,
}
parent.describe_job_definitions(**kwargs)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)
...# describe_job_queues method usage example with argument unpacking
kwargs: DescribeJobQueuesRequestRequestTypeDef = { # (1)
"jobQueues": ...,
}
parent.describe_job_queues(**kwargs)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)
...# describe_jobs method usage example with argument unpacking
kwargs: DescribeJobsRequestRequestTypeDef = { # (1)
"jobs": ...,
}
parent.describe_jobs(**kwargs)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)
...# describe_scheduling_policies method usage example with argument unpacking
kwargs: DescribeSchedulingPoliciesRequestRequestTypeDef = { # (1)
"arns": ...,
}
parent.describe_scheduling_policies(**kwargs)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:
...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)
...- See JobStatusType
- See KeyValuesPairTypeDef
- See ListJobsResponseTypeDef
# list_jobs method usage example with argument unpacking
kwargs: ListJobsRequestRequestTypeDef = { # (1)
"jobQueue": ...,
}
parent.list_jobs(**kwargs)list_scheduling_policies#
Returns a list of Batch scheduling policies.
Type annotations and code completion for boto3.client("batch").list_scheduling_policies method.