AWSBackup (AWS SDK for Java

All Known Subinterfaces:

AWSBackupAsync

All Known Implementing Classes:

AbstractAWSBackup, AbstractAWSBackupAsync, AWSBackupAsyncClient, AWSBackupClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSBackup
```
Interface for accessing AWS Backup.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSBackup instead.

Backup
Backup is a unified backup service designed to protect Amazon Web Services services and their associated data. Backup simplifies the creation, migration, restoration, and deletion of backups, while also providing reporting and auditing.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CreateBackupPlanResult`	`createBackupPlan(CreateBackupPlanRequest createBackupPlanRequest)` Creates a backup plan using a backup plan name and backup rules.
`CreateBackupSelectionResult`	`createBackupSelection(CreateBackupSelectionRequest createBackupSelectionRequest)` Creates a JSON document that specifies a set of resources to assign to a backup plan.
`CreateBackupVaultResult`	`createBackupVault(CreateBackupVaultRequest createBackupVaultRequest)` Creates a logical container where backups are stored.
`CreateFrameworkResult`	`createFramework(CreateFrameworkRequest createFrameworkRequest)` Creates a framework with one or more controls.
`CreateReportPlanResult`	`createReportPlan(CreateReportPlanRequest createReportPlanRequest)` Creates a report plan.
`DeleteBackupPlanResult`	`deleteBackupPlan(DeleteBackupPlanRequest deleteBackupPlanRequest)` Deletes a backup plan.
`DeleteBackupSelectionResult`	`deleteBackupSelection(DeleteBackupSelectionRequest deleteBackupSelectionRequest)` Deletes the resource selection associated with a backup plan that is specified by the `SelectionId`.
`DeleteBackupVaultResult`	`deleteBackupVault(DeleteBackupVaultRequest deleteBackupVaultRequest)` Deletes the backup vault identified by its name.
`DeleteBackupVaultAccessPolicyResult`	`deleteBackupVaultAccessPolicy(DeleteBackupVaultAccessPolicyRequest deleteBackupVaultAccessPolicyRequest)` Deletes the policy document that manages permissions on a backup vault.
`DeleteBackupVaultLockConfigurationResult`	`deleteBackupVaultLockConfiguration(DeleteBackupVaultLockConfigurationRequest deleteBackupVaultLockConfigurationRequest)` Deletes Backup Vault Lock from a backup vault specified by a backup vault name.
`DeleteBackupVaultNotificationsResult`	`deleteBackupVaultNotifications(DeleteBackupVaultNotificationsRequest deleteBackupVaultNotificationsRequest)` Deletes event notifications for the specified backup vault.
`DeleteFrameworkResult`	`deleteFramework(DeleteFrameworkRequest deleteFrameworkRequest)` Deletes the framework specified by a framework name.
`DeleteRecoveryPointResult`	`deleteRecoveryPoint(DeleteRecoveryPointRequest deleteRecoveryPointRequest)` Deletes the recovery point specified by a recovery point ID.
`DeleteReportPlanResult`	`deleteReportPlan(DeleteReportPlanRequest deleteReportPlanRequest)` Deletes the report plan specified by a report plan name.
`DescribeBackupJobResult`	`describeBackupJob(DescribeBackupJobRequest describeBackupJobRequest)` Returns backup job details for the specified `BackupJobId`.
`DescribeBackupVaultResult`	`describeBackupVault(DescribeBackupVaultRequest describeBackupVaultRequest)` Returns metadata about a backup vault specified by its name.
`DescribeCopyJobResult`	`describeCopyJob(DescribeCopyJobRequest describeCopyJobRequest)` Returns metadata associated with creating a copy of a resource.
`DescribeFrameworkResult`	`describeFramework(DescribeFrameworkRequest describeFrameworkRequest)` Returns the framework details for the specified `FrameworkName`.
`DescribeGlobalSettingsResult`	`describeGlobalSettings(DescribeGlobalSettingsRequest describeGlobalSettingsRequest)` Describes whether the Amazon Web Services account is opted in to cross-account backup.
`DescribeProtectedResourceResult`	`describeProtectedResource(DescribeProtectedResourceRequest describeProtectedResourceRequest)` 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.
`DescribeRecoveryPointResult`	`describeRecoveryPoint(DescribeRecoveryPointRequest describeRecoveryPointRequest)` Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
`DescribeRegionSettingsResult`	`describeRegionSettings(DescribeRegionSettingsRequest describeRegionSettingsRequest)` Returns the current service opt-in settings for the Region.
`DescribeReportJobResult`	`describeReportJob(DescribeReportJobRequest describeReportJobRequest)` Returns the details associated with creating a report as specified by its `ReportJobId`.
`DescribeReportPlanResult`	`describeReportPlan(DescribeReportPlanRequest describeReportPlanRequest)` Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.
`DescribeRestoreJobResult`	`describeRestoreJob(DescribeRestoreJobRequest describeRestoreJobRequest)` Returns metadata associated with a restore job that is specified by a job ID.
`DisassociateRecoveryPointResult`	`disassociateRecoveryPoint(DisassociateRecoveryPointRequest disassociateRecoveryPointRequest)` Deletes the specified continuous backup recovery point from Backup and releases control of that continuous backup to the source service, such as Amazon RDS.
`ExportBackupPlanTemplateResult`	`exportBackupPlanTemplate(ExportBackupPlanTemplateRequest exportBackupPlanTemplateRequest)` Returns the backup plan that is specified by the plan ID as a backup template.
`GetBackupPlanResult`	`getBackupPlan(GetBackupPlanRequest getBackupPlanRequest)` Returns `BackupPlan` details for the specified `BackupPlanId`.
`GetBackupPlanFromJSONResult`	`getBackupPlanFromJSON(GetBackupPlanFromJSONRequest getBackupPlanFromJSONRequest)` Returns a valid JSON document specifying a backup plan or an error.
`GetBackupPlanFromTemplateResult`	`getBackupPlanFromTemplate(GetBackupPlanFromTemplateRequest getBackupPlanFromTemplateRequest)` Returns the template specified by its `templateId` as a backup plan.
`GetBackupSelectionResult`	`getBackupSelection(GetBackupSelectionRequest getBackupSelectionRequest)` Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.
`GetBackupVaultAccessPolicyResult`	`getBackupVaultAccessPolicy(GetBackupVaultAccessPolicyRequest getBackupVaultAccessPolicyRequest)` Returns the access policy document that is associated with the named backup vault.
`GetBackupVaultNotificationsResult`	`getBackupVaultNotifications(GetBackupVaultNotificationsRequest getBackupVaultNotificationsRequest)` Returns event notifications for the specified backup vault.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetRecoveryPointRestoreMetadataResult`	`getRecoveryPointRestoreMetadata(GetRecoveryPointRestoreMetadataRequest getRecoveryPointRestoreMetadataRequest)` Returns a set of metadata key-value pairs that were used to create the backup.
`GetSupportedResourceTypesResult`	`getSupportedResourceTypes(GetSupportedResourceTypesRequest getSupportedResourceTypesRequest)` Returns the Amazon Web Services resource types supported by Backup.
`ListBackupJobsResult`	`listBackupJobs(ListBackupJobsRequest listBackupJobsRequest)` Returns a list of existing backup jobs for an authenticated account for the last 30 days.
`ListBackupPlansResult`	`listBackupPlans(ListBackupPlansRequest listBackupPlansRequest)` Returns a list of all active backup plans for an authenticated account.
`ListBackupPlanTemplatesResult`	`listBackupPlanTemplates(ListBackupPlanTemplatesRequest listBackupPlanTemplatesRequest)` Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.
`ListBackupPlanVersionsResult`	`listBackupPlanVersions(ListBackupPlanVersionsRequest listBackupPlanVersionsRequest)` Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.
`ListBackupSelectionsResult`	`listBackupSelections(ListBackupSelectionsRequest listBackupSelectionsRequest)` Returns an array containing metadata of the resources associated with the target backup plan.
`ListBackupVaultsResult`	`listBackupVaults(ListBackupVaultsRequest listBackupVaultsRequest)` Returns a list of recovery point storage containers along with information about them.
`ListCopyJobsResult`	`listCopyJobs(ListCopyJobsRequest listCopyJobsRequest)` Returns metadata about your copy jobs.
`ListFrameworksResult`	`listFrameworks(ListFrameworksRequest listFrameworksRequest)` Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.
`ListProtectedResourcesResult`	`listProtectedResources(ListProtectedResourcesRequest listProtectedResourcesRequest)` 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.
`ListRecoveryPointsByBackupVaultResult`	`listRecoveryPointsByBackupVault(ListRecoveryPointsByBackupVaultRequest listRecoveryPointsByBackupVaultRequest)` Returns detailed information about the recovery points stored in a backup vault.
`ListRecoveryPointsByResourceResult`	`listRecoveryPointsByResource(ListRecoveryPointsByResourceRequest listRecoveryPointsByResourceRequest)` Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource Name (ARN).
`ListReportJobsResult`	`listReportJobs(ListReportJobsRequest listReportJobsRequest)` Returns details about your report jobs.
`ListReportPlansResult`	`listReportPlans(ListReportPlansRequest listReportPlansRequest)` Returns a list of your report plans.
`ListRestoreJobsResult`	`listRestoreJobs(ListRestoreJobsRequest listRestoreJobsRequest)` Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.
`ListTagsResult`	`listTags(ListTagsRequest listTagsRequest)` Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.
`PutBackupVaultAccessPolicyResult`	`putBackupVaultAccessPolicy(PutBackupVaultAccessPolicyRequest putBackupVaultAccessPolicyRequest)` Sets a resource-based policy that is used to manage access permissions on the target backup vault.
`PutBackupVaultLockConfigurationResult`	`putBackupVaultLockConfiguration(PutBackupVaultLockConfigurationRequest putBackupVaultLockConfigurationRequest)` Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or created in a backup vault.
`PutBackupVaultNotificationsResult`	`putBackupVaultNotifications(PutBackupVaultNotificationsRequest putBackupVaultNotificationsRequest)` Turns on notifications on a backup vault for the specified topic and events.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartBackupJobResult`	`startBackupJob(StartBackupJobRequest startBackupJobRequest)` Starts an on-demand backup job for the specified resource.
`StartCopyJobResult`	`startCopyJob(StartCopyJobRequest startCopyJobRequest)` Starts a job to create a one-time copy of the specified resource.
`StartReportJobResult`	`startReportJob(StartReportJobRequest startReportJobRequest)` Starts an on-demand report job for the specified report plan.
`StartRestoreJobResult`	`startRestoreJob(StartRestoreJobRequest startRestoreJobRequest)` Recovers the saved resource identified by an Amazon Resource Name (ARN).
`StopBackupJobResult`	`stopBackupJob(StopBackupJobRequest stopBackupJobRequest)` Attempts to cancel a job to create a one-time backup of a resource.
`TagResourceResult`	`tagResource(TagResourceRequest tagResourceRequest)` Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)
`UpdateBackupPlanResult`	`updateBackupPlan(UpdateBackupPlanRequest updateBackupPlanRequest)` Updates an existing backup plan identified by its `backupPlanId` with the input document in JSON format.
`UpdateFrameworkResult`	`updateFramework(UpdateFrameworkRequest updateFrameworkRequest)` Updates an existing framework identified by its `FrameworkName` with the input document in JSON format.
`UpdateGlobalSettingsResult`	`updateGlobalSettings(UpdateGlobalSettingsRequest updateGlobalSettingsRequest)` Updates whether the Amazon Web Services account is opted in to cross-account backup.
`UpdateRecoveryPointLifecycleResult`	`updateRecoveryPointLifecycle(UpdateRecoveryPointLifecycleRequest updateRecoveryPointLifecycleRequest)` Sets the transition lifecycle of a recovery point.
`UpdateRegionSettingsResult`	`updateRegionSettings(UpdateRegionSettingsRequest updateRegionSettingsRequest)` Updates the current service opt-in settings for the Region.
`UpdateReportPlanResult`	`updateReportPlan(UpdateReportPlanRequest updateReportPlanRequest)` Updates an existing report plan identified by its `ReportPlanName` with the input document in JSON format.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - createBackupPlan
```
CreateBackupPlanResult createBackupPlan(CreateBackupPlanRequest createBackupPlanRequest)
```
    Creates a backup plan using a backup plan name and backup rules. A backup plan is a document that contains information that Backup uses to schedule tasks that create recovery points for resources.
    
    If you call CreateBackupPlan with a plan that already exists, you receive an AlreadyExistsException exception.
    
    Parameters:
    
    createBackupPlanRequest -
    
    Returns:
    
    Result of the CreateBackupPlan operation returned by the service.
    
    Throws:
    
    LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
    
    AlreadyExistsException - The required resource already exists.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - createBackupSelection
