Backup module
Index > Backup
Auto-generated documentation for Backup type annotations stubs module mypy-boto3-backup.
How to install
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 boto3-stubs
for Backup
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[backup]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[backup]'
# standalone installation
python -m pip install mypy-boto3-backup
How to uninstall
Usage
Code samples can be found in Examples.
BackupClient
Type annotations and code completion for boto3.client("backup")
as BackupClient
boto3 documentation
Usage example
from boto3.session import Session
from mypy_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("...")
.
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
- ListBackupPlanTemplatesPaginator
- ListBackupPlanVersionsPaginator
- ListBackupPlansPaginator
- ListBackupSelectionsPaginator
- ListBackupVaultsPaginator
- ListCopyJobsPaginator
- ListLegalHoldsPaginator
- ListProtectedResourcesPaginator
- ListRecoveryPointsByBackupVaultPaginator
- ListRecoveryPointsByLegalHoldPaginator
- ListRecoveryPointsByResourcePaginator
- ListRestoreJobsPaginator
Literals
Type annotations for literals used in methods and schemas.
Usage example
from mypy_boto3_backup.literals import BackupJobStateType
def get_value() -> BackupJobStateType:
return "ABORTED"
- BackupJobStateType
- BackupVaultEventType
- ConditionTypeType
- CopyJobStateType
- LegalHoldStatusType
- ListBackupJobsPaginatorName
- ListBackupPlanTemplatesPaginatorName
- ListBackupPlanVersionsPaginatorName
- ListBackupPlansPaginatorName
- ListBackupSelectionsPaginatorName
- ListBackupVaultsPaginatorName
- ListCopyJobsPaginatorName
- ListLegalHoldsPaginatorName
- ListProtectedResourcesPaginatorName
- ListRecoveryPointsByBackupVaultPaginatorName
- ListRecoveryPointsByLegalHoldPaginatorName
- ListRecoveryPointsByResourcePaginatorName
- ListRestoreJobsPaginatorName
- RecoveryPointStatusType
- RestoreJobStatusType
- StorageClassType
- BackupServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Typed dictionaries
Type annotations for typed dictionaries used in methods and schema.
Usage example
from mypy_boto3_backup.type_defs import AdvancedBackupSettingTypeDef
def get_value() -> AdvancedBackupSettingTypeDef:
return {
"ResourceType": ...,
}
- AdvancedBackupSettingTypeDef
- RecoveryPointCreatorTypeDef
- BackupPlanTemplatesListMemberTypeDef
- LifecycleTypeDef
- ConditionTypeDef
- BackupSelectionsListMemberTypeDef
- BackupVaultListMemberTypeDef
- CalculatedLifecycleTypeDef
- CancelLegalHoldInputRequestTypeDef
- ConditionParameterTypeDef
- ControlInputParameterTypeDef
- ControlScopeTypeDef
- ResponseMetadataTypeDef
- CreateBackupVaultInputRequestTypeDef
- ReportDeliveryChannelTypeDef
- ReportSettingTypeDef
- DateRangeTypeDef
- DeleteBackupPlanInputRequestTypeDef
- DeleteBackupSelectionInputRequestTypeDef
- DeleteBackupVaultAccessPolicyInputRequestTypeDef
- DeleteBackupVaultInputRequestTypeDef
- DeleteBackupVaultLockConfigurationInputRequestTypeDef
- DeleteBackupVaultNotificationsInputRequestTypeDef
- DeleteFrameworkInputRequestTypeDef
- DeleteRecoveryPointInputRequestTypeDef
- DeleteReportPlanInputRequestTypeDef
- DescribeBackupJobInputRequestTypeDef
- DescribeBackupVaultInputRequestTypeDef
- DescribeCopyJobInputRequestTypeDef
- DescribeFrameworkInputRequestTypeDef
- DescribeProtectedResourceInputRequestTypeDef
- DescribeRecoveryPointInputRequestTypeDef
- DescribeReportJobInputRequestTypeDef
- DescribeReportPlanInputRequestTypeDef
- DescribeRestoreJobInputRequestTypeDef
- DisassociateRecoveryPointFromParentInputRequestTypeDef
- DisassociateRecoveryPointInputRequestTypeDef
- ExportBackupPlanTemplateInputRequestTypeDef
- FrameworkTypeDef
- GetBackupPlanFromJSONInputRequestTypeDef
- GetBackupPlanFromTemplateInputRequestTypeDef
- GetBackupPlanInputRequestTypeDef
- GetBackupSelectionInputRequestTypeDef
- GetBackupVaultAccessPolicyInputRequestTypeDef
- GetBackupVaultNotificationsInputRequestTypeDef
- GetLegalHoldInputRequestTypeDef
- GetRecoveryPointRestoreMetadataInputRequestTypeDef
- LegalHoldTypeDef
- PaginatorConfigTypeDef
- ListBackupJobsInputRequestTypeDef
- ListBackupPlanTemplatesInputRequestTypeDef
- ListBackupPlanVersionsInputRequestTypeDef
- ListBackupPlansInputRequestTypeDef
- ListBackupSelectionsInputRequestTypeDef
- ListBackupVaultsInputRequestTypeDef
- ListCopyJobsInputRequestTypeDef
- ListFrameworksInputRequestTypeDef
- ListLegalHoldsInputRequestTypeDef
- ListProtectedResourcesInputRequestTypeDef
- ProtectedResourceTypeDef
- ListRecoveryPointsByBackupVaultInputRequestTypeDef
- ListRecoveryPointsByLegalHoldInputRequestTypeDef
- RecoveryPointMemberTypeDef
- ListRecoveryPointsByResourceInputRequestTypeDef
- RecoveryPointByResourceTypeDef
- ListReportJobsInputRequestTypeDef
- ListReportPlansInputRequestTypeDef
- ListRestoreJobsInputRequestTypeDef
- RestoreJobsListMemberTypeDef
- ListTagsInputRequestTypeDef
- PutBackupVaultAccessPolicyInputRequestTypeDef
- PutBackupVaultLockConfigurationInputRequestTypeDef
- PutBackupVaultNotificationsInputRequestTypeDef
- ReportDestinationTypeDef
- StartReportJobInputRequestTypeDef
- StartRestoreJobInputRequestTypeDef
- StopBackupJobInputRequestTypeDef
- TagResourceInputRequestTypeDef
- UntagResourceInputRequestTypeDef
- UpdateGlobalSettingsInputRequestTypeDef
- UpdateRegionSettingsInputRequestTypeDef
- BackupPlansListMemberTypeDef
- BackupJobTypeDef
- CopyJobTypeDef
- CopyActionTypeDef
- StartBackupJobInputRequestTypeDef
- StartCopyJobInputRequestTypeDef
- UpdateRecoveryPointLifecycleInputRequestTypeDef
- RecoveryPointByBackupVaultTypeDef
- ConditionsTypeDef
- FrameworkControlTypeDef
- CreateBackupPlanOutputTypeDef
- CreateBackupSelectionOutputTypeDef
- CreateBackupVaultOutputTypeDef
- CreateFrameworkOutputTypeDef
- CreateReportPlanOutputTypeDef
- DeleteBackupPlanOutputTypeDef
- DescribeBackupJobOutputTypeDef
- DescribeBackupVaultOutputTypeDef
- DescribeGlobalSettingsOutputTypeDef
- DescribeProtectedResourceOutputTypeDef
- DescribeRecoveryPointOutputTypeDef
- DescribeRegionSettingsOutputTypeDef
- DescribeRestoreJobOutputTypeDef
- EmptyResponseMetadataTypeDef
- ExportBackupPlanTemplateOutputTypeDef
- GetBackupVaultAccessPolicyOutputTypeDef
- GetBackupVaultNotificationsOutputTypeDef
- GetRecoveryPointRestoreMetadataOutputTypeDef
- GetSupportedResourceTypesOutputTypeDef
- ListBackupPlanTemplatesOutputTypeDef
- ListBackupSelectionsOutputTypeDef
- ListBackupVaultsOutputTypeDef
- ListTagsOutputTypeDef
- StartBackupJobOutputTypeDef
- StartCopyJobOutputTypeDef
- StartReportJobOutputTypeDef
- StartRestoreJobOutputTypeDef
- UpdateBackupPlanOutputTypeDef
- UpdateFrameworkOutputTypeDef
- UpdateRecoveryPointLifecycleOutputTypeDef
- UpdateReportPlanOutputTypeDef
- CreateReportPlanInputRequestTypeDef
- ReportPlanTypeDef
- UpdateReportPlanInputRequestTypeDef
- RecoveryPointSelectionTypeDef
- ListFrameworksOutputTypeDef
- ListLegalHoldsOutputTypeDef
- ListBackupJobsInputListBackupJobsPaginateTypeDef
- ListBackupPlanTemplatesInputListBackupPlanTemplatesPaginateTypeDef
- ListBackupPlanVersionsInputListBackupPlanVersionsPaginateTypeDef
- ListBackupPlansInputListBackupPlansPaginateTypeDef
- ListBackupSelectionsInputListBackupSelectionsPaginateTypeDef
- ListBackupVaultsInputListBackupVaultsPaginateTypeDef
- ListCopyJobsInputListCopyJobsPaginateTypeDef
- ListLegalHoldsInputListLegalHoldsPaginateTypeDef
- ListProtectedResourcesInputListProtectedResourcesPaginateTypeDef
- ListRecoveryPointsByBackupVaultInputListRecoveryPointsByBackupVaultPaginateTypeDef
- ListRecoveryPointsByLegalHoldInputListRecoveryPointsByLegalHoldPaginateTypeDef
- ListRecoveryPointsByResourceInputListRecoveryPointsByResourcePaginateTypeDef
- ListRestoreJobsInputListRestoreJobsPaginateTypeDef
- ListProtectedResourcesOutputTypeDef
- ListRecoveryPointsByLegalHoldOutputTypeDef
- ListRecoveryPointsByResourceOutputTypeDef
- ListRestoreJobsOutputTypeDef
- ReportJobTypeDef
- ListBackupPlanVersionsOutputTypeDef
- ListBackupPlansOutputTypeDef
- ListBackupJobsOutputTypeDef
- DescribeCopyJobOutputTypeDef
- ListCopyJobsOutputTypeDef
- BackupRuleInputTypeDef
- BackupRuleTypeDef
- ListRecoveryPointsByBackupVaultOutputTypeDef
- BackupSelectionTypeDef
- CreateFrameworkInputRequestTypeDef
- DescribeFrameworkOutputTypeDef
- UpdateFrameworkInputRequestTypeDef
- DescribeReportPlanOutputTypeDef
- ListReportPlansOutputTypeDef
- CreateLegalHoldInputRequestTypeDef
- CreateLegalHoldOutputTypeDef
- GetLegalHoldOutputTypeDef
- DescribeReportJobOutputTypeDef
- ListReportJobsOutputTypeDef
- BackupPlanInputTypeDef
- BackupPlanTypeDef
- CreateBackupSelectionInputRequestTypeDef
- GetBackupSelectionOutputTypeDef
- CreateBackupPlanInputRequestTypeDef
- UpdateBackupPlanInputRequestTypeDef
- GetBackupPlanFromJSONOutputTypeDef
- GetBackupPlanFromTemplateOutputTypeDef
- GetBackupPlanOutputTypeDef