Skip to content

BackupClient#

Index > Backup > 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:
    ...

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)
  1. See CancelLegalHoldInputRequestTypeDef

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)
    ...
  1. See BackupPlanInputTypeDef
  2. See CreateBackupPlanOutputTypeDef
# create_backup_plan method usage example with argument unpacking

kwargs: CreateBackupPlanInputRequestTypeDef = {  # (1)
    "BackupPlan": ...,
}

parent.create_backup_plan(**kwargs)
  1. See CreateBackupPlanInputRequestTypeDef

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)
    ...
  1. See BackupSelectionTypeDef
  2. See CreateBackupSelectionOutputTypeDef
# create_backup_selection method usage example with argument unpacking

kwargs: CreateBackupSelectionInputRequestTypeDef = {  # (1)
    "BackupPlanId": ...,
    "BackupSelection": ...,
}

parent.create_backup_selection(**kwargs)
  1. See CreateBackupSelectionInputRequestTypeDef

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)
    ...
  1. See CreateBackupVaultOutputTypeDef
# create_backup_vault method usage example with argument unpacking

kwargs: CreateBackupVaultInputRequestTypeDef = {  # (1)
    "BackupVaultName": ...,
}

parent.create_backup_vault(**kwargs)
  1. See CreateBackupVaultInputRequestTypeDef

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)
    ...
  1. See FrameworkControlTypeDef
  2. See CreateFrameworkOutputTypeDef
# create_framework method usage example with argument unpacking

kwargs: CreateFrameworkInputRequestTypeDef = {  # (1)
    "FrameworkName": ...,
    "FrameworkControls": ...,
}

parent.create_framework(**kwargs)
  1. See CreateFrameworkInputRequestTypeDef

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)
    ...
  1. See RecoveryPointSelectionTypeDef
  2. See CreateLegalHoldOutputTypeDef
# create_legal_hold method usage example with argument unpacking

kwargs: CreateLegalHoldInputRequestTypeDef = {  # (1)
    "Title": ...,
    "Description": ...,
}

parent.create_legal_hold(**kwargs)
  1. See CreateLegalHoldInputRequestTypeDef

create_logically_air_gapped_backup_vault#

This request creates a logical container to where backups may be copied.

Type annotations and code completion for boto3.client("backup").create_logically_air_gapped_backup_vault method. boto3 documentation

# create_logically_air_gapped_backup_vault method definition

def create_logically_air_gapped_backup_vault(
    self,
    *,
    BackupVaultName: str,
    MinRetentionDays: int,
    MaxRetentionDays: int,
    BackupVaultTags: Mapping[str, str] = ...,
    CreatorRequestId: str = ...,
) -> CreateLogicallyAirGappedBackupVaultOutputTypeDef:  # (1)
    ...
  1. See CreateLogicallyAirGappedBackupVaultOutputTypeDef
# create_logically_air_gapped_backup_vault method usage example with argument unpacking

kwargs: CreateLogicallyAirGappedBackupVaultInputRequestTypeDef = {  # (1)
    "BackupVaultName": ...,
    "MinRetentionDays": ...,
    "MaxRetentionDays": ...,
}

parent.create_logically_air_gapped_backup_vault(**kwargs)
  1. See CreateLogicallyAirGappedBackupVaultInputRequestTypeDef

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)
    ...
  1. See ReportDeliveryChannelTypeDef
  2. See ReportSettingTypeDef
  3. See CreateReportPlanOutputTypeDef
# create_report_plan method usage example with argument unpacking

kwargs: CreateReportPlanInputRequestTypeDef = {  # (1)
    "ReportPlanName": ...,
    "ReportDeliveryChannel": ...,
    "ReportSetting": ...,
}

parent.create_report_plan(**kwargs)
  1. See CreateReportPlanInputRequestTypeDef

create_restore_testing_plan#

This is the first of two steps to create a restore testing plan; once this request is successful, finish the procedure with request CreateRestoreTestingSelection.

Type annotations and code completion for boto3.client("backup").create_restore_testing_plan method. boto3 documentation

# create_restore_testing_plan method definition

def create_restore_testing_plan(
    self,
    *,
    RestoreTestingPlan: RestoreTestingPlanForCreateTypeDef,  # (1)
    CreatorRequestId: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateRestoreTestingPlanOutputTypeDef:  # (2)
    ...
  1. See RestoreTestingPlanForCreateTypeDef
  2. See CreateRestoreTestingPlanOutputTypeDef
# create_restore_testing_plan method usage example with argument unpacking

kwargs: CreateRestoreTestingPlanInputRequestTypeDef = {  # (1)
    "RestoreTestingPlan": ...,
}

parent.create_restore_testing_plan(**kwargs)
  1. See CreateRestoreTestingPlanInputRequestTypeDef

create_restore_testing_selection#

This request can be sent after CreateRestoreTestingPlan request returns successfully.

Type annotations and code completion for boto3.client("backup").create_restore_testing_selection method. boto3 documentation

# create_restore_testing_selection method definition

def create_restore_testing_selection(
    self,
    *,
    RestoreTestingPlanName: str,
    RestoreTestingSelection: RestoreTestingSelectionForCreateTypeDef,  # (1)
    CreatorRequestId: str = ...,
) -> CreateRestoreTestingSelectionOutputTypeDef:  # (2)
    ...
  1. See RestoreTestingSelectionForCreateTypeDef
  2. See CreateRestoreTestingSelectionOutputTypeDef
# create_restore_testing_selection method usage example with argument unpacking

kwargs: CreateRestoreTestingSelectionInputRequestTypeDef = {  # (1)
    "RestoreTestingPlanName": ...,
    "RestoreTestingSelection": ...,
}

parent.create_restore_testing_selection(**kwargs)
  1. See CreateRestoreTestingSelectionInputRequestTypeDef

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)
    ...
  1. See DeleteBackupPlanOutputTypeDef
