BackupClient#
Auto-generated documentation for Backup type annotations stubs module mypy-boto3-backup.
BackupClient#
Type annotations and code completion for boto3.client("backup").
boto3 documentation
# BackupClient usage example
from boto3.session import Session
from mypy_boto3_backup.client import BackupClient
def get_backup_client() -> BackupClient:
return Session().client("backup")Exceptions#
boto3 client exceptions are generated in runtime.
This class provides code completion for boto3.client("backup").exceptions structure.
# Exceptions.exceptions usage example
client = boto3.client("backup")
try:
do_something(client)
except (
client.exceptions.AlreadyExistsException,
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.DependencyFailureException,
client.exceptions.InvalidParameterValueException,
client.exceptions.InvalidRequestException,
client.exceptions.InvalidResourceStateException,
client.exceptions.LimitExceededException,
client.exceptions.MissingParameterValueException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServiceUnavailableException,
) as e:
print(e)# Exceptions.exceptions type checking example
from mypy_boto3_backup.client import Exceptions
def handle_error(exc: Exceptions.AlreadyExistsException) -> None:
...Methods#
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("backup").can_paginate method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...cancel_legal_hold#
This action removes the specified legal hold on a recovery point.
Type annotations and code completion for boto3.client("backup").cancel_legal_hold method.
boto3 documentation
# cancel_legal_hold method definition
def cancel_legal_hold(
self,
*,
LegalHoldId: str,
CancelDescription: str,
RetainRecordInDays: int = ...,
) -> Dict[str, Any]:
...# cancel_legal_hold method usage example with argument unpacking
kwargs: CancelLegalHoldInputRequestTypeDef = { # (1)
"LegalHoldId": ...,
"CancelDescription": ...,
}
parent.cancel_legal_hold(**kwargs)close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("backup").close method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...create_backup_plan#
Creates a backup plan using a backup plan name and backup rules.
Type annotations and code completion for boto3.client("backup").create_backup_plan method.
boto3 documentation
# create_backup_plan method definition
def create_backup_plan(
self,
*,
BackupPlan: BackupPlanInputTypeDef, # (1)
BackupPlanTags: Mapping[str, str] = ...,
CreatorRequestId: str = ...,
) -> CreateBackupPlanOutputTypeDef: # (2)
...# create_backup_plan method usage example with argument unpacking
kwargs: CreateBackupPlanInputRequestTypeDef = { # (1)
"BackupPlan": ...,
}
parent.create_backup_plan(**kwargs)create_backup_selection#
Creates a JSON document that specifies a set of resources to assign to a backup plan.
Type annotations and code completion for boto3.client("backup").create_backup_selection method.
boto3 documentation
# create_backup_selection method definition
def create_backup_selection(
self,
*,
BackupPlanId: str,
BackupSelection: BackupSelectionTypeDef, # (1)
CreatorRequestId: str = ...,
) -> CreateBackupSelectionOutputTypeDef: # (2)
...# create_backup_selection method usage example with argument unpacking
kwargs: CreateBackupSelectionInputRequestTypeDef = { # (1)
"BackupPlanId": ...,
"BackupSelection": ...,
}
parent.create_backup_selection(**kwargs)create_backup_vault#
Creates a logical container where backups are stored.
Type annotations and code completion for boto3.client("backup").create_backup_vault method.
boto3 documentation
# create_backup_vault method definition
def create_backup_vault(
self,
*,
BackupVaultName: str,
BackupVaultTags: Mapping[str, str] = ...,
EncryptionKeyArn: str = ...,
CreatorRequestId: str = ...,
) -> CreateBackupVaultOutputTypeDef: # (1)
...# create_backup_vault method usage example with argument unpacking
kwargs: CreateBackupVaultInputRequestTypeDef = { # (1)
"BackupVaultName": ...,
}
parent.create_backup_vault(**kwargs)create_framework#
Creates a framework with one or more controls.
Type annotations and code completion for boto3.client("backup").create_framework method.
boto3 documentation
# create_framework method definition
def create_framework(
self,
*,
FrameworkName: str,
FrameworkControls: Sequence[FrameworkControlTypeDef], # (1)
FrameworkDescription: str = ...,
IdempotencyToken: str = ...,
FrameworkTags: Mapping[str, str] = ...,
) -> CreateFrameworkOutputTypeDef: # (2)
...# create_framework method usage example with argument unpacking
kwargs: CreateFrameworkInputRequestTypeDef = { # (1)
"FrameworkName": ...,
"FrameworkControls": ...,
}
parent.create_framework(**kwargs)create_legal_hold#
This action creates a legal hold on a recovery point (backup).
Type annotations and code completion for boto3.client("backup").create_legal_hold method.
boto3 documentation
# create_legal_hold method definition
def create_legal_hold(
self,
*,
Title: str,
Description: str,
IdempotencyToken: str = ...,
RecoveryPointSelection: RecoveryPointSelectionTypeDef = ..., # (1)
Tags: Mapping[str, str] = ...,
) -> CreateLegalHoldOutputTypeDef: # (2)
...# create_legal_hold method usage example with argument unpacking
kwargs: CreateLegalHoldInputRequestTypeDef = { # (1)
"Title": ...,
"Description": ...,
}
parent.create_legal_hold(**kwargs)create_report_plan#
Creates a report plan.
Type annotations and code completion for boto3.client("backup").create_report_plan method.
boto3 documentation
# create_report_plan method definition
def create_report_plan(
self,
*,
ReportPlanName: str,
ReportDeliveryChannel: ReportDeliveryChannelTypeDef, # (1)
ReportSetting: ReportSettingTypeDef, # (2)
ReportPlanDescription: str = ...,
ReportPlanTags: Mapping[str, str] = ...,
IdempotencyToken: str = ...,
) -> CreateReportPlanOutputTypeDef: # (3)
...# create_report_plan method usage example with argument unpacking
kwargs: CreateReportPlanInputRequestTypeDef = { # (1)
"ReportPlanName": ...,
"ReportDeliveryChannel": ...,
"ReportSetting": ...,
}
parent.create_report_plan(**kwargs)delete_backup_plan#
Deletes a backup plan.
Type annotations and code completion for boto3.client("backup").delete_backup_plan method.
boto3 documentation
# delete_backup_plan method definition
def delete_backup_plan(
self,
*,
BackupPlanId: str,
) -> DeleteBackupPlanOutputTypeDef: # (1)
...# delete_backup_plan method usage example with argument unpacking
kwargs: DeleteBackupPlanInputRequestTypeDef = { # (1)
"BackupPlanId": ...,
}
parent.delete_backup_plan(**kwargs)delete_backup_selection#
Deletes the resource selection associated with a backup plan that is specified
by the SelectionId.
Type annotations and code completion for boto3.client("backup").delete_backup_selection method.
boto3 documentation
# delete_backup_selection method definition
def delete_backup_selection(
self,
*,
BackupPlanId: str,
SelectionId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_backup_selection method usage example with argument unpacking
kwargs: DeleteBackupSelectionInputRequestTypeDef = { # (1)
"BackupPlanId": ...,
"SelectionId": ...,
}
parent.delete_backup_selection(**kwargs)delete_backup_vault#
Deletes the backup vault identified by its name.
Type annotations and code completion for boto3.client("backup").delete_backup_vault method.
boto3 documentation
# delete_backup_vault method definition
def delete_backup_vault(
self,
*,
BackupVaultName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_backup_vault method usage example with argument unpacking
kwargs: DeleteBackupVaultInputRequestTypeDef = { # (1)
"BackupVaultName": ...,
}
parent.delete_backup_vault(**kwargs)delete_backup_vault_access_policy#
Deletes the policy document that manages permissions on a backup vault.
Type annotations and code completion for boto3.client("backup").delete_backup_vault_access_policy method.
boto3 documentation
# delete_backup_vault_access_policy method definition
def delete_backup_vault_access_policy(
self,
*,
BackupVaultName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_backup_vault_access_policy method usage example with argument unpacking
kwargs: DeleteBackupVaultAccessPolicyInputRequestTypeDef = { # (1)
"BackupVaultName": ...,
}
parent.delete_backup_vault_access_policy(**kwargs)delete_backup_vault_lock_configuration#
Deletes Backup Vault Lock from a backup vault specified by a backup vault name.
Type annotations and code completion for boto3.client("backup").delete_backup_vault_lock_configuration method.
boto3 documentation
# delete_backup_vault_lock_configuration method definition
def delete_backup_vault_lock_configuration(
self,
*,
BackupVaultName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_backup_vault_lock_configuration method usage example with argument unpacking
kwargs: DeleteBackupVaultLockConfigurationInputRequestTypeDef = { # (1)
"BackupVaultName": ...,
}
parent.delete_backup_vault_lock_configuration(**kwargs)delete_backup_vault_notifications#
Deletes event notifications for the specified backup vault.
Type annotations and code completion for boto3.client("backup").delete_backup_vault_notifications method.
boto3 documentation
# delete_backup_vault_notifications method definition
def delete_backup_vault_notifications(
self,
*,
BackupVaultName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_backup_vault_notifications method usage example with argument unpacking
kwargs: DeleteBackupVaultNotificationsInputRequestTypeDef = { # (1)
"BackupVaultName": ...,
}
parent.delete_backup_vault_notifications(**kwargs)delete_framework#
Deletes the framework specified by a framework name.
Type annotations and code completion for boto3.client("backup").delete_framework method.
boto3 documentation
# delete_framework method definition
def delete_framework(
self,
*,
FrameworkName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_framework method usage example with argument unpacking
kwargs: DeleteFrameworkInputRequestTypeDef = { # (1)
"FrameworkName": ...,
}
parent.delete_framework(**kwargs)delete_recovery_point#
Deletes the recovery point specified by a recovery point ID.
Type annotations and code completion for boto3.client("backup").delete_recovery_point method.
boto3 documentation
# delete_recovery_point method definition
def delete_recovery_point(
self,
*,
BackupVaultName: str,
RecoveryPointArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_recovery_point method usage example with argument unpacking
kwargs: DeleteRecoveryPointInputRequestTypeDef = { # (1)
"BackupVaultName": ...,
"RecoveryPointArn": ...,
}
parent.delete_recovery_point(**kwargs)delete_report_plan#
Deletes the report plan specified by a report plan name.
Type annotations and code completion for boto3.client("backup").delete_report_plan method.
boto3 documentation
# delete_report_plan method definition
def delete_report_plan(
self,
*,
ReportPlanName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_report_plan method usage example with argument unpacking
kwargs: DeleteReportPlanInputRequestTypeDef = { # (1)
"ReportPlanName": ...,
}
parent.delete_report_plan(**kwargs)describe_backup_job#
Returns backup job details for the specified BackupJobId.
Type annotations and code completion for boto3.client("backup").describe_backup_job method.
boto3 documentation
# describe_backup_job method definition
def describe_backup_job(
self,
*,
BackupJobId: str,
) -> DescribeBackupJobOutputTypeDef: # (1)
...# describe_backup_job method usage example with argument unpacking
kwargs: DescribeBackupJobInputRequestTypeDef = { # (1)
"BackupJobId": ...,
}
parent.describe_backup_job(**kwargs)describe_backup_vault#
Returns metadata about a backup vault specified by its name.
Type annotations and code completion for boto3.client("backup").describe_backup_vault method.
boto3 documentation
# describe_backup_vault method definition
def describe_backup_vault(
self,
*,
BackupVaultName: str,
) -> DescribeBackupVaultOutputTypeDef: # (1)
...# describe_backup_vault method usage example with argument unpacking
kwargs: DescribeBackupVaultInputRequestTypeDef = { # (1)
"BackupVaultName": ...,
}
parent.describe_backup_vault(**kwargs)describe_copy_job#
Returns metadata associated with creating a copy of a resource.
Type annotations and code completion for boto3.client("backup").describe_copy_job method.
boto3 documentation
# describe_copy_job method definition
def describe_copy_job(
self,
*,
CopyJobId: str,
) -> DescribeCopyJobOutputTypeDef: # (1)
...# describe_copy_job method usage example with argument unpacking
kwargs: DescribeCopyJobInputRequestTypeDef = { # (1)
"CopyJobId": ...,
}
parent.describe_copy_job(**kwargs)describe_framework#
Returns the framework details for the specified FrameworkName.
Type annotations and code completion for boto3.client("backup").describe_framework method.
boto3 documentation
# describe_framework method definition
def describe_framework(
self,
*,
FrameworkName: str,
) -> DescribeFrameworkOutputTypeDef: # (1)
...# describe_framework method usage example with argument unpacking
kwargs: DescribeFrameworkInputRequestTypeDef = { # (1)
"FrameworkName": ...,
}
parent.describe_framework(**kwargs)describe_global_settings#
Describes whether the Amazon Web Services account is opted in to cross-account backup.
Type annotations and code completion for boto3.client("backup").describe_global_settings method.
boto3 documentation
# describe_global_settings method definition
def describe_global_settings(
self,
) -> DescribeGlobalSettingsOutputTypeDef: # (1)
...describe_protected_resource#
Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name (ARN), and the Amazon Web Services service type of the saved resource.
Type annotations and code completion for boto3.client("backup").describe_protected_resource method.
boto3 documentation
# describe_protected_resource method definition
def describe_protected_resource(
self,
*,
ResourceArn: str,
) -> DescribeProtectedResourceOutputTypeDef: # (1)
...# describe_protected_resource method usage example with argument unpacking
kwargs: DescribeProtectedResourceInputRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.describe_protected_resource(**kwargs)describe_recovery_point#
Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
Type annotations and code completion for boto3.client("backup").describe_recovery_point method.
boto3 documentation
# describe_recovery_point method definition
def describe_recovery_point(
self,
*,
BackupVaultName: str,
RecoveryPointArn: str,
) -> DescribeRecoveryPointOutputTypeDef: # (1)
...# describe_recovery_point method usage example with argument unpacking
kwargs: DescribeRecoveryPointInputRequestTypeDef = { # (1)
"BackupVaultName": ...,
"RecoveryPointArn": ...,
}
parent.describe_recovery_point(**kwargs)describe_region_settings#
Returns the current service opt-in settings for the Region.
Type annotations and code completion for boto3.client("backup").describe_region_settings method.
boto3 documentation
# describe_region_settings method definition
def describe_region_settings(
self,
) -> DescribeRegionSettingsOutputTypeDef: # (1)
...describe_report_job#
Returns the details associated with creating a report as specified by its
ReportJobId.
Type annotations and code completion for boto3.client("backup").describe_report_job method.
boto3 documentation
# describe_report_job method definition
def describe_report_job(
self,
*,
ReportJobId: str,
) -> DescribeReportJobOutputTypeDef: # (1)
...# describe_report_job method usage example with argument unpacking
kwargs: DescribeReportJobInputRequestTypeDef = { # (1)
"ReportJobId": ...,
}
parent.describe_report_job(**kwargs)describe_report_plan#
Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.
Type annotations and code completion for boto3.client("backup").describe_report_plan method.
boto3 documentation
# describe_report_plan method definition
def describe_report_plan(
self,
*,
ReportPlanName: str,
) -> DescribeReportPlanOutputTypeDef: # (1)
...# describe_report_plan method usage example with argument unpacking
kwargs: DescribeReportPlanInputRequestTypeDef = { # (1)
"ReportPlanName": ...,
}
parent.describe_report_plan(**kwargs)describe_restore_job#
Returns metadata associated with a restore job that is specified by a job ID.
Type annotations and code completion for boto3.client("backup").describe_restore_job method.
boto3 documentation
# describe_restore_job method definition
def describe_restore_job(
self,
*,
RestoreJobId: str,
) -> DescribeRestoreJobOutputTypeDef: # (1)
...# describe_restore_job method usage example with argument unpacking
kwargs: DescribeRestoreJobInputRequestTypeDef = { # (1)
"RestoreJobId": ...,
}
parent.describe_restore_job(**kwargs)disassociate_recovery_point#
Deletes the specified continuous backup recovery point from Backup and releases control of that continuous backup to the source service, such as Amazon RDS.
Type annotations and code completion for boto3.client("backup").disassociate_recovery_point method.
boto3 documentation
# disassociate_recovery_point method definition
def disassociate_recovery_point(
self,
*,
BackupVaultName: str,
RecoveryPointArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# disassociate_recovery_point method usage example with argument unpacking
kwargs: DisassociateRecoveryPointInputRequestTypeDef = { # (1)
"BackupVaultName": ...,
"RecoveryPointArn": ...,
}
parent.disassociate_recovery_point(**kwargs)disassociate_recovery_point_from_parent#
This action to a specific child (nested) recovery point removes the relationship between the specified recovery point and its parent (composite) recovery point.
Type annotations and code completion for boto3.client("backup").disassociate_recovery_point_from_parent method.
boto3 documentation
# disassociate_recovery_point_from_parent method definition
def disassociate_recovery_point_from_parent(
self,
*,
BackupVaultName: str,
RecoveryPointArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# disassociate_recovery_point_from_parent method usage example with argument unpacking
kwargs: DisassociateRecoveryPointFromParentInputRequestTypeDef = { # (1)
"BackupVaultName": ...,
"RecoveryPointArn": ...,
}
parent.disassociate_recovery_point_from_parent(**kwargs)export_backup_plan_template#
Returns the backup plan that is specified by the plan ID as a backup template.
Type annotations and code completion for boto3.client("backup").export_backup_plan_template method.
boto3 documentation
# export_backup_plan_template method definition
def export_backup_plan_template(
self,
*,
BackupPlanId: str,
) -> ExportBackupPlanTemplateOutputTypeDef: # (1)
...# export_backup_plan_template method usage example with argument unpacking
kwargs: ExportBackupPlanTemplateInputRequestTypeDef = { # (1)
"BackupPlanId": ...,
}
parent.export_backup_plan_template(**kwargs)generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("backup").generate_presigned_url method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...get_backup_plan#
Returns BackupPlan details for the specified BackupPlanId.
Type annotations and code completion for boto3.client("backup").get_backup_plan method.
boto3 documentation
# get_backup_plan method definition
def get_backup_plan(
self,
*,
BackupPlanId: str,
VersionId: str = ...,
) -> GetBackupPlanOutputTypeDef: # (1)
...# get_backup_plan method usage example with argument unpacking
kwargs: GetBackupPlanInputRequestTypeDef = { # (1)
"BackupPlanId": ...,
}
parent.get_backup_plan(**kwargs)get_backup_plan_from_json#
Returns a valid JSON document specifying a backup plan or an error.
Type annotations and code completion for boto3.client("backup").get_backup_plan_from_json method.
boto3 documentation
# get_backup_plan_from_json method definition
def get_backup_plan_from_json(
self,
*,
BackupPlanTemplateJson: str,
) -> GetBackupPlanFromJSONOutputTypeDef: # (1)
...# get_backup_plan_from_json method usage example with argument unpacking
kwargs: GetBackupPlanFromJSONInputRequestTypeDef = { # (1)
"BackupPlanTemplateJson": ...,
}
parent.get_backup_plan_from_json(**kwargs)get_backup_plan_from_template#
Returns the template specified by its templateId as a backup plan.
Type annotations and code completion for boto3.client("backup").get_backup_plan_from_template method.
boto3 documentation
# get_backup_plan_from_template method definition
def get_backup_plan_from_template(
self,
*,
BackupPlanTemplateId: str,
) -> GetBackupPlanFromTemplateOutputTypeDef: # (1)
...# get_backup_plan_from_template method usage example with argument unpacking
kwargs: GetBackupPlanFromTemplateInputRequestTypeDef = { # (1)
"BackupPlanTemplateId": ...,
}
parent.get_backup_plan_from_template(**kwargs)get_backup_selection#
Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.
Type annotations and code completion for boto3.client("backup").get_backup_selection method.
boto3 documentation
# get_backup_selection method definition
def get_backup_selection(
self,
*,
BackupPlanId: str,
SelectionId: str,
) -> GetBackupSelectionOutputTypeDef: # (1)
...# get_backup_selection method usage example with argument unpacking
kwargs: GetBackupSelectionInputRequestTypeDef = { # (1)
"BackupPlanId": ...,
"SelectionId": ...,
}
parent.get_backup_selection(**kwargs)get_backup_vault_access_policy#
Returns the access policy document that is associated with the named backup vault.
Type annotations and code completion for boto3.client("backup").get_backup_vault_access_policy method.
boto3 documentation
# get_backup_vault_access_policy method definition
def get_backup_vault_access_policy(
self,
*,
BackupVaultName: str,
) -> GetBackupVaultAccessPolicyOutputTypeDef: # (1)
...# get_backup_vault_access_policy method usage example with argument unpacking
kwargs: GetBackupVaultAccessPolicyInputRequestTypeDef = { # (1)
"BackupVaultName": ...,
}
parent.get_backup_vault_access_policy(**kwargs)get_backup_vault_notifications#
Returns event notifications for the specified backup vault.
Type annotations and code completion for boto3.client("backup").get_backup_vault_notifications method.
boto3 documentation
# get_backup_vault_notifications method definition
def get_backup_vault_notifications(
self,
*,
BackupVaultName: str,
) -> GetBackupVaultNotificationsOutputTypeDef: # (1)
...# get_backup_vault_notifications method usage example with argument unpacking
kwargs: GetBackupVaultNotificationsInputRequestTypeDef = { # (1)
"BackupVaultName": ...,
}
parent.get_backup_vault_notifications(**kwargs)get_legal_hold#
This action returns details for a specified legal hold.
Type annotations and code completion for boto3.client("backup").get_legal_hold method.
boto3 documentation
# get_legal_hold method definition
def get_legal_hold(
self,
*,
LegalHoldId: str,
) -> GetLegalHoldOutputTypeDef: # (1)
...# get_legal_hold method usage example with argument unpacking
kwargs: GetLegalHoldInputRequestTypeDef = { # (1)
"LegalHoldId": ...,
}
parent.get_legal_hold(**kwargs)get_recovery_point_restore_metadata#
Returns a set of metadata key-value pairs that were used to create the backup.
Type annotations and code completion for boto3.client("backup").get_recovery_point_restore_metadata method.
boto3 documentation
# get_recovery_point_restore_metadata method definition
def get_recovery_point_restore_metadata(
self,
*,
BackupVaultName: str,
RecoveryPointArn: str,
) -> GetRecoveryPointRestoreMetadataOutputTypeDef: # (1)
...# get_recovery_point_restore_metadata method usage example with argument unpacking
kwargs: GetRecoveryPointRestoreMetadataInputRequestTypeDef = { # (1)
"BackupVaultName": ...,
"RecoveryPointArn": ...,
}
parent.get_recovery_point_restore_metadata(**kwargs)get_supported_resource_types#
Returns the Amazon Web Services resource types supported by Backup.
Type annotations and code completion for boto3.client("backup").get_supported_resource_types method.
boto3 documentation
# get_supported_resource_types method definition
def get_supported_resource_types(
self,
) -> GetSupportedResourceTypesOutputTypeDef: # (1)
...list_backup_jobs#
Returns a list of existing backup jobs for an authenticated account for the last 30 days.
Type annotations and code completion for boto3.client("backup").list_backup_jobs method.
boto3 documentation
# list_backup_jobs method definition
def list_backup_jobs(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
ByResourceArn: str = ...,
ByState: BackupJobStateType = ..., # (1)
ByBackupVaultName: str = ...,
ByCreatedBefore: Union[datetime, str] = ...,
ByCreatedAfter: Union[datetime, str] = ...,
ByResourceType: str = ...,
ByAccountId: str = ...,
ByCompleteAfter: Union[datetime, str] = ...,
ByCompleteBefore: Union[datetime, str] = ...,
ByParentJobId: str = ...,
) -> ListBackupJobsOutputTypeDef: # (2)
...# list_backup_jobs method usage example with argument unpacking
kwargs: ListBackupJobsInputRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_backup_jobs(**kwargs)list_backup_plan_templates#
Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.
Type annotations and code completion for boto3.client("backup").list_backup_plan_templates method.
boto3 documentation
# list_backup_plan_templates method definition
def list_backup_plan_templates(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListBackupPlanTemplatesOutputTypeDef: # (1)
...# list_backup_plan_templates method usage example with argument unpacking
kwargs: ListBackupPlanTemplatesInputRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_backup_plan_templates(**kwargs)list_backup_plan_versions#
Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.
Type annotations and code completion for boto3.client("backup").list_backup_plan_versions method.
boto3 documentation
# list_backup_plan_versions method definition
def list_backup_plan_versions(
self,
*,
BackupPlanId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListBackupPlanVersionsOutputTypeDef: # (1)
...# list_backup_plan_versions method usage example with argument unpacking
kwargs: ListBackupPlanVersionsInputRequestTypeDef = { # (1)
"BackupPlanId": ...,
}
parent.list_backup_plan_versions(**kwargs)list_backup_plans#
Returns a list of all active backup plans for an authenticated account.
Type annotations and code completion for boto3.client("backup").list_backup_plans method.
boto3 documentation
# list_backup_plans method definition
def list_backup_plans(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
IncludeDeleted: bool = ...,
) -> ListBackupPlansOutputTypeDef: # (1)
...# list_backup_plans method usage example with argument unpacking
kwargs: ListBackupPlansInputRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_backup_plans(**kwargs)list_backup_selections#
Returns an array containing metadata of the resources associated with the target backup plan.
Type annotations and code completion for boto3.client("backup").list_backup_selections method.
boto3 documentation
# list_backup_selections method definition
def list_backup_selections(
self,
*,
BackupPlanId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListBackupSelectionsOutputTypeDef: # (1)
...# list_backup_selections method usage example with argument unpacking
kwargs: ListBackupSelectionsInputRequestTypeDef = { # (1)
"BackupPlanId": ...,
}
parent.list_backup_selections(**kwargs)list_backup_vaults#
Returns a list of recovery point storage containers along with information about them.
Type annotations and code completion for boto3.client("backup").list_backup_vaults method.
boto3 documentation
# list_backup_vaults method definition
def list_backup_vaults(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListBackupVaultsOutputTypeDef: # (1)
...# list_backup_vaults method usage example with argument unpacking
kwargs: ListBackupVaultsInputRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_backup_vaults(**kwargs)list_copy_jobs#
Returns metadata about your copy jobs.
Type annotations and code completion for boto3.client("backup").list_copy_jobs method.
boto3 documentation
# list_copy_jobs method definition
def list_copy_jobs(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
ByResourceArn: str = ...,
ByState: CopyJobStateType = ..., # (1)
ByCreatedBefore: Union[datetime, str] = ...,
ByCreatedAfter: Union[datetime, str] = ...,
ByResourceType: str = ...,
ByDestinationVaultArn: str = ...,
ByAccountId: str = ...,
ByCompleteBefore: Union[datetime, str] = ...,
ByCompleteAfter: Union[datetime, str] = ...,
ByParentJobId: str = ...,
) -> ListCopyJobsOutputTypeDef: # (2)
...# list_copy_jobs method usage example with argument unpacking
kwargs: ListCopyJobsInputRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_copy_jobs(**kwargs)list_frameworks#
Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.
Type annotations and code completion for boto3.client("backup").list_frameworks method.
boto3 documentation
# list_frameworks method definition
def list_frameworks(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListFrameworksOutputTypeDef: # (1)
...# list_frameworks method usage example with argument unpacking
kwargs: ListFrameworksInputRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_frameworks(**kwargs)list_legal_holds#
This action returns metadata about active and previous legal holds.
Type annotations and code completion for boto3.client("backup").list_legal_holds method.
boto3 documentation
# list_legal_holds method definition
def list_legal_holds(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListLegalHoldsOutputTypeDef: # (1)
...# list_legal_holds method usage example with argument unpacking
kwargs: ListLegalHoldsInputRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_legal_holds(**kwargs)list_protected_resources#
Returns an array of resources successfully backed up by Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.
Type annotations and code completion for boto3.client("backup").list_protected_resources method.
boto3 documentation
# list_protected_resources method definition
def list_protected_resources(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListProtectedResourcesOutputTypeDef: # (1)
...# list_protected_resources method usage example with argument unpacking
kwargs: ListProtectedResourcesInputRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_protected_resources(**kwargs)list_recovery_points_by_backup_vault#
Returns detailed information about the recovery points stored in a backup vault.
Type annotations and code completion for boto3.client("backup").list_recovery_points_by_backup_vault method.
boto3 documentation
# list_recovery_points_by_backup_vault method definition
def list_recovery_points_by_backup_vault(
self,
*,
BackupVaultName: str,
NextToken: str = ...,
MaxResults: int = ...,
ByResourceArn: str = ...,
ByResourceType: str = ...,
ByBackupPlanId: str = ...,
ByCreatedBefore: Union[datetime, str] = ...,
ByCreatedAfter: Union[datetime, str] = ...,
ByParentRecoveryPointArn: str = ...,
) -> ListRecoveryPointsByBackupVaultOutputTypeDef: # (1)
...# list_recovery_points_by_backup_vault method usage example with argument unpacking
kwargs: ListRecoveryPointsByBackupVaultInputRequestTypeDef = { # (1)
"BackupVaultName": ...,
}
parent.list_recovery_points_by_backup_vault(**kwargs)list_recovery_points_by_legal_hold#
This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.
Type annotations and code completion for boto3.client("backup").list_recovery_points_by_legal_hold method.
boto3 documentation
# list_recovery_points_by_legal_hold method definition
def list_recovery_points_by_legal_hold(
self,
*,
LegalHoldId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListRecoveryPointsByLegalHoldOutputTypeDef: # (1)
...# list_recovery_points_by_legal_hold method usage example with argument unpacking
kwargs: ListRecoveryPointsByLegalHoldInputRequestTypeDef = { # (1)
"LegalHoldId": ...,
}
parent.list_recovery_points_by_legal_hold(**kwargs)list_recovery_points_by_resource#
Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource Name (ARN).
Type annotations and code completion for boto3.client("backup").list_recovery_points_by_resource method.
boto3 documentation
# list_recovery_points_by_resource method definition
def list_recovery_points_by_resource(
self,
*,
ResourceArn: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListRecoveryPointsByResourceOutputTypeDef: # (1)
...# list_recovery_points_by_resource method usage example with argument unpacking
kwargs: ListRecoveryPointsByResourceInputRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_recovery_points_by_resource(**kwargs)list_report_jobs#
Returns details about your report jobs.
Type annotations and code completion for boto3.client("backup").list_report_jobs method.
boto3 documentation
# list_report_jobs method definition
def list_report_jobs(
self,
*,
ByReportPlanName: str = ...,
ByCreationBefore: Union[datetime, str] = ...,
ByCreationAfter: Union[datetime, str] = ...,
ByStatus: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListReportJobsOutputTypeDef: # (1)
...# list_report_jobs method usage example with argument unpacking
kwargs: ListReportJobsInputRequestTypeDef = { # (1)
"ByReportPlanName": ...,
}
parent.list_report_jobs(**kwargs)list_report_plans#
Returns a list of your report plans.
Type annotations and code completion for boto3.client("backup").list_report_plans method.
boto3 documentation
# list_report_plans method definition
def list_report_plans(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListReportPlansOutputTypeDef: # (1)
...# list_report_plans method usage example with argument unpacking
kwargs: ListReportPlansInputRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_report_plans(**kwargs)list_restore_jobs#
Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.
Type annotations and code completion for boto3.client("backup").list_restore_jobs method.
boto3 documentation
# list_restore_jobs method definition
def list_restore_jobs(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
ByAccountId: str = ...,
ByCreatedBefore: Union[datetime, str] = ...,
ByCreatedAfter: Union[datetime, str] = ...,
ByStatus: RestoreJobStatusType = ..., # (1)
ByCompleteBefore: Union[datetime, str] = ...,
ByCompleteAfter: Union[datetime, str] = ...,
) -> ListRestoreJobsOutputTypeDef: # (2)
...# list_restore_jobs method usage example with argument unpacking
kwargs: ListRestoreJobsInputRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_restore_jobs(**kwargs)list_tags#
Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.
Type annotations and code completion for boto3.client("backup").list_tags method.
boto3 documentation
# list_tags method definition
def list_tags(
self,
*,
ResourceArn: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListTagsOutputTypeDef: # (1)
...# list_tags method usage example with argument unpacking
kwargs: ListTagsInputRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags(**kwargs)put_backup_vault_access_policy#
Sets a resource-based policy that is used to manage access permissions on the target backup vault.
Type annotations and code completion for boto3.client("backup").put_backup_vault_access_policy method.
boto3 documentation
# put_backup_vault_access_policy method definition
def put_backup_vault_access_policy(
self,
*,
BackupVaultName: str,
Policy: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# put_backup_vault_access_policy method usage example with argument unpacking
kwargs: PutBackupVaultAccessPolicyInputRequestTypeDef = { # (1)
"BackupVaultName": ...,
}
parent.put_backup_vault_access_policy(**kwargs)put_backup_vault_lock_configuration#
Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or created in a backup vault.
Type annotations and code completion for boto3.client("backup").put_backup_vault_lock_configuration method.
boto3 documentation
# put_backup_vault_lock_configuration method definition
def put_backup_vault_lock_configuration(
self,
*,
BackupVaultName: str,
MinRetentionDays: int = ...,
MaxRetentionDays: int = ...,
ChangeableForDays: int = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# put_backup_vault_lock_configuration method usage example with argument unpacking
kwargs: PutBackupVaultLockConfigurationInputRequestTypeDef = { # (1)
"BackupVaultName": ...,
}
parent.put_backup_vault_lock_configuration(**kwargs)put_backup_vault_notifications#
Turns on notifications on a backup vault for the specified topic and events.
Type annotations and code completion for boto3.client("backup").put_backup_vault_notifications method.
boto3 documentation
# put_backup_vault_notifications method definition
def put_backup_vault_notifications(
self,
*,
BackupVaultName: str,
SNSTopicArn: str,
BackupVaultEvents: Sequence[BackupVaultEventType], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...# put_backup_vault_notifications method usage example with argument unpacking
kwargs: PutBackupVaultNotificationsInputRequestTypeDef = { # (1)
"BackupVaultName": ...,
"SNSTopicArn": ...,
"BackupVaultEvents": ...,
}
parent.put_backup_vault_notifications(**kwargs)start_backup_job#
Starts an on-demand backup job for the specified resource.
Type annotations and code completion for boto3.client("backup").start_backup_job method.
boto3 documentation
# start_backup_job method definition
def start_backup_job(
self,
*,
BackupVaultName: str,
ResourceArn: str,
IamRoleArn: str,
IdempotencyToken: str = ...,
StartWindowMinutes: int = ...,
CompleteWindowMinutes: int = ...,
Lifecycle: LifecycleTypeDef = ..., # (1)
RecoveryPointTags: Mapping[str, str] = ...,
BackupOptions: Mapping[str, str] = ...,
) -> StartBackupJobOutputTypeDef: # (2)
...# start_backup_job method usage example with argument unpacking
kwargs: StartBackupJobInputRequestTypeDef = { # (1)
"BackupVaultName": ...,
"ResourceArn": ...,
"IamRoleArn": ...,
}
parent.start_backup_job(**kwargs)start_copy_job#
Starts a job to create a one-time copy of the specified resource.
Type annotations and code completion for boto3.client("backup").start_copy_job method.
boto3 documentation
# start_copy_job method definition
def start_copy_job(
self,
*,
RecoveryPointArn: str,
SourceBackupVaultName: str,
DestinationBackupVaultArn: str,
IamRoleArn: str,
IdempotencyToken: str = ...,
Lifecycle: LifecycleTypeDef = ..., # (1)
) -> StartCopyJobOutputTypeDef: # (2)
...# start_copy_job method usage example with argument unpacking
kwargs: StartCopyJobInputRequestTypeDef = { # (1)
"RecoveryPointArn": ...,
"SourceBackupVaultName": ...,
"DestinationBackupVaultArn": ...,
"IamRoleArn": ...,
}
parent.start_copy_job(**kwargs)start_report_job#
Starts an on-demand report job for the specified report plan.
Type annotations and code completion for boto3.client("backup").start_report_job method.
boto3 documentation
# start_report_job method definition
def start_report_job(
self,
*,
ReportPlanName: str,
IdempotencyToken: str = ...,
) -> StartReportJobOutputTypeDef: # (1)
...# start_report_job method usage example with argument unpacking
kwargs: StartReportJobInputRequestTypeDef = { # (1)
"ReportPlanName": ...,
}
parent.start_report_job(**kwargs)start_restore_job#
Recovers the saved resource identified by an Amazon Resource Name (ARN).
Type annotations and code completion for boto3.client("backup").start_restore_job method.
boto3 documentation
# start_restore_job method definition
def start_restore_job(
self,
*,
RecoveryPointArn: str,
Metadata: Mapping[str, str],
IamRoleArn: str = ...,
IdempotencyToken: str = ...,
ResourceType: str = ...,
CopySourceTagsToRestoredResource: bool = ...,
) -> StartRestoreJobOutputTypeDef: # (1)
...# start_restore_job method usage example with argument unpacking
kwargs: StartRestoreJobInputRequestTypeDef = { # (1)
"RecoveryPointArn": ...,
"Metadata": ...,
}
parent.start_restore_job(**kwargs)stop_backup_job#
Attempts to cancel a job to create a one-time backup of a resource.
Type annotations and code completion for boto3.client("backup").stop_backup_job method.