Paginators

Index > BackupSearch > Paginators

Auto-generated documentation for BackupSearch type annotations stubs module types-boto3-backupsearch.

ListSearchJobBackupsPaginator

Type annotations and code completion for boto3.client("backupsearch").get_paginator("list_search_job_backups"). boto3 documentation

# ListSearchJobBackupsPaginator usage example

from boto3.session import Session

from types_boto3_backupsearch.paginator import ListSearchJobBackupsPaginator

def get_list_search_job_backups_paginator() -> ListSearchJobBackupsPaginator:
    return Session().client("backupsearch").get_paginator("list_search_job_backups")

# ListSearchJobBackupsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_backupsearch.paginator import ListSearchJobBackupsPaginator

session = Session()

client = Session().client("backupsearch")  # (1)
paginator: ListSearchJobBackupsPaginator = client.get_paginator("list_search_job_backups")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: BackupSearchClient
2. paginator: ListSearchJobBackupsPaginator
3. item: PageIterator[ListSearchJobBackupsOutputTypeDef]

paginate

Type annotations and code completion for ListSearchJobBackupsPaginator.paginate method.

# paginate method definition

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

1. See PaginatorConfigTypeDef
2. See PageIterator[ListSearchJobBackupsOutputTypeDef]

# paginate method usage example with argument unpacking

kwargs: ListSearchJobBackupsInputPaginateTypeDef = {  # (1)
    "SearchJobIdentifier": ...,
}

parent.paginate(**kwargs)

1. See ListSearchJobBackupsInputPaginateTypeDef

ListSearchJobResultsPaginator

Type annotations and code completion for boto3.client("backupsearch").get_paginator("list_search_job_results"). boto3 documentation

# ListSearchJobResultsPaginator usage example

from boto3.session import Session

from types_boto3_backupsearch.paginator import ListSearchJobResultsPaginator

def get_list_search_job_results_paginator() -> ListSearchJobResultsPaginator:
    return Session().client("backupsearch").get_paginator("list_search_job_results")

# ListSearchJobResultsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_backupsearch.paginator import ListSearchJobResultsPaginator

session = Session()

client = Session().client("backupsearch")  # (1)
paginator: ListSearchJobResultsPaginator = client.get_paginator("list_search_job_results")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: BackupSearchClient
2. paginator: ListSearchJobResultsPaginator
3. item: PageIterator[ListSearchJobResultsOutputTypeDef]

paginate

Type annotations and code completion for ListSearchJobResultsPaginator.paginate method.

# paginate method definition

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

1. See PaginatorConfigTypeDef
2. See PageIterator[ListSearchJobResultsOutputTypeDef]

# paginate method usage example with argument unpacking

kwargs: ListSearchJobResultsInputPaginateTypeDef = {  # (1)
    "SearchJobIdentifier": ...,
}

parent.paginate(**kwargs)

1. See ListSearchJobResultsInputPaginateTypeDef

ListSearchJobsPaginator

Type annotations and code completion for boto3.client("backupsearch").get_paginator("list_search_jobs"). boto3 documentation

# ListSearchJobsPaginator usage example

from boto3.session import Session

from types_boto3_backupsearch.paginator import ListSearchJobsPaginator

def get_list_search_jobs_paginator() -> ListSearchJobsPaginator:
    return Session().client("backupsearch").get_paginator("list_search_jobs")

# ListSearchJobsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_backupsearch.paginator import ListSearchJobsPaginator

session = Session()

client = Session().client("backupsearch")  # (1)
paginator: ListSearchJobsPaginator = client.get_paginator("list_search_jobs")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: BackupSearchClient
2. paginator: ListSearchJobsPaginator
3. item: PageIterator[ListSearchJobsOutputTypeDef]

paginate

Type annotations and code completion for ListSearchJobsPaginator.paginate method.

# paginate method definition

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

1. See SearchJobStateType
2. See PaginatorConfigTypeDef
3. See PageIterator[ListSearchJobsOutputTypeDef]

# paginate method usage example with argument unpacking

kwargs: ListSearchJobsInputPaginateTypeDef = {  # (1)
    "ByStatus": ...,
}

parent.paginate(**kwargs)

1. See ListSearchJobsInputPaginateTypeDef

ListSearchResultExportJobsPaginator

Type annotations and code completion for boto3.client("backupsearch").get_paginator("list_search_result_export_jobs"). boto3 documentation

# ListSearchResultExportJobsPaginator usage example

from boto3.session import Session

from types_boto3_backupsearch.paginator import ListSearchResultExportJobsPaginator

def get_list_search_result_export_jobs_paginator() -> ListSearchResultExportJobsPaginator:
    return Session().client("backupsearch").get_paginator("list_search_result_export_jobs")

# ListSearchResultExportJobsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_backupsearch.paginator import ListSearchResultExportJobsPaginator

session = Session()

client = Session().client("backupsearch")  # (1)
paginator: ListSearchResultExportJobsPaginator = client.get_paginator("list_search_result_export_jobs")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: BackupSearchClient
2. paginator: ListSearchResultExportJobsPaginator
3. item: PageIterator[ListSearchResultExportJobsOutputTypeDef]

paginate

Type annotations and code completion for ListSearchResultExportJobsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    Status: ExportJobStatusType = ...,  # (1)
    SearchJobIdentifier: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> botocore.paginate.PageIterator[ListSearchResultExportJobsOutputTypeDef]:  # (3)
    ...

1. See ExportJobStatusType
2. See PaginatorConfigTypeDef
3. See PageIterator[ListSearchResultExportJobsOutputTypeDef]

# paginate method usage example with argument unpacking

kwargs: ListSearchResultExportJobsInputPaginateTypeDef = {  # (1)
    "Status": ...,
}

parent.paginate(**kwargs)

1. See ListSearchResultExportJobsInputPaginateTypeDef