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

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.

Usage example
client = boto3.client("backup")

try:
    do_something(client)
except (
    client.AlreadyExistsException,
    client.ClientError,
    client.ConflictException,
    client.DependencyFailureException,
    client.InvalidParameterValueException,
    client.InvalidRequestException,
    client.InvalidResourceStateException,
    client.LimitExceededException,
    client.MissingParameterValueException,
    client.ResourceNotFoundException,
    client.ServiceUnavailableException,
) as e:
    print(e)
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

Method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

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

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

Method definition
def create_backup_plan(
    self,
    *,
    BackupPlan: BackupPlanInputTypeDef,  # (1)
    BackupPlanTags: Mapping[str, str] = ...,
    CreatorRequestId: str = ...,
) -> CreateBackupPlanOutputTypeDef:  # (2)
    ...
  1. See BackupPlanInputTypeDef
  2. See CreateBackupPlanOutputTypeDef
Usage example with kwargs
kwargs: CreateBackupPlanInputRequestTypeDef = {  # (1)
    "BackupPlan": ...,
}

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

create_backup_selection

.

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

Method definition
def create_backup_selection(
    self,
    *,
    BackupPlanId: str,
    BackupSelection: BackupSelectionTypeDef,  # (1)
    CreatorRequestId: str = ...,
) -> CreateBackupSelectionOutputTypeDef:  # (2)
    ...
  1. See BackupSelectionTypeDef
  2. See CreateBackupSelectionOutputTypeDef
Usage example with kwargs
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

Method definition
def create_backup_vault(
    self,
    *,
    BackupVaultName: str,
    BackupVaultTags: Mapping[str, str] = ...,
    EncryptionKeyArn: str = ...,
    CreatorRequestId: str = ...,
) -> CreateBackupVaultOutputTypeDef:  # (1)
    ...
  1. See CreateBackupVaultOutputTypeDef
Usage example with kwargs
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

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
Usage example with kwargs
kwargs: CreateFrameworkInputRequestTypeDef = {  # (1)
    "FrameworkName": ...,
    "FrameworkControls": ...,
}

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

create_report_plan

Creates a report plan.

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

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
Usage example with kwargs
kwargs: CreateReportPlanInputRequestTypeDef = {  # (1)
    "ReportPlanName": ...,
    "ReportDeliveryChannel": ...,
    "ReportSetting": ...,
}

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

delete_backup_plan

Deletes a backup plan.

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

Method definition
def delete_backup_plan(
    self,
    *,
    BackupPlanId: str,
) -> DeleteBackupPlanOutputTypeDef:  # (1)
    ...
  1. See DeleteBackupPlanOutputTypeDef
Usage example with kwargs
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