```
CreateBackupSelectionResult createBackupSelection(CreateBackupSelectionRequest createBackupSelectionRequest)
```
    Creates a JSON document that specifies a set of resources to assign to a backup plan. For examples, see Assigning resources programmatically.
    
    Parameters:
    
    createBackupSelectionRequest -
    
    Returns:
    
    Result of the CreateBackupSelection operation returned by the service.
    
    Throws:
    
    LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
    
    AlreadyExistsException - The required resource already exists.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - createBackupVault
```
CreateBackupVaultResult createBackupVault(CreateBackupVaultRequest createBackupVaultRequest)
```
    Creates a logical container where backups are stored. A CreateBackupVault request includes a name, optionally one or more resource tags, an encryption key, and a request ID.
    
    Do not include sensitive data, such as passport numbers, in the name of a backup vault.
    
    Parameters:
    
    createBackupVaultRequest -
    
    Returns:
    
    Result of the CreateBackupVault operation returned by the service.
    
    Throws:
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
    
    AlreadyExistsException - The required resource already exists.
    
    See Also:
    
    AWS API Documentation
  - createFramework
```
CreateFrameworkResult createFramework(CreateFrameworkRequest createFrameworkRequest)
```
    Creates a framework with one or more controls. A framework is a collection of controls that you can use to evaluate your backup practices. By using pre-built customizable controls to define your policies, you can evaluate whether your backup practices comply with your policies and which resources are not yet in compliance.
    
    Parameters:
    
    createFrameworkRequest -
    
    Returns:
    
    Result of the CreateFramework operation returned by the service.
    
    Throws:
    
    AlreadyExistsException - The required resource already exists.
    
    LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - createReportPlan
