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#
python -m pip uninstall -y mypy-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 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("...")
.
# 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
- ListBackupPlanTemplatesPaginator
- ListBackupPlanVersionsPaginator
- ListBackupPlansPaginator
- ListBackupSelectionsPaginator
- ListBackupVaultsPaginator
- ListCopyJobsPaginator
- ListLegalHoldsPaginator
- ListProtectedResourcesPaginator
- ListRecoveryPointsByBackupVaultPaginator
- ListRecoveryPointsByLegalHoldPaginator
- ListRecoveryPointsByResourcePaginator
- ListRestoreJobsPaginator
Literals#
Type annotations for literals used in methods and schemas.
# BackupJobStateType 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.
# AdvancedBackupSettingTypeDef 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
- CreateBackupSelectionOutputTypeDef
- CreateBackupVaultInputRequestTypeDef
- CreateBackupVaultOutputTypeDef
- CreateFrameworkOutputTypeDef
- ReportDeliveryChannelTypeDef
- ReportSettingTypeDef
- CreateReportPlanOutputTypeDef
- DateRangeTypeDef
- DeleteBackupPlanInputRequestTypeDef
- DeleteBackupPlanOutputTypeDef
- DeleteBackupSelectionInputRequestTypeDef
- DeleteBackupVaultAccessPolicyInputRequestTypeDef
- DeleteBackupVaultInputRequestTypeDef
- DeleteBackupVaultLockConfigurationInputRequestTypeDef
- DeleteBackupVaultNotificationsInputRequestTypeDef
- DeleteFrameworkInputRequestTypeDef
- DeleteRecoveryPointInputRequestTypeDef
- DeleteReportPlanInputRequestTypeDef
- DescribeBackupJobInputRequestTypeDef
- DescribeBackupVaultInputRequestTypeDef
- DescribeBackupVaultOutputTypeDef
- DescribeCopyJobInputRequestTypeDef
- DescribeFrameworkInputRequestTypeDef
- DescribeGlobalSettingsOutputTypeDef
- DescribeProtectedResourceInputRequestTypeDef
- DescribeProtectedResourceOutputTypeDef
- DescribeRecoveryPointInputRequestTypeDef
- DescribeRegionSettingsOutputTypeDef
- DescribeReportJobInputRequestTypeDef
- DescribeReportPlanInputRequestTypeDef
- DescribeRestoreJobInputRequestTypeDef
- DescribeRestoreJobOutputTypeDef
- DisassociateRecoveryPointFromParentInputRequestTypeDef
- DisassociateRecoveryPointInputRequestTypeDef
- EmptyResponseMetadataTypeDef
- ExportBackupPlanTemplateInputRequestTypeDef
- ExportBackupPlanTemplateOutputTypeDef
- FrameworkTypeDef
- GetBackupPlanFromJSONInputRequestTypeDef
- GetBackupPlanFromTemplateInputRequestTypeDef
- GetBackupPlanInputRequestTypeDef
- GetBackupSelectionInputRequestTypeDef
- GetBackupVaultAccessPolicyInputRequestTypeDef
- GetBackupVaultAccessPolicyOutputTypeDef
- GetBackupVaultNotificationsInputRequestTypeDef
- GetBackupVaultNotificationsOutputTypeDef
- GetLegalHoldInputRequestTypeDef
- GetRecoveryPointRestoreMetadataInputRequestTypeDef
- GetRecoveryPointRestoreMetadataOutputTypeDef
- GetSupportedResourceTypesOutputTypeDef
- LegalHoldTypeDef
- ListBackupJobsInputListBackupJobsPaginateTypeDef
- ListBackupJobsInputRequestTypeDef
- ListBackupPlanTemplatesInputListBackupPlanTemplatesPaginateTypeDef
- ListBackupPlanTemplatesInputRequestTypeDef
- ListBackupPlanVersionsInputListBackupPlanVersionsPaginateTypeDef
- ListBackupPlanVersionsInputRequestTypeDef
- ListBackupPlansInputListBackupPlansPaginateTypeDef
- ListBackupPlansInputRequestTypeDef
- ListBackupSelectionsInputListBackupSelectionsPaginateTypeDef
- ListBackupSelectionsInputRequestTypeDef
- ListBackupVaultsInputListBackupVaultsPaginateTypeDef
- ListBackupVaultsInputRequestTypeDef
- ListCopyJobsInputListCopyJobsPaginateTypeDef
- ListCopyJobsInputRequestTypeDef
- ListFrameworksInputRequestTypeDef
- ListLegalHoldsInputListLegalHoldsPaginateTypeDef
- ListLegalHoldsInputRequestTypeDef
- ListProtectedResourcesInputListProtectedResourcesPaginateTypeDef
- ListProtectedResourcesInputRequestTypeDef
- ProtectedResourceTypeDef
- ListRecoveryPointsByBackupVaultInputListRecoveryPointsByBackupVaultPaginateTypeDef
- ListRecoveryPointsByBackupVaultInputRequestTypeDef
- ListRecoveryPointsByLegalHoldInputListRecoveryPointsByLegalHoldPaginateTypeDef
- ListRecoveryPointsByLegalHoldInputRequestTypeDef
- RecoveryPointMemberTypeDef
- ListRecoveryPointsByResourceInputListRecoveryPointsByResourcePaginateTypeDef
- ListRecoveryPointsByResourceInputRequestTypeDef
- RecoveryPointByResourceTypeDef
- ListReportJobsInputRequestTypeDef
- ListReportPlansInputRequestTypeDef
- ListRestoreJobsInputListRestoreJobsPaginateTypeDef
- ListRestoreJobsInputRequestTypeDef
- RestoreJobsListMemberTypeDef
- ListTagsInputRequestTypeDef
- ListTagsOutputTypeDef
- PaginatorConfigTypeDef
- PutBackupVaultAccessPolicyInputRequestTypeDef
- PutBackupVaultLockConfigurationInputRequestTypeDef
- PutBackupVaultNotificationsInputRequestTypeDef
- ReportDestinationTypeDef
- ResponseMetadataTypeDef
- StartBackupJobOutputTypeDef
- StartCopyJobOutputTypeDef
- StartReportJobInputRequestTypeDef
- StartReportJobOutputTypeDef
- StartRestoreJobInputRequestTypeDef
- StartRestoreJobOutputTypeDef
- StopBackupJobInputRequestTypeDef
- TagResourceInputRequestTypeDef
- UntagResourceInputRequestTypeDef
- UpdateFrameworkOutputTypeDef
- UpdateGlobalSettingsInputRequestTypeDef
- UpdateRegionSettingsInputRequestTypeDef
- UpdateReportPlanOutputTypeDef
- BackupPlansListMemberTypeDef
- CreateBackupPlanOutputTypeDef
- UpdateBackupPlanOutputTypeDef
- BackupJobTypeDef
- CopyJobTypeDef
- DescribeBackupJobOutputTypeDef
- ListBackupPlanTemplatesOutputTypeDef
- CopyActionTypeDef
- StartBackupJobInputRequestTypeDef
- StartCopyJobInputRequestTypeDef
- UpdateRecoveryPointLifecycleInputRequestTypeDef
- ListBackupSelectionsOutputTypeDef
- ListBackupVaultsOutputTypeDef
- DescribeRecoveryPointOutputTypeDef
- RecoveryPointByBackupVaultTypeDef
- UpdateRecoveryPointLifecycleOutputTypeDef
- ConditionsTypeDef
- FrameworkControlTypeDef
- CreateReportPlanInputRequestTypeDef
- ReportPlanTypeDef
- UpdateReportPlanInputRequestTypeDef
- RecoveryPointSelectionTypeDef
- ListFrameworksOutputTypeDef
- ListLegalHoldsOutputTypeDef
- 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