Method definition
def delete_backup_selection(
    self,
    *,
    BackupPlanId: str,
    SelectionId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
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

Method definition
def delete_backup_vault(
    self,
    *,
    BackupVaultName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
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

Method definition
def delete_backup_vault_access_policy(
    self,
    *,
    BackupVaultName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
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

Method definition
def delete_backup_vault_lock_configuration(
    self,
    *,
    BackupVaultName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
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

Method definition
def delete_backup_vault_notifications(
    self,
    *,
    BackupVaultName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
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

Method definition
def delete_framework(
    self,
    *,
    FrameworkName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
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

Method definition
def delete_recovery_point(
    self,
    *,
    BackupVaultName: str,
    RecoveryPointArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
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

Method definition
def delete_report_plan(
    self,
    *,
    ReportPlanName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteReportPlanInputRequestTypeDef = {  # (1)
    "ReportPlanName": ...,
}

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

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

Method definition
def describe_backup_job(
    self,
    *,
    BackupJobId: str,
) -> DescribeBackupJobOutputTypeDef:  # (1)
    ...
  1. See DescribeBackupJobOutputTypeDef
Usage example with kwargs
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

Method definition
def describe_backup_vault(
    self,
    *,
    BackupVaultName: str,
) -> DescribeBackupVaultOutputTypeDef:  # (1)
    ...
  1. See DescribeBackupVaultOutputTypeDef
Usage example with kwargs
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

Method definition
def describe_copy_job(
    self,
    *,
    CopyJobId: str,
) -> DescribeCopyJobOutputTypeDef:  # (1)
    ...
  1. See DescribeCopyJobOutputTypeDef
Usage example with kwargs
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

Method definition
def describe_framework(
    self,
    *,
    FrameworkName: str,
) -> DescribeFrameworkOutputTypeDef:  # (1)
    ...
  1. See DescribeFrameworkOutputTypeDef
Usage example with kwargs
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

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

Method definition
def describe_protected_resource(
    self,
    *,
    ResourceArn: str,
) -> DescribeProtectedResourceOutputTypeDef:  # (1)
    ...
  1. See DescribeProtectedResourceOutputTypeDef
Usage example with kwargs
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

Method definition
def describe_recovery_point(
    self,
    *,
    BackupVaultName: str,
    RecoveryPointArn: str,
) -> DescribeRecoveryPointOutputTypeDef:  # (1)
    ...
  1. See DescribeRecoveryPointOutputTypeDef
Usage example with kwargs
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

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

Method definition
def describe_report_job(
    self,
    *,
    ReportJobId: str,
) -> DescribeReportJobOutputTypeDef:  # (1)
    ...
  1. See DescribeReportJobOutputTypeDef
Usage example with kwargs
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

Method definition
def describe_report_plan(
    self,
    *,
    ReportPlanName: str,
) -> DescribeReportPlanOutputTypeDef:  # (1)
    ...
  1. See DescribeReportPlanOutputTypeDef
Usage example with kwargs
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

Method definition
def describe_restore_job(
    self,
    *,
    RestoreJobId: str,
) -> DescribeRestoreJobOutputTypeDef:  # (1)
    ...
  1. See DescribeRestoreJobOutputTypeDef
Usage example with kwargs
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

Method definition
def disassociate_recovery_point(
    self,
    *,
    BackupVaultName: str,
    RecoveryPointArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DisassociateRecoveryPointInputRequestTypeDef = {  # (1)
    "BackupVaultName": ...,
    "RecoveryPointArn": ...,
}

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

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

Method definition
def export_backup_plan_template(
    self,
    *,
    BackupPlanId: str,
) -> ExportBackupPlanTemplateOutputTypeDef:  # (1)
    ...
  1. See ExportBackupPlanTemplateOutputTypeDef
Usage example with kwargs
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

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

Method definition
def get_backup_plan(
    self,
    *,
    BackupPlanId: str,
    VersionId: str = ...,
) -> GetBackupPlanOutputTypeDef:  # (1)
    ...
  1. See GetBackupPlanOutputTypeDef
Usage example with kwargs
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

Method definition
def get_backup_plan_from_json(
    self,
    *,
    BackupPlanTemplateJson: str,
) -> GetBackupPlanFromJSONOutputTypeDef:  # (1)
    ...
  1. See GetBackupPlanFromJSONOutputTypeDef
Usage example with kwargs
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

Method definition
def get_backup_plan_from_template(
    self,
    *,
    BackupPlanTemplateId: str,
) -> GetBackupPlanFromTemplateOutputTypeDef:  # (1)
    ...
  1. See GetBackupPlanFromTemplateOutputTypeDef
Usage example with kwargs
kwargs: GetBackupPlanFromTemplateInputRequestTypeDef = {  # (1)
    "BackupPlanTemplateId": ...,
}

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

get_backup_selection

.

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

Method definition
def get_backup_selection(
    self,
    *,
    BackupPlanId: str,
    SelectionId: str,
) -> GetBackupSelectionOutputTypeDef:  # (1)
    ...
  1. See GetBackupSelectionOutputTypeDef
Usage example with kwargs
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

Method definition
def get_backup_vault_access_policy(
    self,
    *,
    BackupVaultName: str,
) -> GetBackupVaultAccessPolicyOutputTypeDef:  # (1)
    ...
  1. See GetBackupVaultAccessPolicyOutputTypeDef
Usage example with kwargs
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

Method definition
def get_backup_vault_notifications(
    self,
    *,
    BackupVaultName: str,
) -> GetBackupVaultNotificationsOutputTypeDef:  # (1)
    ...
  1. See GetBackupVaultNotificationsOutputTypeDef
Usage example with kwargs
kwargs: GetBackupVaultNotificationsInputRequestTypeDef = {  # (1)
    "BackupVaultName": ...,
}

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

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

Method definition
def get_recovery_point_restore_metadata(
    self,
    *,
    BackupVaultName: str,
    RecoveryPointArn: str,
) -> GetRecoveryPointRestoreMetadataOutputTypeDef:  # (1)
    ...
  1. See GetRecoveryPointRestoreMetadataOutputTypeDef
Usage example with kwargs
kwargs: GetRecoveryPointRestoreMetadataInputRequestTypeDef = {  # (1)
    "BackupVaultName": ...,
    "RecoveryPointArn": ...,
}

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

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

Method definition
def get_supported_resource_types(
    self,
) -> GetSupportedResourceTypesOutputTypeDef:  # (1)
    ...
  1. See GetSupportedResourceTypesOutputTypeDef

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

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] = ...,
) -> ListBackupJobsOutputTypeDef:  # (2)
    ...
  1. See BackupJobStateType
  2. See ListBackupJobsOutputTypeDef
Usage example with kwargs
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

Method definition
def list_backup_plan_templates(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListBackupPlanTemplatesOutputTypeDef:  # (1)
    ...
  1. See ListBackupPlanTemplatesOutputTypeDef
Usage example with kwargs
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

Method definition
def list_backup_plan_versions(
    self,
    *,
    BackupPlanId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListBackupPlanVersionsOutputTypeDef:  # (1)
    ...
  1. See ListBackupPlanVersionsOutputTypeDef
Usage example with kwargs
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

Method definition
def list_backup_plans(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    IncludeDeleted: bool = ...,
) -> ListBackupPlansOutputTypeDef:  # (1)
    ...
  1. See ListBackupPlansOutputTypeDef
Usage example with kwargs
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

Method definition
def list_backup_selections(
    self,
    *,
    BackupPlanId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListBackupSelectionsOutputTypeDef:  # (1)
    ...
  1. See ListBackupSelectionsOutputTypeDef
Usage example with kwargs
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

Method definition
def list_backup_vaults(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListBackupVaultsOutputTypeDef:  # (1)
    ...
  1. See ListBackupVaultsOutputTypeDef
Usage example with kwargs
kwargs: ListBackupVaultsInputRequestTypeDef = {  # (1)
    "NextToken": ...,
}

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

list_copy_jobs

Returns metadata about your copy jobs.

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

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] = ...,
) -> ListCopyJobsOutputTypeDef:  # (2)
    ...
  1. See CopyJobStateType
  2. See ListCopyJobsOutputTypeDef
Usage example with kwargs
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

Method definition
def list_frameworks(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListFrameworksOutputTypeDef:  # (1)
    ...
  1. See ListFrameworksOutputTypeDef
Usage example with kwargs
kwargs: ListFrameworksInputRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

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

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

Method definition
def list_protected_resources(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListProtectedResourcesOutputTypeDef:  # (1)
    ...
  1. See ListProtectedResourcesOutputTypeDef
Usage example with kwargs
kwargs: ListProtectedResourcesInputRequestTypeDef = {  # (1)
    "NextToken": ...,
}

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

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

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] = ...,
) -> ListRecoveryPointsByBackupVaultOutputTypeDef:  # (1)
    ...
  1. See ListRecoveryPointsByBackupVaultOutputTypeDef
Usage example with kwargs
kwargs: ListRecoveryPointsByBackupVaultInputRequestTypeDef = {  # (1)
    "BackupVaultName": ...,
}

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

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

Method definition
def list_recovery_points_by_resource(
    self,
    *,
    ResourceArn: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListRecoveryPointsByResourceOutputTypeDef:  # (1)
    ...
  1. See ListRecoveryPointsByResourceOutputTypeDef
Usage example with kwargs
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

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
Usage example with kwargs
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

Method definition
def list_report_plans(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListReportPlansOutputTypeDef:  # (1)
    ...
  1. See ListReportPlansOutputTypeDef
Usage example with kwargs
kwargs: ListReportPlansInputRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

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

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

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)
    ...
  1. See RestoreJobStatusType
  2. See ListRestoreJobsOutputTypeDef
Usage example with kwargs
kwargs: ListRestoreJobsInputRequestTypeDef = {  # (1)
    "NextToken": ...,
}

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

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

Method definition
def list_tags(
    self,
    *,
    ResourceArn: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListTagsOutputTypeDef:  # (1)
    ...
  1. See ListTagsOutputTypeDef
Usage example with kwargs
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

Method definition
def put_backup_vault_access_policy(
    self,
    *,
    BackupVaultName: str,
    Policy: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
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

Method definition
def put_backup_vault_lock_configuration(
    self,
    *,
    BackupVaultName: str,
    MinRetentionDays: int = ...,
    MaxRetentionDays: int = ...,
    ChangeableForDays: int = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
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

Method definition
def put_backup_vault_notifications(
    self,