```
CreateReportPlanResult createReportPlan(CreateReportPlanRequest createReportPlanRequest)
```
    Creates a report plan. A report plan is a document that contains information about the contents of the report and where Backup will deliver it.
    
    If you call CreateReportPlan with a plan that already exists, you receive an AlreadyExistsException exception.
    
    Parameters:
    
    createReportPlanRequest -
    
    Returns:
    
    Result of the CreateReportPlan operation returned by the service.
    
    Throws:
    
    AlreadyExistsException - The required resource already exists.
    
    LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    See Also:
    
    AWS API Documentation
  - deleteBackupPlan
```
DeleteBackupPlanResult deleteBackupPlan(DeleteBackupPlanRequest deleteBackupPlanRequest)
```
    Deletes a backup plan. A backup plan can only be deleted after all associated selections of resources have been deleted. Deleting a backup plan deletes the current version of a backup plan. Previous versions, if any, will still exist.
    
    Parameters:
    
    deleteBackupPlanRequest -
    
    Returns:
    
    Result of the DeleteBackupPlan operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
    
    See Also:
    
    AWS API Documentation
  - deleteBackupSelection
```
DeleteBackupSelectionResult deleteBackupSelection(DeleteBackupSelectionRequest deleteBackupSelectionRequest)
```
    Deletes the resource selection associated with a backup plan that is specified by the SelectionId.
    
    Parameters:
    
    deleteBackupSelectionRequest -
    
    Returns:
    
    Result of the DeleteBackupSelection operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - deleteBackupVault
