Skip to content

Batch module#

Index > Batch

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

How to install#

You can generate type annotations for boto3 package locally with mypy_boto3_builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.36.2' mypy_boto3_builder
  2. Select boto3-stubs AWS SDK.
  3. Add Batch service.
  4. Use provided commands to install generated packages.

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and Batch.

From PyPI with pip#

Install boto3-stubs for Batch service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[batch]'

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[batch]'

# standalone installation
python -m pip install mypy-boto3-batch

How to uninstall#

python -m pip uninstall -y mypy-boto3-batch

Usage#

Code samples can be found in Examples.

BatchClient#

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

# BatchClient usage example

from boto3.session import Session

from mypy_boto3_batch.client import BatchClient

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

Paginators#

Type annotations and code completion for paginators from boto3.client("batch").get_paginator("...").

# DescribeComputeEnvironmentsPaginator usage example

from boto3.session import Session

from mypy_boto3_batch.paginator import DescribeComputeEnvironmentsPaginator

def get_describe_compute_environments_paginator() -> DescribeComputeEnvironmentsPaginator:
    return Session().client("batch").get_paginator("describe_compute_environments"))

Literals#

Type annotations for literals used in methods and schema.

# ArrayJobDependencyType usage example

from mypy_boto3_batch.literals import ArrayJobDependencyType

def get_value() -> ArrayJobDependencyType:
    return "N_TO_N"