Typed dictionaries
Auto-generated documentation for Backup type annotations stubs module mypy-boto3-backup.
AdvancedBackupSettingTypeDef
Usage Example
from mypy_boto3_backup.type_defs import AdvancedBackupSettingTypeDef
def get_value() -> AdvancedBackupSettingTypeDef:
return {
"ResourceType": ...,
}
Definition
class AdvancedBackupSettingTypeDef(TypedDict):
ResourceType: NotRequired[str],
BackupOptions: NotRequired[Mapping[str, str]],
RecoveryPointCreatorTypeDef
Usage Example
from mypy_boto3_backup.type_defs import RecoveryPointCreatorTypeDef
def get_value() -> RecoveryPointCreatorTypeDef:
return {
"BackupPlanId": ...,
}
Definition
class RecoveryPointCreatorTypeDef(TypedDict):
BackupPlanId: NotRequired[str],
BackupPlanArn: NotRequired[str],
BackupPlanVersion: NotRequired[str],
BackupRuleId: NotRequired[str],
BackupPlanTemplatesListMemberTypeDef
Usage Example
from mypy_boto3_backup.type_defs import BackupPlanTemplatesListMemberTypeDef
def get_value() -> BackupPlanTemplatesListMemberTypeDef:
return {
"BackupPlanTemplateId": ...,
}
Definition
class BackupPlanTemplatesListMemberTypeDef(TypedDict):
BackupPlanTemplateId: NotRequired[str],
BackupPlanTemplateName: NotRequired[str],
LifecycleTypeDef
Usage Example
from mypy_boto3_backup.type_defs import LifecycleTypeDef
def get_value() -> LifecycleTypeDef:
return {
"MoveToColdStorageAfterDays": ...,
}
Definition
class LifecycleTypeDef(TypedDict):
MoveToColdStorageAfterDays: NotRequired[int],
DeleteAfterDays: NotRequired[int],
ConditionTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ConditionTypeDef
def get_value() -> ConditionTypeDef:
return {
"ConditionType": ...,
"ConditionKey": ...,
"ConditionValue": ...,
}
Definition
class ConditionTypeDef(TypedDict):
ConditionType: ConditionTypeType, # (1)
ConditionKey: str,
ConditionValue: str,
BackupSelectionsListMemberTypeDef
Usage Example
from mypy_boto3_backup.type_defs import BackupSelectionsListMemberTypeDef
def get_value() -> BackupSelectionsListMemberTypeDef:
return {
"SelectionId": ...,
}
Definition
class BackupSelectionsListMemberTypeDef(TypedDict):
SelectionId: NotRequired[str],
SelectionName: NotRequired[str],
BackupPlanId: NotRequired[str],
CreationDate: NotRequired[datetime],
CreatorRequestId: NotRequired[str],
IamRoleArn: NotRequired[str],
BackupVaultListMemberTypeDef
Usage Example
from mypy_boto3_backup.type_defs import BackupVaultListMemberTypeDef
def get_value() -> BackupVaultListMemberTypeDef:
return {
"BackupVaultName": ...,
}
Definition
class BackupVaultListMemberTypeDef(TypedDict):
BackupVaultName: NotRequired[str],
BackupVaultArn: NotRequired[str],
CreationDate: NotRequired[datetime],
EncryptionKeyArn: NotRequired[str],
CreatorRequestId: NotRequired[str],
NumberOfRecoveryPoints: NotRequired[int],
Locked: NotRequired[bool],
MinRetentionDays: NotRequired[int],
MaxRetentionDays: NotRequired[int],
LockDate: NotRequired[datetime],
CalculatedLifecycleTypeDef
Usage Example
from mypy_boto3_backup.type_defs import CalculatedLifecycleTypeDef
def get_value() -> CalculatedLifecycleTypeDef:
return {
"MoveToColdStorageAt": ...,
}
Definition
class CalculatedLifecycleTypeDef(TypedDict):
MoveToColdStorageAt: NotRequired[datetime],
DeleteAt: NotRequired[datetime],
CancelLegalHoldInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import CancelLegalHoldInputRequestTypeDef
def get_value() -> CancelLegalHoldInputRequestTypeDef:
return {
"LegalHoldId": ...,
"CancelDescription": ...,
}
Definition
class CancelLegalHoldInputRequestTypeDef(TypedDict):
LegalHoldId: str,
CancelDescription: str,
RetainRecordInDays: NotRequired[int],
ConditionParameterTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ConditionParameterTypeDef
def get_value() -> ConditionParameterTypeDef:
return {
"ConditionKey": ...,
}
Definition
class ConditionParameterTypeDef(TypedDict):
ConditionKey: NotRequired[str],
ConditionValue: NotRequired[str],
ControlInputParameterTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ControlInputParameterTypeDef
def get_value() -> ControlInputParameterTypeDef:
return {
"ParameterName": ...,
}
Definition
class ControlInputParameterTypeDef(TypedDict):
ParameterName: NotRequired[str],
ParameterValue: NotRequired[str],
ControlScopeTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ControlScopeTypeDef
def get_value() -> ControlScopeTypeDef:
return {
"ComplianceResourceIds": ...,
}
Definition
class ControlScopeTypeDef(TypedDict):
ComplianceResourceIds: NotRequired[Sequence[str]],
ComplianceResourceTypes: NotRequired[Sequence[str]],
Tags: NotRequired[Mapping[str, str]],
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
Definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
CreateBackupVaultInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import CreateBackupVaultInputRequestTypeDef
def get_value() -> CreateBackupVaultInputRequestTypeDef:
return {
"BackupVaultName": ...,
}
Definition
class CreateBackupVaultInputRequestTypeDef(TypedDict):
BackupVaultName: str,
BackupVaultTags: NotRequired[Mapping[str, str]],
EncryptionKeyArn: NotRequired[str],
CreatorRequestId: NotRequired[str],
ReportDeliveryChannelTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ReportDeliveryChannelTypeDef
def get_value() -> ReportDeliveryChannelTypeDef:
return {
"S3BucketName": ...,
}
Definition
class ReportDeliveryChannelTypeDef(TypedDict):
S3BucketName: str,
S3KeyPrefix: NotRequired[str],
Formats: NotRequired[Sequence[str]],
ReportSettingTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ReportSettingTypeDef
def get_value() -> ReportSettingTypeDef:
return {
"ReportTemplate": ...,
}
Definition
class ReportSettingTypeDef(TypedDict):
ReportTemplate: str,
FrameworkArns: NotRequired[Sequence[str]],
NumberOfFrameworks: NotRequired[int],
Accounts: NotRequired[Sequence[str]],
OrganizationUnits: NotRequired[Sequence[str]],
Regions: NotRequired[Sequence[str]],
DateRangeTypeDef
Usage Example
from mypy_boto3_backup.type_defs import DateRangeTypeDef
def get_value() -> DateRangeTypeDef:
return {
"FromDate": ...,
"ToDate": ...,
}
Definition
class DateRangeTypeDef(TypedDict):
FromDate: Union[datetime, str],
ToDate: Union[datetime, str],
DeleteBackupPlanInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import DeleteBackupPlanInputRequestTypeDef
def get_value() -> DeleteBackupPlanInputRequestTypeDef:
return {
"BackupPlanId": ...,
}
DeleteBackupSelectionInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import DeleteBackupSelectionInputRequestTypeDef
def get_value() -> DeleteBackupSelectionInputRequestTypeDef:
return {
"BackupPlanId": ...,
"SelectionId": ...,
}
Definition
class DeleteBackupSelectionInputRequestTypeDef(TypedDict):
BackupPlanId: str,
SelectionId: str,
DeleteBackupVaultAccessPolicyInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import DeleteBackupVaultAccessPolicyInputRequestTypeDef
def get_value() -> DeleteBackupVaultAccessPolicyInputRequestTypeDef:
return {
"BackupVaultName": ...,
}
DeleteBackupVaultInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import DeleteBackupVaultInputRequestTypeDef
def get_value() -> DeleteBackupVaultInputRequestTypeDef:
return {
"BackupVaultName": ...,
}
DeleteBackupVaultLockConfigurationInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import DeleteBackupVaultLockConfigurationInputRequestTypeDef
def get_value() -> DeleteBackupVaultLockConfigurationInputRequestTypeDef:
return {
"BackupVaultName": ...,
}
Definition
class DeleteBackupVaultLockConfigurationInputRequestTypeDef(TypedDict):
BackupVaultName: str,
DeleteBackupVaultNotificationsInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import DeleteBackupVaultNotificationsInputRequestTypeDef
def get_value() -> DeleteBackupVaultNotificationsInputRequestTypeDef:
return {
"BackupVaultName": ...,
}
DeleteFrameworkInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import DeleteFrameworkInputRequestTypeDef
def get_value() -> DeleteFrameworkInputRequestTypeDef:
return {
"FrameworkName": ...,
}
DeleteRecoveryPointInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import DeleteRecoveryPointInputRequestTypeDef
def get_value() -> DeleteRecoveryPointInputRequestTypeDef:
return {
"BackupVaultName": ...,
"RecoveryPointArn": ...,
}
Definition
class DeleteRecoveryPointInputRequestTypeDef(TypedDict):
BackupVaultName: str,
RecoveryPointArn: str,
DeleteReportPlanInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import DeleteReportPlanInputRequestTypeDef
def get_value() -> DeleteReportPlanInputRequestTypeDef:
return {
"ReportPlanName": ...,
}
DescribeBackupJobInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import DescribeBackupJobInputRequestTypeDef
def get_value() -> DescribeBackupJobInputRequestTypeDef:
return {
"BackupJobId": ...,
}
DescribeBackupVaultInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import DescribeBackupVaultInputRequestTypeDef
def get_value() -> DescribeBackupVaultInputRequestTypeDef:
return {
"BackupVaultName": ...,
}
DescribeCopyJobInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import DescribeCopyJobInputRequestTypeDef
def get_value() -> DescribeCopyJobInputRequestTypeDef:
return {
"CopyJobId": ...,
}
DescribeFrameworkInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import DescribeFrameworkInputRequestTypeDef
def get_value() -> DescribeFrameworkInputRequestTypeDef:
return {
"FrameworkName": ...,
}
DescribeProtectedResourceInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import DescribeProtectedResourceInputRequestTypeDef
def get_value() -> DescribeProtectedResourceInputRequestTypeDef:
return {
"ResourceArn": ...,
}
DescribeRecoveryPointInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import DescribeRecoveryPointInputRequestTypeDef
def get_value() -> DescribeRecoveryPointInputRequestTypeDef:
return {
"BackupVaultName": ...,
"RecoveryPointArn": ...,
}
Definition
class DescribeRecoveryPointInputRequestTypeDef(TypedDict):
BackupVaultName: str,
RecoveryPointArn: str,
DescribeReportJobInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import DescribeReportJobInputRequestTypeDef
def get_value() -> DescribeReportJobInputRequestTypeDef:
return {
"ReportJobId": ...,
}
DescribeReportPlanInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import DescribeReportPlanInputRequestTypeDef
def get_value() -> DescribeReportPlanInputRequestTypeDef:
return {
"ReportPlanName": ...,
}
DescribeRestoreJobInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import DescribeRestoreJobInputRequestTypeDef
def get_value() -> DescribeRestoreJobInputRequestTypeDef:
return {
"RestoreJobId": ...,
}
DisassociateRecoveryPointFromParentInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import DisassociateRecoveryPointFromParentInputRequestTypeDef
def get_value() -> DisassociateRecoveryPointFromParentInputRequestTypeDef:
return {
"BackupVaultName": ...,
"RecoveryPointArn": ...,
}
Definition
class DisassociateRecoveryPointFromParentInputRequestTypeDef(TypedDict):
BackupVaultName: str,
RecoveryPointArn: str,
DisassociateRecoveryPointInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import DisassociateRecoveryPointInputRequestTypeDef
def get_value() -> DisassociateRecoveryPointInputRequestTypeDef:
return {
"BackupVaultName": ...,
"RecoveryPointArn": ...,
}
Definition
class DisassociateRecoveryPointInputRequestTypeDef(TypedDict):
BackupVaultName: str,
RecoveryPointArn: str,
ExportBackupPlanTemplateInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ExportBackupPlanTemplateInputRequestTypeDef
def get_value() -> ExportBackupPlanTemplateInputRequestTypeDef:
return {
"BackupPlanId": ...,
}
FrameworkTypeDef
Usage Example
from mypy_boto3_backup.type_defs import FrameworkTypeDef
def get_value() -> FrameworkTypeDef:
return {
"FrameworkName": ...,
}
Definition
class FrameworkTypeDef(TypedDict):
FrameworkName: NotRequired[str],
FrameworkArn: NotRequired[str],
FrameworkDescription: NotRequired[str],
NumberOfControls: NotRequired[int],
CreationTime: NotRequired[datetime],
DeploymentStatus: NotRequired[str],
GetBackupPlanFromJSONInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import GetBackupPlanFromJSONInputRequestTypeDef
def get_value() -> GetBackupPlanFromJSONInputRequestTypeDef:
return {
"BackupPlanTemplateJson": ...,
}
GetBackupPlanFromTemplateInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import GetBackupPlanFromTemplateInputRequestTypeDef
def get_value() -> GetBackupPlanFromTemplateInputRequestTypeDef:
return {
"BackupPlanTemplateId": ...,
}
GetBackupPlanInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import GetBackupPlanInputRequestTypeDef
def get_value() -> GetBackupPlanInputRequestTypeDef:
return {
"BackupPlanId": ...,
}
Definition
class GetBackupPlanInputRequestTypeDef(TypedDict):
BackupPlanId: str,
VersionId: NotRequired[str],
GetBackupSelectionInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import GetBackupSelectionInputRequestTypeDef
def get_value() -> GetBackupSelectionInputRequestTypeDef:
return {
"BackupPlanId": ...,
"SelectionId": ...,
}
Definition
class GetBackupSelectionInputRequestTypeDef(TypedDict):
BackupPlanId: str,
SelectionId: str,
GetBackupVaultAccessPolicyInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import GetBackupVaultAccessPolicyInputRequestTypeDef
def get_value() -> GetBackupVaultAccessPolicyInputRequestTypeDef:
return {
"BackupVaultName": ...,
}
GetBackupVaultNotificationsInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import GetBackupVaultNotificationsInputRequestTypeDef
def get_value() -> GetBackupVaultNotificationsInputRequestTypeDef:
return {
"BackupVaultName": ...,
}
GetLegalHoldInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import GetLegalHoldInputRequestTypeDef
def get_value() -> GetLegalHoldInputRequestTypeDef:
return {
"LegalHoldId": ...,
}
GetRecoveryPointRestoreMetadataInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import GetRecoveryPointRestoreMetadataInputRequestTypeDef
def get_value() -> GetRecoveryPointRestoreMetadataInputRequestTypeDef:
return {
"BackupVaultName": ...,
"RecoveryPointArn": ...,
}
Definition
class GetRecoveryPointRestoreMetadataInputRequestTypeDef(TypedDict):
BackupVaultName: str,
RecoveryPointArn: str,
LegalHoldTypeDef
Usage Example
from mypy_boto3_backup.type_defs import LegalHoldTypeDef
def get_value() -> LegalHoldTypeDef:
return {
"Title": ...,
}
Definition
class LegalHoldTypeDef(TypedDict):
Title: NotRequired[str],
Status: NotRequired[LegalHoldStatusType], # (1)
Description: NotRequired[str],
LegalHoldId: NotRequired[str],
LegalHoldArn: NotRequired[str],
CreationDate: NotRequired[datetime],
CancellationDate: NotRequired[datetime],
PaginatorConfigTypeDef
Usage Example
from mypy_boto3_backup.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
Definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListBackupJobsInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListBackupJobsInputRequestTypeDef
def get_value() -> ListBackupJobsInputRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListBackupJobsInputRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ByResourceArn: NotRequired[str],
ByState: NotRequired[BackupJobStateType], # (1)
ByBackupVaultName: NotRequired[str],
ByCreatedBefore: NotRequired[Union[datetime, str]],
ByCreatedAfter: NotRequired[Union[datetime, str]],
ByResourceType: NotRequired[str],
ByAccountId: NotRequired[str],
ByCompleteAfter: NotRequired[Union[datetime, str]],
ByCompleteBefore: NotRequired[Union[datetime, str]],
ByParentJobId: NotRequired[str],
ListBackupPlanTemplatesInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListBackupPlanTemplatesInputRequestTypeDef
def get_value() -> ListBackupPlanTemplatesInputRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListBackupPlanTemplatesInputRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListBackupPlanVersionsInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListBackupPlanVersionsInputRequestTypeDef
def get_value() -> ListBackupPlanVersionsInputRequestTypeDef:
return {
"BackupPlanId": ...,
}
Definition
class ListBackupPlanVersionsInputRequestTypeDef(TypedDict):
BackupPlanId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListBackupPlansInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListBackupPlansInputRequestTypeDef
def get_value() -> ListBackupPlansInputRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListBackupPlansInputRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
IncludeDeleted: NotRequired[bool],
ListBackupSelectionsInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListBackupSelectionsInputRequestTypeDef
def get_value() -> ListBackupSelectionsInputRequestTypeDef:
return {
"BackupPlanId": ...,
}
Definition
class ListBackupSelectionsInputRequestTypeDef(TypedDict):
BackupPlanId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListBackupVaultsInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListBackupVaultsInputRequestTypeDef
def get_value() -> ListBackupVaultsInputRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListBackupVaultsInputRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListCopyJobsInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListCopyJobsInputRequestTypeDef
def get_value() -> ListCopyJobsInputRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListCopyJobsInputRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ByResourceArn: NotRequired[str],
ByState: NotRequired[CopyJobStateType], # (1)
ByCreatedBefore: NotRequired[Union[datetime, str]],
ByCreatedAfter: NotRequired[Union[datetime, str]],
ByResourceType: NotRequired[str],
ByDestinationVaultArn: NotRequired[str],
ByAccountId: NotRequired[str],
ByCompleteBefore: NotRequired[Union[datetime, str]],
ByCompleteAfter: NotRequired[Union[datetime, str]],
ByParentJobId: NotRequired[str],
- See CopyJobStateType
ListFrameworksInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListFrameworksInputRequestTypeDef
def get_value() -> ListFrameworksInputRequestTypeDef:
return {
"MaxResults": ...,
}
Definition
class ListFrameworksInputRequestTypeDef(TypedDict):
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListLegalHoldsInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListLegalHoldsInputRequestTypeDef
def get_value() -> ListLegalHoldsInputRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListLegalHoldsInputRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListProtectedResourcesInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListProtectedResourcesInputRequestTypeDef
def get_value() -> ListProtectedResourcesInputRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListProtectedResourcesInputRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ProtectedResourceTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ProtectedResourceTypeDef
def get_value() -> ProtectedResourceTypeDef:
return {
"ResourceArn": ...,
}
Definition
class ProtectedResourceTypeDef(TypedDict):
ResourceArn: NotRequired[str],
ResourceType: NotRequired[str],
LastBackupTime: NotRequired[datetime],
ResourceName: NotRequired[str],
ListRecoveryPointsByBackupVaultInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListRecoveryPointsByBackupVaultInputRequestTypeDef
def get_value() -> ListRecoveryPointsByBackupVaultInputRequestTypeDef:
return {
"BackupVaultName": ...,
}
Definition
class ListRecoveryPointsByBackupVaultInputRequestTypeDef(TypedDict):
BackupVaultName: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ByResourceArn: NotRequired[str],
ByResourceType: NotRequired[str],
ByBackupPlanId: NotRequired[str],
ByCreatedBefore: NotRequired[Union[datetime, str]],
ByCreatedAfter: NotRequired[Union[datetime, str]],
ByParentRecoveryPointArn: NotRequired[str],
ListRecoveryPointsByLegalHoldInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListRecoveryPointsByLegalHoldInputRequestTypeDef
def get_value() -> ListRecoveryPointsByLegalHoldInputRequestTypeDef:
return {
"LegalHoldId": ...,
}
Definition
class ListRecoveryPointsByLegalHoldInputRequestTypeDef(TypedDict):
LegalHoldId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
RecoveryPointMemberTypeDef
Usage Example
from mypy_boto3_backup.type_defs import RecoveryPointMemberTypeDef
def get_value() -> RecoveryPointMemberTypeDef:
return {
"RecoveryPointArn": ...,
}
ListRecoveryPointsByResourceInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListRecoveryPointsByResourceInputRequestTypeDef
def get_value() -> ListRecoveryPointsByResourceInputRequestTypeDef:
return {
"ResourceArn": ...,
}
Definition
class ListRecoveryPointsByResourceInputRequestTypeDef(TypedDict):
ResourceArn: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
RecoveryPointByResourceTypeDef
Usage Example
from mypy_boto3_backup.type_defs import RecoveryPointByResourceTypeDef
def get_value() -> RecoveryPointByResourceTypeDef:
return {
"RecoveryPointArn": ...,
}
Definition
class RecoveryPointByResourceTypeDef(TypedDict):
RecoveryPointArn: NotRequired[str],
CreationDate: NotRequired[datetime],
Status: NotRequired[RecoveryPointStatusType], # (1)
StatusMessage: NotRequired[str],
EncryptionKeyArn: NotRequired[str],
BackupSizeBytes: NotRequired[int],
BackupVaultName: NotRequired[str],
IsParent: NotRequired[bool],
ParentRecoveryPointArn: NotRequired[str],
ResourceName: NotRequired[str],
ListReportJobsInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListReportJobsInputRequestTypeDef
def get_value() -> ListReportJobsInputRequestTypeDef:
return {
"ByReportPlanName": ...,
}
Definition
class ListReportJobsInputRequestTypeDef(TypedDict):
ByReportPlanName: NotRequired[str],
ByCreationBefore: NotRequired[Union[datetime, str]],
ByCreationAfter: NotRequired[Union[datetime, str]],
ByStatus: NotRequired[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListReportPlansInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListReportPlansInputRequestTypeDef
def get_value() -> ListReportPlansInputRequestTypeDef:
return {
"MaxResults": ...,
}
Definition
class ListReportPlansInputRequestTypeDef(TypedDict):
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListRestoreJobsInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListRestoreJobsInputRequestTypeDef
def get_value() -> ListRestoreJobsInputRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListRestoreJobsInputRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ByAccountId: NotRequired[str],
ByCreatedBefore: NotRequired[Union[datetime, str]],
ByCreatedAfter: NotRequired[Union[datetime, str]],
ByStatus: NotRequired[RestoreJobStatusType], # (1)
ByCompleteBefore: NotRequired[Union[datetime, str]],
ByCompleteAfter: NotRequired[Union[datetime, str]],
RestoreJobsListMemberTypeDef
Usage Example
from mypy_boto3_backup.type_defs import RestoreJobsListMemberTypeDef
def get_value() -> RestoreJobsListMemberTypeDef:
return {
"AccountId": ...,
}
Definition
class RestoreJobsListMemberTypeDef(TypedDict):
AccountId: NotRequired[str],
RestoreJobId: NotRequired[str],
RecoveryPointArn: NotRequired[str],
CreationDate: NotRequired[datetime],
CompletionDate: NotRequired[datetime],
Status: NotRequired[RestoreJobStatusType], # (1)
StatusMessage: NotRequired[str],
PercentDone: NotRequired[str],
BackupSizeInBytes: NotRequired[int],
IamRoleArn: NotRequired[str],
ExpectedCompletionTimeMinutes: NotRequired[int],
CreatedResourceArn: NotRequired[str],
ResourceType: NotRequired[str],
ListTagsInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListTagsInputRequestTypeDef
def get_value() -> ListTagsInputRequestTypeDef:
return {
"ResourceArn": ...,
}
Definition
class ListTagsInputRequestTypeDef(TypedDict):
ResourceArn: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
PutBackupVaultAccessPolicyInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import PutBackupVaultAccessPolicyInputRequestTypeDef
def get_value() -> PutBackupVaultAccessPolicyInputRequestTypeDef:
return {
"BackupVaultName": ...,
}
Definition
class PutBackupVaultAccessPolicyInputRequestTypeDef(TypedDict):
BackupVaultName: str,
Policy: NotRequired[str],
PutBackupVaultLockConfigurationInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import PutBackupVaultLockConfigurationInputRequestTypeDef
def get_value() -> PutBackupVaultLockConfigurationInputRequestTypeDef:
return {
"BackupVaultName": ...,
}
Definition
class PutBackupVaultLockConfigurationInputRequestTypeDef(TypedDict):
BackupVaultName: str,
MinRetentionDays: NotRequired[int],
MaxRetentionDays: NotRequired[int],
ChangeableForDays: NotRequired[int],
PutBackupVaultNotificationsInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import PutBackupVaultNotificationsInputRequestTypeDef
def get_value() -> PutBackupVaultNotificationsInputRequestTypeDef:
return {
"BackupVaultName": ...,
"SNSTopicArn": ...,
"BackupVaultEvents": ...,
}
Definition
class PutBackupVaultNotificationsInputRequestTypeDef(TypedDict):
BackupVaultName: str,
SNSTopicArn: str,
BackupVaultEvents: Sequence[BackupVaultEventType], # (1)
ReportDestinationTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ReportDestinationTypeDef
def get_value() -> ReportDestinationTypeDef:
return {
"S3BucketName": ...,
}
Definition
class ReportDestinationTypeDef(TypedDict):
S3BucketName: NotRequired[str],
S3Keys: NotRequired[List[str]],
StartReportJobInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import StartReportJobInputRequestTypeDef
def get_value() -> StartReportJobInputRequestTypeDef:
return {
"ReportPlanName": ...,
}
Definition
class StartReportJobInputRequestTypeDef(TypedDict):
ReportPlanName: str,
IdempotencyToken: NotRequired[str],
StartRestoreJobInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import StartRestoreJobInputRequestTypeDef
def get_value() -> StartRestoreJobInputRequestTypeDef:
return {
"RecoveryPointArn": ...,
"Metadata": ...,
}
Definition
class StartRestoreJobInputRequestTypeDef(TypedDict):
RecoveryPointArn: str,
Metadata: Mapping[str, str],
IamRoleArn: NotRequired[str],
IdempotencyToken: NotRequired[str],
ResourceType: NotRequired[str],
StopBackupJobInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import StopBackupJobInputRequestTypeDef
def get_value() -> StopBackupJobInputRequestTypeDef:
return {
"BackupJobId": ...,
}
TagResourceInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import TagResourceInputRequestTypeDef
def get_value() -> TagResourceInputRequestTypeDef:
return {
"ResourceArn": ...,
"Tags": ...,
}
Definition
class TagResourceInputRequestTypeDef(TypedDict):
ResourceArn: str,
Tags: Mapping[str, str],
UntagResourceInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import UntagResourceInputRequestTypeDef
def get_value() -> UntagResourceInputRequestTypeDef:
return {
"ResourceArn": ...,
"TagKeyList": ...,
}
Definition
class UntagResourceInputRequestTypeDef(TypedDict):
ResourceArn: str,
TagKeyList: Sequence[str],
UpdateGlobalSettingsInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import UpdateGlobalSettingsInputRequestTypeDef
def get_value() -> UpdateGlobalSettingsInputRequestTypeDef:
return {
"GlobalSettings": ...,
}
Definition
class UpdateGlobalSettingsInputRequestTypeDef(TypedDict):
GlobalSettings: NotRequired[Mapping[str, str]],
UpdateRegionSettingsInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import UpdateRegionSettingsInputRequestTypeDef
def get_value() -> UpdateRegionSettingsInputRequestTypeDef:
return {
"ResourceTypeOptInPreference": ...,
}
Definition
class UpdateRegionSettingsInputRequestTypeDef(TypedDict):
ResourceTypeOptInPreference: NotRequired[Mapping[str, bool]],
ResourceTypeManagementPreference: NotRequired[Mapping[str, bool]],
BackupPlansListMemberTypeDef
Usage Example
from mypy_boto3_backup.type_defs import BackupPlansListMemberTypeDef
def get_value() -> BackupPlansListMemberTypeDef:
return {
"BackupPlanArn": ...,
}
Definition
class BackupPlansListMemberTypeDef(TypedDict):
BackupPlanArn: NotRequired[str],
BackupPlanId: NotRequired[str],
CreationDate: NotRequired[datetime],
DeletionDate: NotRequired[datetime],
VersionId: NotRequired[str],
BackupPlanName: NotRequired[str],
CreatorRequestId: NotRequired[str],
LastExecutionDate: NotRequired[datetime],
AdvancedBackupSettings: NotRequired[List[AdvancedBackupSettingTypeDef]], # (1)
BackupJobTypeDef
Usage Example
from mypy_boto3_backup.type_defs import BackupJobTypeDef
def get_value() -> BackupJobTypeDef:
return {
"AccountId": ...,
}
Definition
class BackupJobTypeDef(TypedDict):
AccountId: NotRequired[str],
BackupJobId: NotRequired[str],
BackupVaultName: NotRequired[str],
BackupVaultArn: NotRequired[str],
RecoveryPointArn: NotRequired[str],
ResourceArn: NotRequired[str],
CreationDate: NotRequired[datetime],
CompletionDate: NotRequired[datetime],
State: NotRequired[BackupJobStateType], # (1)
StatusMessage: NotRequired[str],
PercentDone: NotRequired[str],
BackupSizeInBytes: NotRequired[int],
IamRoleArn: NotRequired[str],
CreatedBy: NotRequired[RecoveryPointCreatorTypeDef], # (2)
ExpectedCompletionDate: NotRequired[datetime],
StartBy: NotRequired[datetime],
ResourceType: NotRequired[str],
BytesTransferred: NotRequired[int],
BackupOptions: NotRequired[Dict[str, str]],
BackupType: NotRequired[str],
ParentJobId: NotRequired[str],
IsParent: NotRequired[bool],
ResourceName: NotRequired[str],
CopyJobTypeDef
Usage Example
from mypy_boto3_backup.type_defs import CopyJobTypeDef
def get_value() -> CopyJobTypeDef:
return {
"AccountId": ...,
}
Definition
class CopyJobTypeDef(TypedDict):
AccountId: NotRequired[str],
CopyJobId: NotRequired[str],
SourceBackupVaultArn: NotRequired[str],
SourceRecoveryPointArn: NotRequired[str],
DestinationBackupVaultArn: NotRequired[str],
DestinationRecoveryPointArn: NotRequired[str],
ResourceArn: NotRequired[str],
CreationDate: NotRequired[datetime],
CompletionDate: NotRequired[datetime],
State: NotRequired[CopyJobStateType], # (1)
StatusMessage: NotRequired[str],
BackupSizeInBytes: NotRequired[int],
IamRoleArn: NotRequired[str],
CreatedBy: NotRequired[RecoveryPointCreatorTypeDef], # (2)
ResourceType: NotRequired[str],
ParentJobId: NotRequired[str],
IsParent: NotRequired[bool],
CompositeMemberIdentifier: NotRequired[str],
NumberOfChildJobs: NotRequired[int],
ChildJobsInState: NotRequired[Dict[CopyJobStateType, int]], # (3)
ResourceName: NotRequired[str],
CopyActionTypeDef
Usage Example
from mypy_boto3_backup.type_defs import CopyActionTypeDef
def get_value() -> CopyActionTypeDef:
return {
"DestinationBackupVaultArn": ...,
}
Definition
class CopyActionTypeDef(TypedDict):
DestinationBackupVaultArn: str,
Lifecycle: NotRequired[LifecycleTypeDef], # (1)
- See LifecycleTypeDef
StartBackupJobInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import StartBackupJobInputRequestTypeDef
def get_value() -> StartBackupJobInputRequestTypeDef:
return {
"BackupVaultName": ...,
"ResourceArn": ...,
"IamRoleArn": ...,
}
Definition
class StartBackupJobInputRequestTypeDef(TypedDict):
BackupVaultName: str,
ResourceArn: str,
IamRoleArn: str,
IdempotencyToken: NotRequired[str],
StartWindowMinutes: NotRequired[int],
CompleteWindowMinutes: NotRequired[int],
Lifecycle: NotRequired[LifecycleTypeDef], # (1)
RecoveryPointTags: NotRequired[Mapping[str, str]],
BackupOptions: NotRequired[Mapping[str, str]],
- See LifecycleTypeDef
StartCopyJobInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import StartCopyJobInputRequestTypeDef
def get_value() -> StartCopyJobInputRequestTypeDef:
return {
"RecoveryPointArn": ...,
"SourceBackupVaultName": ...,
"DestinationBackupVaultArn": ...,
"IamRoleArn": ...,
}
Definition
class StartCopyJobInputRequestTypeDef(TypedDict):
RecoveryPointArn: str,
SourceBackupVaultName: str,
DestinationBackupVaultArn: str,
IamRoleArn: str,
IdempotencyToken: NotRequired[str],
Lifecycle: NotRequired[LifecycleTypeDef], # (1)
- See LifecycleTypeDef
UpdateRecoveryPointLifecycleInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import UpdateRecoveryPointLifecycleInputRequestTypeDef
def get_value() -> UpdateRecoveryPointLifecycleInputRequestTypeDef:
return {
"BackupVaultName": ...,
"RecoveryPointArn": ...,
}
Definition
class UpdateRecoveryPointLifecycleInputRequestTypeDef(TypedDict):
BackupVaultName: str,
RecoveryPointArn: str,
Lifecycle: NotRequired[LifecycleTypeDef], # (1)
- See LifecycleTypeDef
RecoveryPointByBackupVaultTypeDef
Usage Example
from mypy_boto3_backup.type_defs import RecoveryPointByBackupVaultTypeDef
def get_value() -> RecoveryPointByBackupVaultTypeDef:
return {
"RecoveryPointArn": ...,
}
Definition
class RecoveryPointByBackupVaultTypeDef(TypedDict):
RecoveryPointArn: NotRequired[str],
BackupVaultName: NotRequired[str],
BackupVaultArn: NotRequired[str],
SourceBackupVaultArn: NotRequired[str],
ResourceArn: NotRequired[str],
ResourceType: NotRequired[str],
CreatedBy: NotRequired[RecoveryPointCreatorTypeDef], # (1)
IamRoleArn: NotRequired[str],
Status: NotRequired[RecoveryPointStatusType], # (2)
StatusMessage: NotRequired[str],
CreationDate: NotRequired[datetime],
CompletionDate: NotRequired[datetime],
BackupSizeInBytes: NotRequired[int],
CalculatedLifecycle: NotRequired[CalculatedLifecycleTypeDef], # (3)
Lifecycle: NotRequired[LifecycleTypeDef], # (4)
EncryptionKeyArn: NotRequired[str],
IsEncrypted: NotRequired[bool],
LastRestoreTime: NotRequired[datetime],
ParentRecoveryPointArn: NotRequired[str],
CompositeMemberIdentifier: NotRequired[str],
IsParent: NotRequired[bool],
ResourceName: NotRequired[str],
- See RecoveryPointCreatorTypeDef
- See RecoveryPointStatusType
- See CalculatedLifecycleTypeDef
- See LifecycleTypeDef
ConditionsTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ConditionsTypeDef
def get_value() -> ConditionsTypeDef:
return {
"StringEquals": ...,
}
Definition
class ConditionsTypeDef(TypedDict):
StringEquals: NotRequired[Sequence[ConditionParameterTypeDef]], # (1)
StringNotEquals: NotRequired[Sequence[ConditionParameterTypeDef]], # (1)
StringLike: NotRequired[Sequence[ConditionParameterTypeDef]], # (1)
StringNotLike: NotRequired[Sequence[ConditionParameterTypeDef]], # (1)
- See ConditionParameterTypeDef
- See ConditionParameterTypeDef
- See ConditionParameterTypeDef
- See ConditionParameterTypeDef
FrameworkControlTypeDef
Usage Example
from mypy_boto3_backup.type_defs import FrameworkControlTypeDef
def get_value() -> FrameworkControlTypeDef:
return {
"ControlName": ...,
}
Definition
class FrameworkControlTypeDef(TypedDict):
ControlName: str,
ControlInputParameters: NotRequired[Sequence[ControlInputParameterTypeDef]], # (1)
ControlScope: NotRequired[ControlScopeTypeDef], # (2)
CreateBackupPlanOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import CreateBackupPlanOutputTypeDef
def get_value() -> CreateBackupPlanOutputTypeDef:
return {
"BackupPlanId": ...,
"BackupPlanArn": ...,
"CreationDate": ...,
"VersionId": ...,
"AdvancedBackupSettings": ...,
"ResponseMetadata": ...,
}
Definition
class CreateBackupPlanOutputTypeDef(TypedDict):
BackupPlanId: str,
BackupPlanArn: str,
CreationDate: datetime,
VersionId: str,
AdvancedBackupSettings: List[AdvancedBackupSettingTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateBackupSelectionOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import CreateBackupSelectionOutputTypeDef
def get_value() -> CreateBackupSelectionOutputTypeDef:
return {
"SelectionId": ...,
"BackupPlanId": ...,
"CreationDate": ...,
"ResponseMetadata": ...,
}
Definition
class CreateBackupSelectionOutputTypeDef(TypedDict):
SelectionId: str,
BackupPlanId: str,
CreationDate: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateBackupVaultOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import CreateBackupVaultOutputTypeDef
def get_value() -> CreateBackupVaultOutputTypeDef:
return {
"BackupVaultName": ...,
"BackupVaultArn": ...,
"CreationDate": ...,
"ResponseMetadata": ...,
}
Definition
class CreateBackupVaultOutputTypeDef(TypedDict):
BackupVaultName: str,
BackupVaultArn: str,
CreationDate: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateFrameworkOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import CreateFrameworkOutputTypeDef
def get_value() -> CreateFrameworkOutputTypeDef:
return {
"FrameworkName": ...,
"FrameworkArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateFrameworkOutputTypeDef(TypedDict):
FrameworkName: str,
FrameworkArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateReportPlanOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import CreateReportPlanOutputTypeDef
def get_value() -> CreateReportPlanOutputTypeDef:
return {
"ReportPlanName": ...,
"ReportPlanArn": ...,
"CreationTime": ...,
"ResponseMetadata": ...,
}
Definition
class CreateReportPlanOutputTypeDef(TypedDict):
ReportPlanName: str,
ReportPlanArn: str,
CreationTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteBackupPlanOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import DeleteBackupPlanOutputTypeDef
def get_value() -> DeleteBackupPlanOutputTypeDef:
return {
"BackupPlanId": ...,
"BackupPlanArn": ...,
"DeletionDate": ...,
"VersionId": ...,
"ResponseMetadata": ...,
}
Definition
class DeleteBackupPlanOutputTypeDef(TypedDict):
BackupPlanId: str,
BackupPlanArn: str,
DeletionDate: datetime,
VersionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeBackupJobOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import DescribeBackupJobOutputTypeDef
def get_value() -> DescribeBackupJobOutputTypeDef:
return {
"AccountId": ...,
"BackupJobId": ...,
"BackupVaultName": ...,
"BackupVaultArn": ...,
"RecoveryPointArn": ...,
"ResourceArn": ...,
"CreationDate": ...,
"CompletionDate": ...,
"State": ...,
"StatusMessage": ...,
"PercentDone": ...,
"BackupSizeInBytes": ...,
"IamRoleArn": ...,
"CreatedBy": ...,
"ResourceType": ...,
"BytesTransferred": ...,
"ExpectedCompletionDate": ...,
"StartBy": ...,
"BackupOptions": ...,
"BackupType": ...,
"ParentJobId": ...,
"IsParent": ...,
"NumberOfChildJobs": ...,
"ChildJobsInState": ...,
"ResourceName": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeBackupJobOutputTypeDef(TypedDict):
AccountId: str,
BackupJobId: str,
BackupVaultName: str,
BackupVaultArn: str,
RecoveryPointArn: str,
ResourceArn: str,
CreationDate: datetime,
CompletionDate: datetime,
State: BackupJobStateType, # (1)
StatusMessage: str,
PercentDone: str,
BackupSizeInBytes: int,
IamRoleArn: str,
CreatedBy: RecoveryPointCreatorTypeDef, # (2)
ResourceType: str,
BytesTransferred: int,
ExpectedCompletionDate: datetime,
StartBy: datetime,
BackupOptions: Dict[str, str],
BackupType: str,
ParentJobId: str,
IsParent: bool,
NumberOfChildJobs: int,
ChildJobsInState: Dict[BackupJobStateType, int], # (3)
ResourceName: str,
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See BackupJobStateType
- See RecoveryPointCreatorTypeDef
- See BackupJobStateType
- See ResponseMetadataTypeDef
DescribeBackupVaultOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import DescribeBackupVaultOutputTypeDef
def get_value() -> DescribeBackupVaultOutputTypeDef:
return {
"BackupVaultName": ...,
"BackupVaultArn": ...,
"EncryptionKeyArn": ...,
"CreationDate": ...,
"CreatorRequestId": ...,
"NumberOfRecoveryPoints": ...,
"Locked": ...,
"MinRetentionDays": ...,
"MaxRetentionDays": ...,
"LockDate": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeBackupVaultOutputTypeDef(TypedDict):
BackupVaultName: str,
BackupVaultArn: str,
EncryptionKeyArn: str,
CreationDate: datetime,
CreatorRequestId: str,
NumberOfRecoveryPoints: int,
Locked: bool,
MinRetentionDays: int,
MaxRetentionDays: int,
LockDate: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeGlobalSettingsOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import DescribeGlobalSettingsOutputTypeDef
def get_value() -> DescribeGlobalSettingsOutputTypeDef:
return {
"GlobalSettings": ...,
"LastUpdateTime": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeGlobalSettingsOutputTypeDef(TypedDict):
GlobalSettings: Dict[str, str],
LastUpdateTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeProtectedResourceOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import DescribeProtectedResourceOutputTypeDef
def get_value() -> DescribeProtectedResourceOutputTypeDef:
return {
"ResourceArn": ...,
"ResourceType": ...,
"LastBackupTime": ...,
"ResourceName": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeProtectedResourceOutputTypeDef(TypedDict):
ResourceArn: str,
ResourceType: str,
LastBackupTime: datetime,
ResourceName: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeRecoveryPointOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import DescribeRecoveryPointOutputTypeDef
def get_value() -> DescribeRecoveryPointOutputTypeDef:
return {
"RecoveryPointArn": ...,
"BackupVaultName": ...,
"BackupVaultArn": ...,
"SourceBackupVaultArn": ...,
"ResourceArn": ...,
"ResourceType": ...,
"CreatedBy": ...,
"IamRoleArn": ...,
"Status": ...,
"StatusMessage": ...,
"CreationDate": ...,
"CompletionDate": ...,
"BackupSizeInBytes": ...,
"CalculatedLifecycle": ...,
"Lifecycle": ...,
"EncryptionKeyArn": ...,
"IsEncrypted": ...,
"StorageClass": ...,
"LastRestoreTime": ...,
"ParentRecoveryPointArn": ...,
"CompositeMemberIdentifier": ...,
"IsParent": ...,
"ResourceName": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeRecoveryPointOutputTypeDef(TypedDict):
RecoveryPointArn: str,
BackupVaultName: str,
BackupVaultArn: str,
SourceBackupVaultArn: str,
ResourceArn: str,
ResourceType: str,
CreatedBy: RecoveryPointCreatorTypeDef, # (1)
IamRoleArn: str,
Status: RecoveryPointStatusType, # (2)
StatusMessage: str,
CreationDate: datetime,
CompletionDate: datetime,
BackupSizeInBytes: int,
CalculatedLifecycle: CalculatedLifecycleTypeDef, # (3)
Lifecycle: LifecycleTypeDef, # (4)
EncryptionKeyArn: str,
IsEncrypted: bool,
StorageClass: StorageClassType, # (5)
LastRestoreTime: datetime,
ParentRecoveryPointArn: str,
CompositeMemberIdentifier: str,
IsParent: bool,
ResourceName: str,
ResponseMetadata: ResponseMetadataTypeDef, # (6)
- See RecoveryPointCreatorTypeDef
- See RecoveryPointStatusType
- See CalculatedLifecycleTypeDef
- See LifecycleTypeDef
- See StorageClassType
- See ResponseMetadataTypeDef
DescribeRegionSettingsOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import DescribeRegionSettingsOutputTypeDef
def get_value() -> DescribeRegionSettingsOutputTypeDef:
return {
"ResourceTypeOptInPreference": ...,
"ResourceTypeManagementPreference": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeRegionSettingsOutputTypeDef(TypedDict):
ResourceTypeOptInPreference: Dict[str, bool],
ResourceTypeManagementPreference: Dict[str, bool],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeRestoreJobOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import DescribeRestoreJobOutputTypeDef
def get_value() -> DescribeRestoreJobOutputTypeDef:
return {
"AccountId": ...,
"RestoreJobId": ...,
"RecoveryPointArn": ...,
"CreationDate": ...,
"CompletionDate": ...,
"Status": ...,
"StatusMessage": ...,
"PercentDone": ...,
"BackupSizeInBytes": ...,
"IamRoleArn": ...,
"ExpectedCompletionTimeMinutes": ...,
"CreatedResourceArn": ...,
"ResourceType": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeRestoreJobOutputTypeDef(TypedDict):
AccountId: str,
RestoreJobId: str,
RecoveryPointArn: str,
CreationDate: datetime,
CompletionDate: datetime,
Status: RestoreJobStatusType, # (1)
StatusMessage: str,
PercentDone: str,
BackupSizeInBytes: int,
IamRoleArn: str,
ExpectedCompletionTimeMinutes: int,
CreatedResourceArn: str,
ResourceType: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
EmptyResponseMetadataTypeDef
Usage Example
from mypy_boto3_backup.type_defs import EmptyResponseMetadataTypeDef
def get_value() -> EmptyResponseMetadataTypeDef:
return {
"ResponseMetadata": ...,
}
Definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ExportBackupPlanTemplateOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ExportBackupPlanTemplateOutputTypeDef
def get_value() -> ExportBackupPlanTemplateOutputTypeDef:
return {
"BackupPlanTemplateJson": ...,
"ResponseMetadata": ...,
}
Definition
class ExportBackupPlanTemplateOutputTypeDef(TypedDict):
BackupPlanTemplateJson: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetBackupVaultAccessPolicyOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import GetBackupVaultAccessPolicyOutputTypeDef
def get_value() -> GetBackupVaultAccessPolicyOutputTypeDef:
return {
"BackupVaultName": ...,
"BackupVaultArn": ...,
"Policy": ...,
"ResponseMetadata": ...,
}
Definition
class GetBackupVaultAccessPolicyOutputTypeDef(TypedDict):
BackupVaultName: str,
BackupVaultArn: str,
Policy: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetBackupVaultNotificationsOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import GetBackupVaultNotificationsOutputTypeDef
def get_value() -> GetBackupVaultNotificationsOutputTypeDef:
return {
"BackupVaultName": ...,
"BackupVaultArn": ...,
"SNSTopicArn": ...,
"BackupVaultEvents": ...,
"ResponseMetadata": ...,
}
Definition
class GetBackupVaultNotificationsOutputTypeDef(TypedDict):
BackupVaultName: str,
BackupVaultArn: str,
SNSTopicArn: str,
BackupVaultEvents: List[BackupVaultEventType], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetRecoveryPointRestoreMetadataOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import GetRecoveryPointRestoreMetadataOutputTypeDef
def get_value() -> GetRecoveryPointRestoreMetadataOutputTypeDef:
return {
"BackupVaultArn": ...,
"RecoveryPointArn": ...,
"RestoreMetadata": ...,
"ResponseMetadata": ...,
}
Definition
class GetRecoveryPointRestoreMetadataOutputTypeDef(TypedDict):
BackupVaultArn: str,
RecoveryPointArn: str,
RestoreMetadata: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetSupportedResourceTypesOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import GetSupportedResourceTypesOutputTypeDef
def get_value() -> GetSupportedResourceTypesOutputTypeDef:
return {
"ResourceTypes": ...,
"ResponseMetadata": ...,
}
Definition
class GetSupportedResourceTypesOutputTypeDef(TypedDict):
ResourceTypes: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListBackupPlanTemplatesOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListBackupPlanTemplatesOutputTypeDef
def get_value() -> ListBackupPlanTemplatesOutputTypeDef:
return {
"NextToken": ...,
"BackupPlanTemplatesList": ...,
"ResponseMetadata": ...,
}
Definition
class ListBackupPlanTemplatesOutputTypeDef(TypedDict):
NextToken: str,
BackupPlanTemplatesList: List[BackupPlanTemplatesListMemberTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListBackupSelectionsOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListBackupSelectionsOutputTypeDef
def get_value() -> ListBackupSelectionsOutputTypeDef:
return {
"NextToken": ...,
"BackupSelectionsList": ...,
"ResponseMetadata": ...,
}
Definition
class ListBackupSelectionsOutputTypeDef(TypedDict):
NextToken: str,
BackupSelectionsList: List[BackupSelectionsListMemberTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListBackupVaultsOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListBackupVaultsOutputTypeDef
def get_value() -> ListBackupVaultsOutputTypeDef:
return {
"BackupVaultList": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListBackupVaultsOutputTypeDef(TypedDict):
BackupVaultList: List[BackupVaultListMemberTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListTagsOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListTagsOutputTypeDef
def get_value() -> ListTagsOutputTypeDef:
return {
"NextToken": ...,
"Tags": ...,
"ResponseMetadata": ...,
}
Definition
class ListTagsOutputTypeDef(TypedDict):
NextToken: str,
Tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartBackupJobOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import StartBackupJobOutputTypeDef
def get_value() -> StartBackupJobOutputTypeDef:
return {
"BackupJobId": ...,
"RecoveryPointArn": ...,
"CreationDate": ...,
"IsParent": ...,
"ResponseMetadata": ...,
}
Definition
class StartBackupJobOutputTypeDef(TypedDict):
BackupJobId: str,
RecoveryPointArn: str,
CreationDate: datetime,
IsParent: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartCopyJobOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import StartCopyJobOutputTypeDef
def get_value() -> StartCopyJobOutputTypeDef:
return {
"CopyJobId": ...,
"CreationDate": ...,
"IsParent": ...,
"ResponseMetadata": ...,
}
Definition
class StartCopyJobOutputTypeDef(TypedDict):
CopyJobId: str,
CreationDate: datetime,
IsParent: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartReportJobOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import StartReportJobOutputTypeDef
def get_value() -> StartReportJobOutputTypeDef:
return {
"ReportJobId": ...,
"ResponseMetadata": ...,
}
Definition
class StartReportJobOutputTypeDef(TypedDict):
ReportJobId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartRestoreJobOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import StartRestoreJobOutputTypeDef
def get_value() -> StartRestoreJobOutputTypeDef:
return {
"RestoreJobId": ...,
"ResponseMetadata": ...,
}
Definition
class StartRestoreJobOutputTypeDef(TypedDict):
RestoreJobId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateBackupPlanOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import UpdateBackupPlanOutputTypeDef
def get_value() -> UpdateBackupPlanOutputTypeDef:
return {
"BackupPlanId": ...,
"BackupPlanArn": ...,
"CreationDate": ...,
"VersionId": ...,
"AdvancedBackupSettings": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateBackupPlanOutputTypeDef(TypedDict):
BackupPlanId: str,
BackupPlanArn: str,
CreationDate: datetime,
VersionId: str,
AdvancedBackupSettings: List[AdvancedBackupSettingTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateFrameworkOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import UpdateFrameworkOutputTypeDef
def get_value() -> UpdateFrameworkOutputTypeDef:
return {
"FrameworkName": ...,
"FrameworkArn": ...,
"CreationTime": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateFrameworkOutputTypeDef(TypedDict):
FrameworkName: str,
FrameworkArn: str,
CreationTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateRecoveryPointLifecycleOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import UpdateRecoveryPointLifecycleOutputTypeDef
def get_value() -> UpdateRecoveryPointLifecycleOutputTypeDef:
return {
"BackupVaultArn": ...,
"RecoveryPointArn": ...,
"Lifecycle": ...,
"CalculatedLifecycle": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateRecoveryPointLifecycleOutputTypeDef(TypedDict):
BackupVaultArn: str,
RecoveryPointArn: str,
Lifecycle: LifecycleTypeDef, # (1)
CalculatedLifecycle: CalculatedLifecycleTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
UpdateReportPlanOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import UpdateReportPlanOutputTypeDef
def get_value() -> UpdateReportPlanOutputTypeDef:
return {
"ReportPlanName": ...,
"ReportPlanArn": ...,
"CreationTime": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateReportPlanOutputTypeDef(TypedDict):
ReportPlanName: str,
ReportPlanArn: str,
CreationTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateReportPlanInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import CreateReportPlanInputRequestTypeDef
def get_value() -> CreateReportPlanInputRequestTypeDef:
return {
"ReportPlanName": ...,
"ReportDeliveryChannel": ...,
"ReportSetting": ...,
}
Definition
class CreateReportPlanInputRequestTypeDef(TypedDict):
ReportPlanName: str,
ReportDeliveryChannel: ReportDeliveryChannelTypeDef, # (1)
ReportSetting: ReportSettingTypeDef, # (2)
ReportPlanDescription: NotRequired[str],
ReportPlanTags: NotRequired[Mapping[str, str]],
IdempotencyToken: NotRequired[str],
ReportPlanTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ReportPlanTypeDef
def get_value() -> ReportPlanTypeDef:
return {
"ReportPlanArn": ...,
}
Definition
class ReportPlanTypeDef(TypedDict):
ReportPlanArn: NotRequired[str],
ReportPlanName: NotRequired[str],
ReportPlanDescription: NotRequired[str],
ReportSetting: NotRequired[ReportSettingTypeDef], # (1)
ReportDeliveryChannel: NotRequired[ReportDeliveryChannelTypeDef], # (2)
DeploymentStatus: NotRequired[str],
CreationTime: NotRequired[datetime],
LastAttemptedExecutionTime: NotRequired[datetime],
LastSuccessfulExecutionTime: NotRequired[datetime],
UpdateReportPlanInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import UpdateReportPlanInputRequestTypeDef
def get_value() -> UpdateReportPlanInputRequestTypeDef:
return {
"ReportPlanName": ...,
}
Definition
class UpdateReportPlanInputRequestTypeDef(TypedDict):
ReportPlanName: str,
ReportPlanDescription: NotRequired[str],
ReportDeliveryChannel: NotRequired[ReportDeliveryChannelTypeDef], # (1)
ReportSetting: NotRequired[ReportSettingTypeDef], # (2)
IdempotencyToken: NotRequired[str],
RecoveryPointSelectionTypeDef
Usage Example
from mypy_boto3_backup.type_defs import RecoveryPointSelectionTypeDef
def get_value() -> RecoveryPointSelectionTypeDef:
return {
"VaultNames": ...,
}
Definition
class RecoveryPointSelectionTypeDef(TypedDict):
VaultNames: NotRequired[Sequence[str]],
ResourceIdentifiers: NotRequired[Sequence[str]],
DateRange: NotRequired[DateRangeTypeDef], # (1)
- See DateRangeTypeDef
ListFrameworksOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListFrameworksOutputTypeDef
def get_value() -> ListFrameworksOutputTypeDef:
return {
"Frameworks": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListFrameworksOutputTypeDef(TypedDict):
Frameworks: List[FrameworkTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListLegalHoldsOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListLegalHoldsOutputTypeDef
def get_value() -> ListLegalHoldsOutputTypeDef:
return {
"NextToken": ...,
"LegalHolds": ...,
"ResponseMetadata": ...,
}
Definition
class ListLegalHoldsOutputTypeDef(TypedDict):
NextToken: str,
LegalHolds: List[LegalHoldTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListBackupJobsInputListBackupJobsPaginateTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListBackupJobsInputListBackupJobsPaginateTypeDef
def get_value() -> ListBackupJobsInputListBackupJobsPaginateTypeDef:
return {
"ByResourceArn": ...,
}
Definition
class ListBackupJobsInputListBackupJobsPaginateTypeDef(TypedDict):
ByResourceArn: NotRequired[str],
ByState: NotRequired[BackupJobStateType], # (1)
ByBackupVaultName: NotRequired[str],
ByCreatedBefore: NotRequired[Union[datetime, str]],
ByCreatedAfter: NotRequired[Union[datetime, str]],
ByResourceType: NotRequired[str],
ByAccountId: NotRequired[str],
ByCompleteAfter: NotRequired[Union[datetime, str]],
ByCompleteBefore: NotRequired[Union[datetime, str]],
ByParentJobId: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListBackupPlanTemplatesInputListBackupPlanTemplatesPaginateTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListBackupPlanTemplatesInputListBackupPlanTemplatesPaginateTypeDef
def get_value() -> ListBackupPlanTemplatesInputListBackupPlanTemplatesPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class ListBackupPlanTemplatesInputListBackupPlanTemplatesPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListBackupPlanVersionsInputListBackupPlanVersionsPaginateTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListBackupPlanVersionsInputListBackupPlanVersionsPaginateTypeDef
def get_value() -> ListBackupPlanVersionsInputListBackupPlanVersionsPaginateTypeDef:
return {
"BackupPlanId": ...,
}
Definition
class ListBackupPlanVersionsInputListBackupPlanVersionsPaginateTypeDef(TypedDict):
BackupPlanId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListBackupPlansInputListBackupPlansPaginateTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListBackupPlansInputListBackupPlansPaginateTypeDef
def get_value() -> ListBackupPlansInputListBackupPlansPaginateTypeDef:
return {
"IncludeDeleted": ...,
}
Definition
class ListBackupPlansInputListBackupPlansPaginateTypeDef(TypedDict):
IncludeDeleted: NotRequired[bool],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListBackupSelectionsInputListBackupSelectionsPaginateTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListBackupSelectionsInputListBackupSelectionsPaginateTypeDef
def get_value() -> ListBackupSelectionsInputListBackupSelectionsPaginateTypeDef:
return {
"BackupPlanId": ...,
}
Definition
class ListBackupSelectionsInputListBackupSelectionsPaginateTypeDef(TypedDict):
BackupPlanId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListBackupVaultsInputListBackupVaultsPaginateTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListBackupVaultsInputListBackupVaultsPaginateTypeDef
def get_value() -> ListBackupVaultsInputListBackupVaultsPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class ListBackupVaultsInputListBackupVaultsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListCopyJobsInputListCopyJobsPaginateTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListCopyJobsInputListCopyJobsPaginateTypeDef
def get_value() -> ListCopyJobsInputListCopyJobsPaginateTypeDef:
return {
"ByResourceArn": ...,
}
Definition
class ListCopyJobsInputListCopyJobsPaginateTypeDef(TypedDict):
ByResourceArn: NotRequired[str],
ByState: NotRequired[CopyJobStateType], # (1)
ByCreatedBefore: NotRequired[Union[datetime, str]],
ByCreatedAfter: NotRequired[Union[datetime, str]],
ByResourceType: NotRequired[str],
ByDestinationVaultArn: NotRequired[str],
ByAccountId: NotRequired[str],
ByCompleteBefore: NotRequired[Union[datetime, str]],
ByCompleteAfter: NotRequired[Union[datetime, str]],
ByParentJobId: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListLegalHoldsInputListLegalHoldsPaginateTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListLegalHoldsInputListLegalHoldsPaginateTypeDef
def get_value() -> ListLegalHoldsInputListLegalHoldsPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class ListLegalHoldsInputListLegalHoldsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListProtectedResourcesInputListProtectedResourcesPaginateTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListProtectedResourcesInputListProtectedResourcesPaginateTypeDef
def get_value() -> ListProtectedResourcesInputListProtectedResourcesPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class ListProtectedResourcesInputListProtectedResourcesPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListRecoveryPointsByBackupVaultInputListRecoveryPointsByBackupVaultPaginateTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListRecoveryPointsByBackupVaultInputListRecoveryPointsByBackupVaultPaginateTypeDef
def get_value() -> ListRecoveryPointsByBackupVaultInputListRecoveryPointsByBackupVaultPaginateTypeDef:
return {
"BackupVaultName": ...,
}
Definition
class ListRecoveryPointsByBackupVaultInputListRecoveryPointsByBackupVaultPaginateTypeDef(TypedDict):
BackupVaultName: str,
ByResourceArn: NotRequired[str],
ByResourceType: NotRequired[str],
ByBackupPlanId: NotRequired[str],
ByCreatedBefore: NotRequired[Union[datetime, str]],
ByCreatedAfter: NotRequired[Union[datetime, str]],
ByParentRecoveryPointArn: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListRecoveryPointsByLegalHoldInputListRecoveryPointsByLegalHoldPaginateTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListRecoveryPointsByLegalHoldInputListRecoveryPointsByLegalHoldPaginateTypeDef
def get_value() -> ListRecoveryPointsByLegalHoldInputListRecoveryPointsByLegalHoldPaginateTypeDef:
return {
"LegalHoldId": ...,
}
Definition
class ListRecoveryPointsByLegalHoldInputListRecoveryPointsByLegalHoldPaginateTypeDef(TypedDict):
LegalHoldId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListRecoveryPointsByResourceInputListRecoveryPointsByResourcePaginateTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListRecoveryPointsByResourceInputListRecoveryPointsByResourcePaginateTypeDef
def get_value() -> ListRecoveryPointsByResourceInputListRecoveryPointsByResourcePaginateTypeDef:
return {
"ResourceArn": ...,
}
Definition
class ListRecoveryPointsByResourceInputListRecoveryPointsByResourcePaginateTypeDef(TypedDict):
ResourceArn: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListRestoreJobsInputListRestoreJobsPaginateTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListRestoreJobsInputListRestoreJobsPaginateTypeDef
def get_value() -> ListRestoreJobsInputListRestoreJobsPaginateTypeDef:
return {
"ByAccountId": ...,
}
Definition
class ListRestoreJobsInputListRestoreJobsPaginateTypeDef(TypedDict):
ByAccountId: NotRequired[str],
ByCreatedBefore: NotRequired[Union[datetime, str]],
ByCreatedAfter: NotRequired[Union[datetime, str]],
ByStatus: NotRequired[RestoreJobStatusType], # (1)
ByCompleteBefore: NotRequired[Union[datetime, str]],
ByCompleteAfter: NotRequired[Union[datetime, str]],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListProtectedResourcesOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListProtectedResourcesOutputTypeDef
def get_value() -> ListProtectedResourcesOutputTypeDef:
return {
"Results": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListProtectedResourcesOutputTypeDef(TypedDict):
Results: List[ProtectedResourceTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListRecoveryPointsByLegalHoldOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListRecoveryPointsByLegalHoldOutputTypeDef
def get_value() -> ListRecoveryPointsByLegalHoldOutputTypeDef:
return {
"RecoveryPoints": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListRecoveryPointsByLegalHoldOutputTypeDef(TypedDict):
RecoveryPoints: List[RecoveryPointMemberTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListRecoveryPointsByResourceOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListRecoveryPointsByResourceOutputTypeDef
def get_value() -> ListRecoveryPointsByResourceOutputTypeDef:
return {
"NextToken": ...,
"RecoveryPoints": ...,
"ResponseMetadata": ...,
}
Definition
class ListRecoveryPointsByResourceOutputTypeDef(TypedDict):
NextToken: str,
RecoveryPoints: List[RecoveryPointByResourceTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListRestoreJobsOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListRestoreJobsOutputTypeDef
def get_value() -> ListRestoreJobsOutputTypeDef:
return {
"RestoreJobs": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListRestoreJobsOutputTypeDef(TypedDict):
RestoreJobs: List[RestoreJobsListMemberTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ReportJobTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ReportJobTypeDef
def get_value() -> ReportJobTypeDef:
return {
"ReportJobId": ...,
}
Definition
class ReportJobTypeDef(TypedDict):
ReportJobId: NotRequired[str],
ReportPlanArn: NotRequired[str],
ReportTemplate: NotRequired[str],
CreationTime: NotRequired[datetime],
CompletionTime: NotRequired[datetime],
Status: NotRequired[str],
StatusMessage: NotRequired[str],
ReportDestination: NotRequired[ReportDestinationTypeDef], # (1)
ListBackupPlanVersionsOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListBackupPlanVersionsOutputTypeDef
def get_value() -> ListBackupPlanVersionsOutputTypeDef:
return {
"NextToken": ...,
"BackupPlanVersionsList": ...,
"ResponseMetadata": ...,
}
Definition
class ListBackupPlanVersionsOutputTypeDef(TypedDict):
NextToken: str,
BackupPlanVersionsList: List[BackupPlansListMemberTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListBackupPlansOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListBackupPlansOutputTypeDef
def get_value() -> ListBackupPlansOutputTypeDef:
return {
"NextToken": ...,
"BackupPlansList": ...,
"ResponseMetadata": ...,
}
Definition
class ListBackupPlansOutputTypeDef(TypedDict):
NextToken: str,
BackupPlansList: List[BackupPlansListMemberTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListBackupJobsOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListBackupJobsOutputTypeDef
def get_value() -> ListBackupJobsOutputTypeDef:
return {
"BackupJobs": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListBackupJobsOutputTypeDef(TypedDict):
BackupJobs: List[BackupJobTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeCopyJobOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import DescribeCopyJobOutputTypeDef
def get_value() -> DescribeCopyJobOutputTypeDef:
return {
"CopyJob": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeCopyJobOutputTypeDef(TypedDict):
CopyJob: CopyJobTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListCopyJobsOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListCopyJobsOutputTypeDef
def get_value() -> ListCopyJobsOutputTypeDef:
return {
"CopyJobs": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListCopyJobsOutputTypeDef(TypedDict):
CopyJobs: List[CopyJobTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BackupRuleInputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import BackupRuleInputTypeDef
def get_value() -> BackupRuleInputTypeDef:
return {
"RuleName": ...,
"TargetBackupVaultName": ...,
}
Definition
class BackupRuleInputTypeDef(TypedDict):
RuleName: str,
TargetBackupVaultName: str,
ScheduleExpression: NotRequired[str],
StartWindowMinutes: NotRequired[int],
CompletionWindowMinutes: NotRequired[int],
Lifecycle: NotRequired[LifecycleTypeDef], # (1)
RecoveryPointTags: NotRequired[Mapping[str, str]],
CopyActions: NotRequired[Sequence[CopyActionTypeDef]], # (2)
EnableContinuousBackup: NotRequired[bool],
- See LifecycleTypeDef
- See CopyActionTypeDef
BackupRuleTypeDef
Usage Example
from mypy_boto3_backup.type_defs import BackupRuleTypeDef
def get_value() -> BackupRuleTypeDef:
return {
"RuleName": ...,
"TargetBackupVaultName": ...,
}
Definition
class BackupRuleTypeDef(TypedDict):
RuleName: str,
TargetBackupVaultName: str,
ScheduleExpression: NotRequired[str],
StartWindowMinutes: NotRequired[int],
CompletionWindowMinutes: NotRequired[int],
Lifecycle: NotRequired[LifecycleTypeDef], # (1)
RecoveryPointTags: NotRequired[Dict[str, str]],
RuleId: NotRequired[str],
CopyActions: NotRequired[List[CopyActionTypeDef]], # (2)
EnableContinuousBackup: NotRequired[bool],
- See LifecycleTypeDef
- See CopyActionTypeDef
ListRecoveryPointsByBackupVaultOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListRecoveryPointsByBackupVaultOutputTypeDef
def get_value() -> ListRecoveryPointsByBackupVaultOutputTypeDef:
return {
"NextToken": ...,
"RecoveryPoints": ...,
"ResponseMetadata": ...,
}
Definition
class ListRecoveryPointsByBackupVaultOutputTypeDef(TypedDict):
NextToken: str,
RecoveryPoints: List[RecoveryPointByBackupVaultTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BackupSelectionTypeDef
Usage Example
from mypy_boto3_backup.type_defs import BackupSelectionTypeDef
def get_value() -> BackupSelectionTypeDef:
return {
"SelectionName": ...,
"IamRoleArn": ...,
}
Definition
class BackupSelectionTypeDef(TypedDict):
SelectionName: str,
IamRoleArn: str,
Resources: NotRequired[Sequence[str]],
ListOfTags: NotRequired[Sequence[ConditionTypeDef]], # (1)
NotResources: NotRequired[Sequence[str]],
Conditions: NotRequired[ConditionsTypeDef], # (2)
- See ConditionTypeDef
- See ConditionsTypeDef
CreateFrameworkInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import CreateFrameworkInputRequestTypeDef
def get_value() -> CreateFrameworkInputRequestTypeDef:
return {
"FrameworkName": ...,
"FrameworkControls": ...,
}
Definition
class CreateFrameworkInputRequestTypeDef(TypedDict):
FrameworkName: str,
FrameworkControls: Sequence[FrameworkControlTypeDef], # (1)
FrameworkDescription: NotRequired[str],
IdempotencyToken: NotRequired[str],
FrameworkTags: NotRequired[Mapping[str, str]],
DescribeFrameworkOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import DescribeFrameworkOutputTypeDef
def get_value() -> DescribeFrameworkOutputTypeDef:
return {
"FrameworkName": ...,
"FrameworkArn": ...,
"FrameworkDescription": ...,
"FrameworkControls": ...,
"CreationTime": ...,
"DeploymentStatus": ...,
"FrameworkStatus": ...,
"IdempotencyToken": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeFrameworkOutputTypeDef(TypedDict):
FrameworkName: str,
FrameworkArn: str,
FrameworkDescription: str,
FrameworkControls: List[FrameworkControlTypeDef], # (1)
CreationTime: datetime,
DeploymentStatus: str,
FrameworkStatus: str,
IdempotencyToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateFrameworkInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import UpdateFrameworkInputRequestTypeDef
def get_value() -> UpdateFrameworkInputRequestTypeDef:
return {
"FrameworkName": ...,
}
Definition
class UpdateFrameworkInputRequestTypeDef(TypedDict):
FrameworkName: str,
FrameworkDescription: NotRequired[str],
FrameworkControls: NotRequired[Sequence[FrameworkControlTypeDef]], # (1)
IdempotencyToken: NotRequired[str],
DescribeReportPlanOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import DescribeReportPlanOutputTypeDef
def get_value() -> DescribeReportPlanOutputTypeDef:
return {
"ReportPlan": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeReportPlanOutputTypeDef(TypedDict):
ReportPlan: ReportPlanTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListReportPlansOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListReportPlansOutputTypeDef
def get_value() -> ListReportPlansOutputTypeDef:
return {
"ReportPlans": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListReportPlansOutputTypeDef(TypedDict):
ReportPlans: List[ReportPlanTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateLegalHoldInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import CreateLegalHoldInputRequestTypeDef
def get_value() -> CreateLegalHoldInputRequestTypeDef:
return {
"Title": ...,
"Description": ...,
}
Definition
class CreateLegalHoldInputRequestTypeDef(TypedDict):
Title: str,
Description: str,
IdempotencyToken: NotRequired[str],
RecoveryPointSelection: NotRequired[RecoveryPointSelectionTypeDef], # (1)
Tags: NotRequired[Mapping[str, str]],
CreateLegalHoldOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import CreateLegalHoldOutputTypeDef
def get_value() -> CreateLegalHoldOutputTypeDef:
return {
"Title": ...,
"Status": ...,
"Description": ...,
"LegalHoldId": ...,
"LegalHoldArn": ...,
"CreationDate": ...,
"RecoveryPointSelection": ...,
"ResponseMetadata": ...,
}
Definition
class CreateLegalHoldOutputTypeDef(TypedDict):
Title: str,
Status: LegalHoldStatusType, # (1)
Description: str,
LegalHoldId: str,
LegalHoldArn: str,
CreationDate: datetime,
RecoveryPointSelection: RecoveryPointSelectionTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
GetLegalHoldOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import GetLegalHoldOutputTypeDef
def get_value() -> GetLegalHoldOutputTypeDef:
return {
"Title": ...,
"Status": ...,
"Description": ...,
"CancelDescription": ...,
"LegalHoldId": ...,
"LegalHoldArn": ...,
"CreationDate": ...,
"CancellationDate": ...,
"RetainRecordUntil": ...,
"RecoveryPointSelection": ...,
"ResponseMetadata": ...,
}
Definition
class GetLegalHoldOutputTypeDef(TypedDict):
Title: str,
Status: LegalHoldStatusType, # (1)
Description: str,
CancelDescription: str,
LegalHoldId: str,
LegalHoldArn: str,
CreationDate: datetime,
CancellationDate: datetime,
RetainRecordUntil: datetime,
RecoveryPointSelection: RecoveryPointSelectionTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
DescribeReportJobOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import DescribeReportJobOutputTypeDef
def get_value() -> DescribeReportJobOutputTypeDef:
return {
"ReportJob": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeReportJobOutputTypeDef(TypedDict):
ReportJob: ReportJobTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListReportJobsOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import ListReportJobsOutputTypeDef
def get_value() -> ListReportJobsOutputTypeDef:
return {
"ReportJobs": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListReportJobsOutputTypeDef(TypedDict):
ReportJobs: List[ReportJobTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BackupPlanInputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import BackupPlanInputTypeDef
def get_value() -> BackupPlanInputTypeDef:
return {
"BackupPlanName": ...,
"Rules": ...,
}
Definition
class BackupPlanInputTypeDef(TypedDict):
BackupPlanName: str,
Rules: Sequence[BackupRuleInputTypeDef], # (1)
AdvancedBackupSettings: NotRequired[Sequence[AdvancedBackupSettingTypeDef]], # (2)
BackupPlanTypeDef
Usage Example
from mypy_boto3_backup.type_defs import BackupPlanTypeDef
def get_value() -> BackupPlanTypeDef:
return {
"BackupPlanName": ...,
"Rules": ...,
}
Definition
class BackupPlanTypeDef(TypedDict):
BackupPlanName: str,
Rules: List[BackupRuleTypeDef], # (1)
AdvancedBackupSettings: NotRequired[List[AdvancedBackupSettingTypeDef]], # (2)
CreateBackupSelectionInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import CreateBackupSelectionInputRequestTypeDef
def get_value() -> CreateBackupSelectionInputRequestTypeDef:
return {
"BackupPlanId": ...,
"BackupSelection": ...,
}
Definition
class CreateBackupSelectionInputRequestTypeDef(TypedDict):
BackupPlanId: str,
BackupSelection: BackupSelectionTypeDef, # (1)
CreatorRequestId: NotRequired[str],
GetBackupSelectionOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import GetBackupSelectionOutputTypeDef
def get_value() -> GetBackupSelectionOutputTypeDef:
return {
"BackupSelection": ...,
"SelectionId": ...,
"BackupPlanId": ...,
"CreationDate": ...,
"CreatorRequestId": ...,
"ResponseMetadata": ...,
}
Definition
class GetBackupSelectionOutputTypeDef(TypedDict):
BackupSelection: BackupSelectionTypeDef, # (1)
SelectionId: str,
BackupPlanId: str,
CreationDate: datetime,
CreatorRequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateBackupPlanInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import CreateBackupPlanInputRequestTypeDef
def get_value() -> CreateBackupPlanInputRequestTypeDef:
return {
"BackupPlan": ...,
}
Definition
class CreateBackupPlanInputRequestTypeDef(TypedDict):
BackupPlan: BackupPlanInputTypeDef, # (1)
BackupPlanTags: NotRequired[Mapping[str, str]],
CreatorRequestId: NotRequired[str],
UpdateBackupPlanInputRequestTypeDef
Usage Example
from mypy_boto3_backup.type_defs import UpdateBackupPlanInputRequestTypeDef
def get_value() -> UpdateBackupPlanInputRequestTypeDef:
return {
"BackupPlanId": ...,
"BackupPlan": ...,
}
Definition
class UpdateBackupPlanInputRequestTypeDef(TypedDict):
BackupPlanId: str,
BackupPlan: BackupPlanInputTypeDef, # (1)
GetBackupPlanFromJSONOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import GetBackupPlanFromJSONOutputTypeDef
def get_value() -> GetBackupPlanFromJSONOutputTypeDef:
return {
"BackupPlan": ...,
"ResponseMetadata": ...,
}
Definition
class GetBackupPlanFromJSONOutputTypeDef(TypedDict):
BackupPlan: BackupPlanTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetBackupPlanFromTemplateOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import GetBackupPlanFromTemplateOutputTypeDef
def get_value() -> GetBackupPlanFromTemplateOutputTypeDef:
return {
"BackupPlanDocument": ...,
"ResponseMetadata": ...,
}
Definition
class GetBackupPlanFromTemplateOutputTypeDef(TypedDict):
BackupPlanDocument: BackupPlanTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetBackupPlanOutputTypeDef
Usage Example
from mypy_boto3_backup.type_defs import GetBackupPlanOutputTypeDef
def get_value() -> GetBackupPlanOutputTypeDef:
return {
"BackupPlan": ...,
"BackupPlanId": ...,
"BackupPlanArn": ...,
"VersionId": ...,
"CreatorRequestId": ...,
"CreationDate": ...,
"DeletionDate": ...,
"LastExecutionDate": ...,
"AdvancedBackupSettings": ...,
"ResponseMetadata": ...,
}
Definition
class GetBackupPlanOutputTypeDef(TypedDict):
BackupPlan: BackupPlanTypeDef, # (1)
BackupPlanId: str,
BackupPlanArn: str,
VersionId: str,
CreatorRequestId: str,
CreationDate: datetime,
DeletionDate: datetime,
LastExecutionDate: datetime,
AdvancedBackupSettings: List[AdvancedBackupSettingTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)