Type definitions#
Auto-generated documentation for Backup type annotations stubs module mypy-boto3-backup.
TimestampTypeDef#
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime,
str,
]
AdvancedBackupSettingPaginatorTypeDef#
# AdvancedBackupSettingPaginatorTypeDef definition
class AdvancedBackupSettingPaginatorTypeDef(TypedDict):
ResourceType: NotRequired[str],
BackupOptions: NotRequired[Dict[str, str]],
AdvancedBackupSettingTypeDef#
# AdvancedBackupSettingTypeDef definition
class AdvancedBackupSettingTypeDef(TypedDict):
ResourceType: NotRequired[str],
BackupOptions: NotRequired[Mapping[str, str]],
BackupJobSummaryTypeDef#
# BackupJobSummaryTypeDef definition
class BackupJobSummaryTypeDef(TypedDict):
Region: NotRequired[str],
AccountId: NotRequired[str],
State: NotRequired[BackupJobStatusType], # (1)
ResourceType: NotRequired[str],
MessageCategory: NotRequired[str],
Count: NotRequired[int],
StartTime: NotRequired[datetime],
EndTime: NotRequired[datetime],
RecoveryPointCreatorTypeDef#
# RecoveryPointCreatorTypeDef definition
class RecoveryPointCreatorTypeDef(TypedDict):
BackupPlanId: NotRequired[str],
BackupPlanArn: NotRequired[str],
BackupPlanVersion: NotRequired[str],
BackupRuleId: NotRequired[str],
BackupPlanTemplatesListMemberTypeDef#
# BackupPlanTemplatesListMemberTypeDef definition
class BackupPlanTemplatesListMemberTypeDef(TypedDict):
BackupPlanTemplateId: NotRequired[str],
BackupPlanTemplateName: NotRequired[str],
LifecycleTypeDef#
# LifecycleTypeDef definition
class LifecycleTypeDef(TypedDict):
MoveToColdStorageAfterDays: NotRequired[int],
DeleteAfterDays: NotRequired[int],
ConditionTypeDef#
# ConditionTypeDef definition
class ConditionTypeDef(TypedDict):
ConditionType: ConditionTypeType, # (1)
ConditionKey: str,
ConditionValue: str,
BackupSelectionsListMemberTypeDef#
# BackupSelectionsListMemberTypeDef definition
class BackupSelectionsListMemberTypeDef(TypedDict):
SelectionId: NotRequired[str],
SelectionName: NotRequired[str],
BackupPlanId: NotRequired[str],
CreationDate: NotRequired[datetime],
CreatorRequestId: NotRequired[str],
IamRoleArn: NotRequired[str],
BackupVaultListMemberTypeDef#
# BackupVaultListMemberTypeDef 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#
# CalculatedLifecycleTypeDef definition
class CalculatedLifecycleTypeDef(TypedDict):
MoveToColdStorageAt: NotRequired[datetime],
DeleteAt: NotRequired[datetime],
CancelLegalHoldInputRequestTypeDef#
# CancelLegalHoldInputRequestTypeDef definition
class CancelLegalHoldInputRequestTypeDef(TypedDict):
LegalHoldId: str,
CancelDescription: str,
RetainRecordInDays: NotRequired[int],
ConditionParameterTypeDef#
# ConditionParameterTypeDef definition
class ConditionParameterTypeDef(TypedDict):
ConditionKey: NotRequired[str],
ConditionValue: NotRequired[str],
ControlInputParameterTypeDef#
# ControlInputParameterTypeDef definition
class ControlInputParameterTypeDef(TypedDict):
ParameterName: NotRequired[str],
ParameterValue: NotRequired[str],
ControlScopeTypeDef#
# ControlScopeTypeDef definition
class ControlScopeTypeDef(TypedDict):
ComplianceResourceIds: NotRequired[Sequence[str]],
ComplianceResourceTypes: NotRequired[Sequence[str]],
Tags: NotRequired[Mapping[str, str]],
CopyJobSummaryTypeDef#
# CopyJobSummaryTypeDef definition
class CopyJobSummaryTypeDef(TypedDict):
Region: NotRequired[str],
AccountId: NotRequired[str],
State: NotRequired[CopyJobStatusType], # (1)
ResourceType: NotRequired[str],
MessageCategory: NotRequired[str],
Count: NotRequired[int],
StartTime: NotRequired[datetime],
EndTime: NotRequired[datetime],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
CreateBackupVaultInputRequestTypeDef#
# CreateBackupVaultInputRequestTypeDef definition
class CreateBackupVaultInputRequestTypeDef(TypedDict):
BackupVaultName: str,
BackupVaultTags: NotRequired[Mapping[str, str]],
EncryptionKeyArn: NotRequired[str],
CreatorRequestId: NotRequired[str],
CreateLogicallyAirGappedBackupVaultInputRequestTypeDef#
# CreateLogicallyAirGappedBackupVaultInputRequestTypeDef definition
class CreateLogicallyAirGappedBackupVaultInputRequestTypeDef(TypedDict):
BackupVaultName: str,
MinRetentionDays: int,
MaxRetentionDays: int,
BackupVaultTags: NotRequired[Mapping[str, str]],
CreatorRequestId: NotRequired[str],
ReportDeliveryChannelTypeDef#
# ReportDeliveryChannelTypeDef definition
class ReportDeliveryChannelTypeDef(TypedDict):
S3BucketName: str,
S3KeyPrefix: NotRequired[str],
Formats: NotRequired[Sequence[str]],
ReportSettingTypeDef#
# ReportSettingTypeDef 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]],
DeleteBackupPlanInputRequestTypeDef#
# DeleteBackupPlanInputRequestTypeDef definition
class DeleteBackupPlanInputRequestTypeDef(TypedDict):
BackupPlanId: str,
DeleteBackupSelectionInputRequestTypeDef#
# DeleteBackupSelectionInputRequestTypeDef definition
class DeleteBackupSelectionInputRequestTypeDef(TypedDict):
BackupPlanId: str,
SelectionId: str,
DeleteBackupVaultAccessPolicyInputRequestTypeDef#
# DeleteBackupVaultAccessPolicyInputRequestTypeDef definition
class DeleteBackupVaultAccessPolicyInputRequestTypeDef(TypedDict):
BackupVaultName: str,
DeleteBackupVaultInputRequestTypeDef#
# DeleteBackupVaultInputRequestTypeDef definition
class DeleteBackupVaultInputRequestTypeDef(TypedDict):
BackupVaultName: str,
DeleteBackupVaultLockConfigurationInputRequestTypeDef#
# DeleteBackupVaultLockConfigurationInputRequestTypeDef definition
class DeleteBackupVaultLockConfigurationInputRequestTypeDef(TypedDict):
BackupVaultName: str,
DeleteBackupVaultNotificationsInputRequestTypeDef#
# DeleteBackupVaultNotificationsInputRequestTypeDef definition
class DeleteBackupVaultNotificationsInputRequestTypeDef(TypedDict):
BackupVaultName: str,
DeleteFrameworkInputRequestTypeDef#
# DeleteFrameworkInputRequestTypeDef definition
class DeleteFrameworkInputRequestTypeDef(TypedDict):
FrameworkName: str,
DeleteRecoveryPointInputRequestTypeDef#
# DeleteRecoveryPointInputRequestTypeDef definition
class DeleteRecoveryPointInputRequestTypeDef(TypedDict):
BackupVaultName: str,
RecoveryPointArn: str,
DeleteReportPlanInputRequestTypeDef#
# DeleteReportPlanInputRequestTypeDef definition
class DeleteReportPlanInputRequestTypeDef(TypedDict):
ReportPlanName: str,
DescribeBackupJobInputRequestTypeDef#
# DescribeBackupJobInputRequestTypeDef definition
class DescribeBackupJobInputRequestTypeDef(TypedDict):
BackupJobId: str,
DescribeBackupVaultInputRequestTypeDef#
# DescribeBackupVaultInputRequestTypeDef definition
class DescribeBackupVaultInputRequestTypeDef(TypedDict):
BackupVaultName: str,
BackupVaultAccountId: NotRequired[str],
DescribeCopyJobInputRequestTypeDef#
# DescribeCopyJobInputRequestTypeDef definition
class DescribeCopyJobInputRequestTypeDef(TypedDict):
CopyJobId: str,
DescribeFrameworkInputRequestTypeDef#
# DescribeFrameworkInputRequestTypeDef definition
class DescribeFrameworkInputRequestTypeDef(TypedDict):
FrameworkName: str,
DescribeProtectedResourceInputRequestTypeDef#
# DescribeProtectedResourceInputRequestTypeDef definition
class DescribeProtectedResourceInputRequestTypeDef(TypedDict):
ResourceArn: str,
DescribeRecoveryPointInputRequestTypeDef#
# DescribeRecoveryPointInputRequestTypeDef definition
class DescribeRecoveryPointInputRequestTypeDef(TypedDict):
BackupVaultName: str,
RecoveryPointArn: str,
BackupVaultAccountId: NotRequired[str],
DescribeReportJobInputRequestTypeDef#
# DescribeReportJobInputRequestTypeDef definition
class DescribeReportJobInputRequestTypeDef(TypedDict):
ReportJobId: str,
DescribeReportPlanInputRequestTypeDef#
# DescribeReportPlanInputRequestTypeDef definition
class DescribeReportPlanInputRequestTypeDef(TypedDict):
ReportPlanName: str,
DescribeRestoreJobInputRequestTypeDef#
# DescribeRestoreJobInputRequestTypeDef definition
class DescribeRestoreJobInputRequestTypeDef(TypedDict):
RestoreJobId: str,
DisassociateRecoveryPointFromParentInputRequestTypeDef#
# DisassociateRecoveryPointFromParentInputRequestTypeDef definition
class DisassociateRecoveryPointFromParentInputRequestTypeDef(TypedDict):
BackupVaultName: str,
RecoveryPointArn: str,
DisassociateRecoveryPointInputRequestTypeDef#
# DisassociateRecoveryPointInputRequestTypeDef definition
class DisassociateRecoveryPointInputRequestTypeDef(TypedDict):
BackupVaultName: str,
RecoveryPointArn: str,
ExportBackupPlanTemplateInputRequestTypeDef#
# ExportBackupPlanTemplateInputRequestTypeDef definition
class ExportBackupPlanTemplateInputRequestTypeDef(TypedDict):
BackupPlanId: str,
FrameworkTypeDef#
# FrameworkTypeDef definition
class FrameworkTypeDef(TypedDict):
FrameworkName: NotRequired[str],
FrameworkArn: NotRequired[str],
FrameworkDescription: NotRequired[str],
NumberOfControls: NotRequired[int],
CreationTime: NotRequired[datetime],
DeploymentStatus: NotRequired[str],
GetBackupPlanFromJSONInputRequestTypeDef#
# GetBackupPlanFromJSONInputRequestTypeDef definition
class GetBackupPlanFromJSONInputRequestTypeDef(TypedDict):
BackupPlanTemplateJson: str,
GetBackupPlanFromTemplateInputRequestTypeDef#
# GetBackupPlanFromTemplateInputRequestTypeDef definition
class GetBackupPlanFromTemplateInputRequestTypeDef(TypedDict):
BackupPlanTemplateId: str,
GetBackupPlanInputRequestTypeDef#
# GetBackupPlanInputRequestTypeDef definition
class GetBackupPlanInputRequestTypeDef(TypedDict):
BackupPlanId: str,
VersionId: NotRequired[str],
GetBackupSelectionInputRequestTypeDef#
# GetBackupSelectionInputRequestTypeDef definition
class GetBackupSelectionInputRequestTypeDef(TypedDict):
BackupPlanId: str,
SelectionId: str,
GetBackupVaultAccessPolicyInputRequestTypeDef#
# GetBackupVaultAccessPolicyInputRequestTypeDef definition
class GetBackupVaultAccessPolicyInputRequestTypeDef(TypedDict):
BackupVaultName: str,
GetBackupVaultNotificationsInputRequestTypeDef#
# GetBackupVaultNotificationsInputRequestTypeDef definition
class GetBackupVaultNotificationsInputRequestTypeDef(TypedDict):
BackupVaultName: str,
GetLegalHoldInputRequestTypeDef#
# GetLegalHoldInputRequestTypeDef definition
class GetLegalHoldInputRequestTypeDef(TypedDict):
LegalHoldId: str,
GetRecoveryPointRestoreMetadataInputRequestTypeDef#
# GetRecoveryPointRestoreMetadataInputRequestTypeDef definition
class GetRecoveryPointRestoreMetadataInputRequestTypeDef(TypedDict):
BackupVaultName: str,
RecoveryPointArn: str,
BackupVaultAccountId: NotRequired[str],
LegalHoldTypeDef#
# LegalHoldTypeDef 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],
ListBackupJobSummariesInputRequestTypeDef#
# ListBackupJobSummariesInputRequestTypeDef definition
class ListBackupJobSummariesInputRequestTypeDef(TypedDict):
AccountId: NotRequired[str],
State: NotRequired[BackupJobStatusType], # (1)
ResourceType: NotRequired[str],
MessageCategory: NotRequired[str],
AggregationPeriod: NotRequired[AggregationPeriodType], # (2)
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListBackupPlanTemplatesInputRequestTypeDef#
# ListBackupPlanTemplatesInputRequestTypeDef definition
class ListBackupPlanTemplatesInputRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListBackupPlanVersionsInputRequestTypeDef#
# ListBackupPlanVersionsInputRequestTypeDef definition
class ListBackupPlanVersionsInputRequestTypeDef(TypedDict):
BackupPlanId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListBackupPlansInputRequestTypeDef#
# ListBackupPlansInputRequestTypeDef definition
class ListBackupPlansInputRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
IncludeDeleted: NotRequired[bool],
ListBackupSelectionsInputRequestTypeDef#
# ListBackupSelectionsInputRequestTypeDef definition
class ListBackupSelectionsInputRequestTypeDef(TypedDict):
BackupPlanId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListBackupVaultsInputRequestTypeDef#
# ListBackupVaultsInputRequestTypeDef definition
class ListBackupVaultsInputRequestTypeDef(TypedDict):
ByVaultType: NotRequired[VaultTypeType], # (1)
ByShared: NotRequired[bool],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
- See VaultTypeType
ListCopyJobSummariesInputRequestTypeDef#
# ListCopyJobSummariesInputRequestTypeDef definition
class ListCopyJobSummariesInputRequestTypeDef(TypedDict):
AccountId: NotRequired[str],
State: NotRequired[CopyJobStatusType], # (1)
ResourceType: NotRequired[str],
MessageCategory: NotRequired[str],
AggregationPeriod: NotRequired[AggregationPeriodType], # (2)
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListFrameworksInputRequestTypeDef#
# ListFrameworksInputRequestTypeDef definition
class ListFrameworksInputRequestTypeDef(TypedDict):
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListLegalHoldsInputRequestTypeDef#
# ListLegalHoldsInputRequestTypeDef definition
class ListLegalHoldsInputRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListProtectedResourcesByBackupVaultInputRequestTypeDef#
# ListProtectedResourcesByBackupVaultInputRequestTypeDef definition
class ListProtectedResourcesByBackupVaultInputRequestTypeDef(TypedDict):
BackupVaultName: str,
BackupVaultAccountId: NotRequired[str],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ProtectedResourceTypeDef#
# ProtectedResourceTypeDef definition
class ProtectedResourceTypeDef(TypedDict):
ResourceArn: NotRequired[str],
ResourceType: NotRequired[str],
LastBackupTime: NotRequired[datetime],
ResourceName: NotRequired[str],