```
DeleteBackupVaultResult deleteBackupVault(DeleteBackupVaultRequest deleteBackupVaultRequest)
```
    Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.
    
    Parameters:
    
    deleteBackupVaultRequest -
    
    Returns:
    
    Result of the DeleteBackupVault operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
    
    See Also:
    
    AWS API Documentation
  - deleteBackupVaultAccessPolicy
```
DeleteBackupVaultAccessPolicyResult deleteBackupVaultAccessPolicy(DeleteBackupVaultAccessPolicyRequest deleteBackupVaultAccessPolicyRequest)
```
    Deletes the policy document that manages permissions on a backup vault.
    
    Parameters:
    
    deleteBackupVaultAccessPolicyRequest -
    
    Returns:
    
    Result of the DeleteBackupVaultAccessPolicy operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - deleteBackupVaultLockConfiguration
```
DeleteBackupVaultLockConfigurationResult deleteBackupVaultLockConfiguration(DeleteBackupVaultLockConfigurationRequest deleteBackupVaultLockConfigurationRequest)
```
    Deletes Backup Vault Lock from a backup vault specified by a backup vault name.
    
    If the Vault Lock configuration is immutable, then you cannot delete Vault Lock using API operations, and you will receive an InvalidRequestException if you attempt to do so. For more information, see Vault Lock in the Backup Developer Guide.
    
    Parameters:
    
    deleteBackupVaultLockConfigurationRequest -
    
    Returns:
    
    Result of the DeleteBackupVaultLockConfiguration operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - deleteBackupVaultNotifications
```
DeleteBackupVaultNotificationsResult deleteBackupVaultNotifications(DeleteBackupVaultNotificationsRequest deleteBackupVaultNotificationsRequest)
```
    Deletes event notifications for the specified backup vault.
    
    Parameters:
    
    deleteBackupVaultNotificationsRequest -
    
    Returns:
    
    Result of the DeleteBackupVaultNotifications operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - deleteFramework
```
DeleteFrameworkResult deleteFramework(DeleteFrameworkRequest deleteFrameworkRequest)
```
    Deletes the framework specified by a framework name.
    
    Parameters:
    
    deleteFrameworkRequest -
    
    Returns:
    
    Result of the DeleteFramework operation returned by the service.
    
    Throws:
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    ConflictException - Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    See Also:
    
    AWS API Documentation
  - deleteRecoveryPoint
```
DeleteRecoveryPointResult deleteRecoveryPoint(DeleteRecoveryPointRequest deleteRecoveryPointRequest)
```
    Deletes the recovery point specified by a recovery point ID.
    
    If the recovery point ID belongs to a continuous backup, calling this endpoint deletes the existing continuous backup and stops future continuous backup.
    
    Parameters:
    
    deleteRecoveryPointRequest -
    
    Returns:
    
    Result of the DeleteRecoveryPoint operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    InvalidResourceStateException - Backup is already performing an action on this recovery point. It can't perform the action you requested until the first action finishes. Try again later.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
    
    See Also:
    
    AWS API Documentation
  - deleteReportPlan
```
DeleteReportPlanResult deleteReportPlan(DeleteReportPlanRequest deleteReportPlanRequest)
```
    Deletes the report plan specified by a report plan name.
    
    Parameters:
    
    deleteReportPlanRequest -
    
    Returns:
    
    Result of the DeleteReportPlan operation returned by the service.
    
    Throws:
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    ConflictException - Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    See Also:
    
    AWS API Documentation
  - describeBackupJob
```
DescribeBackupJobResult describeBackupJob(DescribeBackupJobRequest describeBackupJobRequest)
```
    Returns backup job details for the specified BackupJobId.
    
    Parameters:
    
    describeBackupJobRequest -
    
    Returns:
    
    Result of the DescribeBackupJob operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    DependencyFailureException - A dependent Amazon Web Services service or resource returned an error to the Backup service, and the action cannot be completed.
    
    See Also:
    
    AWS API Documentation
  - describeBackupVault
```
DescribeBackupVaultResult describeBackupVault(DescribeBackupVaultRequest describeBackupVaultRequest)
```
    Returns metadata about a backup vault specified by its name.
    
    Parameters:
    
    describeBackupVaultRequest -
    
    Returns:
    
    Result of the DescribeBackupVault operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - describeCopyJob
```
DescribeCopyJobResult describeCopyJob(DescribeCopyJobRequest describeCopyJobRequest)
```
    Returns metadata associated with creating a copy of a resource.
    
    Parameters:
    
    describeCopyJobRequest -
    
    Returns:
    
    Result of the DescribeCopyJob operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - describeFramework
```
DescribeFrameworkResult describeFramework(DescribeFrameworkRequest describeFrameworkRequest)
```
    Returns the framework details for the specified FrameworkName.
    
    Parameters:
    
    describeFrameworkRequest -
    
    Returns:
    
    Result of the DescribeFramework operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - describeGlobalSettings
