Skip to content

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

# ListBackupJobsPaginator 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")
# ListBackupJobsPaginator usage example with type annotations

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.

# paginate 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 = ...,
    ByMessageCategory: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> _PageIterator[ListBackupJobsOutputTypeDef]:  # (3)
    ...
  1. See BackupJobStateType
  2. See PaginatorConfigTypeDef
  3. See ListBackupJobsOutputTypeDef
# paginate method usage example with argument unpacking

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

# ListBackupPlanTemplatesPaginator 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")
# ListBackupPlanTemplatesPaginator usage example with type annotations

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.

# paginate method definition

def paginate(
    self,
    *,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[ListBackupPlanTemplatesOutputTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListBackupPlanTemplatesOutputTypeDef
# paginate method usage example with argument unpacking

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

# ListBackupPlanVersionsPaginator 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")
# ListBackupPlanVersionsPaginator usage example with type annotations

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: ListBackupPlanVersionsOutputPaginatorTypeDef

paginate#

Type annotations and code completion for ListBackupPlanVersionsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    BackupPlanId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[ListBackupPlanVersionsOutputPaginatorTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListBackupPlanVersionsOutputPaginatorTypeDef
# paginate method usage example with argument unpacking

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

# ListBackupPlansPaginator 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")
# ListBackupPlansPaginator usage example with type annotations

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: ListBackupPlansOutputPaginatorTypeDef

paginate#

Type annotations and code completion for ListBackupPlansPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    IncludeDeleted: bool = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[ListBackupPlansOutputPaginatorTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListBackupPlansOutputPaginatorTypeDef
# paginate method usage example with argument unpacking

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

# ListBackupSelectionsPaginator 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")
# ListBackupSelectionsPaginator usage example with type annotations

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.

# paginate method definition

def paginate(
    self,
    *,
    BackupPlanId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[ListBackupSelectionsOutputTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListBackupSelectionsOutputTypeDef
# paginate method usage example with argument unpacking

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

# ListBackupVaultsPaginator 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")
# ListBackupVaultsPaginator usage example with type annotations

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.

# paginate method definition

def paginate(
    self,
    *,
    ByVaultType: VaultTypeType = ...,  # (1)
    ByShared: bool = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> _PageIterator[ListBackupVaultsOutputTypeDef]:  # (3)
    ...
  1. See VaultTypeType
  2. See PaginatorConfigTypeDef
  3. See ListBackupVaultsOutputTypeDef
# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)
  1. See ListBackupVaultsInputListBackupVaultsPaginateTypeDef

ListCopyJobsPaginator#

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

# ListCopyJobsPaginator 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")
# ListCopyJobsPaginator usage example with type annotations

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.

# paginate 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 = ...,
    ByMessageCategory: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> _PageIterator[ListCopyJobsOutputTypeDef]:  # (3)
    ...
  1. See CopyJobStateType
  2. See PaginatorConfigTypeDef
  3. See ListCopyJobsOutputTypeDef
# paginate method usage example with argument unpacking

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

# ListLegalHoldsPaginator 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")
# ListLegalHoldsPaginator usage example with type annotations

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.

# paginate method definition

def paginate(
    self,
    *,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[ListLegalHoldsOutputTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListLegalHoldsOutputTypeDef
# paginate method usage example with argument unpacking

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

# ListProtectedResourcesPaginator 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")
# ListProtectedResourcesPaginator usage example with type annotations

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.

# paginate method definition

def paginate(
    self,
    *,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[ListProtectedResourcesOutputTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListProtectedResourcesOutputTypeDef
# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)
  1. See ListProtectedResourcesInputListProtectedResourcesPaginateTypeDef

ListProtectedResourcesByBackupVaultPaginator#

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

# ListProtectedResourcesByBackupVaultPaginator usage example

from boto3.session import Session

from mypy_boto3_backup.paginator import ListProtectedResourcesByBackupVaultPaginator

def get_list_protected_resources_by_backup_vault_paginator() -> ListProtectedResourcesByBackupVaultPaginator:
    return Session().client("backup").get_paginator("list_protected_resources_by_backup_vault")
# ListProtectedResourcesByBackupVaultPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_backup.paginator import ListProtectedResourcesByBackupVaultPaginator

session = Session()

client = Session().client("backup")  # (1)
paginator: ListProtectedResourcesByBackupVaultPaginator = client.get_paginator("list_protected_resources_by_backup_vault")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: BackupClient
  2. paginator: ListProtectedResourcesByBackupVaultPaginator
  3. item: ListProtectedResourcesByBackupVaultOutputTypeDef

paginate#

Type annotations and code completion for ListProtectedResourcesByBackupVaultPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    BackupVaultName: str,
    BackupVaultAccountId: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[ListProtectedResourcesByBackupVaultOutputTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListProtectedResourcesByBackupVaultOutputTypeDef
# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)
  1. See