# delete_backup_plan method usage example with argument unpacking

kwargs: DeleteBackupPlanInputRequestTypeDef = {  # (1)
    "BackupPlanId": ...,
}

parent.delete_backup_plan(**kwargs)
  1. See DeleteBackupPlanInputRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_backup_selection method usage example with argument unpacking

kwargs: DeleteBackupSelectionInputRequestTypeDef = {  # (1)
    "BackupPlanId": ...,
    "SelectionId": ...,
}

parent.delete_backup_selection(**kwargs)
  1. See DeleteBackupSelectionInputRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_backup_vault method usage example with argument unpacking

kwargs: DeleteBackupVaultInputRequestTypeDef = {  # (1)
    "BackupVaultName": ...,
}

parent.delete_backup_vault(**kwargs)
  1. See DeleteBackupVaultInputRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_backup_vault_access_policy method usage example with argument unpacking

kwargs: DeleteBackupVaultAccessPolicyInputRequestTypeDef = {  # (1)
    "BackupVaultName": ...,
}

parent.delete_backup_vault_access_policy(**kwargs)
  1. See DeleteBackupVaultAccessPolicyInputRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_backup_vault_lock_configuration method usage example with argument unpacking

kwargs: DeleteBackupVaultLockConfigurationInputRequestTypeDef = {  # (1)
    "BackupVaultName": ...,
}

parent.delete_backup_vault_lock_configuration(**kwargs)
  1. See DeleteBackupVaultLockConfigurationInputRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_backup_vault_notifications method usage example with argument unpacking

kwargs: DeleteBackupVaultNotificationsInputRequestTypeDef = {  # (1)
    "BackupVaultName": ...,
}

parent.delete_backup_vault_notifications(**kwargs)
  1. See DeleteBackupVaultNotificationsInputRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_framework method usage example with argument unpacking

kwargs: DeleteFrameworkInputRequestTypeDef = {  # (1)
    "FrameworkName": ...,
}

parent.delete_framework(**kwargs)
  1. See DeleteFrameworkInputRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_recovery_point method usage example with argument unpacking

kwargs: DeleteRecoveryPointInputRequestTypeDef = {  # (1)
    "BackupVaultName": ...,
    "RecoveryPointArn": ...,
}

parent.delete_recovery_point(**kwargs)
  1. See DeleteRecoveryPointInputRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_report_plan method usage example with argument unpacking

kwargs: DeleteReportPlanInputRequestTypeDef = {  # (1)
    "ReportPlanName": ...,
}

parent.delete_report_plan(**kwargs)
  1. See DeleteReportPlanInputRequestTypeDef

delete_restore_testing_plan#

This request deletes the specified restore testing plan.

Type annotations and code completion for boto3.client("backup").delete_restore_testing_plan method. boto3 documentation

# delete_restore_testing_plan method definition

def delete_restore_testing_plan(
    self,
    *,
    RestoreTestingPlanName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_restore_testing_plan method usage example with argument unpacking

kwargs: DeleteRestoreTestingPlanInputRequestTypeDef = {  # (1)
    "RestoreTestingPlanName": ...,
}

parent.delete_restore_testing_plan(**kwargs)
  1. See DeleteRestoreTestingPlanInputRequestTypeDef

delete_restore_testing_selection#

Input the Restore Testing Plan name and Restore Testing Selection name.

Type annotations and code completion for boto3.client("backup").delete_restore_testing_selection method. boto3 documentation

# delete_restore_testing_selection method definition

def delete_restore_testing_selection(
    self,
    *,
    RestoreTestingPlanName: str,
    RestoreTestingSelectionName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_restore_testing_selection method usage example with argument unpacking

kwargs: DeleteRestoreTestingSelectionInputRequestTypeDef = {  # (1)
    "RestoreTestingPlanName": ...,
    "RestoreTestingSelectionName": ...,
}

parent.delete_restore_testing_selection(**kwargs)
  1. See DeleteRestoreTestingSelectionInputRequestTypeDef

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)
    ...
  1. See DescribeBackupJobOutputTypeDef
# describe_backup_job method usage example with argument unpacking

kwargs: DescribeBackupJobInputRequestTypeDef = {  # (1)
    "BackupJobId": ...,
}

parent.describe_backup_job(**kwargs)
  1. See DescribeBackupJobInputRequestTypeDef

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,
    BackupVaultAccountId: str = ...,
) -> DescribeBackupVaultOutputTypeDef:  # (1)
    ...
  1. See DescribeBackupVaultOutputTypeDef
# describe_backup_vault method usage example with argument unpacking

kwargs: DescribeBackupVaultInputRequestTypeDef = {  # (1)
    "BackupVaultName": ...,
}

parent.describe_backup_vault(**kwargs)
  1. See DescribeBackupVaultInputRequestTypeDef

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)
    ...
  1. See DescribeCopyJobOutputTypeDef
# describe_copy_job method usage example with argument unpacking

kwargs: DescribeCopyJobInputRequestTypeDef = {  # (1)
    "CopyJobId": ...,
}

parent.describe_copy_job(**kwargs)
  1. See DescribeCopyJobInputRequestTypeDef

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)
    ...
  1. See DescribeFrameworkOutputTypeDef
# describe_framework method usage example with argument unpacking

kwargs: DescribeFrameworkInputRequestTypeDef = {  # (1)
    "FrameworkName": ...,
}

parent.describe_framework(**kwargs)
  1. See DescribeFrameworkInputRequestTypeDef

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)
    ...
  1. See DescribeGlobalSettingsOutputTypeDef

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)
    ...
  1. See DescribeProtectedResourceOutputTypeDef