```
DescribeGlobalSettingsResult describeGlobalSettings(DescribeGlobalSettingsRequest describeGlobalSettingsRequest)
```
    Describes whether the Amazon Web Services account is opted in to cross-account backup. Returns an error if the account is not a member of an Organizations organization. Example: describe-global-settings --region us-west-2
    
    Parameters:
    
    describeGlobalSettingsRequest -
    
    Returns:
    
    Result of the DescribeGlobalSettings operation returned by the service.
    
    Throws:
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - describeProtectedResource
```
DescribeProtectedResourceResult describeProtectedResource(DescribeProtectedResourceRequest describeProtectedResourceRequest)
```
    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.
    
    Parameters:
    
    describeProtectedResourceRequest -
    
    Returns:
    
    Result of the DescribeProtectedResource operation returned by the service.
    
    Throws:
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    See Also:
    
    AWS API Documentation
  - describeRecoveryPoint
```
DescribeRecoveryPointResult describeRecoveryPoint(DescribeRecoveryPointRequest describeRecoveryPointRequest)
```
    Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
    
    Parameters:
    
    describeRecoveryPointRequest -
    
    Returns:
    
    Result of the DescribeRecoveryPoint operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - describeRegionSettings
```
DescribeRegionSettingsResult describeRegionSettings(DescribeRegionSettingsRequest describeRegionSettingsRequest)
```
    Returns the current service opt-in settings for the Region. If service opt-in is enabled for a service, Backup tries to protect that service's resources in this Region, when the resource is included in an on-demand backup or scheduled backup plan. Otherwise, Backup does not try to protect that service's resources in this Region.
    
    Parameters:
    
    describeRegionSettingsRequest -
    
    Returns:
    
    Result of the DescribeRegionSettings operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - describeReportJob
```
DescribeReportJobResult describeReportJob(DescribeReportJobRequest describeReportJobRequest)
```
    Returns the details associated with creating a report as specified by its ReportJobId.
    
    Parameters:
    
    describeReportJobRequest -
    
    Returns:
    
    Result of the DescribeReportJob operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    See Also:
    
    AWS API Documentation
  - describeReportPlan
```
DescribeReportPlanResult describeReportPlan(DescribeReportPlanRequest describeReportPlanRequest)
```
    Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.
    
    Parameters:
    
    describeReportPlanRequest -
    
    Returns:
    
    Result of the DescribeReportPlan operation returned by the service.
    
    Throws:
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - describeRestoreJob
```
DescribeRestoreJobResult describeRestoreJob(DescribeRestoreJobRequest describeRestoreJobRequest)
```
    Returns metadata associated with a restore job that is specified by a job ID.
    
    Parameters:
    
    describeRestoreJobRequest -
    
    Returns:
    
    Result of the DescribeRestoreJob operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    DependencyFailureException - A dependent Amazon Web Services service or resource returned an error to the Backup service, and the action cannot be completed.
    
    See Also:
    
    AWS API Documentation
  - disassociateRecoveryPoint
```
DisassociateRecoveryPointResult disassociateRecoveryPoint(DisassociateRecoveryPointRequest disassociateRecoveryPointRequest)
```
    Deletes the specified continuous backup recovery point from Backup and releases control of that continuous backup to the source service, such as Amazon RDS. The source service will continue to create and retain continuous backups using the lifecycle that you specified in your original backup plan.
    
    Does not support snapshot backup recovery points.
    
    Parameters:
    
    disassociateRecoveryPointRequest -
    
    Returns:
    
    Result of the DisassociateRecoveryPoint operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    InvalidResourceStateException - Backup is already performing an action on this recovery point. It can't perform the action you requested until the first action finishes. Try again later.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
    
    See Also:
    
    AWS API Documentation
  - exportBackupPlanTemplate
```
ExportBackupPlanTemplateResult exportBackupPlanTemplate(ExportBackupPlanTemplateRequest exportBackupPlanTemplateRequest)
```
    Returns the backup plan that is specified by the plan ID as a backup template.
    
    Parameters:
    
    exportBackupPlanTemplateRequest -
    
    Returns:
    
    Result of the ExportBackupPlanTemplate operation returned by the service.
    
    Throws:
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    See Also:
    
    AWS API Documentation
  - getBackupPlan
```
GetBackupPlanResult getBackupPlan(GetBackupPlanRequest getBackupPlanRequest)
```
    Returns BackupPlan details for the specified BackupPlanId. The details are the body of a backup plan in JSON format, in addition to plan metadata.
    
    Parameters:
    
    getBackupPlanRequest -
    
    Returns:
    
    Result of the GetBackupPlan operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - getBackupPlanFromJSON
```
GetBackupPlanFromJSONResult getBackupPlanFromJSON(GetBackupPlanFromJSONRequest getBackupPlanFromJSONRequest)
```
    Returns a valid JSON document specifying a backup plan or an error.
    
    Parameters:
    
    getBackupPlanFromJSONRequest -
    
    Returns:
    
    Result of the GetBackupPlanFromJSON operation returned by the service.
    
    Throws:
    
    LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
    
    See Also:
    
    AWS API Documentation
  - getBackupPlanFromTemplate
