/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.backup; import javax.annotation.Generated; import com.amazonaws.*; import com.amazonaws.regions.*; import com.amazonaws.services.backup.model.*; /** * Interface for accessing AWS Backup. *
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.backup.AbstractAWSBackup} instead. *
*
*
* 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. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSBackup { /** * 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 RegionUtils#getRegionsForService(String) */ String ENDPOINT_PREFIX = "backup"; /** ** This action removes the specified legal hold on a recovery point. This action can only be performed by a user * with sufficient permissions. *
* * @param cancelLegalHoldRequest * @return Result of the CancelLegalHold 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. * @throws 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. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @sample AWSBackup.CancelLegalHold * @see AWS API * Documentation */ CancelLegalHoldResult cancelLegalHold(CancelLegalHoldRequest cancelLegalHoldRequest); /** ** 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.
*
* Creates a JSON document that specifies a set of resources to assign to a backup plan. For examples, see Assigning resources programmatically. *
* * @param createBackupSelectionRequest * @return 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. * @throws AlreadyExistsException * The required resource already exists. * @throws InvalidParameterValueException * Indicates that something is wrong with a parameter's value. For example, the value is out of range. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @sample AWSBackup.CreateBackupSelection * @see AWS * API Documentation */ CreateBackupSelectionResult createBackupSelection(CreateBackupSelectionRequest createBackupSelectionRequest); /** *
* 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. *
** 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. *
* * @param createFrameworkRequest * @return Result of the CreateFramework operation returned by the service. * @throws AlreadyExistsException * The required resource already exists. * @throws LimitExceededException * A limit in the request has been exceeded; for example, a maximum number of items allowed in a request. * @throws InvalidParameterValueException * Indicates that something is wrong with a parameter's value. For example, the value is out of range. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @sample AWSBackup.CreateFramework * @see AWS API * Documentation */ CreateFrameworkResult createFramework(CreateFrameworkRequest createFrameworkRequest); /** ** This action creates a legal hold on a recovery point (backup). A legal hold is a restraint on altering or * deleting a backup until an authorized user cancels the legal hold. Any actions to delete or disassociate a * recovery point will fail with an error if one or more active legal holds are on the recovery point. *
* * @param createLegalHoldRequest * @return Result of the CreateLegalHold 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. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @throws LimitExceededException * A limit in the request has been exceeded; for example, a maximum number of items allowed in a request. * @sample AWSBackup.CreateLegalHold * @see AWS API * Documentation */ CreateLegalHoldResult createLegalHold(CreateLegalHoldRequest createLegalHoldRequest); /** ** 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.
*
* 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. *
* * @param deleteBackupPlanRequest * @return Result of the DeleteBackupPlan operation returned by the service. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws InvalidParameterValueException * Indicates that something is wrong with a parameter's value. For example, the value is out of range. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @throws InvalidRequestException * Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong * type. * @sample AWSBackup.DeleteBackupPlan * @see AWS API * Documentation */ DeleteBackupPlanResult deleteBackupPlan(DeleteBackupPlanRequest deleteBackupPlanRequest); /** *
* Deletes the resource selection associated with a backup plan that is specified by the SelectionId
.
*
* Deletes the backup vault identified by its name. A vault can be deleted only if it is empty. *
* * @param deleteBackupVaultRequest * @return Result of the DeleteBackupVault operation returned by the service. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws InvalidParameterValueException * Indicates that something is wrong with a parameter's value. For example, the value is out of range. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @throws InvalidRequestException * Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong * type. * @sample AWSBackup.DeleteBackupVault * @see AWS API * Documentation */ DeleteBackupVaultResult deleteBackupVault(DeleteBackupVaultRequest deleteBackupVaultRequest); /** ** Deletes the policy document that manages permissions on a backup vault. *
* * @param deleteBackupVaultAccessPolicyRequest * @return Result of the DeleteBackupVaultAccessPolicy operation returned by the service. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws InvalidParameterValueException * Indicates that something is wrong with a parameter's value. For example, the value is out of range. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @sample AWSBackup.DeleteBackupVaultAccessPolicy * @see AWS API Documentation */ DeleteBackupVaultAccessPolicyResult deleteBackupVaultAccessPolicy(DeleteBackupVaultAccessPolicyRequest deleteBackupVaultAccessPolicyRequest); /** ** 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.
*
* Deletes event notifications for the specified backup vault. *
* * @param deleteBackupVaultNotificationsRequest * @return Result of the DeleteBackupVaultNotifications operation returned by the service. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws InvalidParameterValueException * Indicates that something is wrong with a parameter's value. For example, the value is out of range. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @sample AWSBackup.DeleteBackupVaultNotifications * @see AWS API Documentation */ DeleteBackupVaultNotificationsResult deleteBackupVaultNotifications(DeleteBackupVaultNotificationsRequest deleteBackupVaultNotificationsRequest); /** ** Deletes the framework specified by a framework name. *
* * @param deleteFrameworkRequest * @return Result of the DeleteFramework operation returned by the service. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws InvalidParameterValueException * Indicates that something is wrong with a parameter's value. For example, the value is out of range. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @throws ConflictException * Backup can't perform the action that you requested until it finishes performing a previous action. Try * again later. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @sample AWSBackup.DeleteFramework * @see AWS API * Documentation */ DeleteFrameworkResult deleteFramework(DeleteFrameworkRequest deleteFrameworkRequest); /** ** 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. *
*
* When an IAM role's permissions are insufficient to call this API, the service sends back an HTTP 200 response
* with an empty HTTP body, but the recovery point is not deleted. Instead, it enters an EXPIRED
state.
*
* EXPIRED
recovery points can be deleted with this API once the IAM role has the
* iam:CreateServiceLinkedRole
action. To learn more about adding this role, see
* Troubleshooting manual deletions.
*
* If the user or role is deleted or the permission within the role is removed, the deletion will not be successful
* and will enter an EXPIRED
state.
*
* Deletes the report plan specified by a report plan name. *
* * @param deleteReportPlanRequest * @return Result of the DeleteReportPlan operation returned by the service. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws InvalidParameterValueException * Indicates that something is wrong with a parameter's value. For example, the value is out of range. * @throws ConflictException * Backup can't perform the action that you requested until it finishes performing a previous action. Try * again later. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @sample AWSBackup.DeleteReportPlan * @see AWS API * Documentation */ DeleteReportPlanResult deleteReportPlan(DeleteReportPlanRequest deleteReportPlanRequest); /** *
* Returns backup job details for the specified BackupJobId
.
*
* Returns metadata about a backup vault specified by its name. *
* * @param describeBackupVaultRequest * @return Result of the DescribeBackupVault operation returned by the service. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws InvalidParameterValueException * Indicates that something is wrong with a parameter's value. For example, the value is out of range. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @sample AWSBackup.DescribeBackupVault * @see AWS API * Documentation */ DescribeBackupVaultResult describeBackupVault(DescribeBackupVaultRequest describeBackupVaultRequest); /** ** Returns metadata associated with creating a copy of a resource. *
* * @param describeCopyJobRequest * @return Result of the DescribeCopyJob operation returned by the service. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws InvalidParameterValueException * Indicates that something is wrong with a parameter's value. For example, the value is out of range. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @sample AWSBackup.DescribeCopyJob * @see AWS API * Documentation */ DescribeCopyJobResult describeCopyJob(DescribeCopyJobRequest describeCopyJobRequest); /** *
* Returns the framework details for the specified FrameworkName
.
*
* 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
*
* 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. *
* * @param describeProtectedResourceRequest * @return Result of the DescribeProtectedResource operation returned by the service. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws InvalidParameterValueException * Indicates that something is wrong with a parameter's value. For example, the value is out of range. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @sample AWSBackup.DescribeProtectedResource * @see AWS API Documentation */ DescribeProtectedResourceResult describeProtectedResource(DescribeProtectedResourceRequest describeProtectedResourceRequest); /** ** Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle. *
* * @param describeRecoveryPointRequest * @return Result of the DescribeRecoveryPoint operation returned by the service. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws InvalidParameterValueException * Indicates that something is wrong with a parameter's value. For example, the value is out of range. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @sample AWSBackup.DescribeRecoveryPoint * @see AWS * API Documentation */ DescribeRecoveryPointResult describeRecoveryPoint(DescribeRecoveryPointRequest describeRecoveryPointRequest); /** ** 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. *
* * @param describeRegionSettingsRequest * @return Result of the DescribeRegionSettings operation returned by the service. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @sample AWSBackup.DescribeRegionSettings * @see AWS * API Documentation */ DescribeRegionSettingsResult describeRegionSettings(DescribeRegionSettingsRequest describeRegionSettingsRequest); /** *
* Returns the details associated with creating a report as specified by its ReportJobId
.
*
* Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region. *
* * @param describeReportPlanRequest * @return 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. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @sample AWSBackup.DescribeReportPlan * @see AWS API * Documentation */ DescribeReportPlanResult describeReportPlan(DescribeReportPlanRequest describeReportPlanRequest); /** ** Returns metadata associated with a restore job that is specified by a job ID. *
* * @param describeRestoreJobRequest * @return Result of the DescribeRestoreJob operation returned by the service. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws InvalidParameterValueException * Indicates that something is wrong with a parameter's value. For example, the value is out of range. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @throws DependencyFailureException * A dependent Amazon Web Services service or resource returned an error to the Backup service, and the * action cannot be completed. * @sample AWSBackup.DescribeRestoreJob * @see AWS API * Documentation */ DescribeRestoreJobResult describeRestoreJob(DescribeRestoreJobRequest describeRestoreJobRequest); /** ** 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. *
* * @param disassociateRecoveryPointRequest * @return Result of the DisassociateRecoveryPoint operation returned by the service. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws InvalidParameterValueException * Indicates that something is wrong with a parameter's value. For example, the value is out of range. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws 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. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @throws InvalidRequestException * Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong * type. * @sample AWSBackup.DisassociateRecoveryPoint * @see AWS API Documentation */ DisassociateRecoveryPointResult disassociateRecoveryPoint(DisassociateRecoveryPointRequest disassociateRecoveryPointRequest); /** ** This action to a specific child (nested) recovery point removes the relationship between the specified recovery * point and its parent (composite) recovery point. *
* * @param disassociateRecoveryPointFromParentRequest * @return Result of the DisassociateRecoveryPointFromParent operation returned by the service. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws InvalidParameterValueException * Indicates that something is wrong with a parameter's value. For example, the value is out of range. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @throws InvalidRequestException * Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong * type. * @sample AWSBackup.DisassociateRecoveryPointFromParent * @see AWS API Documentation */ DisassociateRecoveryPointFromParentResult disassociateRecoveryPointFromParent( DisassociateRecoveryPointFromParentRequest disassociateRecoveryPointFromParentRequest); /** ** Returns the backup plan that is specified by the plan ID as a backup template. *
* * @param exportBackupPlanTemplateRequest * @return 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. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @sample AWSBackup.ExportBackupPlanTemplate * @see AWS API Documentation */ ExportBackupPlanTemplateResult exportBackupPlanTemplate(ExportBackupPlanTemplateRequest exportBackupPlanTemplateRequest); /** *
* Returns BackupPlan
details for the specified BackupPlanId
. The details are the body of
* a backup plan in JSON format, in addition to plan metadata.
*
* Returns a valid JSON document specifying a backup plan or an error. *
* * @param getBackupPlanFromJSONRequest * @return 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. * @throws InvalidParameterValueException * Indicates that something is wrong with a parameter's value. For example, the value is out of range. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @throws InvalidRequestException * Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong * type. * @sample AWSBackup.GetBackupPlanFromJSON * @see AWS * API Documentation */ GetBackupPlanFromJSONResult getBackupPlanFromJSON(GetBackupPlanFromJSONRequest getBackupPlanFromJSONRequest); /** *
* Returns the template specified by its templateId
as a backup plan.
*
* Returns selection metadata and a document in JSON format that specifies a list of resources that are associated * with a backup plan. *
* * @param getBackupSelectionRequest * @return Result of the GetBackupSelection operation returned by the service. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws InvalidParameterValueException * Indicates that something is wrong with a parameter's value. For example, the value is out of range. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @sample AWSBackup.GetBackupSelection * @see AWS API * Documentation */ GetBackupSelectionResult getBackupSelection(GetBackupSelectionRequest getBackupSelectionRequest); /** ** Returns the access policy document that is associated with the named backup vault. *
* * @param getBackupVaultAccessPolicyRequest * @return Result of the GetBackupVaultAccessPolicy operation returned by the service. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws InvalidParameterValueException * Indicates that something is wrong with a parameter's value. For example, the value is out of range. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @sample AWSBackup.GetBackupVaultAccessPolicy * @see AWS API Documentation */ GetBackupVaultAccessPolicyResult getBackupVaultAccessPolicy(GetBackupVaultAccessPolicyRequest getBackupVaultAccessPolicyRequest); /** ** Returns event notifications for the specified backup vault. *
* * @param getBackupVaultNotificationsRequest * @return Result of the GetBackupVaultNotifications operation returned by the service. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws InvalidParameterValueException * Indicates that something is wrong with a parameter's value. For example, the value is out of range. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @sample AWSBackup.GetBackupVaultNotifications * @see AWS API Documentation */ GetBackupVaultNotificationsResult getBackupVaultNotifications(GetBackupVaultNotificationsRequest getBackupVaultNotificationsRequest); /** ** This action returns details for a specified legal hold. The details are the body of a legal hold in JSON format, * in addition to metadata. *
* * @param getLegalHoldRequest * @return Result of the GetLegalHold 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. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @sample AWSBackup.GetLegalHold * @see AWS API * Documentation */ GetLegalHoldResult getLegalHold(GetLegalHoldRequest getLegalHoldRequest); /** ** Returns a set of metadata key-value pairs that were used to create the backup. *
* * @param getRecoveryPointRestoreMetadataRequest * @return Result of the GetRecoveryPointRestoreMetadata operation returned by the service. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws InvalidParameterValueException * Indicates that something is wrong with a parameter's value. For example, the value is out of range. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @sample AWSBackup.GetRecoveryPointRestoreMetadata * @see AWS API Documentation */ GetRecoveryPointRestoreMetadataResult getRecoveryPointRestoreMetadata(GetRecoveryPointRestoreMetadataRequest getRecoveryPointRestoreMetadataRequest); /** ** Returns the Amazon Web Services resource types supported by Backup. *
* * @param getSupportedResourceTypesRequest * @return Result of the GetSupportedResourceTypes operation returned by the service. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @sample AWSBackup.GetSupportedResourceTypes * @see AWS API Documentation */ GetSupportedResourceTypesResult getSupportedResourceTypes(GetSupportedResourceTypesRequest getSupportedResourceTypesRequest); /** ** 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. *
* * @param listBackupJobsRequest * @return 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. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @sample AWSBackup.ListBackupJobs * @see AWS API * Documentation */ ListBackupJobsResult listBackupJobs(ListBackupJobsRequest listBackupJobsRequest); /** ** Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and * deletion dates. *
* * @param listBackupPlanTemplatesRequest * @return 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. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @sample AWSBackup.ListBackupPlanTemplates * @see AWS * API Documentation */ ListBackupPlanTemplatesResult listBackupPlanTemplates(ListBackupPlanTemplatesRequest listBackupPlanTemplatesRequest); /** ** Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation * and deletion dates, plan names, and version IDs. *
* * @param listBackupPlanVersionsRequest * @return Result of the ListBackupPlanVersions operation returned by the service. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws InvalidParameterValueException * Indicates that something is wrong with a parameter's value. For example, the value is out of range. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @sample AWSBackup.ListBackupPlanVersions * @see AWS * API Documentation */ ListBackupPlanVersionsResult listBackupPlanVersions(ListBackupPlanVersionsRequest listBackupPlanVersionsRequest); /** ** 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. *
* * @param listBackupPlansRequest * @return Result of the ListBackupPlans operation returned by the service. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws InvalidParameterValueException * Indicates that something is wrong with a parameter's value. For example, the value is out of range. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @sample AWSBackup.ListBackupPlans * @see AWS API * Documentation */ ListBackupPlansResult listBackupPlans(ListBackupPlansRequest listBackupPlansRequest); /** ** Returns an array containing metadata of the resources associated with the target backup plan. *
* * @param listBackupSelectionsRequest * @return Result of the ListBackupSelections operation returned by the service. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws InvalidParameterValueException * Indicates that something is wrong with a parameter's value. For example, the value is out of range. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @sample AWSBackup.ListBackupSelections * @see AWS * API Documentation */ ListBackupSelectionsResult listBackupSelections(ListBackupSelectionsRequest listBackupSelectionsRequest); /** ** Returns a list of recovery point storage containers along with information about them. *
* * @param listBackupVaultsRequest * @return Result of the ListBackupVaults operation returned by the service. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws InvalidParameterValueException * Indicates that something is wrong with a parameter's value. For example, the value is out of range. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @sample AWSBackup.ListBackupVaults * @see AWS API * Documentation */ ListBackupVaultsResult listBackupVaults(ListBackupVaultsRequest listBackupVaultsRequest); /** ** Returns metadata about your copy jobs. *
* * @param listCopyJobsRequest * @return 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. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @sample AWSBackup.ListCopyJobs * @see AWS API * Documentation */ ListCopyJobsResult listCopyJobs(ListCopyJobsRequest listCopyJobsRequest); /** ** Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region. *
* * @param listFrameworksRequest * @return 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. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @sample AWSBackup.ListFrameworks * @see AWS API * Documentation */ ListFrameworksResult listFrameworks(ListFrameworksRequest listFrameworksRequest); /** ** This action returns metadata about active and previous legal holds. *
* * @param listLegalHoldsRequest * @return Result of the ListLegalHolds 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. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @sample AWSBackup.ListLegalHolds * @see AWS API * Documentation */ ListLegalHoldsResult listLegalHolds(ListLegalHoldsRequest listLegalHoldsRequest); /** ** 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. *
* * @param listProtectedResourcesRequest * @return 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. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @sample AWSBackup.ListProtectedResources * @see AWS * API Documentation */ ListProtectedResourcesResult listProtectedResources(ListProtectedResourcesRequest listProtectedResourcesRequest); /** ** Returns detailed information about the recovery points stored in a backup vault. *
* * @param listRecoveryPointsByBackupVaultRequest * @return Result of the ListRecoveryPointsByBackupVault operation returned by the service. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws InvalidParameterValueException * Indicates that something is wrong with a parameter's value. For example, the value is out of range. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @sample AWSBackup.ListRecoveryPointsByBackupVault * @see AWS API Documentation */ ListRecoveryPointsByBackupVaultResult listRecoveryPointsByBackupVault(ListRecoveryPointsByBackupVaultRequest listRecoveryPointsByBackupVaultRequest); /** ** This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold. *
* * @param listRecoveryPointsByLegalHoldRequest * @return Result of the ListRecoveryPointsByLegalHold 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. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @sample AWSBackup.ListRecoveryPointsByLegalHold * @see AWS API Documentation */ ListRecoveryPointsByLegalHoldResult listRecoveryPointsByLegalHold(ListRecoveryPointsByLegalHoldRequest listRecoveryPointsByLegalHoldRequest); /** ** 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. *
** Returns details about your report jobs. *
* * @param listReportJobsRequest * @return 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. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @sample AWSBackup.ListReportJobs * @see AWS API * Documentation */ ListReportJobsResult listReportJobs(ListReportJobsRequest listReportJobsRequest); /** *
* Returns a list of your report plans. For detailed information about a single report plan, use
* DescribeReportPlan
.
*
* Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery * process. *
* * @param listRestoreJobsRequest * @return Result of the ListRestoreJobs operation returned by the service. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws InvalidParameterValueException * Indicates that something is wrong with a parameter's value. For example, the value is out of range. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @sample AWSBackup.ListRestoreJobs * @see AWS API * Documentation */ ListRestoreJobsResult listRestoreJobs(ListRestoreJobsRequest listRestoreJobsRequest); /** ** 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.
*
* 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. *
* * @param putBackupVaultAccessPolicyRequest * @return Result of the PutBackupVaultAccessPolicy operation returned by the service. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws InvalidParameterValueException * Indicates that something is wrong with a parameter's value. For example, the value is out of range. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @sample AWSBackup.PutBackupVaultAccessPolicy * @see AWS API Documentation */ PutBackupVaultAccessPolicyResult putBackupVaultAccessPolicy(PutBackupVaultAccessPolicyRequest putBackupVaultAccessPolicyRequest); /** ** 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 been assessed by Cohasset Associates for use in environments that are subject to SEC 17a-4, * CFTC, and FINRA regulations. For more information about how Backup Vault Lock relates to these regulations, see * the Cohasset Associates Compliance Assessment. *
** Turns on notifications on a backup vault for the specified topic and events. *
* * @param putBackupVaultNotificationsRequest * @return Result of the PutBackupVaultNotifications operation returned by the service. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws InvalidParameterValueException * Indicates that something is wrong with a parameter's value. For example, the value is out of range. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @sample AWSBackup.PutBackupVaultNotifications * @see AWS API Documentation */ PutBackupVaultNotificationsResult putBackupVaultNotifications(PutBackupVaultNotificationsRequest putBackupVaultNotificationsRequest); /** ** Starts an on-demand backup job for the specified resource. *
* * @param startBackupJobRequest * @return Result of the StartBackupJob operation returned by the service. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws InvalidParameterValueException * Indicates that something is wrong with a parameter's value. For example, the value is out of range. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws InvalidRequestException * Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong * type. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @throws LimitExceededException * A limit in the request has been exceeded; for example, a maximum number of items allowed in a request. * @sample AWSBackup.StartBackupJob * @see AWS API * Documentation */ StartBackupJobResult startBackupJob(StartBackupJobRequest startBackupJobRequest); /** ** Starts a job to create a one-time copy of the specified resource. *
** Does not support continuous backups. *
* * @param startCopyJobRequest * @return Result of the StartCopyJob operation returned by the service. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws InvalidParameterValueException * Indicates that something is wrong with a parameter's value. For example, the value is out of range. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @throws LimitExceededException * A limit in the request has been exceeded; for example, a maximum number of items allowed in a request. * @throws InvalidRequestException * Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong * type. * @sample AWSBackup.StartCopyJob * @see AWS API * Documentation */ StartCopyJobResult startCopyJob(StartCopyJobRequest startCopyJobRequest); /** ** Starts an on-demand report job for the specified report plan. *
* * @param startReportJobRequest * @return 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. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @sample AWSBackup.StartReportJob * @see AWS API * Documentation */ StartReportJobResult startReportJob(StartReportJobRequest startReportJobRequest); /** ** Recovers the saved resource identified by an Amazon Resource Name (ARN). *
* * @param startRestoreJobRequest * @return Result of the StartRestoreJob operation returned by the service. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws InvalidParameterValueException * Indicates that something is wrong with a parameter's value. For example, the value is out of range. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @throws InvalidRequestException * Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong * type. * @sample AWSBackup.StartRestoreJob * @see AWS API * Documentation */ StartRestoreJobResult startRestoreJob(StartRestoreJobRequest startRestoreJobRequest); /** ** Attempts to cancel a job to create a one-time backup of a resource. *
** This action is not supported for the following services: Amazon FSx for Windows File Server, Amazon FSx for * Lustre, FSx for ONTAP , Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, * Amazon Aurora, and Amazon Neptune. *
* * @param stopBackupJobRequest * @return Result of the StopBackupJob operation returned by the service. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws InvalidParameterValueException * Indicates that something is wrong with a parameter's value. For example, the value is out of range. * @throws InvalidRequestException * Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong * type. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @sample AWSBackup.StopBackupJob * @see AWS API * Documentation */ StopBackupJobResult stopBackupJob(StopBackupJobRequest stopBackupJobRequest); /** ** Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon * Resource Name (ARN). *
* * @param tagResourceRequest * @return Result of the TagResource operation returned by the service. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws InvalidParameterValueException * Indicates that something is wrong with a parameter's value. For example, the value is out of range. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @throws LimitExceededException * A limit in the request has been exceeded; for example, a maximum number of items allowed in a request. * @sample AWSBackup.TagResource * @see AWS API * Documentation */ TagResourceResult tagResource(TagResourceRequest tagResourceRequest); /** ** Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon * Resource Name (ARN) *
* * @param untagResourceRequest * @return Result of the UntagResource operation returned by the service. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws InvalidParameterValueException * Indicates that something is wrong with a parameter's value. For example, the value is out of range. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @sample AWSBackup.UntagResource * @see AWS API * Documentation */ UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest); /** *
* 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
.
*
* Updates an existing framework identified by its FrameworkName
with the input document in JSON
* format.
*
* 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.
*
* 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. *
** Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" * section of the Feature * availability by resource table. Backup ignores this expression for other resource types. *
** This operation does not support continuous backups. *
* * @param updateRecoveryPointLifecycleRequest * @return Result of the UpdateRecoveryPointLifecycle operation returned by the service. * @throws ResourceNotFoundException * A resource that is required for the action doesn't exist. * @throws InvalidParameterValueException * Indicates that something is wrong with a parameter's value. For example, the value is out of range. * @throws InvalidRequestException * Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong * type. * @throws MissingParameterValueException * Indicates that a required parameter is missing. * @throws ServiceUnavailableException * The request failed due to a temporary failure of the server. * @sample AWSBackup.UpdateRecoveryPointLifecycle * @see AWS API Documentation */ UpdateRecoveryPointLifecycleResult updateRecoveryPointLifecycle(UpdateRecoveryPointLifecycleRequest updateRecoveryPointLifecycleRequest); /** *
* 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.
*
* Updates an existing report plan identified by its ReportPlanName
with the input document in JSON
* format.
*
* 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. * * @param request * The originally executed request. * * @return The response metadata for the specified request, or null if none is available. */ ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }