Paginators

Index > BackupGateway > Paginators

Auto-generated documentation for BackupGateway type annotations stubs module mypy-boto3-backup-gateway.

ListGatewaysPaginator

Type annotations and code completion for boto3.client("backup-gateway").get_paginator("list_gateways"). boto3 documentation

# ListGatewaysPaginator usage example

from boto3.session import Session

from mypy_boto3_backup_gateway.paginator import ListGatewaysPaginator

def get_list_gateways_paginator() -> ListGatewaysPaginator:
    return Session().client("backup-gateway").get_paginator("list_gateways")

# ListGatewaysPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_backup_gateway.paginator import ListGatewaysPaginator

session = Session()

client = Session().client("backup-gateway")  # (1)
paginator: ListGatewaysPaginator = client.get_paginator("list_gateways")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: BackupGatewayClient
2. paginator: ListGatewaysPaginator
3. item: ListGatewaysOutputTypeDef

paginate

Type annotations and code completion for ListGatewaysPaginator.paginate method.

# paginate method definition

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

1. See PaginatorConfigTypeDef
2. See ListGatewaysOutputTypeDef

# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)

1. See ListGatewaysInputPaginateTypeDef

ListHypervisorsPaginator

Type annotations and code completion for boto3.client("backup-gateway").get_paginator("list_hypervisors"). boto3 documentation

# ListHypervisorsPaginator usage example

from boto3.session import Session

from mypy_boto3_backup_gateway.paginator import ListHypervisorsPaginator

def get_list_hypervisors_paginator() -> ListHypervisorsPaginator:
    return Session().client("backup-gateway").get_paginator("list_hypervisors")

# ListHypervisorsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_backup_gateway.paginator import ListHypervisorsPaginator

session = Session()

client = Session().client("backup-gateway")  # (1)
paginator: ListHypervisorsPaginator = client.get_paginator("list_hypervisors")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: BackupGatewayClient
2. paginator: ListHypervisorsPaginator
3. item: ListHypervisorsOutputTypeDef

paginate

Type annotations and code completion for ListHypervisorsPaginator.paginate method.

# paginate method definition

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

1. See PaginatorConfigTypeDef
2. See ListHypervisorsOutputTypeDef

# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)

1. See ListHypervisorsInputPaginateTypeDef

ListVirtualMachinesPaginator

Type annotations and code completion for boto3.client("backup-gateway").get_paginator("list_virtual_machines"). boto3 documentation

# ListVirtualMachinesPaginator usage example

from boto3.session import Session

from mypy_boto3_backup_gateway.paginator import ListVirtualMachinesPaginator

def get_list_virtual_machines_paginator() -> ListVirtualMachinesPaginator:
    return Session().client("backup-gateway").get_paginator("list_virtual_machines")

# ListVirtualMachinesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_backup_gateway.paginator import ListVirtualMachinesPaginator

session = Session()

client = Session().client("backup-gateway")  # (1)
paginator: ListVirtualMachinesPaginator = client.get_paginator("list_virtual_machines")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: BackupGatewayClient
2. paginator: ListVirtualMachinesPaginator
3. item: ListVirtualMachinesOutputTypeDef

paginate

Type annotations and code completion for ListVirtualMachinesPaginator.paginate method.

# paginate method definition

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

1. See PaginatorConfigTypeDef
2. See ListVirtualMachinesOutputTypeDef

# paginate method usage example with argument unpacking

kwargs: ListVirtualMachinesInputPaginateTypeDef = {  # (1)
    "HypervisorArn": ...,
}

parent.paginate(**kwargs)

1. See ListVirtualMachinesInputPaginateTypeDef