```
GetBackupPlanFromTemplateResult getBackupPlanFromTemplate(GetBackupPlanFromTemplateRequest getBackupPlanFromTemplateRequest)
```
    Returns the template specified by its templateId as a backup plan.
    
    Parameters:
    
    getBackupPlanFromTemplateRequest -
    
    Returns:
    
    Result of the GetBackupPlanFromTemplate operation returned by the service.
    
    Throws:
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    See Also:
    
    AWS API Documentation
  - getBackupSelection
```
GetBackupSelectionResult getBackupSelection(GetBackupSelectionRequest getBackupSelectionRequest)
```
    Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.
    
    Parameters:
    
    getBackupSelectionRequest -
    
    Returns:
    
    Result of the GetBackupSelection operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - getBackupVaultAccessPolicy
```
GetBackupVaultAccessPolicyResult getBackupVaultAccessPolicy(GetBackupVaultAccessPolicyRequest getBackupVaultAccessPolicyRequest)
```
    Returns the access policy document that is associated with the named backup vault.
    
    Parameters:
    
    getBackupVaultAccessPolicyRequest -
    
    Returns:
    
    Result of the GetBackupVaultAccessPolicy operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - getBackupVaultNotifications
```
GetBackupVaultNotificationsResult getBackupVaultNotifications(GetBackupVaultNotificationsRequest getBackupVaultNotificationsRequest)
```
    Returns event notifications for the specified backup vault.
    
    Parameters:
    
    getBackupVaultNotificationsRequest -
    
    Returns:
    
    Result of the GetBackupVaultNotifications operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - getRecoveryPointRestoreMetadata
```
GetRecoveryPointRestoreMetadataResult getRecoveryPointRestoreMetadata(GetRecoveryPointRestoreMetadataRequest getRecoveryPointRestoreMetadataRequest)
```
    Returns a set of metadata key-value pairs that were used to create the backup.
    
    Parameters:
    
    getRecoveryPointRestoreMetadataRequest -
    
    Returns:
    
    Result of the GetRecoveryPointRestoreMetadata operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - getSupportedResourceTypes
```
GetSupportedResourceTypesResult getSupportedResourceTypes(GetSupportedResourceTypesRequest getSupportedResourceTypesRequest)
```
    Returns the Amazon Web Services resource types supported by Backup.
    
    Parameters:
    
    getSupportedResourceTypesRequest -
    
    Returns:
    
    Result of the GetSupportedResourceTypes operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - listBackupJobs
```
ListBackupJobsResult listBackupJobs(ListBackupJobsRequest listBackupJobsRequest)
```
    Returns a list of existing backup jobs for an authenticated account for the last 30 days. For a longer period of time, consider using these monitoring tools.
    
    Parameters:
    
    listBackupJobsRequest -
    
    Returns:
    
    Result of the ListBackupJobs operation returned by the service.
    
    Throws:
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - listBackupPlanTemplates
```
ListBackupPlanTemplatesResult listBackupPlanTemplates(ListBackupPlanTemplatesRequest listBackupPlanTemplatesRequest)
```
    Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.
    
    Parameters:
    
    listBackupPlanTemplatesRequest -
    
    Returns:
    
    Result of the ListBackupPlanTemplates operation returned by the service.
    
    Throws:
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    See Also:
    
    AWS API Documentation
  - listBackupPlanVersions
```
ListBackupPlanVersionsResult listBackupPlanVersions(ListBackupPlanVersionsRequest listBackupPlanVersionsRequest)
```
    Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.
    
    Parameters:
    
    listBackupPlanVersionsRequest -
    
    Returns:
    
    Result of the ListBackupPlanVersions operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - listBackupPlans
```
ListBackupPlansResult listBackupPlans(ListBackupPlansRequest listBackupPlansRequest)
```
    Returns a list of all active backup plans for an authenticated account. The list contains information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.
    
    Parameters:
    
    listBackupPlansRequest -
    
    Returns:
    
    Result of the ListBackupPlans operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - listBackupSelections
```
ListBackupSelectionsResult listBackupSelections(ListBackupSelectionsRequest listBackupSelectionsRequest)
```
    Returns an array containing metadata of the resources associated with the target backup plan.
    
    Parameters:
    
    listBackupSelectionsRequest -
    
    Returns:
    
    Result of the ListBackupSelections operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - listBackupVaults
```
ListBackupVaultsResult listBackupVaults(ListBackupVaultsRequest listBackupVaultsRequest)
```
    Returns a list of recovery point storage containers along with information about them.
    
    Parameters:
    
    listBackupVaultsRequest -
    
    Returns:
    
    Result of the ListBackupVaults operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - listCopyJobs
```
ListCopyJobsResult listCopyJobs(ListCopyJobsRequest listCopyJobsRequest)
```
    Returns metadata about your copy jobs.
    
    Parameters:
    
    listCopyJobsRequest -
    
    Returns:
    
    Result of the ListCopyJobs operation returned by the service.
    
    Throws:
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - listFrameworks
```
ListFrameworksResult listFrameworks(ListFrameworksRequest listFrameworksRequest)
```
    Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.
    
    Parameters:
    
    listFrameworksRequest -
    
    Returns:
    
    Result of the ListFrameworks operation returned by the service.
    
    Throws:
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - listProtectedResources
```
ListProtectedResourcesResult listProtectedResources(ListProtectedResourcesRequest listProtectedResourcesRequest)
```
    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.
    
    Parameters:
    
    listProtectedResourcesRequest -
    
    Returns:
    
    Result of the ListProtectedResources operation returned by the service.
    
    Throws:
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - listRecoveryPointsByBackupVault
```
ListRecoveryPointsByBackupVaultResult listRecoveryPointsByBackupVault(ListRecoveryPointsByBackupVaultRequest listRecoveryPointsByBackupVaultRequest)
```
    Returns detailed information about the recovery points stored in a backup vault.
    
    Parameters:
    
    listRecoveryPointsByBackupVaultRequest -
    
    Returns:
    
    Result of the ListRecoveryPointsByBackupVault operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - listRecoveryPointsByResource
