Paginators

Index > Backup > Paginators

Auto-generated documentation for Backup type annotations stubs module types-aiobotocore-backup.

ListBackupJobsPaginator

Type annotations and code completion for session.client("backup").get_paginator("list_backup_jobs"). boto3 documentation

Usage example

from aioboto3.session import Session

from types_aiobotocore_backup.paginator import ListBackupJobsPaginator

session = Session()

session = get_session()
async with session.client("backup") as client:  # (1)
    paginator: ListBackupJobsPaginator = client.get_paginator("list_backup_jobs")  # (2)
    async for item in paginator.paginate(...):
        item: ListBackupJobsOutputTypeDef
        print(item)  # (3)

1. client: BackupClient
2. paginator: ListBackupJobsPaginator
3. item: ListBackupJobsOutputTypeDef

paginate

Type annotations and code completion for ListBackupJobsPaginator.paginate method.

Method definition

def paginate(
    self,
    *,
    ByResourceArn: str = ...,
    ByState: BackupJobStateType = ...,  # (1)
    ByBackupVaultName: str = ...,
    ByCreatedBefore: Union[datetime, str] = ...,
    ByCreatedAfter: Union[datetime, str] = ...,
    ByResourceType: str = ...,
    ByAccountId: str = ...,
    ByCompleteAfter: Union[datetime, str] = ...,
    ByCompleteBefore: Union[datetime, str] = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> AsyncIterator[ListBackupJobsOutputTypeDef]:  # (3)
    ...

1. See BackupJobStateType
2. See PaginatorConfigTypeDef
3. See ListBackupJobsOutputTypeDef

Usage example with kwargs

kwargs: ListBackupJobsInputListBackupJobsPaginateTypeDef = {  # (1)
    "ByResourceArn": ...,
}

parent.paginate(**kwargs)

1. See ListBackupJobsInputListBackupJobsPaginateTypeDef

ListBackupPlanTemplatesPaginator

Type annotations and code completion for session.client("backup").get_paginator("list_backup_plan_templates"). boto3 documentation

Usage example

from aioboto3.session import Session

from types_aiobotocore_backup.paginator import ListBackupPlanTemplatesPaginator

session = Session()

session = get_session()
async with session.client("backup") as client:  # (1)
    paginator: ListBackupPlanTemplatesPaginator = client.get_paginator("list_backup_plan_templates")  # (2)
    async for item in paginator.paginate(...):
        item: ListBackupPlanTemplatesOutputTypeDef
        print(item)  # (3)

1. client: BackupClient
2. paginator: ListBackupPlanTemplatesPaginator
3. item: ListBackupPlanTemplatesOutputTypeDef

paginate

Type annotations and code completion for ListBackupPlanTemplatesPaginator.paginate method.

Method definition

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

1. See PaginatorConfigTypeDef
2. See ListBackupPlanTemplatesOutputTypeDef

Usage example with kwargs

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

parent.paginate(**kwargs)

1. See ListBackupPlanTemplatesInputListBackupPlanTemplatesPaginateTypeDef

ListBackupPlanVersionsPaginator

Type annotations and code completion for session.client("backup").get_paginator("list_backup_plan_versions"). boto3 documentation

Usage example

from aioboto3.session import Session

from types_aiobotocore_backup.paginator import ListBackupPlanVersionsPaginator

session = Session()

session = get_session()
async with session.client("backup") as client:  # (1)
    paginator: ListBackupPlanVersionsPaginator = client.get_paginator("list_backup_plan_versions")  # (2)
    async for item in paginator.paginate(...):
        item: ListBackupPlanVersionsOutputTypeDef
        print(item)  # (3)

1. client: BackupClient
2. paginator: ListBackupPlanVersionsPaginator
3. item: ListBackupPlanVersionsOutputTypeDef

paginate

Type annotations and code completion for ListBackupPlanVersionsPaginator.paginate method.

Method definition

def paginate(
    self,
    *,
    BackupPlanId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[ListBackupPlanVersionsOutputTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See ListBackupPlanVersionsOutputTypeDef

Usage example with kwargs

kwargs: ListBackupPlanVersionsInputListBackupPlanVersionsPaginateTypeDef = {  # (1)
    "BackupPlanId": ...,
}

parent.paginate(**kwargs)

1. See ListBackupPlanVersionsInputListBackupPlanVersionsPaginateTypeDef

ListBackupPlansPaginator

Type annotations and code completion for session.client("backup").get_paginator("list_backup_plans"). boto3 documentation

Usage example

from aioboto3.session import Session

from types_aiobotocore_backup.paginator import ListBackupPlansPaginator

session = Session()

session = get_session()
async with session.client("backup") as client:  # (1)
    paginator: ListBackupPlansPaginator = client.get_paginator("list_backup_plans")  # (2)
    async for item in paginator.paginate(...):
        item: ListBackupPlansOutputTypeDef
        print(item)  # (3)

1. client: BackupClient
2. paginator: ListBackupPlansPaginator
3. item: ListBackupPlansOutputTypeDef

paginate

Type annotations and code completion for ListBackupPlansPaginator.paginate method.

Method definition

def paginate(
    self,
    *,
    IncludeDeleted: bool = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[ListBackupPlansOutputTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See ListBackupPlansOutputTypeDef

Usage example with kwargs

kwargs: ListBackupPlansInputListBackupPlansPaginateTypeDef = {  # (1)
    "IncludeDeleted": ...,
}

parent.paginate(**kwargs)

1. See ListBackupPlansInputListBackupPlansPaginateTypeDef

ListBackupSelectionsPaginator

Type annotations and code completion for session.client("backup").get_paginator("list_backup_selections"). boto3 documentation

Usage example

from aioboto3.session import Session

from types_aiobotocore_backup.paginator import ListBackupSelectionsPaginator

session = Session()

session = get_session()
async with session.client("backup") as client:  # (1)
    paginator: ListBackupSelectionsPaginator = client.get_paginator("list_backup_selections")  # (2)
    async for item in paginator.paginate(...):
        item: ListBackupSelectionsOutputTypeDef
        print(item)  # (3)

1. client: BackupClient
2. paginator: ListBackupSelectionsPaginator
3. item: ListBackupSelectionsOutputTypeDef

paginate

Type annotations and code completion for ListBackupSelectionsPaginator.paginate method.

Method definition

def paginate(
    self,
    *,
    BackupPlanId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[ListBackupSelectionsOutputTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See ListBackupSelectionsOutputTypeDef

Usage example with kwargs

kwargs: ListBackupSelectionsInputListBackupSelectionsPaginateTypeDef = {  # (1)
    "BackupPlanId": ...,
}

parent.paginate(**kwargs)

1. See ListBackupSelectionsInputListBackupSelectionsPaginateTypeDef

ListBackupVaultsPaginator

Type annotations and code completion for session.client("backup").get_paginator("list_backup_vaults"). boto3 documentation

Usage example

from aioboto3.session import Session

from types_aiobotocore_backup.paginator import ListBackupVaultsPaginator

session = Session()

session = get_session()
async with session.client("backup") as client:  # (1)
    paginator: ListBackupVaultsPaginator = client.get_paginator("list_backup_vaults")  # (2)
    async for item in paginator.paginate(...):
        item: ListBackupVaultsOutputTypeDef
        print(item)  # (3)

1. client: BackupClient
2. paginator: ListBackupVaultsPaginator
3. item: ListBackupVaultsOutputTypeDef

paginate

Type annotations and code completion for ListBackupVaultsPaginator.paginate method.

Method definition

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

1. See PaginatorConfigTypeDef
2. See ListBackupVaultsOutputTypeDef

Usage example with kwargs

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

parent.paginate(**kwargs)

1. See ListBackupVaultsInputListBackupVaultsPaginateTypeDef

ListCopyJobsPaginator

Type annotations and code completion for session.client("backup").get_paginator("list_copy_jobs"). boto3 documentation

Usage example

from aioboto3.session import Session

from types_aiobotocore_backup.paginator import ListCopyJobsPaginator

session = Session()

session = get_session()
async with session.client("backup") as client:  # (1)
    paginator: ListCopyJobsPaginator = client.get_paginator("list_copy_jobs")  # (2)
    async for item in paginator.paginate(...):
        item: ListCopyJobsOutputTypeDef
        print(item)  # (3)

1. client: BackupClient
2. paginator: ListCopyJobsPaginator
3. item: ListCopyJobsOutputTypeDef

paginate

Type annotations and code completion for ListCopyJobsPaginator.paginate method.

Method definition

def paginate(
    self,
    *,
    ByResourceArn: str = ...,
    ByState: CopyJobStateType = ...,  # (1)
    ByCreatedBefore: Union[datetime, str] = ...,
    ByCreatedAfter: Union[datetime, str] = ...,
    ByResourceType: str = ...,
    ByDestinationVaultArn: str = ...,
    ByAccountId: str = ...,
    ByCompleteBefore: Union[datetime, str] = ...,
    ByCompleteAfter: Union[datetime, str] = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> AsyncIterator[ListCopyJobsOutputTypeDef]:  # (3)
    ...

1. See CopyJobStateType
2. See PaginatorConfigTypeDef
3. See ListCopyJobsOutputTypeDef

Usage example with kwargs

kwargs: ListCopyJobsInputListCopyJobsPaginateTypeDef = {  # (1)
    "ByResourceArn": ...,
}

parent.paginate(**kwargs)

1. See ListCopyJobsInputListCopyJobsPaginateTypeDef

ListProtectedResourcesPaginator

Type annotations and code completion for session.client("backup").get_paginator("list_protected_resources"). boto3 documentation

Usage example

from aioboto3.session import Session

from types_aiobotocore_backup.paginator import ListProtectedResourcesPaginator

session = Session()

session = get_session()
async with session.client("backup") as client:  # (1)
    paginator: ListProtectedResourcesPaginator = client.get_paginator("list_protected_resources")  # (2)
    async for item in paginator.paginate(...):
        item: ListProtectedResourcesOutputTypeDef
        print(item)  # (3)

1. client: BackupClient
2. paginator: ListProtectedResourcesPaginator
3. item: ListProtectedResourcesOutputTypeDef

paginate

Type annotations and code completion for ListProtectedResourcesPaginator.paginate method.

Method definition

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

1. See PaginatorConfigTypeDef
2. See ListProtectedResourcesOutputTypeDef

Usage example with kwargs

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

parent.paginate(**kwargs)

1. See ListProtectedResourcesInputListProtectedResourcesPaginateTypeDef

ListRecoveryPointsByBackupVaultPaginator

Type annotations and code completion for session.client("backup").get_paginator("list_recovery_points_by_backup_vault"). boto3 documentation

Usage example

from aioboto3.session import Session

from types_aiobotocore_backup.paginator import ListRecoveryPointsByBackupVaultPaginator

session = Session()

session = get_session()
async with session.client("backup") as client:  # (1)
    paginator: ListRecoveryPointsByBackupVaultPaginator = client.get_paginator("list_recovery_points_by_backup_vault")  # (2)
    async for item in paginator.paginate(...):
        item: ListRecoveryPointsByBackupVaultOutputTypeDef
        print(item)  # (3)

1. client: BackupClient
2. paginator: ListRecoveryPointsByBackupVaultPaginator
3. item: ListRecoveryPointsByBackupVaultOutputTypeDef

paginate

Type annotations and code completion for ListRecoveryPointsByBackupVaultPaginator.paginate method.

Method definition

def paginate(
    self,
    *,
    BackupVaultName: str,
    ByResourceArn: str = ...,
    ByResourceType: str = ...,
    ByBackupPlanId: str = ...,
    ByCreatedBefore: Union[datetime, str] = ...,
    ByCreatedAfter: Union[datetime, str] = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[ListRecoveryPointsByBackupVaultOutputTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See ListRecoveryPointsByBackupVaultOutputTypeDef

Usage example with kwargs

kwargs: ListRecoveryPointsByBackupVaultInputListRecoveryPointsByBackupVaultPaginateTypeDef = {  # (1)
    "BackupVaultName": ...,
}

parent.paginate(**kwargs)

1. See ListRecoveryPointsByBackupVaultInputListRecoveryPointsByBackupVaultPaginateTypeDef

ListRecoveryPointsByResourcePaginator

Type annotations and code completion for session.client("backup").get_paginator("list_recovery_points_by_resource"). boto3 documentation

Usage example

from aioboto3.session import Session

from types_aiobotocore_backup.paginator import ListRecoveryPointsByResourcePaginator

session = Session()

session = get_session()
async with session.client("backup") as client:  # (1)
    paginator: ListRecoveryPointsByResourcePaginator = client.get_paginator("list_recovery_points_by_resource")  # (2)
    async for item in paginator.paginate(...):
        item: ListRecoveryPointsByResourceOutputTypeDef
        print(item)  # (3)

1. client: BackupClient
2. paginator: ListRecoveryPointsByResourcePaginator
3. item: ListRecoveryPointsByResourceOutputTypeDef

paginate

Type annotations and code completion for ListRecoveryPointsByResourcePaginator.paginate method.

Method definition

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

1. See PaginatorConfigTypeDef
2. See ListRecoveryPointsByResourceOutputTypeDef

Usage example with kwargs

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

parent.paginate(**kwargs)

1. See ListRecoveryPointsByResourceInputListRecoveryPointsByResourcePaginateTypeDef

ListRestoreJobsPaginator

Type annotations and code completion for session.client("backup").get_paginator("list_restore_jobs"). boto3 documentation

Usage example

from aioboto3.session import Session

from types_aiobotocore_backup.paginator import ListRestoreJobsPaginator

session = Session()

session = get_session()
async with session.client("backup") as client:  # (1)
    paginator: ListRestoreJobsPaginator = client.get_paginator("list_restore_jobs")  # (2)
    async for item in paginator.paginate(...):
        item: ListRestoreJobsOutputTypeDef
        print(item)  # (3)

1. client: BackupClient
2. paginator: ListRestoreJobsPaginator
3. item: ListRestoreJobsOutputTypeDef

paginate

Type annotations and code completion for ListRestoreJobsPaginator.paginate method.

Method definition

def paginate(
    self,
    *,
    ByAccountId: str = ...,
    ByCreatedBefore: Union[datetime, str] = ...,
    ByCreatedAfter: Union[datetime, str] = ...,
    ByStatus: RestoreJobStatusType = ...,  # (1)
    ByCompleteBefore: Union[datetime, str] = ...,
    ByCompleteAfter: Union[datetime, str] = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> AsyncIterator[ListRestoreJobsOutputTypeDef]:  # (3)
    ...

1. See RestoreJobStatusType
2. See PaginatorConfigTypeDef
3. See ListRestoreJobsOutputTypeDef

Usage example with kwargs

kwargs: ListRestoreJobsInputListRestoreJobsPaginateTypeDef = {  # (1)
    "ByAccountId": ...,
}

parent.paginate(**kwargs)

1. See ListRestoreJobsInputListRestoreJobsPaginateTypeDef