# describe_protected_resource method usage example with argument unpacking

kwargs: DescribeProtectedResourceInputRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.describe_protected_resource(**kwargs)
  1. See DescribeProtectedResourceInputRequestTypeDef

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,
    BackupVaultAccountId: str = ...,
) -> DescribeRecoveryPointOutputTypeDef:  # (1)
    ...
  1. See DescribeRecoveryPointOutputTypeDef
# describe_recovery_point method usage example with argument unpacking

kwargs: DescribeRecoveryPointInputRequestTypeDef = {  # (1)
    "BackupVaultName": ...,
    "RecoveryPointArn": ...,
}

parent.describe_recovery_point(**kwargs)
  1. See DescribeRecoveryPointInputRequestTypeDef

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)
    ...
  1. See DescribeRegionSettingsOutputTypeDef

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)
    ...
  1. See DescribeReportJobOutputTypeDef
# describe_report_job method usage example with argument unpacking

kwargs: DescribeReportJobInputRequestTypeDef = {  # (1)
    "ReportJobId": ...,
}

parent.describe_report_job(**kwargs)
  1. See DescribeReportJobInputRequestTypeDef

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)
    ...
  1. See DescribeReportPlanOutputTypeDef
# describe_report_plan method usage example with argument unpacking

kwargs: DescribeReportPlanInputRequestTypeDef = {  # (1)
    "ReportPlanName": ...,
}

parent.describe_report_plan(**kwargs)
  1. See DescribeReportPlanInputRequestTypeDef

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)
    ...
  1. See DescribeRestoreJobOutputTypeDef
# describe_restore_job method usage example with argument unpacking

kwargs: DescribeRestoreJobInputRequestTypeDef = {  # (1)
    "RestoreJobId": ...,
}

parent.describe_restore_job(**kwargs)
  1. See DescribeRestoreJobInputRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# disassociate_recovery_point method usage example with argument unpacking

kwargs: DisassociateRecoveryPointInputRequestTypeDef = {  # (1)
    "BackupVaultName": ...,
    "RecoveryPointArn": ...,
}

parent.disassociate_recovery_point(**kwargs)
  1. See DisassociateRecoveryPointInputRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# disassociate_recovery_point_from_parent method usage example with argument unpacking

kwargs: DisassociateRecoveryPointFromParentInputRequestTypeDef = {  # (1)
    "BackupVaultName": ...,
    "RecoveryPointArn": ...,
}

parent.disassociate_recovery_point_from_parent(**kwargs)
  1. See DisassociateRecoveryPointFromParentInputRequestTypeDef

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)
    ...
  1. See ExportBackupPlanTemplateOutputTypeDef
# export_backup_plan_template method usage example with argument unpacking

kwargs: ExportBackupPlanTemplateInputRequestTypeDef = {  # (1)
    "BackupPlanId": ...,
}

parent.export_backup_plan_template(**kwargs)
  1. See ExportBackupPlanTemplateInputRequestTypeDef

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)
    ...
  1. See GetBackupPlanOutputTypeDef
# get_backup_plan method usage example with argument unpacking

kwargs: GetBackupPlanInputRequestTypeDef = {  # (1)
    "BackupPlanId": ...,
}

parent.get_backup_plan(**kwargs)
  1. See GetBackupPlanInputRequestTypeDef

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)
    ...
  1. See GetBackupPlanFromJSONOutputTypeDef
# get_backup_plan_from_json method usage example with argument unpacking

kwargs: GetBackupPlanFromJSONInputRequestTypeDef = {  # (1)
    "BackupPlanTemplateJson": ...,
}

parent.get_backup_plan_from_json(**kwargs)
  1. See GetBackupPlanFromJSONInputRequestTypeDef

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)
    ...
  1. See GetBackupPlanFromTemplateOutputTypeDef
# get_backup_plan_from_template method usage example with argument unpacking

kwargs: GetBackupPlanFromTemplateInputRequestTypeDef = {  # (1)
    "BackupPlanTemplateId": ...,
}

parent.get_backup_plan_from_template(**kwargs)
  1. See GetBackupPlanFromTemplateInputRequestTypeDef

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)
    ...
  1. See GetBackupSelectionOutputTypeDef
# get_backup_selection method usage example with argument unpacking

kwargs: GetBackupSelectionInputRequestTypeDef = {  # (1)
    "BackupPlanId": ...,
    "SelectionId": ...,
}

parent.get_backup_selection(**kwargs)
  1. See GetBackupSelectionInputRequestTypeDef

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)
    ...
  1. See GetBackupVaultAccessPolicyOutputTypeDef
# get_backup_vault_access_policy method usage example with argument unpacking

kwargs: GetBackupVaultAccessPolicyInputRequestTypeDef = {  # (1)
    "BackupVaultName": ...,
}

parent.get_backup_vault_access_policy(**kwargs)
  1. See GetBackupVaultAccessPolicyInputRequestTypeDef

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)
    ...
  1. See GetBackupVaultNotificationsOutputTypeDef
# get_backup_vault_notifications method usage example with argument unpacking

kwargs: GetBackupVaultNotificationsInputRequestTypeDef = {  # (1)
    "BackupVaultName": ...,
}

parent.get_backup_vault_notifications(**kwargs)
  1. See GetBackupVaultNotificationsInputRequestTypeDef

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)
    ...
  1. See GetLegalHoldOutputTypeDef
# get_legal_hold method usage example with argument unpacking

kwargs: GetLegalHoldInputRequestTypeDef = {  # (1)
    "LegalHoldId": ...,
}

