Examples

Index > Batch > Examples

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

Client

Implicit type annotations

Can be used with types-aioboto3[batch] package installed.

Write your Batch code as usual, type checking and code completion should work out of the box.

# BatchClient usage example

from aioboto3.session import Session


session = Session()

async with session.client("batch") as client:  # (1)
    result = await client.create_compute_environment()  # (2)

1. client: BatchClient
2. result: CreateComputeEnvironmentResponseTypeDef

# DescribeComputeEnvironmentsPaginator usage example

from aioboto3.session import Session


session = Session()

async with session.client("batch") as client:  # (1)
    paginator = client.get_paginator("describe_compute_environments")  # (2)
    async for item in paginator.paginate(...):
        print(item)  # (3)

1. client: BatchClient
2. paginator: DescribeComputeEnvironmentsPaginator
3. item: DescribeComputeEnvironmentsResponsePaginatorTypeDef

Explicit type annotations

With types-aioboto3-lite[batch] or a standalone types_aiobotocore_batch package, you have to explicitly specify client: BatchClient type annotation.

All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.

# BatchClient usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_batch.client import BatchClient
from types_aiobotocore_batch.type_defs import CreateComputeEnvironmentResponseTypeDef
from types_aiobotocore_batch.type_defs import CreateComputeEnvironmentRequestRequestTypeDef


session = Session()

client: BatchClient
async with session.client("batch") as client:  # (1)
    kwargs: CreateComputeEnvironmentRequestRequestTypeDef = {...}  # (2)
    result: CreateComputeEnvironmentResponseTypeDef = await client.create_compute_environment(**kwargs)  # (3)

1. client: BatchClient
2. kwargs: CreateComputeEnvironmentRequestRequestTypeDef
3. result: CreateComputeEnvironmentResponseTypeDef

# DescribeComputeEnvironmentsPaginator usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_batch.client import BatchClient
from types_aiobotocore_batch.paginator import DescribeComputeEnvironmentsPaginator
from types_aiobotocore_batch.type_defs import DescribeComputeEnvironmentsResponsePaginatorTypeDef


session = Session()

client: BatchClient
async with session.client("batch") as client:  # (1)
    paginator: DescribeComputeEnvironmentsPaginator = client.get_paginator("describe_compute_environments")  # (2)
    async for item in paginator.paginate(...):
        item: DescribeComputeEnvironmentsResponsePaginatorTypeDef
        print(item)  # (3)

1. client: BatchClient
2. paginator: DescribeComputeEnvironmentsPaginator
3. item: DescribeComputeEnvironmentsResponsePaginatorTypeDef