Paginators

Index > DataSync > Paginators

Auto-generated documentation for DataSync type annotations stubs module types-boto3-datasync.

ListAgentsPaginator

Type annotations and code completion for boto3.client("datasync").get_paginator("list_agents"). boto3 documentation

# ListAgentsPaginator usage example

from boto3.session import Session

from types_boto3_datasync.paginator import ListAgentsPaginator

def get_list_agents_paginator() -> ListAgentsPaginator:
    return Session().client("datasync").get_paginator("list_agents")

# ListAgentsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_datasync.paginator import ListAgentsPaginator

session = Session()

client = Session().client("datasync")  # (1)
paginator: ListAgentsPaginator = client.get_paginator("list_agents")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: DataSyncClient
2. paginator: ListAgentsPaginator
3. item: PageIterator[ListAgentsResponseTypeDef]

paginate

Type annotations and code completion for ListAgentsPaginator.paginate method.

# paginate method definition

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

1. See PaginatorConfigTypeDef
2. See PageIterator[ListAgentsResponseTypeDef]

# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)

1. See ListAgentsRequestPaginateTypeDef

ListLocationsPaginator

Type annotations and code completion for boto3.client("datasync").get_paginator("list_locations"). boto3 documentation

# ListLocationsPaginator usage example

from boto3.session import Session

from types_boto3_datasync.paginator import ListLocationsPaginator

def get_list_locations_paginator() -> ListLocationsPaginator:
    return Session().client("datasync").get_paginator("list_locations")

# ListLocationsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_datasync.paginator import ListLocationsPaginator

session = Session()

client = Session().client("datasync")  # (1)
paginator: ListLocationsPaginator = client.get_paginator("list_locations")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: DataSyncClient
2. paginator: ListLocationsPaginator
3. item: PageIterator[ListLocationsResponseTypeDef]

paginate

Type annotations and code completion for ListLocationsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    Filters: Sequence[LocationFilterTypeDef] = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> botocore.paginate.PageIterator[ListLocationsResponseTypeDef]:  # (3)
    ...

1. See Sequence[LocationFilterTypeDef]
2. See PaginatorConfigTypeDef
3. See PageIterator[ListLocationsResponseTypeDef]

# paginate method usage example with argument unpacking

kwargs: ListLocationsRequestPaginateTypeDef = {  # (1)
    "Filters": ...,
}

parent.paginate(**kwargs)

1. See ListLocationsRequestPaginateTypeDef

ListTagsForResourcePaginator

Type annotations and code completion for boto3.client("datasync").get_paginator("list_tags_for_resource"). boto3 documentation

# ListTagsForResourcePaginator usage example

from boto3.session import Session

from types_boto3_datasync.paginator import ListTagsForResourcePaginator

def get_list_tags_for_resource_paginator() -> ListTagsForResourcePaginator:
    return Session().client("datasync").get_paginator("list_tags_for_resource")

# ListTagsForResourcePaginator usage example with type annotations

from boto3.session import Session

from types_boto3_datasync.paginator import ListTagsForResourcePaginator

session = Session()

client = Session().client("datasync")  # (1)
paginator: ListTagsForResourcePaginator = client.get_paginator("list_tags_for_resource")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: DataSyncClient
2. paginator: ListTagsForResourcePaginator
3. item: PageIterator[ListTagsForResourceResponseTypeDef]

paginate

Type annotations and code completion for ListTagsForResourcePaginator.paginate method.

# paginate method definition

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

1. See PaginatorConfigTypeDef
2. See PageIterator[ListTagsForResourceResponseTypeDef]

# paginate method usage example with argument unpacking

kwargs: ListTagsForResourceRequestPaginateTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.paginate(**kwargs)

1. See ListTagsForResourceRequestPaginateTypeDef

ListTaskExecutionsPaginator

Type annotations and code completion for boto3.client("datasync").get_paginator("list_task_executions"). boto3 documentation

# ListTaskExecutionsPaginator usage example

from boto3.session import Session

from types_boto3_datasync.paginator import ListTaskExecutionsPaginator

def get_list_task_executions_paginator() -> ListTaskExecutionsPaginator:
    return Session().client("datasync").get_paginator("list_task_executions")

# ListTaskExecutionsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_datasync.paginator import ListTaskExecutionsPaginator

session = Session()

client = Session().client("datasync")  # (1)
paginator: ListTaskExecutionsPaginator = client.get_paginator("list_task_executions")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: DataSyncClient
2. paginator: ListTaskExecutionsPaginator
3. item: PageIterator[ListTaskExecutionsResponseTypeDef]

paginate

Type annotations and code completion for ListTaskExecutionsPaginator.paginate method.

# paginate method definition

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

1. See PaginatorConfigTypeDef
2. See PageIterator[ListTaskExecutionsResponseTypeDef]

# paginate method usage example with argument unpacking

kwargs: ListTaskExecutionsRequestPaginateTypeDef = {  # (1)
    "TaskArn": ...,
}

parent.paginate(**kwargs)

1. See ListTaskExecutionsRequestPaginateTypeDef

ListTasksPaginator

Type annotations and code completion for boto3.client("datasync").get_paginator("list_tasks"). boto3 documentation

# ListTasksPaginator usage example

from boto3.session import Session

from types_boto3_datasync.paginator import ListTasksPaginator

def get_list_tasks_paginator() -> ListTasksPaginator:
    return Session().client("datasync").get_paginator("list_tasks")

# ListTasksPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_datasync.paginator import ListTasksPaginator

session = Session()

client = Session().client("datasync")  # (1)
paginator: ListTasksPaginator = client.get_paginator("list_tasks")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: DataSyncClient
2. paginator: ListTasksPaginator
3. item: PageIterator[ListTasksResponseTypeDef]

paginate

Type annotations and code completion for ListTasksPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    Filters: Sequence[TaskFilterTypeDef] = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> botocore.paginate.PageIterator[ListTasksResponseTypeDef]:  # (3)
    ...

1. See Sequence[TaskFilterTypeDef]
2. See PaginatorConfigTypeDef
3. See PageIterator[ListTasksResponseTypeDef]

# paginate method usage example with argument unpacking

kwargs: ListTasksRequestPaginateTypeDef = {  # (1)
    "Filters": ...,
}

parent.paginate(**kwargs)

1. See ListTasksRequestPaginateTypeDef