Paginators

Index > Batch > Paginators

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

DescribeComputeEnvironmentsPaginator

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

# 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")

# DescribeComputeEnvironmentsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_batch.paginator import DescribeComputeEnvironmentsPaginator

session = Session()

client = Session().client("batch")  # (1)
paginator: DescribeComputeEnvironmentsPaginator = client.get_paginator("describe_compute_environments")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

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

paginate

Type annotations and code completion for DescribeComputeEnvironmentsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    computeEnvironments: Sequence[str] = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[DescribeComputeEnvironmentsResponseTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See DescribeComputeEnvironmentsResponseTypeDef

# paginate method usage example with argument unpacking

kwargs: DescribeComputeEnvironmentsRequestPaginateTypeDef = {  # (1)
    "computeEnvironments": ...,
}

parent.paginate(**kwargs)

1. See DescribeComputeEnvironmentsRequestPaginateTypeDef

DescribeJobDefinitionsPaginator

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

# DescribeJobDefinitionsPaginator usage example

from boto3.session import Session

from mypy_boto3_batch.paginator import DescribeJobDefinitionsPaginator

def get_describe_job_definitions_paginator() -> DescribeJobDefinitionsPaginator:
    return Session().client("batch").get_paginator("describe_job_definitions")

# DescribeJobDefinitionsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_batch.paginator import DescribeJobDefinitionsPaginator

session = Session()

client = Session().client("batch")  # (1)
paginator: DescribeJobDefinitionsPaginator = client.get_paginator("describe_job_definitions")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: BatchClient
2. paginator: DescribeJobDefinitionsPaginator
3. item: DescribeJobDefinitionsResponseTypeDef

paginate

Type annotations and code completion for DescribeJobDefinitionsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    jobDefinitions: Sequence[str] = ...,
    jobDefinitionName: str = ...,
    status: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[DescribeJobDefinitionsResponseTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See DescribeJobDefinitionsResponseTypeDef

# paginate method usage example with argument unpacking

kwargs: DescribeJobDefinitionsRequestPaginateTypeDef = {  # (1)
    "jobDefinitions": ...,
}

parent.paginate(**kwargs)

1. See DescribeJobDefinitionsRequestPaginateTypeDef

DescribeJobQueuesPaginator

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

# DescribeJobQueuesPaginator usage example

from boto3.session import Session

from mypy_boto3_batch.paginator import DescribeJobQueuesPaginator

def get_describe_job_queues_paginator() -> DescribeJobQueuesPaginator:
    return Session().client("batch").get_paginator("describe_job_queues")

# DescribeJobQueuesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_batch.paginator import DescribeJobQueuesPaginator

session = Session()

client = Session().client("batch")  # (1)
paginator: DescribeJobQueuesPaginator = client.get_paginator("describe_job_queues")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: BatchClient
2. paginator: DescribeJobQueuesPaginator
3. item: DescribeJobQueuesResponseTypeDef

paginate

Type annotations and code completion for DescribeJobQueuesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    jobQueues: Sequence[str] = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[DescribeJobQueuesResponseTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See DescribeJobQueuesResponseTypeDef

# paginate method usage example with argument unpacking

kwargs: DescribeJobQueuesRequestPaginateTypeDef = {  # (1)
    "jobQueues": ...,
}

parent.paginate(**kwargs)

1. See DescribeJobQueuesRequestPaginateTypeDef

ListJobsPaginator

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

# ListJobsPaginator usage example

from boto3.session import Session

from mypy_boto3_batch.paginator import ListJobsPaginator

def get_list_jobs_paginator() -> ListJobsPaginator:
    return Session().client("batch").get_paginator("list_jobs")

# ListJobsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_batch.paginator import ListJobsPaginator

session = Session()

client = Session().client("batch")  # (1)
paginator: ListJobsPaginator = client.get_paginator("list_jobs")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: BatchClient
2. paginator: ListJobsPaginator
3. item: ListJobsResponseTypeDef

paginate

Type annotations and code completion for ListJobsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    jobQueue: str = ...,
    arrayJobId: str = ...,
    multiNodeJobId: str = ...,
    jobStatus: JobStatusType = ...,  # (1)
    filters: Sequence[KeyValuesPairTypeDef] = ...,  # (2)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (3)
) -> PageIterator[ListJobsResponseTypeDef]:  # (4)
    ...

1. See JobStatusType
2. See KeyValuesPairTypeDef
3. See PaginatorConfigTypeDef
4. See ListJobsResponseTypeDef

# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)

1. See ListJobsRequestPaginateTypeDef

ListSchedulingPoliciesPaginator

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

# ListSchedulingPoliciesPaginator usage example

from boto3.session import Session

from mypy_boto3_batch.paginator import ListSchedulingPoliciesPaginator

def get_list_scheduling_policies_paginator() -> ListSchedulingPoliciesPaginator:
    return Session().client("batch").get_paginator("list_scheduling_policies")

# ListSchedulingPoliciesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_batch.paginator import ListSchedulingPoliciesPaginator

session = Session()

client = Session().client("batch")  # (1)
paginator: ListSchedulingPoliciesPaginator = client.get_paginator("list_scheduling_policies")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: BatchClient
2. paginator: ListSchedulingPoliciesPaginator
3. item: ListSchedulingPoliciesResponseTypeDef

paginate

Type annotations and code completion for ListSchedulingPoliciesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[ListSchedulingPoliciesResponseTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See ListSchedulingPoliciesResponseTypeDef

# paginate method usage example with argument unpacking

kwargs: ListSchedulingPoliciesRequestPaginateTypeDef = {  # (1)
    "PaginationConfig": ...,
}

parent.paginate(**kwargs)

1. See ListSchedulingPoliciesRequestPaginateTypeDef