parent.get_legal_hold(**kwargs)
  1. See GetLegalHoldInputRequestTypeDef

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,
    BackupVaultAccountId: str = ...,
) -> GetRecoveryPointRestoreMetadataOutputTypeDef:  # (1)
    ...
  1. See GetRecoveryPointRestoreMetadataOutputTypeDef
# get_recovery_point_restore_metadata method usage example with argument unpacking

kwargs: GetRecoveryPointRestoreMetadataInputRequestTypeDef = {  # (1)
    "BackupVaultName": ...,
    "RecoveryPointArn": ...,
}

parent.get_recovery_point_restore_metadata(**kwargs)
  1. See GetRecoveryPointRestoreMetadataInputRequestTypeDef

get_restore_job_metadata#

This request returns the metadata for the specified restore job.

Type annotations and code completion for boto3.client("backup").get_restore_job_metadata method. boto3 documentation

# get_restore_job_metadata method definition

def get_restore_job_metadata(
    self,
    *,
    RestoreJobId: str,
) -> GetRestoreJobMetadataOutputTypeDef:  # (1)
    ...
  1. See GetRestoreJobMetadataOutputTypeDef
# get_restore_job_metadata method usage example with argument unpacking

kwargs: GetRestoreJobMetadataInputRequestTypeDef = {  # (1)
    "RestoreJobId": ...,
}

parent.get_restore_job_metadata(**kwargs)
  1. See GetRestoreJobMetadataInputRequestTypeDef

get_restore_testing_inferred_metadata#

This request returns the minimal required set of metadata needed to start a restore job with secure default settings.

Type annotations and code completion for boto3.client("backup").get_restore_testing_inferred_metadata method. boto3 documentation

# get_restore_testing_inferred_metadata method definition

def get_restore_testing_inferred_metadata(
    self,
    *,
    BackupVaultName: str,
    RecoveryPointArn: str,
    BackupVaultAccountId: str = ...,
) -> GetRestoreTestingInferredMetadataOutputTypeDef:  # (1)
    ...
  1. See GetRestoreTestingInferredMetadataOutputTypeDef
# get_restore_testing_inferred_metadata method usage example with argument unpacking

kwargs: GetRestoreTestingInferredMetadataInputRequestTypeDef = {  # (1)
    "BackupVaultName": ...,
    "RecoveryPointArn": ...,
}

parent.get_restore_testing_inferred_metadata(**kwargs)
  1. See GetRestoreTestingInferredMetadataInputRequestTypeDef

get_restore_testing_plan#

Returns RestoreTestingPlan details for the specified RestoreTestingPlanName.

Type annotations and code completion for boto3.client("backup").get_restore_testing_plan method. boto3 documentation

# get_restore_testing_plan method definition

def get_restore_testing_plan(
    self,
    *,
    RestoreTestingPlanName: str,
) -> GetRestoreTestingPlanOutputTypeDef:  # (1)
    ...
  1. See GetRestoreTestingPlanOutputTypeDef
# get_restore_testing_plan method usage example with argument unpacking

kwargs: GetRestoreTestingPlanInputRequestTypeDef = {  # (1)
    "RestoreTestingPlanName": ...,
}

parent.get_restore_testing_plan(**kwargs)
  1. See GetRestoreTestingPlanInputRequestTypeDef

get_restore_testing_selection#

Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan.

Type annotations and code completion for boto3.client("backup").get_restore_testing_selection method. boto3 documentation

# get_restore_testing_selection method definition

def get_restore_testing_selection(
    self,
    *,
    RestoreTestingPlanName: str,
    RestoreTestingSelectionName: str,
) -> GetRestoreTestingSelectionOutputTypeDef:  # (1)
    ...
  1. See GetRestoreTestingSelectionOutputTypeDef
# get_restore_testing_selection method usage example with argument unpacking

kwargs: GetRestoreTestingSelectionInputRequestTypeDef = {  # (1)
    "RestoreTestingPlanName": ...,
    "RestoreTestingSelectionName": ...,
}

parent.get_restore_testing_selection(**kwargs)
  1. See GetRestoreTestingSelectionInputRequestTypeDef

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)
    ...
  1. See GetSupportedResourceTypesOutputTypeDef

list_backup_job_summaries#

This is a request for a summary of backup jobs created or running within the most recent 30 days.

Type annotations and code completion for boto3.client("backup").list_backup_job_summaries method. boto3 documentation

# list_backup_job_summaries method definition

def list_backup_job_summaries(
    self,
    *,
    AccountId: str = ...,
    State: BackupJobStatusType = ...,  # (1)
    ResourceType: str = ...,
    MessageCategory: str = ...,
    AggregationPeriod: AggregationPeriodType = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListBackupJobSummariesOutputTypeDef:  # (3)
    ...
  1. See BackupJobStatusType
  2. See AggregationPeriodType
  3. See ListBackupJobSummariesOutputTypeDef
# list_backup_job_summaries method usage example with argument unpacking

kwargs: ListBackupJobSummariesInputRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.list_backup_job_summaries(**kwargs)
  1. See ListBackupJobSummariesInputRequestTypeDef

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 = ...,
    ByMessageCategory: str = ...,
) -> ListBackupJobsOutputTypeDef:  # (2)
    ...
  1. See BackupJobStateType
  2. See ListBackupJobsOutputTypeDef
# list_backup_jobs method usage example with argument unpacking

kwargs: ListBackupJobsInputRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_backup_jobs(**kwargs)
  1. See ListBackupJobsInputRequestTypeDef

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)
    ...
  1. See ListBackupPlanTemplatesOutputTypeDef
# list_backup_plan_templates method usage example with argument unpacking

kwargs: ListBackupPlanTemplatesInputRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_backup_plan_templates(**kwargs)
  1. See ListBackupPlanTemplatesInputRequestTypeDef

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)
    ...
  1. See ListBackupPlanVersionsOutputTypeDef
# list_backup_plan_versions method usage example with argument unpacking

kwargs: ListBackupPlanVersionsInputRequestTypeDef = {  # (1)
    "BackupPlanId": ...,
}

parent.list_backup_plan_versions(**kwargs)
  1. See ListBackupPlanVersionsInputRequestTypeDef

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)
    ...
  1. See ListBackupPlansOutputTypeDef
# list_backup_plans method usage example with argument unpacking

kwargs: ListBackupPlansInputRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_backup_plans(**kwargs)
  1. See ListBackupPlansInputRequestTypeDef

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)
    ...
  1. See ListBackupSelectionsOutputTypeDef
# list_backup_selections method usage example with argument unpacking

kwargs: ListBackupSelectionsInputRequestTypeDef = {  # (1)
    "BackupPlanId": ...,
}

parent.list_backup_selections(**kwargs)
  1. See ListBackupSelectionsInputRequestTypeDef

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,
    *,
    ByVaultType: VaultTypeType = ...,  # (1)
    ByShared: bool = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListBackupVaultsOutputTypeDef:  # (2)
    ...
  1. See VaultTypeType
  2. See ListBackupVaultsOutputTypeDef
# list_backup_vaults method usage example with argument unpacking

kwargs: ListBackupVaultsInputRequestTypeDef = {  # (1)
    "ByVaultType": ...,
}

parent.list_backup_vaults(**kwargs)
  1. See ListBackupVaultsInputRequestTypeDef

list_copy_job_summaries#

This request obtains a list of copy jobs created or running within the the most recent 30 days.

Type annotations and code completion for boto3.client("backup").list_copy_job_summaries method. boto3 documentation

# list_copy_job_summaries method definition

def list_copy_job_summaries(
    self,
    *,
    AccountId: str = ...,
    State: CopyJobStatusType = ...,  # (1)
    ResourceType: str = ...,
    MessageCategory: str = ...,
    AggregationPeriod: AggregationPeriodType = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListCopyJobSummariesOutputTypeDef:  # (3)
    ...
  1. See CopyJobStatusType
  2. See AggregationPeriodType
  3. See ListCopyJobSummariesOutputTypeDef
# list_copy_job_summaries method usage example with argument unpacking

kwargs: ListCopyJobSummariesInputRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.list_copy_job_summaries(**kwargs)
  1. See ListCopyJobSummariesInputRequestTypeDef

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 = ...,
    ByMessageCategory: str = ...,
) -> ListCopyJobsOutputTypeDef:  # (2)
    ...
  1. See CopyJobStateType
  2. See ListCopyJobsOutputTypeDef
# list_copy_jobs method usage example with argument unpacking

kwargs: ListCopyJobsInputRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_copy_jobs(**kwargs)
  1. See ListCopyJobsInputRequestTypeDef

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)
    ...
  1. See ListFrameworksOutputTypeDef
# list_frameworks method usage example with argument unpacking

kwargs: ListFrameworksInputRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_frameworks(**kwargs)
  1. See ListFrameworksInputRequestTypeDef

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)
    ...
  1. See ListLegalHoldsOutputTypeDef
# list_legal_holds method usage example with argument unpacking

kwargs: ListLegalHoldsInputRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_legal_holds(**kwargs)
  1. See ListLegalHoldsInputRequestTypeDef

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)
    ...
  1. See ListProtectedResourcesOutputTypeDef
# list_protected_resources method usage example with argument unpacking

kwargs: ListProtectedResourcesInputRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_protected_resources(**kwargs)
  1. See ListProtectedResourcesInputRequestTypeDef

list_protected_resources_by_backup_vault#

This request lists the protected resources corresponding to each backup vault.

Type annotations and code completion for boto3.client("backup").list_protected_resources_by_backup_vault method. boto3 documentation

# list_protected_resources_by_backup_vault method definition

def list_protected_resources_by_backup_vault(
    self,
    *,
    BackupVaultName: str,
    BackupVaultAccountId: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListProtectedResourcesByBackupVaultOutputTypeDef:  # (1)
    ...
  1. See ListProtectedResourcesByBackupVaultOutputTypeDef
# list_protected_resources_by_backup_vault method usage example with argument unpacking

kwargs: ListProtectedResourcesByBackupVaultInputRequestTypeDef = {  # (1)
    "BackupVaultName": ...,
}

parent.list_protected_resources_by_backup_vault(**kwargs)
  1. See ListProtectedResourcesByBackupVaultInputRequestTypeDef

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,
    BackupVaultAccountId: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
    ByResourceArn: str = ...,
    ByResourceType: str = ...,
    ByBackupPlanId: str = ...,
    ByCreatedBefore: Union[datetime, str] = ...,
    ByCreatedAfter: Union[datetime, str] = ...,
    ByParentRecoveryPointArn: str = ...,
) -> ListRecoveryPointsByBackupVaultOutputTypeDef:  # (1)
    ...
  1. See ListRecoveryPointsByBackupVaultOutputTypeDef
# list_recovery_points_by_backup_vault method usage example with argument unpacking

kwargs: ListRecoveryPointsByBackupVaultInputRequestTypeDef = {  # (1)
    "BackupVaultName": ...,
}

parent.list_recovery_points_by_backup_vault(**kwargs)
  1. See ListRecoveryPointsByBackupVaultInputRequestTypeDef

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)
    ...
  1. See ListRecoveryPointsByLegalHoldOutputTypeDef
# list_recovery_points_by_legal_hold method usage example with argument unpacking

kwargs: ListRecoveryPointsByLegalHoldInputRequestTypeDef = {  # (1)
    "LegalHoldId": ...,
}

