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)
- client: BatchClient
- paginator: DescribeComputeEnvironmentsPaginator
- item:
PageIterator[DescribeComputeEnvironmentsResponseTypeDef]
paginate#
Type annotations and code completion for DescribeComputeEnvironmentsPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
computeEnvironments: Sequence[str] = ...,
PaginationConfig: PaginatorConfigTypeDef = ..., # (1)
) -> botocore.paginate.PageIterator[DescribeComputeEnvironmentsResponseTypeDef]: # (2)
...
- See PaginatorConfigTypeDef
- See
PageIterator[DescribeComputeEnvironmentsResponseTypeDef]
# paginate method usage example with argument unpacking
kwargs: DescribeComputeEnvironmentsRequestPaginateTypeDef = { # (1)
"computeEnvironments": ...,
}
parent.paginate(**kwargs)
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)
- client: BatchClient
- paginator: DescribeJobDefinitionsPaginator
- item:
PageIterator[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)
) -> botocore.paginate.PageIterator[DescribeJobDefinitionsResponseTypeDef]: # (2)
...
- See PaginatorConfigTypeDef
- See
PageIterator[DescribeJobDefinitionsResponseTypeDef]
# paginate method usage example with argument unpacking
kwargs: DescribeJobDefinitionsRequestPaginateTypeDef = { # (1)
"jobDefinitions": ...,
}
parent.paginate(**kwargs)
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)
- client: BatchClient
- paginator: DescribeJobQueuesPaginator
- item:
PageIterator[DescribeJobQueuesResponseTypeDef]
paginate#
Type annotations and code completion for DescribeJobQueuesPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
jobQueues: Sequence[str] = ...,
PaginationConfig: PaginatorConfigTypeDef = ..., # (1)
) -> botocore.paginate.PageIterator[DescribeJobQueuesResponseTypeDef]: # (2)
...
- See PaginatorConfigTypeDef
- See
PageIterator[DescribeJobQueuesResponseTypeDef]
# paginate method usage example with argument unpacking
kwargs: DescribeJobQueuesRequestPaginateTypeDef = { # (1)
"jobQueues": ...,
}
parent.paginate(**kwargs)
ListConsumableResourcesPaginator#
Type annotations and code completion for boto3.client("batch").get_paginator("list_consumable_resources")
.
boto3 documentation
# ListConsumableResourcesPaginator usage example
from boto3.session import Session
from mypy_boto3_batch.paginator import ListConsumableResourcesPaginator
def get_list_consumable_resources_paginator() -> ListConsumableResourcesPaginator:
return Session().client("batch").get_paginator("list_consumable_resources")
# ListConsumableResourcesPaginator usage example with type annotations
from boto3.session import Session
from mypy_boto3_batch.paginator import ListConsumableResourcesPaginator
session = Session()
client = Session().client("batch") # (1)
paginator: ListConsumableResourcesPaginator = client.get_paginator("list_consumable_resources") # (2)
for item in paginator.paginate(...):
print(item) # (3)
- client: BatchClient
- paginator: ListConsumableResourcesPaginator
- item:
PageIterator[ListConsumableResourcesResponseTypeDef]
paginate#
Type annotations and code completion for ListConsumableResourcesPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
filters: Sequence[KeyValuesPairTypeDef] = ..., # (1)
PaginationConfig: PaginatorConfigTypeDef = ..., # (2)
) -> botocore.paginate.PageIterator[ListConsumableResourcesResponseTypeDef]: # (3)
...
- See
Sequence[KeyValuesPairTypeDef]
- See PaginatorConfigTypeDef
- See
PageIterator[ListConsumableResourcesResponseTypeDef]
# paginate method usage example with argument unpacking
kwargs: ListConsumableResourcesRequestPaginateTypeDef = { # (1)
"filters": ...,
}
parent.paginate(**kwargs)
ListJobsByConsumableResourcePaginator#
Type annotations and code completion for boto3.client("batch").get_paginator("list_jobs_by_consumable_resource")
.
boto3 documentation
# ListJobsByConsumableResourcePaginator usage example
from boto3.session import Session
from mypy_boto3_batch.paginator import ListJobsByConsumableResourcePaginator
def get_list_jobs_by_consumable_resource_paginator() -> ListJobsByConsumableResourcePaginator:
return Session().client("batch").get_paginator("list_jobs_by_consumable_resource")
# ListJobsByConsumableResourcePaginator usage example with type annotations
from boto3.session import Session
from mypy_boto3_batch.paginator import ListJobsByConsumableResourcePaginator
session = Session()
client = Session().client("batch") # (1)
paginator: ListJobsByConsumableResourcePaginator = client.get_paginator("list_jobs_by_consumable_resource") # (2)
for item in paginator.paginate(...):
print(item) # (3)
- client: BatchClient
- paginator: ListJobsByConsumableResourcePaginator
- item:
PageIterator[ListJobsByConsumableResourceResponseTypeDef]
paginate#
Type annotations and code completion for ListJobsByConsumableResourcePaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
consumableResource: str,
filters: Sequence[KeyValuesPairTypeDef] = ..., # (1)
PaginationConfig: PaginatorConfigTypeDef = ..., # (2)
) -> botocore.paginate.PageIterator[ListJobsByConsumableResourceResponseTypeDef]: # (3)
...
- See
Sequence[KeyValuesPairTypeDef]
- See PaginatorConfigTypeDef
- See
PageIterator[ListJobsByConsumableResourceResponseTypeDef]
# paginate method usage example with argument unpacking
kwargs: ListJobsByConsumableResourceRequestPaginateTypeDef = { # (1)
"consumableResource": ...,
}
parent.paginate(**kwargs)
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)
- client: BatchClient
- paginator: ListJobsPaginator
- item:
PageIterator[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)
) -> botocore.paginate.PageIterator[ListJobsResponseTypeDef]: # (4)
...
- See JobStatusType
- See
Sequence[KeyValuesPairTypeDef]
- See PaginatorConfigTypeDef
- See
PageIterator[ListJobsResponseTypeDef]
# paginate method usage example with argument unpacking
kwargs: ListJobsRequestPaginateTypeDef = { # (1)
"jobQueue": ...,
}
parent.paginate(**kwargs)
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)
- client: BatchClient
- paginator: ListSchedulingPoliciesPaginator
- item:
PageIterator[ListSchedulingPoliciesResponseTypeDef]
paginate#
Type annotations and code completion for ListSchedulingPoliciesPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
PaginationConfig: PaginatorConfigTypeDef = ..., # (1)
) -> botocore.paginate.PageIterator[ListSchedulingPoliciesResponseTypeDef]: # (2)
...
- See PaginatorConfigTypeDef
- See
PageIterator[ListSchedulingPoliciesResponseTypeDef]
# paginate method usage example with argument unpacking
kwargs: ListSchedulingPoliciesRequestPaginateTypeDef = { # (1)
"PaginationConfig": ...,
}
parent.paginate(**kwargs)