```
ListRecoveryPointsByResourceResult listRecoveryPointsByResource(ListRecoveryPointsByResourceRequest listRecoveryPointsByResourceRequest)
```
    Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource Name (ARN).
    
    For Amazon EFS and Amazon EC2, this action only lists recovery points created by Backup.
    
    Parameters:
    
    listRecoveryPointsByResourceRequest -
    
    Returns:
    
    Result of the ListRecoveryPointsByResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - listReportJobs
```
ListReportJobsResult listReportJobs(ListReportJobsRequest listReportJobsRequest)
```
    Returns details about your report jobs.
    
    Parameters:
    
    listReportJobsRequest -
    
    Returns:
    
    Result of the ListReportJobs operation returned by the service.
    
    Throws:
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - listReportPlans
```
ListReportPlansResult listReportPlans(ListReportPlansRequest listReportPlansRequest)
```
    Returns a list of your report plans. For detailed information about a single report plan, use DescribeReportPlan.
    
    Parameters:
    
    listReportPlansRequest -
    
    Returns:
    
    Result of the ListReportPlans operation returned by the service.
    
    Throws:
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - listRestoreJobs
```
ListRestoreJobsResult listRestoreJobs(ListRestoreJobsRequest listRestoreJobsRequest)
```
    Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.
    
    Parameters:
    
    listRestoreJobsRequest -
    
    Returns:
    
    Result of the ListRestoreJobs operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - listTags
```
ListTagsResult listTags(ListTagsRequest listTagsRequest)
```
    Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.
    
    ListTags only works for resource types that support full Backup management of their backups. Those resource types are listed in the "Full Backup management" section of the Feature availability by resource table.
    
    Parameters:
    
    listTagsRequest -
    
    Returns:
    
    Result of the ListTags operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - putBackupVaultAccessPolicy
```
PutBackupVaultAccessPolicyResult putBackupVaultAccessPolicy(PutBackupVaultAccessPolicyRequest putBackupVaultAccessPolicyRequest)
```
    Sets a resource-based policy that is used to manage access permissions on the target backup vault. Requires a backup vault name and an access policy document in JSON format.
    
    Parameters:
    
    putBackupVaultAccessPolicyRequest -
    
    Returns:
    
    Result of the PutBackupVaultAccessPolicy operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - putBackupVaultLockConfiguration
```
PutBackupVaultLockConfigurationResult putBackupVaultLockConfiguration(PutBackupVaultLockConfigurationRequest putBackupVaultLockConfigurationRequest)
```
    Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or created in a backup vault. Vault Lock also prevents attempts to update the lifecycle policy that controls the retention period of any recovery point currently stored in a backup vault. If specified, Vault Lock enforces a minimum and maximum retention period for future backup and copy jobs that target a backup vault.
    
    Backup Vault Lock has yet to receive a third-party assessment for SEC 17a-4(f) and CFTC.
    
    Parameters:
    
    putBackupVaultLockConfigurationRequest -
    
    Returns:
    
    Result of the PutBackupVaultLockConfiguration operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - putBackupVaultNotifications
```
PutBackupVaultNotificationsResult putBackupVaultNotifications(PutBackupVaultNotificationsRequest putBackupVaultNotificationsRequest)
```
    Turns on notifications on a backup vault for the specified topic and events.
    
    Parameters:
    
    putBackupVaultNotificationsRequest -
    
    Returns:
    
    Result of the PutBackupVaultNotifications operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - startBackupJob
```
StartBackupJobResult startBackupJob(StartBackupJobRequest startBackupJobRequest)
```
    Starts an on-demand backup job for the specified resource.
    
    Parameters:
    
    startBackupJobRequest -
    
    Returns:
    
    Result of the StartBackupJob operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
    
    See Also:
    
    AWS API Documentation
  - startCopyJob
```
StartCopyJobResult startCopyJob(StartCopyJobRequest startCopyJobRequest)
```
    Starts a job to create a one-time copy of the specified resource.
    
    Does not support continuous backups.
    
    Parameters:
    
    startCopyJobRequest -
    
    Returns:
    
    Result of the StartCopyJob operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
    
    See Also:
    
    AWS API Documentation
  - startReportJob
```
StartReportJobResult startReportJob(StartReportJobRequest startReportJobRequest)
```
    Starts an on-demand report job for the specified report plan.
    
    Parameters:
    
    startReportJobRequest -
    
    Returns:
    
    Result of the StartReportJob operation returned by the service.
    
    Throws:
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    See Also:
    
    AWS API Documentation
  - startRestoreJob