parent.list_recovery_points_by_legal_hold(**kwargs)
  1. See ListRecoveryPointsByLegalHoldInputRequestTypeDef

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 = ...,
    ManagedByAWSBackupOnly: bool = ...,
) -> ListRecoveryPointsByResourceOutputTypeDef:  # (1)
    ...
  1. See ListRecoveryPointsByResourceOutputTypeDef
# list_recovery_points_by_resource method usage example with argument unpacking

kwargs: ListRecoveryPointsByResourceInputRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_recovery_points_by_resource(**kwargs)
  1. See ListRecoveryPointsByResourceInputRequestTypeDef

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)
    ...
  1. See ListReportJobsOutputTypeDef
# list_report_jobs method usage example with argument unpacking

kwargs: ListReportJobsInputRequestTypeDef = {  # (1)
    "ByReportPlanName": ...,
}

parent.list_report_jobs(**kwargs)
  1. See ListReportJobsInputRequestTypeDef

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)
    ...
  1. See ListReportPlansOutputTypeDef
# list_report_plans method usage example with argument unpacking

kwargs: ListReportPlansInputRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_report_plans(**kwargs)
  1. See ListReportPlansInputRequestTypeDef

list_restore_job_summaries#

This request obtains a summary of restore jobs created or running within the the most recent 30 days.

Type annotations and code completion for boto3.client("backup").list_restore_job_summaries method. boto3 documentation

# list_restore_job_summaries method definition

def list_restore_job_summaries(
    self,
    *,
    AccountId: str = ...,
    State: RestoreJobStateType = ...,  # (1)
    ResourceType: str = ...,
    AggregationPeriod: AggregationPeriodType = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListRestoreJobSummariesOutputTypeDef:  # (3)
    ...
  1. See RestoreJobStateType
  2. See AggregationPeriodType
  3. See ListRestoreJobSummariesOutputTypeDef
# list_restore_job_summaries method usage example with argument unpacking

kwargs: ListRestoreJobSummariesInputRequestTypeDef = {  # (1)
    "AccountId": ...,
}

parent.list_restore_job_summaries(**kwargs)
  1. See ListRestoreJobSummariesInputRequestTypeDef

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 = ...,
    ByResourceType: str = ...,
    ByCreatedBefore: Union[datetime, str] = ...,
    ByCreatedAfter: Union[datetime, str] = ...,
    ByStatus: RestoreJobStatusType = ...,  # (1)
    ByCompleteBefore: Union[datetime, str] = ...,
    ByCompleteAfter: Union[datetime, str] = ...,
    ByRestoreTestingPlanArn: str = ...,
) -> ListRestoreJobsOutputTypeDef:  # (2)
    ...
  1. See RestoreJobStatusType
  2. See ListRestoreJobsOutputTypeDef
# list_restore_jobs method usage example with argument unpacking

kwargs: ListRestoreJobsInputRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_restore_jobs(**kwargs)
  1. See ListRestoreJobsInputRequestTypeDef

list_restore_jobs_by_protected_resource#

This returns restore jobs that contain the specified protected resource.

Type annotations and code completion for boto3.client("backup").list_restore_jobs_by_protected_resource method. boto3 documentation

# list_restore_jobs_by_protected_resource method definition

