Backup module#
Index > Backup
Auto-generated documentation for Backup type annotations stubs module types-boto3-backup.
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
Backup
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 Backup
.
From PyPI with pip#
Install types-boto3
for Backup
service.
# install with boto3 type annotations
python -m pip install 'types-boto3[backup]'
# 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[backup]'
# standalone installation
python -m pip install types-boto3-backup
How to uninstall#
python -m pip uninstall -y types-boto3-backup
Usage#
Code samples can be found in Examples.
BackupClient#
Type annotations and code completion for boto3.client("backup")
as BackupClient
boto3 documentation
# BackupClient usage example
from boto3.session import Session
from types_boto3_backup.client import BackupClient
def get_client() -> BackupClient:
return Session().client("backup")
Paginators#
Type annotations and code completion for paginators
from boto3.client("backup").get_paginator("...")
.
# ListBackupJobsPaginator usage example
from boto3.session import Session
from types_boto3_backup.paginator import ListBackupJobsPaginator
def get_list_backup_jobs_paginator() -> ListBackupJobsPaginator:
return Session().client("backup").get_paginator("list_backup_jobs"))
- ListBackupJobsPaginator
- ListBackupPlanTemplatesPaginator
- ListBackupPlanVersionsPaginator
- ListBackupPlansPaginator
- ListBackupSelectionsPaginator
- ListBackupVaultsPaginator
- ListCopyJobsPaginator
- ListIndexedRecoveryPointsPaginator
- ListLegalHoldsPaginator
- ListProtectedResourcesByBackupVaultPaginator
- ListProtectedResourcesPaginator
- ListRecoveryPointsByBackupVaultPaginator
- ListRecoveryPointsByLegalHoldPaginator
- ListRecoveryPointsByResourcePaginator
- ListRestoreJobsByProtectedResourcePaginator
- ListRestoreJobsPaginator
- ListRestoreTestingPlansPaginator
- ListRestoreTestingSelectionsPaginator
Literals#
Type annotations for literals used in methods and schema.
# AggregationPeriodType usage example
from types_boto3_backup.literals import AggregationPeriodType
def get_value() -> AggregationPeriodType:
return "FOURTEEN_DAYS"
- AggregationPeriodType
- BackupJobStateType
- BackupJobStatusType
- BackupVaultEventType
- ConditionTypeType
- CopyJobStateType
- CopyJobStatusType
- IndexStatusType
- IndexType
- LegalHoldStatusType
- ListBackupJobsPaginatorName
- ListBackupPlanTemplatesPaginatorName
- ListBackupPlanVersionsPaginatorName
- ListBackupPlansPaginatorName
- ListBackupSelectionsPaginatorName
- ListBackupVaultsPaginatorName
- ListCopyJobsPaginatorName
- ListIndexedRecoveryPointsPaginatorName
- ListLegalHoldsPaginatorName
- ListProtectedResourcesByBackupVaultPaginatorName
- ListProtectedResourcesPaginatorName
- ListRecoveryPointsByBackupVaultPaginatorName
- ListRecoveryPointsByLegalHoldPaginatorName
- ListRecoveryPointsByResourcePaginatorName
- ListRestoreJobsByProtectedResourcePaginatorName
- ListRestoreJobsPaginatorName
- ListRestoreTestingPlansPaginatorName
- ListRestoreTestingSelectionsPaginatorName
- RecoveryPointStatusType
- RestoreDeletionStatusType
- RestoreJobStateType
- RestoreJobStatusType
- RestoreTestingRecoveryPointSelectionAlgorithmType
- RestoreTestingRecoveryPointTypeType
- RestoreValidationStatusType
- StorageClassType
- VaultStateType
- VaultTypeType
- BackupServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AdvancedBackupSettingOutputTypeDef
- AdvancedBackupSettingTypeDef
- BackupJobSummaryTypeDef
- RecoveryPointCreatorTypeDef
- BackupPlanTemplatesListMemberTypeDef
- LifecycleTypeDef
- IndexActionOutputTypeDef
- ConditionTypeDef
- BackupSelectionsListMemberTypeDef
- BackupVaultListMemberTypeDef
- CalculatedLifecycleTypeDef
- CancelLegalHoldInputTypeDef
- ConditionParameterTypeDef
- ControlInputParameterTypeDef
- ControlScopeOutputTypeDef
- ControlScopeTypeDef
- CopyJobSummaryTypeDef
- ResponseMetadataTypeDef
- CreateBackupVaultInputTypeDef
- CreateLogicallyAirGappedBackupVaultInputTypeDef
- DateRangeOutputTypeDef
- TimestampTypeDef
- DeleteBackupPlanInputTypeDef
- DeleteBackupSelectionInputTypeDef
- DeleteBackupVaultAccessPolicyInputTypeDef
- DeleteBackupVaultInputTypeDef
- DeleteBackupVaultLockConfigurationInputTypeDef
- DeleteBackupVaultNotificationsInputTypeDef
- DeleteFrameworkInputTypeDef
- DeleteRecoveryPointInputTypeDef
- DeleteReportPlanInputTypeDef
- DeleteRestoreTestingPlanInputTypeDef
- DeleteRestoreTestingSelectionInputTypeDef
- DescribeBackupJobInputTypeDef
- DescribeBackupVaultInputTypeDef
- DescribeCopyJobInputTypeDef
- DescribeFrameworkInputTypeDef
- DescribeProtectedResourceInputTypeDef
- DescribeRecoveryPointInputTypeDef
- DescribeReportJobInputTypeDef
- DescribeReportPlanInputTypeDef
- DescribeRestoreJobInputTypeDef
- RestoreJobCreatorTypeDef
- DisassociateRecoveryPointFromParentInputTypeDef
- DisassociateRecoveryPointInputTypeDef
- ExportBackupPlanTemplateInputTypeDef
- FrameworkTypeDef
- GetBackupPlanFromJSONInputTypeDef
- GetBackupPlanFromTemplateInputTypeDef
- GetBackupPlanInputTypeDef
- GetBackupSelectionInputTypeDef
- GetBackupVaultAccessPolicyInputTypeDef
- GetBackupVaultNotificationsInputTypeDef
- GetLegalHoldInputTypeDef
- GetRecoveryPointIndexDetailsInputTypeDef
- GetRecoveryPointRestoreMetadataInputTypeDef
- GetRestoreJobMetadataInputTypeDef
- GetRestoreTestingInferredMetadataInputTypeDef
- GetRestoreTestingPlanInputTypeDef
- GetRestoreTestingSelectionInputTypeDef
- IndexActionTypeDef
- IndexedRecoveryPointTypeDef
- KeyValueTypeDef
- LegalHoldTypeDef
- ListBackupJobSummariesInputTypeDef
- PaginatorConfigTypeDef
- ListBackupPlanTemplatesInputTypeDef
- ListBackupPlanVersionsInputTypeDef
- ListBackupPlansInputTypeDef
- ListBackupSelectionsInputTypeDef
- ListBackupVaultsInputTypeDef
- ListCopyJobSummariesInputTypeDef
- ListFrameworksInputTypeDef
- ListLegalHoldsInputTypeDef
- ListProtectedResourcesByBackupVaultInputTypeDef
- ProtectedResourceTypeDef
- ListProtectedResourcesInputTypeDef
- ListRecoveryPointsByLegalHoldInputTypeDef
- RecoveryPointMemberTypeDef
- ListRecoveryPointsByResourceInputTypeDef
- RecoveryPointByResourceTypeDef
- ListReportPlansInputTypeDef
- ListRestoreJobSummariesInputTypeDef
- RestoreJobSummaryTypeDef
- ListRestoreTestingPlansInputTypeDef
- RestoreTestingPlanForListTypeDef
- ListRestoreTestingSelectionsInputTypeDef
- RestoreTestingSelectionForListTypeDef
- ListTagsInputTypeDef
- PutBackupVaultAccessPolicyInputTypeDef
- PutBackupVaultLockConfigurationInputTypeDef
- PutBackupVaultNotificationsInputTypeDef
- PutRestoreValidationResultInputTypeDef
- ReportDeliveryChannelOutputTypeDef
- ReportDeliveryChannelTypeDef
- ReportDestinationTypeDef
- ReportSettingOutputTypeDef
- ReportSettingTypeDef
- RestoreTestingRecoveryPointSelectionOutputTypeDef
- RestoreTestingRecoveryPointSelectionTypeDef
- StartReportJobInputTypeDef
- StartRestoreJobInputTypeDef
- StopBackupJobInputTypeDef
- TagResourceInputTypeDef
- UntagResourceInputTypeDef
- UpdateGlobalSettingsInputTypeDef
- UpdateRecoveryPointIndexSettingsInputTypeDef
- UpdateRegionSettingsInputTypeDef
- BackupPlansListMemberTypeDef
- AdvancedBackupSettingUnionTypeDef
- BackupJobTypeDef
- CopyJobTypeDef
- CopyActionTypeDef
- StartBackupJobInputTypeDef
- StartCopyJobInputTypeDef
- UpdateRecoveryPointLifecycleInputTypeDef
- RecoveryPointByBackupVaultTypeDef
- ConditionsOutputTypeDef
- ConditionsTypeDef
- FrameworkControlOutputTypeDef
- ControlScopeUnionTypeDef
- CreateBackupPlanOutputTypeDef
- CreateBackupSelectionOutputTypeDef
- CreateBackupVaultOutputTypeDef
- CreateFrameworkOutputTypeDef
- CreateLogicallyAirGappedBackupVaultOutputTypeDef
- CreateReportPlanOutputTypeDef
- CreateRestoreTestingPlanOutputTypeDef
- CreateRestoreTestingSelectionOutputTypeDef
- DeleteBackupPlanOutputTypeDef
- DescribeBackupJobOutputTypeDef
- DescribeBackupVaultOutputTypeDef
- DescribeGlobalSettingsOutputTypeDef
- DescribeProtectedResourceOutputTypeDef
- DescribeRecoveryPointOutputTypeDef
- DescribeRegionSettingsOutputTypeDef
- EmptyResponseMetadataTypeDef
- ExportBackupPlanTemplateOutputTypeDef
- GetBackupVaultAccessPolicyOutputTypeDef
- GetBackupVaultNotificationsOutputTypeDef
- GetRecoveryPointIndexDetailsOutputTypeDef
- GetRecoveryPointRestoreMetadataOutputTypeDef
- GetRestoreJobMetadataOutputTypeDef
- GetRestoreTestingInferredMetadataOutputTypeDef
- GetSupportedResourceTypesOutputTypeDef
- ListBackupJobSummariesOutputTypeDef
- ListBackupPlanTemplatesOutputTypeDef
- ListBackupSelectionsOutputTypeDef
- ListBackupVaultsOutputTypeDef
- ListCopyJobSummariesOutputTypeDef
- ListTagsOutputTypeDef
- StartBackupJobOutputTypeDef
- StartCopyJobOutputTypeDef
- StartReportJobOutputTypeDef
- StartRestoreJobOutputTypeDef
- UpdateBackupPlanOutputTypeDef
- UpdateFrameworkOutputTypeDef
- UpdateRecoveryPointIndexSettingsOutputTypeDef
- UpdateRecoveryPointLifecycleOutputTypeDef
- UpdateReportPlanOutputTypeDef
- UpdateRestoreTestingPlanOutputTypeDef
- UpdateRestoreTestingSelectionOutputTypeDef
- RecoveryPointSelectionOutputTypeDef
- DateRangeTypeDef
- ListBackupJobsInputTypeDef
- ListCopyJobsInputTypeDef
- ListIndexedRecoveryPointsInputTypeDef
- ListRecoveryPointsByBackupVaultInputTypeDef
- ListReportJobsInputTypeDef
- ListRestoreJobsByProtectedResourceInputTypeDef
- ListRestoreJobsInputTypeDef
- DescribeRestoreJobOutputTypeDef
- RestoreJobsListMemberTypeDef
- ListFrameworksOutputTypeDef
- IndexActionUnionTypeDef
- ListIndexedRecoveryPointsOutputTypeDef
- ProtectedResourceConditionsOutputTypeDef
- ProtectedResourceConditionsTypeDef
- ListLegalHoldsOutputTypeDef
- ListBackupJobsInputPaginateTypeDef
- ListBackupPlanTemplatesInputPaginateTypeDef
- ListBackupPlanVersionsInputPaginateTypeDef
- ListBackupPlansInputPaginateTypeDef
- ListBackupSelectionsInputPaginateTypeDef
- ListBackupVaultsInputPaginateTypeDef
- ListCopyJobsInputPaginateTypeDef
- ListIndexedRecoveryPointsInputPaginateTypeDef
- ListLegalHoldsInputPaginateTypeDef
- ListProtectedResourcesByBackupVaultInputPaginateTypeDef
- ListProtectedResourcesInputPaginateTypeDef
- ListRecoveryPointsByBackupVaultInputPaginateTypeDef
- ListRecoveryPointsByLegalHoldInputPaginateTypeDef
- ListRecoveryPointsByResourceInputPaginateTypeDef
- ListRestoreJobsByProtectedResourceInputPaginateTypeDef
- ListRestoreJobsInputPaginateTypeDef
- ListRestoreTestingPlansInputPaginateTypeDef
- ListRestoreTestingSelectionsInputPaginateTypeDef
- ListProtectedResourcesByBackupVaultOutputTypeDef
- ListProtectedResourcesOutputTypeDef
- ListRecoveryPointsByLegalHoldOutputTypeDef
- ListRecoveryPointsByResourceOutputTypeDef
- ListRestoreJobSummariesOutputTypeDef
- ListRestoreTestingPlansOutputTypeDef
- ListRestoreTestingSelectionsOutputTypeDef
- ReportDeliveryChannelUnionTypeDef
- ReportJobTypeDef
- ReportPlanTypeDef
- ReportSettingUnionTypeDef
- RestoreTestingPlanForGetTypeDef
- RestoreTestingRecoveryPointSelectionUnionTypeDef
- ListBackupPlanVersionsOutputTypeDef
- ListBackupPlansOutputTypeDef
- ListBackupJobsOutputTypeDef
- DescribeCopyJobOutputTypeDef
- ListCopyJobsOutputTypeDef
- BackupRuleTypeDef
- ListRecoveryPointsByBackupVaultOutputTypeDef
- BackupSelectionOutputTypeDef
- BackupSelectionTypeDef
- DescribeFrameworkOutputTypeDef
- FrameworkControlTypeDef
- CreateLegalHoldOutputTypeDef
- GetLegalHoldOutputTypeDef
- RecoveryPointSelectionTypeDef
- ListRestoreJobsByProtectedResourceOutputTypeDef
- ListRestoreJobsOutputTypeDef
- BackupRuleInputTypeDef
- RestoreTestingSelectionForGetTypeDef
- ProtectedResourceConditionsUnionTypeDef
- DescribeReportJobOutputTypeDef
- ListReportJobsOutputTypeDef
- DescribeReportPlanOutputTypeDef
- ListReportPlansOutputTypeDef
- CreateReportPlanInputTypeDef
- UpdateReportPlanInputTypeDef
- GetRestoreTestingPlanOutputTypeDef
- RestoreTestingPlanForCreateTypeDef
- RestoreTestingPlanForUpdateTypeDef
- BackupPlanTypeDef
- GetBackupSelectionOutputTypeDef
- BackupSelectionUnionTypeDef
- FrameworkControlUnionTypeDef
- RecoveryPointSelectionUnionTypeDef
- BackupPlanInputTypeDef
- GetRestoreTestingSelectionOutputTypeDef
- RestoreTestingSelectionForCreateTypeDef
- RestoreTestingSelectionForUpdateTypeDef
- CreateRestoreTestingPlanInputTypeDef
- UpdateRestoreTestingPlanInputTypeDef
- GetBackupPlanFromJSONOutputTypeDef
- GetBackupPlanFromTemplateOutputTypeDef
- GetBackupPlanOutputTypeDef
- CreateBackupSelectionInputTypeDef
- CreateFrameworkInputTypeDef
- UpdateFrameworkInputTypeDef
- CreateLegalHoldInputTypeDef
- CreateBackupPlanInputTypeDef
- UpdateBackupPlanInputTypeDef
- CreateRestoreTestingSelectionInputTypeDef
- UpdateRestoreTestingSelectionInputTypeDef