AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Name | Description | |
---|---|---|
AdvancedBackupSetting |
A list of backup options for each resource type. |
|
AlreadyExistsException |
The required resource already exists. |
|
BackupJob |
Contains detailed information about a backup job. |
|
BackupJobSummary |
This is a summary of jobs created or running within the most recent 30 days. The returned summary may contain the following: Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs. |
|
BackupPaginatorFactory |
Paginators for the Backup service |
|
BackupPlan |
Contains an optional backup plan display name and an array of |
|
BackupPlanInput |
Contains an optional backup plan display name and an array of |
|
BackupPlansListMember |
Contains metadata about a backup plan. |
|
BackupPlanTemplatesListMember |
An object specifying metadata associated with a backup plan template. |
|
BackupRule |
Specifies a scheduled task used to back up a selection of resources. |
|
BackupRuleInput |
Specifies a scheduled task used to back up a selection of resources. |
|
BackupSelection |
Used to specify a set of resources to a backup plan.
Specifying your desired |
|
BackupSelectionsListMember |
Contains metadata about a |
|
BackupVaultListMember |
Contains metadata about a backup vault. |
|
CalculatedLifecycle |
Contains 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. |
|
CancelLegalHoldRequest |
Container for the parameters to the CancelLegalHold operation. This action removes the specified legal hold on a recovery point. This action can only be performed by a user with sufficient permissions. |
|
CancelLegalHoldResponse |
This is the response object from the CancelLegalHold operation. |
|
Condition |
Contains an array of triplets made up of a condition type (such as |
|
ConditionParameter |
Includes information about tags you define to assign tagged resources to a backup plan. |
|
Conditions |
Contains information about which resources to include or exclude from a backup plan using their tags. Conditions are case sensitive. |
|
ConflictException |
Backup can't perform the action that you requested until it finishes performing a previous action. Try again later. |
|
ControlInputParameter |
A list of parameters for a control. A control can have zero, one, or more than one
parameter. An example of a control with two parameters is: "backup plan frequency
is at least |
|
ControlScope |
A framework consists of one or more controls. Each control has its own control scope.
The control scope can include one or more resource types, a combination of a tag key
and value, or a combination of one resource type and one resource ID. If no scope
is specified, evaluations for the rule are triggered when any resource in your recording
group changes in configuration.
To set a control scope that includes all of a particular resource, leave the |
|
CopyAction |
The details of the copy operation. |
|
CopyJob |
Contains detailed information about a copy job. |
|
CopyJobSummary |
This is a summary of copy jobs created or running within the most recent 30 days. The returned summary may contain the following: Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs. |
|
CreateBackupPlanRequest |
Container for the parameters to the CreateBackupPlan operation. 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 |
|
CreateBackupPlanResponse |
This is the response object from the CreateBackupPlan operation. |
|
CreateBackupSelectionRequest |
Container for the parameters to the CreateBackupSelection operation. Creates a JSON document that specifies a set of resources to assign to a backup plan. For examples, see Assigning resources programmatically. |
|
CreateBackupSelectionResponse |
This is the response object from the CreateBackupSelection operation. |
|
CreateBackupVaultRequest |
Container for the parameters to the CreateBackupVault operation.
Creates a logical container where backups are stored. A
Do not include sensitive data, such as passport numbers, in the name of a backup vault.
|
|
CreateBackupVaultResponse |
This is the response object from the CreateBackupVault operation. |
|
CreateFrameworkRequest |
Container for the parameters to the CreateFramework operation. 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. |
|
CreateFrameworkResponse |
This is the response object from the CreateFramework operation. |
|
CreateLegalHoldRequest |
Container for the parameters to the CreateLegalHold operation. 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. |
|
CreateLegalHoldResponse |
This is the response object from the CreateLegalHold operation. |
|
CreateLogicallyAirGappedBackupVaultRequest |
Container for the parameters to the CreateLogicallyAirGappedBackupVault operation. This request creates a logical container to where backups may be copied. This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID. Do not include sensitive data, such as passport numbers, in the name of a backup vault. |
|
CreateLogicallyAirGappedBackupVaultResponse |
This is the response object from the CreateLogicallyAirGappedBackupVault operation. |
|
CreateReportPlanRequest |
Container for the parameters to the CreateReportPlan operation. 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 |
|
CreateReportPlanResponse |
This is the response object from the CreateReportPlan operation. |
|
CreateRestoreTestingPlanRequest |
Container for the parameters to the CreateRestoreTestingPlan operation. This is the first of two steps to create a restore testing plan; once this request is successful, finish the procedure with request CreateRestoreTestingSelection. You must include the parameter RestoreTestingPlan. You may optionally include CreatorRequestId and Tags. |
|
CreateRestoreTestingPlanResponse |
This is the response object from the CreateRestoreTestingPlan operation. |
|
CreateRestoreTestingSelectionRequest |
Container for the parameters to the CreateRestoreTestingSelection operation. This request can be sent after CreateRestoreTestingPlan request returns successfully. This is the second part of creating a resource testing plan, and it must be completed sequentially.
This consists of
Each protected resource type can have one single value.
A restore testing selection can include a wildcard value ("*") for Cannot select by both protected resource types AND specific ARNs. Request will fail if both are included. |
|
CreateRestoreTestingSelectionResponse |
This is the response object from the CreateRestoreTestingSelection operation. |
|
DateRange |
This is a resource filter containing FromDate: DateTime and ToDate: DateTime. Both values are required. Future DateTime values are not permitted. The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds ((milliseconds are optional). For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. |
|
DeleteBackupPlanRequest |
Container for the parameters to the DeleteBackupPlan operation. 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. |
|
DeleteBackupPlanResponse |
This is the response object from the DeleteBackupPlan operation. |
|
DeleteBackupSelectionRequest |
Container for the parameters to the DeleteBackupSelection operation.
Deletes the resource selection associated with a backup plan that is specified by
the |
|
DeleteBackupSelectionResponse |
This is the response object from the DeleteBackupSelection operation. |
|
DeleteBackupVaultAccessPolicyRequest |
Container for the parameters to the DeleteBackupVaultAccessPolicy operation. Deletes the policy document that manages permissions on a backup vault. |
|
DeleteBackupVaultAccessPolicyResponse |
This is the response object from the DeleteBackupVaultAccessPolicy operation. |
|
DeleteBackupVaultLockConfigurationRequest |
Container for the parameters to the DeleteBackupVaultLockConfiguration operation. 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 |
|
DeleteBackupVaultLockConfigurationResponse |
This is the response object from the DeleteBackupVaultLockConfiguration operation. |
|
DeleteBackupVaultNotificationsRequest |
Container for the parameters to the DeleteBackupVaultNotifications operation. Deletes event notifications for the specified backup vault. |
|
DeleteBackupVaultNotificationsResponse |
This is the response object from the DeleteBackupVaultNotifications operation. |
|
DeleteBackupVaultRequest |
Container for the parameters to the DeleteBackupVault operation. Deletes the backup vault identified by its name. A vault can be deleted only if it is empty. |
|
DeleteBackupVaultResponse |
This is the response object from the DeleteBackupVault operation. |
|
DeleteFrameworkRequest |
Container for the parameters to the DeleteFramework operation. Deletes the framework specified by a framework name. |
|
DeleteFrameworkResponse |
This is the response object from the DeleteFramework operation. |
|
DeleteRecoveryPointRequest |
Container for the parameters to the DeleteRecoveryPoint operation. 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
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 |
|
DeleteRecoveryPointResponse |
This is the response object from the DeleteRecoveryPoint operation. |
|
DeleteReportPlanRequest |
Container for the parameters to the DeleteReportPlan operation. Deletes the report plan specified by a report plan name. |
|
DeleteReportPlanResponse |
This is the response object from the DeleteReportPlan operation. |
|
DeleteRestoreTestingPlanRequest |
Container for the parameters to the DeleteRestoreTestingPlan operation. This request deletes the specified restore testing plan. Deletion can only successfully occur if all associated restore testing selections are deleted first. |
|
DeleteRestoreTestingPlanResponse |
This is the response object from the DeleteRestoreTestingPlan operation. |
|
DeleteRestoreTestingSelectionRequest |
Container for the parameters to the DeleteRestoreTestingSelection operation. Input the Restore Testing Plan name and Restore Testing Selection name. All testing selections associated with a restore testing plan must be deleted before the restore testing plan can be deleted. |
|
DeleteRestoreTestingSelectionResponse |
This is the response object from the DeleteRestoreTestingSelection operation. |
|
DependencyFailureException |
A dependent Amazon Web Services service or resource returned an error to the Backup service, and the action cannot be completed. |
|
DescribeBackupJobRequest |
Container for the parameters to the DescribeBackupJob operation.
Returns backup job details for the specified |
|
DescribeBackupJobResponse |
This is the response object from the DescribeBackupJob operation. |
|
DescribeBackupVaultRequest |
Container for the parameters to the DescribeBackupVault operation. Returns metadata about a backup vault specified by its name. |
|
DescribeBackupVaultResponse |
This is the response object from the DescribeBackupVault operation. |
|
DescribeCopyJobRequest |
Container for the parameters to the DescribeCopyJob operation. Returns metadata associated with creating a copy of a resource. |
|
DescribeCopyJobResponse |
This is the response object from the DescribeCopyJob operation. |
|
DescribeFrameworkRequest |
Container for the parameters to the DescribeFramework operation.
Returns the framework details for the specified |
|
DescribeFrameworkResponse |
This is the response object from the DescribeFramework operation. |
|
DescribeGlobalSettingsRequest |
Container for the parameters to the DescribeGlobalSettings operation.
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: |
|
DescribeGlobalSettingsResponse |
This is the response object from the DescribeGlobalSettings operation. |
|
DescribeProtectedResourceRequest |
Container for the parameters to the DescribeProtectedResource operation. 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. |
|
DescribeProtectedResourceResponse |
This is the response object from the DescribeProtectedResource operation. |
|
DescribeRecoveryPointRequest |
Container for the parameters to the DescribeRecoveryPoint operation. Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle. |
|
DescribeRecoveryPointResponse |
This is the response object from the DescribeRecoveryPoint operation. |
|
DescribeRegionSettingsRequest |
Container for the parameters to the DescribeRegionSettings operation. 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. |
|
DescribeRegionSettingsResponse |
This is the response object from the DescribeRegionSettings operation. |
|
DescribeReportJobRequest |
Container for the parameters to the DescribeReportJob operation.
Returns the details associated with creating a report as specified by its |
|
DescribeReportJobResponse |
This is the response object from the DescribeReportJob operation. |
|
DescribeReportPlanRequest |
Container for the parameters to the DescribeReportPlan operation. Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region. |
|
DescribeReportPlanResponse |
This is the response object from the DescribeReportPlan operation. |
|
DescribeRestoreJobRequest |
Container for the parameters to the DescribeRestoreJob operation. Returns metadata associated with a restore job that is specified by a job ID. |
|
DescribeRestoreJobResponse |
This is the response object from the DescribeRestoreJob operation. |
|
DisassociateRecoveryPointFromParentRequest |
Container for the parameters to the DisassociateRecoveryPointFromParent operation. This action to a specific child (nested) recovery point removes the relationship between the specified recovery point and its parent (composite) recovery point. |
|
DisassociateRecoveryPointFromParentResponse |
This is the response object from the DisassociateRecoveryPointFromParent operation. |
|
DisassociateRecoveryPointRequest |
Container for the parameters to the DisassociateRecoveryPoint operation. 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. |
|
DisassociateRecoveryPointResponse |
This is the response object from the DisassociateRecoveryPoint operation. |
|
ExportBackupPlanTemplateRequest |
Container for the parameters to the ExportBackupPlanTemplate operation. Returns the backup plan that is specified by the plan ID as a backup template. |
|
ExportBackupPlanTemplateResponse |
This is the response object from the ExportBackupPlanTemplate operation. |
|
Framework |
Contains detailed information about a framework. Frameworks contain controls, which evaluate and report on your backup events and resources. Frameworks generate daily compliance results. |
|
FrameworkControl |
Contains detailed information about all of the controls of a framework. Each framework must contain at least one control. |
|
GetBackupPlanFromJSONRequest |
Container for the parameters to the GetBackupPlanFromJSON operation. Returns a valid JSON document specifying a backup plan or an error. |
|
GetBackupPlanFromJSONResponse |
This is the response object from the GetBackupPlanFromJSON operation. |
|
GetBackupPlanFromTemplateRequest |
Container for the parameters to the GetBackupPlanFromTemplate operation.
Returns the template specified by its |
|
GetBackupPlanFromTemplateResponse |
This is the response object from the GetBackupPlanFromTemplate operation. |
|
GetBackupPlanRequest |
Container for the parameters to the GetBackupPlan operation.
Returns |
|
GetBackupPlanResponse |
This is the response object from the GetBackupPlan operation. |
|
GetBackupSelectionRequest |
Container for the parameters to the GetBackupSelection operation. Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan. |
|
GetBackupSelectionResponse |
This is the response object from the GetBackupSelection operation. |
|
GetBackupVaultAccessPolicyRequest |
Container for the parameters to the GetBackupVaultAccessPolicy operation. Returns the access policy document that is associated with the named backup vault. |
|
GetBackupVaultAccessPolicyResponse |
This is the response object from the GetBackupVaultAccessPolicy operation. |
|
GetBackupVaultNotificationsRequest |
Container for the parameters to the GetBackupVaultNotifications operation. Returns event notifications for the specified backup vault. |
|
GetBackupVaultNotificationsResponse |
This is the response object from the GetBackupVaultNotifications operation. |
|
GetLegalHoldRequest |
Container for the parameters to the GetLegalHold operation. 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. |
|
GetLegalHoldResponse |
This is the response object from the GetLegalHold operation. |
|
GetRecoveryPointRestoreMetadataRequest |
Container for the parameters to the GetRecoveryPointRestoreMetadata operation. Returns a set of metadata key-value pairs that were used to create the backup. |
|
GetRecoveryPointRestoreMetadataResponse |
This is the response object from the GetRecoveryPointRestoreMetadata operation. |
|
GetRestoreJobMetadataRequest |
Container for the parameters to the GetRestoreJobMetadata operation. This request returns the metadata for the specified restore job. |
|
GetRestoreJobMetadataResponse |
This is the response object from the GetRestoreJobMetadata operation. |
|
GetRestoreTestingInferredMetadataRequest |
Container for the parameters to the GetRestoreTestingInferredMetadata operation.
This request returns the minimal required set of metadata needed to start a restore
job with secure default settings. |
|
GetRestoreTestingInferredMetadataResponse |
This is the response object from the GetRestoreTestingInferredMetadata operation. |
|
GetRestoreTestingPlanRequest |
Container for the parameters to the GetRestoreTestingPlan operation.
Returns |
|
GetRestoreTestingPlanResponse |
This is the response object from the GetRestoreTestingPlan operation. |
|
GetRestoreTestingSelectionRequest |
Container for the parameters to the GetRestoreTestingSelection operation. Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan. |
|
GetRestoreTestingSelectionResponse |
This is the response object from the GetRestoreTestingSelection operation. |
|
GetSupportedResourceTypesRequest |
Container for the parameters to the GetSupportedResourceTypes operation. Returns the Amazon Web Services resource types supported by Backup. |
|
GetSupportedResourceTypesResponse |
This is the response object from the GetSupportedResourceTypes operation. |
|
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. |
|
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. |
|
KeyValue |
Pair of two related strings. Allowed characters are letters, white space, and numbers
that can be represented in UTF-8 and the following characters: |
|
LegalHold |
A legal hold is an administrative tool that helps prevent backups from being deleted while under a hold. While the hold is in place, backups under a hold cannot be deleted and lifecycle policies that would alter the backup status (such as transition to cold storage) are delayed until the legal hold is removed. A backup can have more than one legal hold. Legal holds are applied to one or more backups (also known as recovery points). These backups can be filtered by resource types and by resource IDs. |
|
Lifecycle |
Contains an array of Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, 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. |
|
LimitExceededException |
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request. |
|
ListBackupJobsRequest |
Container for the parameters to the ListBackupJobs operation. 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. |
|
ListBackupJobsResponse |
This is the response object from the ListBackupJobs operation. |
|
ListBackupJobSummariesRequest |
Container for the parameters to the ListBackupJobSummaries operation. This is a request for a summary of backup jobs created or running within the most recent 30 days. You can include parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results. This request returns a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs. |
|
ListBackupJobSummariesResponse |
This is the response object from the ListBackupJobSummaries operation. |
|
ListBackupPlansRequest |
Container for the parameters to the ListBackupPlans operation. 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. |
|
ListBackupPlansResponse |
This is the response object from the ListBackupPlans operation. |
|
ListBackupPlanTemplatesRequest |
Container for the parameters to the ListBackupPlanTemplates operation. Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates. |
|
ListBackupPlanTemplatesResponse |
This is the response object from the ListBackupPlanTemplates operation. |
|
ListBackupPlanVersionsRequest |
Container for the parameters to the ListBackupPlanVersions operation. Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs. |
|
ListBackupPlanVersionsResponse |
This is the response object from the ListBackupPlanVersions operation. |
|
ListBackupSelectionsRequest |
Container for the parameters to the ListBackupSelections operation. Returns an array containing metadata of the resources associated with the target backup plan. |
|
ListBackupSelectionsResponse |
This is the response object from the ListBackupSelections operation. |
|
ListBackupVaultsRequest |
Container for the parameters to the ListBackupVaults operation. Returns a list of recovery point storage containers along with information about them. |
|
ListBackupVaultsResponse |
This is the response object from the ListBackupVaults operation. |
|
ListCopyJobsRequest |
Container for the parameters to the ListCopyJobs operation. Returns metadata about your copy jobs. |
|
ListCopyJobsResponse |
This is the response object from the ListCopyJobs operation. |
|
ListCopyJobSummariesRequest |
Container for the parameters to the ListCopyJobSummaries operation. This request obtains a list of copy jobs created or running within the the most recent 30 days. You can include parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results. This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs. |
|
ListCopyJobSummariesResponse |
This is the response object from the ListCopyJobSummaries operation. |
|
ListFrameworksRequest |
Container for the parameters to the ListFrameworks operation. Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region. |
|
ListFrameworksResponse |
This is the response object from the ListFrameworks operation. |
|
ListLegalHoldsRequest |
Container for the parameters to the ListLegalHolds operation. This action returns metadata about active and previous legal holds. |
|
ListLegalHoldsResponse |
This is the response object from the ListLegalHolds operation. |
|
ListProtectedResourcesByBackupVaultRequest |
Container for the parameters to the ListProtectedResourcesByBackupVault operation. This request lists the protected resources corresponding to each backup vault. |
|
ListProtectedResourcesByBackupVaultResponse |
This is the response object from the ListProtectedResourcesByBackupVault operation. |
|
ListProtectedResourcesRequest |
Container for the parameters to the ListProtectedResources operation. 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. |
|
ListProtectedResourcesResponse |
This is the response object from the ListProtectedResources operation. |
|
ListRecoveryPointsByBackupVaultRequest |
Container for the parameters to the ListRecoveryPointsByBackupVault operation. Returns detailed information about the recovery points stored in a backup vault. |
|
ListRecoveryPointsByBackupVaultResponse |
This is the response object from the ListRecoveryPointsByBackupVault operation. |
|
ListRecoveryPointsByLegalHoldRequest |
Container for the parameters to the ListRecoveryPointsByLegalHold operation. This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold. |
|
ListRecoveryPointsByLegalHoldResponse |
This is the response object from the ListRecoveryPointsByLegalHold operation. |
|
ListRecoveryPointsByResourceRequest |
Container for the parameters to the ListRecoveryPointsByResource operation.
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.
|
|
ListRecoveryPointsByResourceResponse |
This is the response object from the ListRecoveryPointsByResource operation. |
|
ListReportJobsRequest |
Container for the parameters to the ListReportJobs operation. Returns details about your report jobs. |
|
ListReportJobsResponse |
This is the response object from the ListReportJobs operation. |
|
ListReportPlansRequest |
Container for the parameters to the ListReportPlans operation.
Returns a list of your report plans. For detailed information about a single report
plan, use |
|
ListReportPlansResponse |
This is the response object from the ListReportPlans operation. |
|
ListRestoreJobsByProtectedResourceRequest |
Container for the parameters to the ListRestoreJobsByProtectedResource operation. This returns restore jobs that contain the specified protected resource.
You must include |
|
ListRestoreJobsByProtectedResourceResponse |
This is the response object from the ListRestoreJobsByProtectedResource operation. |
|
ListRestoreJobsRequest |
Container for the parameters to the ListRestoreJobs operation. Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process. |
|
ListRestoreJobsResponse |
This is the response object from the ListRestoreJobs operation. |
|
ListRestoreJobSummariesRequest |
Container for the parameters to the ListRestoreJobSummaries operation. This request obtains a summary of restore jobs created or running within the the most recent 30 days. You can include parameters AccountID, State, ResourceType, AggregationPeriod, MaxResults, or NextToken to filter results. This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs. |
|
ListRestoreJobSummariesResponse |
This is the response object from the ListRestoreJobSummaries operation. |
|
ListRestoreTestingPlansRequest |
Container for the parameters to the ListRestoreTestingPlans operation. Returns a list of restore testing plans. |
|
ListRestoreTestingPlansResponse |
This is the response object from the ListRestoreTestingPlans operation. |
|
ListRestoreTestingSelectionsRequest |
Container for the parameters to the ListRestoreTestingSelections operation.
Returns a list of restore testing selections. Can be filtered by |
|
ListRestoreTestingSelectionsResponse |
This is the response object from the ListRestoreTestingSelections operation. |
|
ListTagsRequest |
Container for the parameters to the ListTags operation. Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.
|
|
ListTagsResponse |
This is the response object from the ListTags operation. |
|
MissingParameterValueException |
Indicates that a required parameter is missing. |
|
ProtectedResource |
A structure that contains information about a backed-up resource. |
|
ProtectedResourceConditions |
A list of conditions that you define for resources in your restore testing plan using tags.
For example, |
|
PutBackupVaultAccessPolicyRequest |
Container for the parameters to the PutBackupVaultAccessPolicy operation. 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. |
|
PutBackupVaultAccessPolicyResponse |
This is the response object from the PutBackupVaultAccessPolicy operation. |
|
PutBackupVaultLockConfigurationRequest |
Container for the parameters to the PutBackupVaultLockConfiguration operation.
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.
|
|
PutBackupVaultLockConfigurationResponse |
This is the response object from the PutBackupVaultLockConfiguration operation. |
|
PutBackupVaultNotificationsRequest |
Container for the parameters to the PutBackupVaultNotifications operation. Turns on notifications on a backup vault for the specified topic and events. |
|
PutBackupVaultNotificationsResponse |
This is the response object from the PutBackupVaultNotifications operation. |
|
PutRestoreValidationResultRequest |
Container for the parameters to the PutRestoreValidationResult operation.
This request allows you to send your independent self-run restore test validation
results. |
|
PutRestoreValidationResultResponse |
This is the response object from the PutRestoreValidationResult operation. |
|
RecoveryPointByBackupVault |
Contains detailed information about the recovery points stored in a backup vault. |
|
RecoveryPointByResource |
Contains detailed information about a saved recovery point. |
|
RecoveryPointCreator |
Contains information about the backup plan and rule that Backup used to initiate the recovery point backup. |
|
RecoveryPointMember |
This is a recovery point which is a child (nested) recovery point of a parent (composite) recovery point. These recovery points can be disassociated from their parent (composite) recovery point, in which case they will no longer be a member. |
|
RecoveryPointSelection |
This specifies criteria to assign a set of resources, such as resource types or backup vaults. |
|
ReportDeliveryChannel |
Contains information from your report plan about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports. |
|
ReportDestination |
Contains information from your report job about your report destination. |
|
ReportJob |
Contains detailed information about a report job. A report job compiles a report based on a report plan and publishes it to Amazon S3. |
|
ReportPlan |
Contains detailed information about a report plan. |
|
ReportSetting |
Contains detailed information about a report setting. |
|
ResourceNotFoundException |
A resource that is required for the action doesn't exist. |
|
RestoreJobCreator |
Contains information about the restore testing plan that Backup used to initiate the restore job. |
|
RestoreJobsListMember |
Contains metadata about a restore job. |
|
RestoreJobSummary |
This is a summary of restore jobs created or running within the most recent 30 days. The returned summary may contain the following: Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs. |
|
RestoreTestingPlanForCreate |
This contains metadata about a restore testing plan. |
|
RestoreTestingPlanForGet |
This contains metadata about a restore testing plan. |
|
RestoreTestingPlanForList |
This contains metadata about a restore testing plan. |
|
RestoreTestingPlanForUpdate |
This contains metadata about a restore testing plan. |
|
RestoreTestingRecoveryPointSelection |
Required: Algorithm; Required: Recovery point types; IncludeVaults(one or more). Optional: SelectionWindowDays ('30' if not specified);ExcludeVaults (list of selectors), defaults to empty list if not listed. |
|
RestoreTestingSelectionForCreate |
This contains metadata about a specific restore testing selection. ProtectedResourceType is required, such as Amazon EBS or Amazon EC2.
This consists of
Each protected resource type can have one single value.
A restore testing selection can include a wildcard value ("*") for
|
|
RestoreTestingSelectionForGet |
This contains metadata about a restore testing selection. |
|
RestoreTestingSelectionForList |
This contains metadata about a restore testing selection. |
|
RestoreTestingSelectionForUpdate |
This contains metadata about a restore testing selection. |
|
ServiceUnavailableException |
The request failed due to a temporary failure of the server. |
|
StartBackupJobRequest |
Container for the parameters to the StartBackupJob operation. Starts an on-demand backup job for the specified resource. |
|
StartBackupJobResponse |
This is the response object from the StartBackupJob operation. |
|
StartCopyJobRequest |
Container for the parameters to the StartCopyJob operation. Starts a job to create a one-time copy of the specified resource. Does not support continuous backups. |
|
StartCopyJobResponse |
This is the response object from the StartCopyJob operation. |
|
StartReportJobRequest |
Container for the parameters to the StartReportJob operation. Starts an on-demand report job for the specified report plan. |
|
StartReportJobResponse |
This is the response object from the StartReportJob operation. |
|
StartRestoreJobRequest |
Container for the parameters to the StartRestoreJob operation. Recovers the saved resource identified by an Amazon Resource Name (ARN). |
|
StartRestoreJobResponse |
This is the response object from the StartRestoreJob operation. |
|
StopBackupJobRequest |
Container for the parameters to the StopBackupJob operation. 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, Amazon FSx for NetApp ONTAP , Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon Aurora, and Amazon Neptune. |
|
StopBackupJobResponse |
This is the response object from the StopBackupJob operation. |
|
TagResourceRequest |
Container for the parameters to the TagResource operation. Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN). |
|
TagResourceResponse |
This is the response object from the TagResource operation. |
|
UntagResourceRequest |
Container for the parameters to the UntagResource operation. Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN) |
|
UntagResourceResponse |
This is the response object from the UntagResource operation. |
|
UpdateBackupPlanRequest |
Container for the parameters to the UpdateBackupPlan operation.
Updates an existing backup plan identified by its |
|
UpdateBackupPlanResponse |
This is the response object from the UpdateBackupPlan operation. |
|
UpdateFrameworkRequest |
Container for the parameters to the UpdateFramework operation.
Updates an existing framework identified by its |
|
UpdateFrameworkResponse |
This is the response object from the UpdateFramework operation. |
|
UpdateGlobalSettingsRequest |
Container for the parameters to the UpdateGlobalSettings operation.
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
|
|
UpdateGlobalSettingsResponse |
This is the response object from the UpdateGlobalSettings operation. |
|
UpdateRecoveryPointLifecycleRequest |
Container for the parameters to the UpdateRecoveryPointLifecycle operation. 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. |
|
UpdateRecoveryPointLifecycleResponse |
This is the response object from the UpdateRecoveryPointLifecycle operation. |
|
UpdateRegionSettingsRequest |
Container for the parameters to the UpdateRegionSettings operation. Updates the current service opt-in settings for the Region.
Use the |
|
UpdateRegionSettingsResponse |
This is the response object from the UpdateRegionSettings operation. |
|
UpdateReportPlanRequest |
Container for the parameters to the UpdateReportPlan operation.
Updates an existing report plan identified by its |
|
UpdateReportPlanResponse |
This is the response object from the UpdateReportPlan operation. |
|
UpdateRestoreTestingPlanRequest |
Container for the parameters to the UpdateRestoreTestingPlan operation.
This request will send changes to your specified restore testing plan.
|
|
UpdateRestoreTestingPlanResponse |
This is the response object from the UpdateRestoreTestingPlan operation. |
|
UpdateRestoreTestingSelectionRequest |
Container for the parameters to the UpdateRestoreTestingSelection operation.
Most elements except the
|
|
UpdateRestoreTestingSelectionResponse |
This is the response object from the UpdateRestoreTestingSelection operation. |
Name | Description | |
---|---|---|
IBackupPaginatorFactory |
Paginators for the Backup service |
|
IListBackupJobsPaginator |
Paginator for the ListBackupJobs operation |
|
IListBackupJobSummariesPaginator |
Paginator for the ListBackupJobSummaries operation |
|
IListBackupPlansPaginator |
Paginator for the ListBackupPlans operation |
|
IListBackupPlanTemplatesPaginator |
Paginator for the ListBackupPlanTemplates operation |
|
IListBackupPlanVersionsPaginator |
Paginator for the ListBackupPlanVersions operation |
|
IListBackupSelectionsPaginator |
Paginator for the ListBackupSelections operation |
|
IListBackupVaultsPaginator |
Paginator for the ListBackupVaults operation |
|
IListCopyJobsPaginator |
Paginator for the ListCopyJobs operation |
|
IListCopyJobSummariesPaginator |
Paginator for the ListCopyJobSummaries operation |
|
IListFrameworksPaginator |
Paginator for the ListFrameworks operation |
|
IListLegalHoldsPaginator |
Paginator for the ListLegalHolds operation |
|
IListProtectedResourcesByBackupVaultPaginator |
Paginator for the ListProtectedResourcesByBackupVault operation |
|
IListProtectedResourcesPaginator |
Paginator for the ListProtectedResources operation |
|
IListRecoveryPointsByBackupVaultPaginator |
Paginator for the ListRecoveryPointsByBackupVault operation |
|
IListRecoveryPointsByLegalHoldPaginator |
Paginator for the ListRecoveryPointsByLegalHold operation |
|
IListRecoveryPointsByResourcePaginator |
Paginator for the ListRecoveryPointsByResource operation |
|
IListReportJobsPaginator |
Paginator for the ListReportJobs operation |
|
IListReportPlansPaginator |
Paginator for the ListReportPlans operation |
|
IListRestoreJobsByProtectedResourcePaginator |
Paginator for the ListRestoreJobsByProtectedResource operation |
|
IListRestoreJobsPaginator |
Paginator for the ListRestoreJobs operation |
|
IListRestoreJobSummariesPaginator |
Paginator for the ListRestoreJobSummaries operation |
|
IListRestoreTestingPlansPaginator |
Paginator for the ListRestoreTestingPlans operation |
|
IListRestoreTestingSelectionsPaginator |
Paginator for the ListRestoreTestingSelections operation |
|
IListTagsPaginator |
Paginator for the ListTags operation |