def list_restore_jobs_by_protected_resource(
    self,
    *,
    ResourceArn: str,
    ByStatus: RestoreJobStatusType = ...,  # (1)
    ByRecoveryPointCreationDateAfter: Union[datetime, str] = ...,
    ByRecoveryPointCreationDateBefore: Union[datetime, str] = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListRestoreJobsByProtectedResourceOutputTypeDef:  # (2)
    ...
  1. See RestoreJobStatusType
  2. See ListRestoreJobsByProtectedResourceOutputTypeDef
# list_restore_jobs_by_protected_resource method usage example with argument unpacking

kwargs: ListRestoreJobsByProtectedResourceInputRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_restore_jobs_by_protected_resource(**kwargs)
  1. See ListRestoreJobsByProtectedResourceInputRequestTypeDef

list_restore_testing_plans#

Returns a list of restore testing plans.

Type annotations and code completion for boto3.client("backup").list_restore_testing_plans method. boto3 documentation

# list_restore_testing_plans method definition

def list_restore_testing_plans(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListRestoreTestingPlansOutputTypeDef:  # (1)
    ...
  1. See ListRestoreTestingPlansOutputTypeDef
# list_restore_testing_plans method usage example with argument unpacking

kwargs: ListRestoreTestingPlansInputRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_restore_testing_plans(**kwargs)
  1. See ListRestoreTestingPlansInputRequestTypeDef

list_restore_testing_selections#

Returns a list of restore testing selections.

Type annotations and code completion for boto3.client("backup").list_restore_testing_selections method. boto3 documentation

# list_restore_testing_selections method definition

def list_restore_testing_selections(
    self,
    *,
    RestoreTestingPlanName: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListRestoreTestingSelectionsOutputTypeDef:  # (1)
    ...
  1. See ListRestoreTestingSelectionsOutputTypeDef
# list_restore_testing_selections method usage example with argument unpacking

kwargs: ListRestoreTestingSelectionsInputRequestTypeDef = {  # (1)
    "RestoreTestingPlanName": ...,
}

parent.list_restore_testing_selections(**kwargs)
  1. See ListRestoreTestingSelectionsInputRequestTypeDef

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)
    ...
  1. See ListTagsOutputTypeDef
# list_tags method usage example with argument unpacking

kwargs: ListTagsInputRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags(**kwargs)
  1. See ListTagsInputRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# put_backup_vault_access_policy method usage example with argument unpacking

kwargs: PutBackupVaultAccessPolicyInputRequestTypeDef = {  # (1)
    "BackupVaultName": ...,
}

parent.put_backup_vault_access_policy(**kwargs)
  1. See PutBackupVaultAccessPolicyInputRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# put_backup_vault_lock_configuration method usage example with argument unpacking

kwargs: PutBackupVaultLockConfigurationInputRequestTypeDef = {  # (1)
    "BackupVaultName": ...,
}

parent.put_backup_vault_lock_configuration(**kwargs)
  1. See PutBackupVaultLockConfigurationInputRequestTypeDef

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)
    ...
  1. See BackupVaultEventType
  2. See EmptyResponseMetadataTypeDef
# put_backup_vault_notifications method usage example with argument unpacking

kwargs: PutBackupVaultNotificationsInputRequestTypeDef = {  # (1)
    "BackupVaultName": ...,
    "SNSTopicArn": ...,
    "BackupVaultEvents": ...,
}

parent.put_backup_vault_notifications(**kwargs)
  1. See PutBackupVaultNotificationsInputRequestTypeDef

put_restore_validation_result#

This request allows you to send your independent self-run restore test validation results.

Type annotations and code completion for boto3.client("backup").put_restore_validation_result method. boto3 documentation

# put_restore_validation_result method definition

def put_restore_validation_result(
    self,
    *,
    RestoreJobId: str,
    ValidationStatus: RestoreValidationStatusType,  # (1)
    ValidationStatusMessage: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See RestoreValidationStatusType
  2. See EmptyResponseMetadataTypeDef
# put_restore_validation_result method usage example with argument unpacking

kwargs: PutRestoreValidationResultInputRequestTypeDef = {  # (1)
    "RestoreJobId": ...,
    "ValidationStatus": ...,
}

parent.put_restore_validation_result(**kwargs)
  1. See PutRestoreValidationResultInputRequestTypeDef

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)
    ...
  1. See LifecycleTypeDef
  2. See StartBackupJobOutputTypeDef
# start_backup_job method usage example with argument unpacking

kwargs: StartBackupJobInputRequestTypeDef = {  # (1)
    "BackupVaultName": ...,
    "ResourceArn": ...,
    "IamRoleArn": ...,
}

parent.start_backup_job(**kwargs)
  1. See StartBackupJobInputRequestTypeDef

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)
    ...
  1. See LifecycleTypeDef
  2. See StartCopyJobOutputTypeDef
# start_copy_job method usage example with argument unpacking

kwargs: StartCopyJobInputRequestTypeDef = {  # (1)
    "RecoveryPointArn": ...,
    "SourceBackupVaultName": ...,
    "DestinationBackupVaultArn": ...,
    "IamRoleArn": ...,
}

parent.start_copy_job(**kwargs)
  1. See StartCopyJobInputRequestTypeDef

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)
    ...
  1. See StartReportJobOutputTypeDef
# start_report_job method usage example with argument unpacking

kwargs: StartReportJobInputRequestTypeDef = {  # (1)
    "ReportPlanName": ...,
}

parent.start_report_job(**kwargs)
  1. See StartReportJobInputRequestTypeDef

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)
    ...
  1. See StartRestoreJobOutputTypeDef
# start_restore_job method usage example with argument unpacking

kwargs: StartRestoreJobInputRequestTypeDef = {  # (1)
    "RecoveryPointArn": ...,
    "Metadata": ...,
}

parent.start_restore_job(**kwargs)
  1. See StartRestoreJobInputRequestTypeDef

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. boto3 documentation

# stop_backup_job method definition

def stop_backup_job(
    self,
    *,
    BackupJobId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# stop_backup_job method usage example with argument unpacking

kwargs: StopBackupJobInputRequestTypeDef = {  # (1)
    "BackupJobId": ...,
}

parent.stop_backup_job(**kwargs)
  1. See StopBackupJobInputRequestTypeDef

tag_resource#

Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).

Type annotations and code completion for boto3.client("backup").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# tag_resource method usage example with argument unpacking

kwargs: TagResourceInputRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceInputRequestTypeDef

untag_resource#

Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN) See also: AWS API Documentation.

Type annotations and code completion for boto3.client("backup").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeyList: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceInputRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeyList": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceInputRequestTypeDef

update_backup_plan#

Updates an existing backup plan identified by its backupPlanId with the input document in JSON format.

Type annotations and code completion for boto3.client("backup").update_backup_plan method. boto3 documentation

# update_backup_plan method definition

def update_backup_plan(
    self,
    *,
    BackupPlanId: str,
    BackupPlan: BackupPlanInputTypeDef,  # (1)
) -> UpdateBackupPlanOutputTypeDef:  # (2)
    ...
  1. See BackupPlanInputTypeDef
  2. See UpdateBackupPlanOutputTypeDef
# update_backup_plan method usage example with argument unpacking

kwargs: UpdateBackupPlanInputRequestTypeDef = {  # (1)
    "BackupPlanId": ...,
    "BackupPlan": ...,
}

parent.update_backup_plan(**kwargs)
  1. See UpdateBackupPlanInputRequestTypeDef

update_framework#

Updates an existing framework identified by its FrameworkName with the input document in JSON format.

Type annotations and code completion for boto3.client("backup").update_framework method. boto3 documentation

# update_framework method definition

def update_framework(
    self,
    *,
    FrameworkName: str,
    FrameworkDescription: str = ...,
    FrameworkControls: Sequence[FrameworkControlTypeDef] = ...,  # (1)
    IdempotencyToken: str = ...,
) -> UpdateFrameworkOutputTypeDef:  # (2)
    ...
  1. See FrameworkControlTypeDef
  2. See UpdateFrameworkOutputTypeDef
