Paginators

Index > Backup > Paginators

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

ListBackupJobsPaginator

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

Usage example

from boto3.session import Session

from mypy_boto3_backup.paginator import ListBackupJobsPaginator

def get_list_backup_jobs_paginator() -> ListBackupJobsPaginator:
    return Session().client("backup").get_paginator("list_backup_jobs")

Usage example

from boto3.session import Session

from mypy_boto3_backup.paginator import ListBackupJobsPaginator

session = Session()

client = Session().client("backup")  # (1)
paginator: ListBackupJobsPaginator = client.get_paginator("list_backup_jobs")  # (2)
for item in paginator.paginate(...):
    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] = ...,
    ByParentJobId: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> _PageIterator[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 boto3.client("backup").get_paginator("list_backup_plan_templates"). boto3 documentation

Usage example

from boto3.session import Session

from mypy_boto3_backup.paginator import ListBackupPlanTemplatesPaginator

def get_list_backup_plan_templates_paginator() -> ListBackupPlanTemplatesPaginator:
    return Session().client("backup").get_paginator("list_backup_plan_templates")

Usage example

from boto3.session import Session

from mypy_boto3_backup.paginator import ListBackupPlanTemplatesPaginator

session = Session()

client = Session().client("backup")  # (1)
paginator: ListBackupPlanTemplatesPaginator = client.get_paginator("list_backup_plan_templates")  # (2)
for item in paginator.paginate(...):
    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)
) -> _PageIterator[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 boto3.client("backup").get_paginator("list_backup_plan_versions"). boto3 documentation

Usage example

from boto3.session import Session

from mypy_boto3_backup.paginator import ListBackupPlanVersionsPaginator

def get_list_backup_plan_versions_paginator() -> ListBackupPlanVersionsPaginator:
    return Session().client("backup").get_paginator("list_backup_plan_versions")

Usage example

from boto3.session import Session

from mypy_boto3_backup.paginator import ListBackupPlanVersionsPaginator

session = Session()

client = Session().client("backup")  # (1)
paginator: ListBackupPlanVersionsPaginator = client.get_paginator("list_backup_plan_versions")  # (2)
for item in paginator.paginate(...):
    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)
) -> _PageIterator[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 boto3.client("backup").get_paginator("list_backup_plans"). boto3 documentation

Usage example

from boto3.session import Session

from mypy_boto3_backup.paginator import ListBackupPlansPaginator

def get_list_backup_plans_paginator() -> ListBackupPlansPaginator:
    return Session().client("backup").get_paginator("list_backup_plans")

Usage example

from boto3.session import Session

from mypy_boto3_backup.paginator import ListBackupPlansPaginator

session = Session()

client = Session().client("backup")  # (1)
paginator: ListBackupPlansPaginator = client.get_paginator("list_backup_plans")  # (2)
for item in paginator.paginate(...):
    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)
) -> _PageIterator[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 boto3.client("backup").get_paginator("list_backup_selections"). boto3 documentation

Usage example

from boto3.session import Session

from mypy_boto3_backup.paginator import ListBackupSelectionsPaginator

def get_list_backup_selections_paginator() -> ListBackupSelectionsPaginator:
    return Session().client("backup").get_paginator("list_backup_selections")

Usage example

from boto3.session import Session

from mypy_boto3_backup.paginator import ListBackupSelectionsPaginator

session = Session()

client = Session().client("backup")  # (1)
paginator: ListBackupSelectionsPaginator = client.get_paginator("list_backup_selections")  # (2)
for item in paginator.paginate(...):
    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)
) -> _PageIterator[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 boto3.client("backup").get_paginator("list_backup_vaults"). boto3 documentation

Usage example

from boto3.session import Session

from mypy_boto3_backup.paginator import ListBackupVaultsPaginator

def get_list_backup_vaults_paginator() -> ListBackupVaultsPaginator:
    return Session().client("backup").get_paginator("list_backup_vaults")

Usage example

from boto3.session import Session

from mypy_boto3_backup.paginator import ListBackupVaultsPaginator

session = Session()

client = Session().client("backup")  # (1)
paginator: ListBackupVaultsPaginator = client.get_paginator("list_backup_vaults")  # (2)
for item in paginator.paginate(...):
    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)
) -> _PageIterator[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 boto3.client("backup").get_paginator("list_copy_jobs"). boto3 documentation

Usage example

from boto3.session import Session

from mypy_boto3_backup.paginator import ListCopyJobsPaginator

def get_list_copy_jobs_paginator() -> ListCopyJobsPaginator:
    return Session().client("backup").get_paginator("list_copy_jobs")

Usage example

from boto3.session import Session

from mypy_boto3_backup.paginator import ListCopyJobsPaginator

session = Session()

client = Session().client("backup")  # (1)
paginator: ListCopyJobsPaginator = client.get_paginator("list_copy_jobs")  # (2)
for item in paginator.paginate(...):
    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] = ...,
    ByParentJobId: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> _PageIterator[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

ListLegalHoldsPaginator

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

Usage example

from boto3.session import Session

from mypy_boto3_backup.paginator import ListLegalHoldsPaginator

def get_list_legal_holds_paginator() -> ListLegalHoldsPaginator:
    return Session().client("backup").get_paginator("list_legal_holds")

Usage example

from boto3.session import Session

from mypy_boto3_backup.paginator import ListLegalHoldsPaginator

session = Session()

client = Session().client("backup")  # (1)
paginator: ListLegalHoldsPaginator = client.get_paginator("list_legal_holds")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: BackupClient
2. paginator: ListLegalHoldsPaginator
3. item: ListLegalHoldsOutputTypeDef

paginate

Type annotations and code completion for ListLegalHoldsPaginator.paginate method.

Method definition

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

1. See PaginatorConfigTypeDef
2. See ListLegalHoldsOutputTypeDef

Usage example with kwargs

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

parent.paginate(**kwargs)

1. See ListLegalHoldsInputListLegalHoldsPaginateTypeDef

ListProtectedResourcesPaginator

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

Usage example

from boto3.session import Session

from mypy_boto3_backup.paginator import ListProtectedResourcesPaginator

def get_list_protected_resources_paginator() -> ListProtectedResourcesPaginator:
    return Session().client("backup").get_paginator("list_protected_resources")

Usage example

from boto3.session import Session

from mypy_boto3_backup.paginator import ListProtectedResourcesPaginator

session = Session()

client = Session().client("backup")  # (1)
paginator: ListProtectedResourcesPaginator = client.get_paginator("list_protected_resources")  # (2)
for item in paginator.paginate(...):
    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)
) -> _PageIterator[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 boto3.client("backup").get_paginator("list_recovery_points_by_backup_vault"). boto3 documentation

Usage example

from boto3.session import Session

from mypy_boto3_backup.paginator import ListRecoveryPointsByBackupVaultPaginator

def get_list_recovery_points_by_backup_vault_paginator() -> ListRecoveryPointsByBackupVaultPaginator:
    return Session().client("backup").get_paginator("list_recovery_points_by_backup_vault")

Usage example

from boto3.session import Session

from mypy_boto3_backup.paginator import ListRecoveryPointsByBackupVaultPaginator

session = Session()

client = Session().client("backup")  # (1)
paginator: ListRecoveryPointsByBackupVaultPaginator = client.get_paginator("list_recovery_points_by_backup_vault")  # (2)
for item in paginator.paginate(...):
    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] = ...,
    ByParentRecoveryPointArn: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[ListRecoveryPointsByBackupVaultOutputTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See ListRecoveryPointsByBackupVaultOutputTypeDef

Usage example with kwargs

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

parent.paginate(**kwargs)

1. See ListRecoveryPointsByBackupVaultInputListRecoveryPointsByBackupVaultPaginateTypeDef

ListRecoveryPointsByLegalHoldPaginator

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

Usage example

from boto3.session import Session

from mypy_boto3_backup.paginator import ListRecoveryPointsByLegalHoldPaginator

def get_list_recovery_points_by_legal_hold_paginator() -> ListRecoveryPointsByLegalHoldPaginator:
    return Session().client("backup").get_paginator("list_recovery_points_by_legal_hold")

Usage example

from boto3.session import Session

from mypy_boto3_backup.paginator import ListRecoveryPointsByLegalHoldPaginator

session = Session()

client = Session().client("backup")  # (1)
paginator: ListRecoveryPointsByLegalHoldPaginator = client.get_paginator("list_recovery_points_by_legal_hold")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: BackupClient
2. paginator: ListRecoveryPointsByLegalHoldPaginator
3. item: ListRecoveryPointsByLegalHoldOutputTypeDef

paginate

Type annotations and code completion for ListRecoveryPointsByLegalHoldPaginator.paginate method.

Method definition

def paginate(
    self,
    *,
    LegalHoldId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[ListRecoveryPointsByLegalHoldOutputTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See ListRecoveryPointsByLegalHoldOutputTypeDef

Usage example with kwargs

kwargs: ListRecoveryPointsByLegalHoldInputListRecoveryPointsByLegalHoldPaginateTypeDef = {  # (1)
    "LegalHoldId": ...,
}

parent.paginate(**kwargs)

1. See ListRecoveryPointsByLegalHoldInputListRecoveryPointsByLegalHoldPaginateTypeDef

ListRecoveryPointsByResourcePaginator

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

Usage example

from boto3.session import Session

from mypy_boto3_backup.paginator import ListRecoveryPointsByResourcePaginator

def get_list_recovery_points_by_resource_paginator() -> ListRecoveryPointsByResourcePaginator:
    return Session().client("backup").get_paginator("list_recovery_points_by_resource")

Usage example

from boto3.session import Session

from mypy_boto3_backup.paginator import ListRecoveryPointsByResourcePaginator

session = Session()

client = Session().client("backup")  # (1)
paginator: ListRecoveryPointsByResourcePaginator = client.get_paginator("list_recovery_points_by_resource")  # (2)
for item in paginator.paginate(...):
    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)
) -> _PageIterator[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 boto3.client("backup").get_paginator("list_restore_jobs"). boto3 documentation

Usage example

from boto3.session import Session

from mypy_boto3_backup.paginator import ListRestoreJobsPaginator

def get_list_restore_jobs_paginator() -> ListRestoreJobsPaginator:
    return Session().client("backup").get_paginator("list_restore_jobs")

Usage example

from boto3.session import Session

from mypy_boto3_backup.paginator import ListRestoreJobsPaginator

session = Session()

client = Session().client("backup")  # (1)
paginator: ListRestoreJobsPaginator = client.get_paginator("list_restore_jobs")  # (2)
for item in paginator.paginate(...):
    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)
) -> _PageIterator[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