BackupSearch module#
Index > BackupSearch
Auto-generated documentation for BackupSearch type annotations stubs module types-boto3-backupsearch.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy-boto3-builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.36.26' mypy-boto3-builder
- Select
boto3
AWS SDK. - Add
BackupSearch
service. - Use provided commands to install generated packages.
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and BackupSearch
.
From PyPI with pip#
Install types-boto3
for BackupSearch
service.
# install with boto3 type annotations
python -m pip install 'types-boto3[backupsearch]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[backupsearch]'
# standalone installation
python -m pip install types-boto3-backupsearch
How to uninstall#
python -m pip uninstall -y types-boto3-backupsearch
Usage#
Code samples can be found in Examples.
BackupSearchClient#
Type annotations and code completion for boto3.client("backupsearch")
as BackupSearchClient
boto3 documentation
# BackupSearchClient usage example
from boto3.session import Session
from types_boto3_backupsearch.client import BackupSearchClient
def get_client() -> BackupSearchClient:
return Session().client("backupsearch")
Paginators#
Type annotations and code completion for paginators
from boto3.client("backupsearch").get_paginator("...")
.
# 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
- ListSearchJobResultsPaginator
- ListSearchJobsPaginator
- ListSearchResultExportJobsPaginator
Literals#
Type annotations for literals used in methods and schema.
# ExportJobStatusType usage example
from types_boto3_backupsearch.literals import ExportJobStatusType
def get_value() -> ExportJobStatusType:
return "COMPLETED"
- ExportJobStatusType
- ListSearchJobBackupsPaginatorName
- ListSearchJobResultsPaginatorName
- ListSearchJobsPaginatorName
- ListSearchResultExportJobsPaginatorName
- LongConditionOperatorType
- ResourceTypeType
- SearchJobStateType
- StringConditionOperatorType
- TimeConditionOperatorType
- BackupSearchServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
Type definitions#
Type annotations for type definitions used in methods and schema.
- BackupCreationTimeFilterOutputTypeDef
- TimestampTypeDef
- CurrentSearchProgressTypeDef
- LongConditionTypeDef
- StringConditionTypeDef
- TimeConditionOutputTypeDef
- EBSResultItemTypeDef
- ExportJobSummaryTypeDef
- S3ExportSpecificationTypeDef
- GetSearchJobInputTypeDef
- ResponseMetadataTypeDef
- SearchScopeSummaryTypeDef
- GetSearchResultExportJobInputTypeDef
- PaginatorConfigTypeDef
- ListSearchJobBackupsInputTypeDef
- SearchJobBackupsResultTypeDef
- ListSearchJobResultsInputTypeDef
- ListSearchJobsInputTypeDef
- ListSearchResultExportJobsInputTypeDef
- ListTagsForResourceRequestTypeDef
- S3ResultItemTypeDef
- StopSearchJobInputTypeDef
- TagResourceRequestTypeDef
- UntagResourceRequestTypeDef
- SearchScopeOutputTypeDef
- BackupCreationTimeFilterTypeDef
- TimeConditionTypeDef
- EBSItemFilterOutputTypeDef
- S3ItemFilterOutputTypeDef
- ExportSpecificationTypeDef
- ListSearchResultExportJobsOutputTypeDef
- ListTagsForResourceResponseTypeDef
- StartSearchJobOutputTypeDef
- StartSearchResultExportJobOutputTypeDef
- SearchJobSummaryTypeDef
- ListSearchJobBackupsInputPaginateTypeDef
- ListSearchJobResultsInputPaginateTypeDef
- ListSearchJobsInputPaginateTypeDef
- ListSearchResultExportJobsInputPaginateTypeDef
- ListSearchJobBackupsOutputTypeDef
- ResultItemTypeDef
- SearchScopeTypeDef
- EBSItemFilterTypeDef
- S3ItemFilterTypeDef
- ItemFiltersOutputTypeDef
- GetSearchResultExportJobOutputTypeDef
- StartSearchResultExportJobInputTypeDef
- ListSearchJobsOutputTypeDef
- ListSearchJobResultsOutputTypeDef
- SearchScopeUnionTypeDef
- ItemFiltersTypeDef
- GetSearchJobOutputTypeDef
- ItemFiltersUnionTypeDef
- StartSearchJobInputTypeDef