# update_framework method usage example with argument unpacking

kwargs: UpdateFrameworkInputRequestTypeDef = {  # (1)
    "FrameworkName": ...,
}

parent.update_framework(**kwargs)
  1. See UpdateFrameworkInputRequestTypeDef

update_global_settings#

Updates whether the Amazon Web Services account is opted in to cross-account backup.

Type annotations and code completion for boto3.client("backup").update_global_settings method. boto3 documentation

# update_global_settings method definition

def update_global_settings(
    self,
    *,
    GlobalSettings: Mapping[str, str] = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# update_global_settings method usage example with argument unpacking

kwargs: UpdateGlobalSettingsInputRequestTypeDef = {  # (1)
    "GlobalSettings": ...,
}

parent.update_global_settings(**kwargs)
  1. See UpdateGlobalSettingsInputRequestTypeDef

update_recovery_point_lifecycle#

Sets the transition lifecycle of a recovery point.

Type annotations and code completion for boto3.client("backup").update_recovery_point_lifecycle method. boto3 documentation

# update_recovery_point_lifecycle method definition

def update_recovery_point_lifecycle(
    self,
    *,
    BackupVaultName: str,
    RecoveryPointArn: str,
    Lifecycle: LifecycleTypeDef = ...,  # (1)
) -> UpdateRecoveryPointLifecycleOutputTypeDef:  # (2)
    ...
  1. See LifecycleTypeDef
  2. See UpdateRecoveryPointLifecycleOutputTypeDef
# update_recovery_point_lifecycle method usage example with argument unpacking

kwargs: UpdateRecoveryPointLifecycleInputRequestTypeDef = {  # (1)
    "BackupVaultName": ...,
    "RecoveryPointArn": ...,
}

parent.update_recovery_point_lifecycle(**kwargs)
  1. See UpdateRecoveryPointLifecycleInputRequestTypeDef

update_region_settings#

Updates the current service opt-in settings for the Region.

Type annotations and code completion for boto3.client("backup").update_region_settings method. boto3 documentation

# update_region_settings method definition

def update_region_settings(
    self,
    *,
    ResourceTypeOptInPreference: Mapping[str, bool] = ...,
    ResourceTypeManagementPreference: Mapping[str, bool] = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# update_region_settings method usage example with argument unpacking

kwargs: UpdateRegionSettingsInputRequestTypeDef = {  # (1)
    "ResourceTypeOptInPreference": ...,
}

parent.update_region_settings(**kwargs)
  1. See UpdateRegionSettingsInputRequestTypeDef

update_report_plan#

Updates an existing report plan identified by its ReportPlanName with the input document in JSON format.

Type annotations and code completion for boto3.client("backup").update_report_plan method. boto3 documentation

# update_report_plan method definition

def update_report_plan(
    self,
    *,
    ReportPlanName: str,
    ReportPlanDescription: str = ...,
    ReportDeliveryChannel: ReportDeliveryChannelTypeDef = ...,  # (1)
    ReportSetting: ReportSettingTypeDef = ...,  # (2)
    IdempotencyToken: str = ...,
) -> UpdateReportPlanOutputTypeDef:  # (3)
    ...
  1. See ReportDeliveryChannelTypeDef
  2. See ReportSettingTypeDef
  3. See UpdateReportPlanOutputTypeDef
# update_report_plan method usage example with argument unpacking

kwargs: UpdateReportPlanInputRequestTypeDef = {  # (1)
    "ReportPlanName": ...,
}

parent.update_report_plan(**kwargs)
  1. See UpdateReportPlanInputRequestTypeDef

update_restore_testing_plan#

This request will send changes to your specified restore testing plan.

Type annotations and code completion for boto3.client("backup").update_restore_testing_plan method. boto3 documentation

# update_restore_testing_plan method definition

def update_restore_testing_plan(
    self,
    *,
    RestoreTestingPlan: RestoreTestingPlanForUpdateTypeDef,  # (1)
    RestoreTestingPlanName: str,
) -> UpdateRestoreTestingPlanOutputTypeDef:  # (2)
    ...
  1. See RestoreTestingPlanForUpdateTypeDef
  2. See UpdateRestoreTestingPlanOutputTypeDef
# update_restore_testing_plan method usage example with argument unpacking

kwargs: UpdateRestoreTestingPlanInputRequestTypeDef = {  # (1)
    "RestoreTestingPlan": ...,
    "RestoreTestingPlanName": ...,
}

parent.update_restore_testing_plan(**kwargs)
  1. See UpdateRestoreTestingPlanInputRequestTypeDef

update_restore_testing_selection#

Most elements except the RestoreTestingSelectionName can be updated with this request.

Type annotations and code completion for boto3.client("backup").update_restore_testing_selection method. boto3 documentation

# update_restore_testing_selection method definition

def update_restore_testing_selection(
    self,
    *,
    RestoreTestingPlanName: str,
    RestoreTestingSelection: RestoreTestingSelectionForUpdateTypeDef,  # (1)
    RestoreTestingSelectionName: str,
) -> UpdateRestoreTestingSelectionOutputTypeDef:  # (2)
    ...
  1. See RestoreTestingSelectionForUpdateTypeDef
  2. See UpdateRestoreTestingSelectionOutputTypeDef
# update_restore_testing_selection method usage example with argument unpacking

kwargs: UpdateRestoreTestingSelectionInputRequestTypeDef = {  # (1)
    "RestoreTestingPlanName": ...,
    "RestoreTestingSelection": ...,
    "RestoreTestingSelectionName": ...,
}

parent.update_restore_testing_selection(**kwargs)
  1. See UpdateRestoreTestingSelectionInputRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("backup").get_paginator method with overloads.