<a id="mypy-boto3-batch"></a>

mypy-boto3-batch

Type annotations for boto3 Batch 1.42.59 compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.

Generated with mypy-boto3-builder 8.12.0.

More information can be found on boto3-stubs page and in mypy-boto3-batch docs.

See how it helps you find and fix potential bugs:

• mypy-boto3-batch
  • How to install
    • Generate locally (recommended)
    • VSCode extension
    • From PyPI with pip
  • How to uninstall
  • Usage
    • VSCode
    • PyCharm
    • Emacs
    • Sublime Text
    • Other IDEs
    • mypy
    • pyright
    • Pylint compatibility
  • Explicit type annotations
    • Client annotations
    • Paginators annotations
    • Literals
    • Type definitions
  • How it works
  • What's new
    • Implemented features
    • Latest changes
  • Versioning
  • Thank you
  • Documentation
  • Support and contributing

<a id="how-to-install"></a>

How to install

<a id="generate-locally-(recommended)"></a>

Generate locally (recommended)

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.42.59' mypy-boto3-builder
2. Select boto3-stubs AWS SDK.
3. Add Batch service.
4. Use provided commands to install generated packages.

<a id="vscode-extension"></a>

VSCode extension

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

Click Modify and select boto3 common and Batch.

<a id="from-pypi-with-pip"></a>

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

<a id="how-to-uninstall"></a>

How to uninstall

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

<a id="usage"></a>

Usage

<a id="vscode"></a>

VSCode

• Install Python extension
• Install Pylance extension
• Set Pylance as your Python Language Server
• Install boto3-stubs[batch] in your environment:

python -m pip install 'boto3-stubs[batch]'

Both type checking and code completion should now work. No explicit type annotations required, write your boto3 code as usual.

<a id="pycharm"></a>

PyCharm

⚠️ Due to slow PyCharm performance on Literal overloads (issue PY-40997), it is recommended to use boto3-stubs-lite until the issue is resolved.

⚠️ If you experience slow performance and high CPU usage, try to disable PyCharm type checker and use mypy or pyright instead.

⚠️ To continue using PyCharm type checker, you can try to replace boto3-stubs with boto3-stubs-lite:

pip uninstall boto3-stubs
pip install boto3-stubs-lite

Install boto3-stubs[batch] in your environment:

python -m pip install 'boto3-stubs[batch]'

Both type checking and code completion should now work.

<a id="emacs"></a>

Emacs

• Install boto3-stubs with services you use in your environment:

python -m pip install 'boto3-stubs[batch]'

• Install use-package, lsp, company and flycheck packages
• Install lsp-pyright package

(use-package lsp-pyright
  :ensure t
  :hook (python-mode . (lambda ()
                          (require 'lsp-pyright)
                          (lsp)))  ; or lsp-deferred
  :init (when (executable-find "python3")
          (setq lsp-pyright-python-executable-cmd "python3"))
  )

• Make sure emacs uses the environment where you have installed boto3-stubs

Type checking should now work. No explicit type annotations required, write your boto3 code as usual.

<a id="sublime-text"></a>

Sublime Text

• Install boto3-stubs[batch] with services you use in your environment:

python -m pip install 'boto3-stubs[batch]'

• Install LSP-pyright package

Type checking should now work. No explicit type annotations required, write your boto3 code as usual.

<a id="other-ides"></a>

Other IDEs

Not tested, but as long as your IDE supports mypy or pyright, everything should work.

<a id="mypy"></a>

mypy

• Install mypy: python -m pip install mypy
• Install boto3-stubs[batch] in your environment:

python -m pip install 'boto3-stubs[batch]'

Type checking should now work. No explicit type annotations required, write your boto3 code as usual.

<a id="pyright"></a>

pyright

• Install pyright: npm i -g pyright
• Install boto3-stubs[batch] in your environment:

python -m pip install 'boto3-stubs[batch]'

Optionally, you can install boto3-stubs to typings directory.

Type checking should now work. No explicit type annotations required, write your boto3 code as usual.

<a id="pylint-compatibility"></a>

Pylint compatibility

It is totally safe to use TYPE_CHECKING flag in order to avoid mypy-boto3-batch dependency in production. However, there is an issue in pylint that it complains about undefined variables. To fix it, set all types to object in non-TYPE_CHECKING mode.

from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from mypy_boto3_ec2 import EC2Client, EC2ServiceResource
    from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
    from mypy_boto3_ec2.paginators import DescribeVolumesPaginator
else:
    EC2Client = object
    EC2ServiceResource = object
    BundleTaskCompleteWaiter = object
    DescribeVolumesPaginator = object

...

<a id="explicit-type-annotations"></a>

Explicit type annotations

<a id="client-annotations"></a>

Client annotations

BatchClient provides annotations for boto3.client("batch").

from boto3.session import Session

from mypy_boto3_batch import BatchClient

client: BatchClient = Session().client("batch")

# now client usage is checked by mypy and IDE should provide code completion

<a id="paginators-annotations"></a>

Paginators annotations

mypy_boto3_batch.paginator module contains type annotations for all paginators.

from boto3.session import Session

from mypy_boto3_batch import BatchClient
from mypy_boto3_batch.paginator import (
    DescribeComputeEnvironmentsPaginator,
    DescribeJobDefinitionsPaginator,
    DescribeJobQueuesPaginator,
    DescribeServiceEnvironmentsPaginator,
    ListConsumableResourcesPaginator,
    ListJobsByConsumableResourcePaginator,
    ListJobsPaginator,
    ListSchedulingPoliciesPaginator,
    ListServiceJobsPaginator,
)

client: BatchClient = Session().client("batch")

# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
describe_compute_environments_paginator: DescribeComputeEnvironmentsPaginator = (
    client.get_paginator("describe_compute_environments")
)
describe_job_definitions_paginator: DescribeJobDefinitionsPaginator = client.get_paginator(
    "describe_job_definitions"
)
describe_job_queues_paginator: DescribeJobQueuesPaginator = client.get_paginator(
    "describe_job_queues"
)
describe_service_environments_paginator: DescribeServiceEnvironmentsPaginator = (
    client.get_paginator("describe_service_environments")
)
list_consumable_resources_paginator: ListConsumableResourcesPaginator = client.get_paginator(
    "list_consumable_resources"
)
list_jobs_by_consumable_resource_paginator: ListJobsByConsum