```
StartRestoreJobResult startRestoreJob(StartRestoreJobRequest startRestoreJobRequest)
```
    Recovers the saved resource identified by an Amazon Resource Name (ARN).
    
    Parameters:
    
    startRestoreJobRequest -
    
    Returns:
    
    Result of the StartRestoreJob operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - stopBackupJob
```
StopBackupJobResult stopBackupJob(StopBackupJobRequest stopBackupJobRequest)
```
    Attempts to cancel a job to create a one-time backup of a resource.
    
    Parameters:
    
    stopBackupJobRequest -
    
    Returns:
    
    Result of the StopBackupJob operation returned by the service.
    
    Throws:
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - updateBackupPlan
```
UpdateBackupPlanResult updateBackupPlan(UpdateBackupPlanRequest updateBackupPlanRequest)
```
    Updates an existing backup plan identified by its backupPlanId with the input document in JSON format. The new version is uniquely identified by a VersionId.
    
    Parameters:
    
    updateBackupPlanRequest -
    
    Returns:
    
    Result of the UpdateBackupPlan operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - updateFramework
```
UpdateFrameworkResult updateFramework(UpdateFrameworkRequest updateFrameworkRequest)
```
    Updates an existing framework identified by its FrameworkName with the input document in JSON format.
    
    Parameters:
    
    updateFrameworkRequest -
    
    Returns:
    
    Result of the UpdateFramework operation returned by the service.
    
    Throws:
    
    AlreadyExistsException - The required resource already exists.
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ConflictException - Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - updateGlobalSettings
```
UpdateGlobalSettingsResult updateGlobalSettings(UpdateGlobalSettingsRequest updateGlobalSettingsRequest)
```
    Updates whether the Amazon Web Services account is opted in to cross-account backup. Returns an error if the account is not an Organizations management account. Use the DescribeGlobalSettings API to determine the current settings.
    
    Parameters:
    
    updateGlobalSettingsRequest -
    
    Returns:
    
    Result of the UpdateGlobalSettings operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
    
    See Also:
    
    AWS API Documentation
  - updateRecoveryPointLifecycle
```
UpdateRecoveryPointLifecycleResult updateRecoveryPointLifecycle(UpdateRecoveryPointLifecycleRequest updateRecoveryPointLifecycleRequest)
```
    Sets the transition lifecycle of a recovery point.
    
    The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.
    
    Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
    
    Only resource types that support full Backup management can transition their backups to cold storage. Those resource types are listed in the "Full Backup management" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
    
    This operation does not support continuous backups.
    
    Parameters:
    
    updateRecoveryPointLifecycleRequest -
    
    Returns:
    
    Result of the UpdateRecoveryPointLifecycle operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - updateRegionSettings
```
UpdateRegionSettingsResult updateRegionSettings(UpdateRegionSettingsRequest updateRegionSettingsRequest)
```
    Updates the current service opt-in settings for the Region. If service-opt-in is enabled for a service, Backup tries to protect that service's resources in this Region, when the resource is included in an on-demand backup or scheduled backup plan. Otherwise, Backup does not try to protect that service's resources in this Region. Use the DescribeRegionSettings API to determine the resource types that are supported.
    
    Parameters:
    
    updateRegionSettingsRequest -
    
    Returns:
    
    Result of the UpdateRegionSettings operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    See Also:
    
    AWS API Documentation
  - updateReportPlan
```
UpdateReportPlanResult updateReportPlan(UpdateReportPlanRequest updateReportPlanRequest)
```
    Updates an existing report plan identified by its ReportPlanName with the input document in JSON format.
    
    Parameters:
    
    updateReportPlanRequest -
    
    Returns:
    
    Result of the UpdateReportPlan operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ConflictException - Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Interface AWSBackup

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

createBackupPlan

createBackupSelection

createBackupVault

createFramework

createReportPlan

deleteBackupPlan

deleteBackupSelection

deleteBackupVault

deleteBackupVaultAccessPolicy

deleteBackupVaultLockConfiguration

deleteBackupVaultNotifications

deleteFramework

deleteRecoveryPoint

deleteReportPlan

describeBackupJob

describeBackupVault

describeCopyJob

describeFramework

describeGlobalSettings

describeProtectedResource

describeRecoveryPoint

describeRegionSettings

describeReportJob

describeReportPlan

describeRestoreJob

disassociateRecoveryPoint

exportBackupPlanTemplate

getBackupPlan

getBackupPlanFromJSON

getBackupPlanFromTemplate

getBackupSelection

getBackupVaultAccessPolicy

getBackupVaultNotifications

getRecoveryPointRestoreMetadata

getSupportedResourceTypes

listBackupJobs

listBackupPlanTemplates

listBackupPlanVersions

listBackupPlans

listBackupSelections

listBackupVaults

listCopyJobs

listFrameworks

listProtectedResources

listRecoveryPointsByBackupVault

listRecoveryPointsByResource

listReportJobs

listReportPlans

listRestoreJobs

listTags

putBackupVaultAccessPolicy

putBackupVaultLockConfiguration

putBackupVaultNotifications

startBackupJob

startCopyJob

startReportJob

startRestoreJob

stopBackupJob

tagResource

untagResource

updateBackupPlan

updateFramework

updateGlobalSettings

updateRecoveryPointLifecycle

updateRegionSettings

updateReportPlan

shutdown

getCachedResponseMetadata