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.
", "operations": { "CancelLegalHold": "This action removes the specified legal hold on a recovery point. This action can only be performed by a user with sufficient permissions.
", "CreateBackupPlan": "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.
", "CreateBackupVault": "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.
", "CreateLegalHold": "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.
", "CreateLogicallyAirGappedBackupVault": "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.
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.
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.
", "CreateRestoreTestingSelection": "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 RestoreTestingSelectionName, ProtectedResourceType, and one of the following:
ProtectedResourceArns
ProtectedResourceConditions
Each protected resource type can have one single value.
A restore testing selection can include a wildcard value (\"*\") for ProtectedResourceArns along with ProtectedResourceConditions. Alternatively, you can include up to 30 specific protected resource ARNs in ProtectedResourceArns.
Cannot select by both protected resource types AND specific ARNs. Request will fail if both are included.
", "DeleteBackupPlan": "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.
", "DeleteBackupSelection": "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.
", "DeleteBackupVaultAccessPolicy": "Deletes the policy document that manages permissions on a backup vault.
", "DeleteBackupVaultLockConfiguration": "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.
", "DeleteFramework": "Deletes the framework specified by a framework name.
", "DeleteRecoveryPoint": "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.
", "DeleteRestoreTestingPlan": "This request deletes the specified restore testing plan.
Deletion can only successfully occur if all associated restore testing selections are deleted first.
", "DeleteRestoreTestingSelection": "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.
", "DescribeBackupJob": "Returns backup job details for the specified BackupJobId.
Returns metadata about a backup vault specified by its name.
", "DescribeCopyJob": "Returns metadata associated with creating a copy of a resource.
", "DescribeFramework": "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.
", "DescribeRecoveryPoint": "Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
", "DescribeRegionSettings": "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.
", "DescribeReportJob": "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.
", "DescribeRestoreJob": "Returns metadata associated with a restore job that is specified by a job ID.
", "DisassociateRecoveryPoint": "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.
", "DisassociateRecoveryPointFromParent": "This action to a specific child (nested) recovery point removes the relationship between the specified recovery point and its parent (composite) recovery point.
", "ExportBackupPlanTemplate": "Returns the backup plan that is specified by the plan ID as a backup template.
", "GetBackupPlan": "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.
", "GetBackupPlanFromTemplate": "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.
", "GetBackupVaultAccessPolicy": "Returns the access policy document that is associated with the named backup vault.
", "GetBackupVaultNotifications": "Returns event notifications for the specified backup vault.
", "GetLegalHold": "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.
", "GetRecoveryPointRestoreMetadata": "Returns a set of metadata key-value pairs that were used to create the backup.
", "GetRestoreJobMetadata": "This request returns the metadata for the specified restore job.
", "GetRestoreTestingInferredMetadata": "This request returns the minimal required set of metadata needed to start a restore job with secure default settings. BackupVaultName and RecoveryPointArn are required parameters. BackupVaultAccountId is an optional parameter.
Returns RestoreTestingPlan details for the specified RestoreTestingPlanName. The details are the body of a restore testing plan in JSON format, in addition to plan metadata.
Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan.
", "GetSupportedResourceTypes": "Returns the Amazon Web Services resource types supported by Backup.
", "ListBackupJobSummaries": "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.
", "ListBackupJobs": "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.
", "ListBackupPlanTemplates": "Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.
", "ListBackupPlanVersions": "Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.
", "ListBackupPlans": "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.
", "ListBackupSelections": "Returns an array containing metadata of the resources associated with the target backup plan.
", "ListBackupVaults": "Returns a list of recovery point storage containers along with information about them.
", "ListCopyJobSummaries": "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.
", "ListCopyJobs": "Returns metadata about your copy jobs.
", "ListFrameworks": "Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.
", "ListLegalHolds": "This action returns metadata about active and previous legal holds.
", "ListProtectedResources": "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.
", "ListProtectedResourcesByBackupVault": "This request lists the protected resources corresponding to each backup vault.
", "ListRecoveryPointsByBackupVault": "Returns detailed information about the recovery points stored in a backup vault.
", "ListRecoveryPointsByLegalHold": "This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.
", "ListRecoveryPointsByResource": "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.
", "ListReportPlans": "Returns a list of your report plans. For detailed information about a single report plan, use DescribeReportPlan.
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.
", "ListRestoreJobs": "Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.
", "ListRestoreJobsByProtectedResource": "This returns restore jobs that contain the specified protected resource.
You must include ResourceArn. You can optionally include NextToken, ByStatus, MaxResults, ByRecoveryPointCreationDateAfter , and ByRecoveryPointCreationDateBefore.
Returns a list of restore testing plans.
", "ListRestoreTestingSelections": "Returns a list of restore testing selections. Can be filtered by MaxResults and RestoreTestingPlanName.
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.
", "PutBackupVaultLockConfiguration": "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.
", "PutRestoreValidationResult": "This request allows you to send your independent self-run restore test validation results. RestoreJobId and ValidationStatus are required. Optionally, you can input a ValidationStatusMessage.
Starts an on-demand backup job for the specified resource.
", "StartCopyJob": "Starts a job to create a one-time copy of the specified resource.
Does not support continuous backups.
", "StartReportJob": "Starts an on-demand report job for the specified report plan.
", "StartRestoreJob": "Recovers the saved resource identified by an Amazon Resource Name (ARN).
", "StopBackupJob": "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.
", "TagResource": "Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).
", "UntagResource": "Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)
", "UpdateBackupPlan": "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.
", "UpdateRegionSettings": "Updates the current service opt-in settings for the 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.
This request will send changes to your specified restore testing plan. RestoreTestingPlanName cannot be updated after it is created.
RecoveryPointSelection can contain:
Algorithm
ExcludeVaults
IncludeVaults
RecoveryPointTypes
SelectionWindowDays
Most elements except the RestoreTestingSelectionName can be updated with this request.
RestoreTestingSelection can use either protected resource ARNs or conditions, but not both. That is, if your selection has ProtectedResourceArns, requesting an update with the parameter ProtectedResourceConditions will be unsuccessful.
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
", "BackupPlansListMember$BackupPlanArn": "An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
A server-side encryption key you can specify to encrypt your backups from services that support full Backup management; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. If you specify a key, you must specify its ARN, not its alias. If you do not specify a key, Backup creates a KMS key for you by default.
To learn which Backup services support full Backup management and how Backup handles encryption for backups from services that do not yet support full Backup, see Encryption for backups in Backup
", "CopyAction$DestinationBackupVaultArn": "An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copied backup. For example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An ARN that uniquely identifies a source recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An ARN that uniquely identifies a destination recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
The Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
", "CreateBackupPlanOutput$BackupPlanArn": "An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
", "CreateLegalHoldOutput$LegalHoldArn": "This is the ARN (Amazon Resource Number) of the created legal hold.
", "CreateLogicallyAirGappedBackupVaultOutput$BackupVaultArn": "This is the ARN (Amazon Resource Name) of the vault being created.
", "CreateReportPlanOutput$ReportPlanArn": "An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
", "DeleteBackupPlanOutput$BackupPlanArn": "An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
", "DescribeBackupVaultOutput$BackupVaultArn": "An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
", "DescribeProtectedResourceInput$ResourceArn": "An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
", "DescribeProtectedResourceOutput$ResourceArn": "An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
", "DescribeProtectedResourceOutput$LastBackupVaultArn": "This is the ARN (Amazon Resource Name) of the backup vault that contains the most recent backup recovery point.
", "DescribeProtectedResourceOutput$LastRecoveryPointArn": "This is the ARN (Amazon Resource Name) of the most recent recovery point.
", "DescribeRecoveryPointInput$RecoveryPointArn": "An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An Amazon Resource Name (ARN) that uniquely identifies the source vault where the resource was originally backed up in; for example, arn:aws:backup:us-east-1:123456789012:vault:BackupVault. If the recovery is restored to the same Amazon Web Services account or Region, this value will be null.
An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
", "DescribeRecoveryPointOutput$EncryptionKeyArn": "The server-side encryption key used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
This is an ARN that uniquely identifies a parent (composite) recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery point is being restored. The format of the ARN depends on the resource type of the backed-up resource.
", "DisassociateRecoveryPointFromParentInput$RecoveryPointArn": "This is the Amazon Resource Name (ARN) that uniquely identifies the child (nested) recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
An Amazon Resource Name (ARN) that uniquely identifies an Backup recovery point.
", "Framework$FrameworkArn": "An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
", "GetBackupPlanOutput$BackupPlanArn": "An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An ARN that uniquely identifies an Amazon Simple Notification Service (Amazon SNS) topic; for example, arn:aws:sns:us-west-2:111122223333:MyTopic.
This is the returned framework ARN for the specified legal hold. An Amazon Resource Name (ARN) uniquely identifies a resource. The format of the ARN depends on the resource type.
", "GetRecoveryPointRestoreMetadataInput$RecoveryPointArn": "An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
This is an Amazon Resource Number (ARN) that uniquely identifies the legal hold; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).
", "ListCopyJobsInput$ByResourceArn": "Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).
", "ListRecoveryPointsByBackupVaultInput$ByResourceArn": "Returns only recovery points that match the specified resource Amazon Resource Name (ARN).
", "ListRecoveryPointsByBackupVaultInput$ByParentRecoveryPointArn": "This returns only recovery points that match the specified parent (composite) recovery point Amazon Resource Name (ARN).
", "ListRecoveryPointsByResourceInput$ResourceArn": "An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
", "ListRestoreJobsByProtectedResourceInput$ResourceArn": "Returns only restore jobs that match the specified resource Amazon Resource Name (ARN).
", "ListRestoreJobsInput$ByRestoreTestingPlanArn": "This returns only restore testing jobs that match the specified resource Amazon Resource Name (ARN).
", "ListTagsInput$ResourceArn": "An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the type of resource. Valid targets for ListTags are recovery points, backup plans, and backup vaults.
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
", "ProtectedResource$LastBackupVaultArn": "This is the ARN (Amazon Resource Name) of the backup vault that contains the most recent backup recovery point.
", "ProtectedResource$LastRecoveryPointArn": "This is the ARN (Amazon Resource Name) of the most recent recovery point.
", "PutBackupVaultNotificationsInput$SNSTopicArn": "The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic.
An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
The backup vault where the recovery point was originally copied from. If the recovery point is restored to the same account this value will be null.
An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
", "RecoveryPointByBackupVault$EncryptionKeyArn": "The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.
", "RecoveryPointByResource$RecoveryPointArn": "An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.
", "RecoveryPointCreator$BackupPlanArn": "An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
This is the Amazon Resource Name (ARN) of the parent (composite) recovery point.
", "RecoveryPointMember$ResourceArn": "This is the Amazon Resource Name (ARN) that uniquely identifies a saved resource.
", "ReportJob$ReportPlanArn": "An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
", "ReportPlan$ReportPlanArn": "An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
", "ResourceArns$member": null, "ResourceTypeList$member": null, "RestoreJobCreator$RestoreTestingPlanArn": "An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.
", "RestoreJobsListMember$RecoveryPointArn": "An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
", "StartBackupJobInput$ResourceArn": "An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
", "StartBackupJobOutput$RecoveryPointArn": "Note: This field is only returned for Amazon EFS and Advanced DynamoDB resources.
An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
An ARN that uniquely identifies a recovery point to use for the copy job; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
", "StartCopyJobInput$DestinationBackupVaultArn": "An Amazon Resource Name (ARN) that uniquely identifies a destination backup vault to copy to; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource.
", "UntagResourceInput$ResourceArn": "An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource.
", "UpdateBackupPlanOutput$BackupPlanArn": "An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
", "UpdateRecoveryPointLifecycleInput$RecoveryPointArn": "An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
" } }, "AccountId": { "base": null, "refs": { "BackupJob$AccountId": "The account ID that owns the backup job.
", "BackupJobSummary$AccountId": "The account ID that owns the jobs within the summary.
", "CopyJob$AccountId": "The account ID that owns the copy job.
", "CopyJobSummary$AccountId": "The account ID that owns the jobs within the summary.
", "DescribeBackupJobOutput$AccountId": "Returns the account ID that owns the backup job.
", "DescribeRecoveryPointInput$BackupVaultAccountId": "This is the account ID of the specified backup vault.
", "DescribeRestoreJobOutput$AccountId": "Returns the account ID that owns the restore job.
", "GetRecoveryPointRestoreMetadataInput$BackupVaultAccountId": "This is the account ID of the specified backup vault.
", "ListBackupJobSummariesInput$AccountId": "Returns the job count for the specified account.
If the request is sent from a member account or an account not part of Amazon Web Services Organizations, jobs within requestor's account will be returned.
Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.
AGGREGATE_ALL aggregates job counts from all accounts within the authenticated organization, then returns the sum.
The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.
If used from an Organizations management account, passing * returns all jobs across the organization.
Returns the job count for the specified account.
If the request is sent from a member account or an account not part of Amazon Web Services Organizations, jobs within requestor's account will be returned.
Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.
AGGREGATE_ALL aggregates job counts from all accounts within the authenticated organization, then returns the sum.
The account ID to list the jobs from. Returns only copy jobs associated with the specified account ID.
", "ListProtectedResourcesByBackupVaultInput$BackupVaultAccountId": "This is the list of protected resources by backup vault within the vault(s) you specify by account ID.
", "ListRecoveryPointsByBackupVaultInput$BackupVaultAccountId": "This parameter will sort the list of recovery points by account ID.
", "ListRestoreJobSummariesInput$AccountId": "Returns the job count for the specified account.
If the request is sent from a member account or an account not part of Amazon Web Services Organizations, jobs within requestor's account will be returned.
Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.
AGGREGATE_ALL aggregates job counts from all accounts within the authenticated organization, then returns the sum.
The account ID to list the jobs from. Returns only restore jobs associated with the specified account ID.
", "RestoreJobSummary$AccountId": "The account ID that owns the jobs within the summary.
", "RestoreJobsListMember$AccountId": "The account ID that owns the restore job.
" } }, "AdvancedBackupSetting": { "base": "A list of backup options for each resource type.
", "refs": { "AdvancedBackupSettings$member": null } }, "AdvancedBackupSettings": { "base": null, "refs": { "BackupPlan$AdvancedBackupSettings": "Contains a list of BackupOptions for each resource type.
Specifies a list of BackupOptions for each resource type. These settings are only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
Contains a list of BackupOptions for a resource type.
A list of BackupOptions settings for a resource type. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
Contains a list of BackupOptions for each resource type. The list is populated only if the advanced option is set for the backup plan.
Contains a list of BackupOptions for each resource type.
This is the period that sets the boundaries for returned results.
Acceptable values include
ONE_DAY for daily job count for the prior 14 days.
SEVEN_DAYS for the aggregated job count for the prior 7 days.
FOURTEEN_DAYS for aggregated job count for prior 14 days.
This is the period that sets the boundaries for returned results.
ONE_DAY for daily job count for the prior 14 days.
SEVEN_DAYS for the aggregated job count for the prior 7 days.
FOURTEEN_DAYS for aggregated job count for prior 14 days.
This is the period that sets the boundaries for returned results.
Acceptable values include
ONE_DAY for daily job count for the prior 14 days.
SEVEN_DAYS for the aggregated job count for the prior 7 days.
FOURTEEN_DAYS for aggregated job count for prior 14 days.
The required resource already exists.
", "refs": { } }, "BackupJob": { "base": "Contains detailed information about a backup job.
", "refs": { "BackupJobsList$member": null } }, "BackupJobChildJobsInState": { "base": null, "refs": { "DescribeBackupJobOutput$ChildJobsInState": "This returns the statistics of the included child (nested) backup jobs.
" } }, "BackupJobState": { "base": null, "refs": { "BackupJob$State": "The current state of a backup job.
", "BackupJobChildJobsInState$key": null, "DescribeBackupJobOutput$State": "The current state of a backup job.
", "ListBackupJobsInput$ByState": "Returns only backup jobs that are in the specified state.
" } }, "BackupJobStatus": { "base": null, "refs": { "BackupJobSummary$State": "This value is job count for jobs with the specified state.
", "ListBackupJobSummariesInput$State": "This parameter returns the job count for jobs with the specified state.
The the value ANY returns count of all states.
AGGREGATE_ALL aggregates job counts for all states and returns the sum.
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.
", "refs": { "BackupJobSummaryList$member": null } }, "BackupJobSummaryList": { "base": null, "refs": { "ListBackupJobSummariesOutput$BackupJobSummaries": "This request returns a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
" } }, "BackupJobsList": { "base": null, "refs": { "ListBackupJobsOutput$BackupJobs": "An array of structures containing metadata about your backup jobs returned in JSON format.
" } }, "BackupOptionKey": { "base": null, "refs": { "BackupOptions$key": null } }, "BackupOptionValue": { "base": null, "refs": { "BackupOptions$value": null } }, "BackupOptions": { "base": null, "refs": { "AdvancedBackupSetting$BackupOptions": "Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.
Valid values:
Set to \"WindowsVSS\":\"enabled\" to enable the WindowsVSS backup option and create a Windows VSS backup.
Set to \"WindowsVSS\":\"disabled\" to create a regular backup. The WindowsVSS option is not enabled by default.
If you specify an invalid option, you get an InvalidParameterValueException exception.
For more information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup.
", "BackupJob$BackupOptions": "Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
Valid values: Set to \"WindowsVSS\":\"enabled\" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to \"WindowsVSS\":\"disabled\" to create a regular backup. If you specify an invalid option, you get an InvalidParameterValueException exception.
Represents the options specified as part of backup plan or on-demand backup job.
", "StartBackupJobInput$BackupOptions": "Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
Valid values: Set to \"WindowsVSS\":\"enabled\" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to \"WindowsVSS\"\"disabled\" to create a regular backup. The WindowsVSS option is not enabled by default.
Contains an optional backup plan display name and an array of BackupRule objects, each of which specifies a backup rule. Each rule in a backup plan is a separate scheduled task and can back up a different selection of Amazon Web Services resources.
Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.
Returns the body of a backup plan based on the target template, including the name, rules, and backup vault of the plan.
", "GetBackupPlanOutput$BackupPlan": "Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.
Contains an optional backup plan display name and an array of BackupRule objects, each of which specifies a backup rule. Each rule in a backup plan is a separate scheduled task.
Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.
Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.
The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' characters.
", "BackupPlanInput$BackupPlanName": "The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' characters.
", "BackupPlansListMember$BackupPlanName": "The display name of a saved backup plan.
" } }, "BackupPlanTemplatesList": { "base": null, "refs": { "ListBackupPlanTemplatesOutput$BackupPlanTemplatesList": "An array of template list items containing metadata about your saved templates.
" } }, "BackupPlanTemplatesListMember": { "base": "An object specifying metadata associated with a backup plan template.
", "refs": { "BackupPlanTemplatesList$member": null } }, "BackupPlanVersionsList": { "base": null, "refs": { "ListBackupPlanVersionsOutput$BackupPlanVersionsList": "An array of version list items containing metadata about your backup plans.
" } }, "BackupPlansList": { "base": null, "refs": { "ListBackupPlansOutput$BackupPlansList": "An array of backup plan list items containing metadata about your saved backup plans.
" } }, "BackupPlansListMember": { "base": "Contains metadata about a backup plan.
", "refs": { "BackupPlanVersionsList$member": null, "BackupPlansList$member": null } }, "BackupRule": { "base": "Specifies a scheduled task used to back up a selection of resources.
", "refs": { "BackupRules$member": null } }, "BackupRuleInput": { "base": "Specifies a scheduled task used to back up a selection of resources.
", "refs": { "BackupRulesInput$member": null } }, "BackupRuleName": { "base": null, "refs": { "BackupRule$RuleName": "A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.
", "BackupRuleInput$RuleName": "A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.
" } }, "BackupRules": { "base": null, "refs": { "BackupPlan$Rules": "An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.
An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.
Used to specify a set of resources to a backup plan.
Specifying your desired Conditions, ListOfTags, NotResources, and/or Resources is recommended. If none of these are specified, Backup will attempt to select all supported and opted-in storage resources, which could have unintended cost implications.
Specifies the body of a request to assign a set of resources to a backup plan.
", "GetBackupSelectionOutput$BackupSelection": "Specifies the body of a request to assign a set of resources to a backup plan.
" } }, "BackupSelectionName": { "base": null, "refs": { "BackupSelection$SelectionName": "The display name of a resource selection document. Must contain 1 to 50 alphanumeric or '-_.' characters.
", "BackupSelectionsListMember$SelectionName": "The display name of a resource selection document.
" } }, "BackupSelectionsList": { "base": null, "refs": { "ListBackupSelectionsOutput$BackupSelectionsList": "An array of backup selection list items containing metadata about each resource in the list.
" } }, "BackupSelectionsListMember": { "base": "Contains metadata about a BackupSelection object.
An array of events that indicate the status of jobs to back up resources to the backup vault.
", "PutBackupVaultNotificationsInput$BackupVaultEvents": "An array of events that indicate the status of jobs to back up resources to the backup vault.
For common use cases and code samples, see Using Amazon SNS to track Backup events.
The following events are supported:
BACKUP_JOB_STARTED | BACKUP_JOB_COMPLETED
COPY_JOB_STARTED | COPY_JOB_SUCCESSFUL | COPY_JOB_FAILED
RESTORE_JOB_STARTED | RESTORE_JOB_COMPLETED | RECOVERY_POINT_MODIFIED
S3_BACKUP_OBJECT_FAILED | S3_RESTORE_OBJECT_FAILED
The list below shows items that are deprecated events (for reference) and are no longer in use. They are no longer supported and will not return statuses or notifications. Refer to the list above for current supported events.
An array of backup vault list members containing vault metadata, including Amazon Resource Name (ARN), display name, creation date, number of saved recovery points, and encryption information if the resources saved in the backup vault are encrypted.
" } }, "BackupVaultListMember": { "base": "Contains metadata about a backup vault.
", "refs": { "BackupVaultList$member": null } }, "BackupVaultName": { "base": null, "refs": { "BackupJob$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", "BackupRule$TargetBackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", "BackupRuleInput$TargetBackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", "BackupVaultListMember$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", "CreateBackupVaultInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.
", "CreateBackupVaultOutput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", "CreateLogicallyAirGappedBackupVaultInput$BackupVaultName": "This is the name of the vault that is being created.
", "CreateLogicallyAirGappedBackupVaultOutput$BackupVaultName": "The name of a logical container where backups are stored. Logically air-gapped backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", "DeleteBackupVaultAccessPolicyInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", "DeleteBackupVaultLockConfigurationInput$BackupVaultName": "The name of the backup vault from which to delete Backup Vault Lock.
", "DeleteBackupVaultNotificationsInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", "DeleteRecoveryPointInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", "DescribeBackupJobOutput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", "DescribeRecoveryPointInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", "DescribeRecoveryPointOutput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", "DisassociateRecoveryPointFromParentInput$BackupVaultName": "This is the name of a logical container where the child (nested) recovery point is stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", "DisassociateRecoveryPointInput$BackupVaultName": "The unique name of an Backup vault.
", "GetBackupVaultAccessPolicyInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", "GetBackupVaultAccessPolicyOutput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", "GetBackupVaultNotificationsInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", "GetBackupVaultNotificationsOutput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", "GetRecoveryPointRestoreMetadataInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", "ListBackupJobsInput$ByBackupVaultName": "Returns only backup jobs that will be stored in the specified backup vault. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", "ListProtectedResourcesByBackupVaultInput$BackupVaultName": "This is the list of protected resources by backup vault within the vault(s) you specify by name.
", "ListRecoveryPointsByBackupVaultInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
Backup vault name might not be available when a supported service creates the backup.
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", "PutBackupVaultLockConfigurationInput$BackupVaultName": "The Backup Vault Lock configuration that specifies the name of the backup vault it protects.
", "PutBackupVaultNotificationsInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", "RecoveryPointByBackupVault$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", "RecoveryPointByResource$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", "RecoveryPointMember$BackupVaultName": "This is the name of the backup vault (the logical container in which backups are stored).
", "StartBackupJobInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", "StartCopyJobInput$SourceBackupVaultName": "The name of a logical source container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", "UpdateRecoveryPointLifecycleInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
" } }, "Boolean": { "base": null, "refs": { "BackupRule$EnableContinuousBackup": "Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes Backup to create snapshot backups.
", "BackupRuleInput$EnableContinuousBackup": "Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes Backup to create snapshot backups.
", "BackupVaultListMember$Locked": "A Boolean value that indicates whether Backup Vault Lock applies to the selected backup vault. If true, Vault Lock prevents delete and update operations on the recovery points in the selected vault.
A Boolean that indicates whether Backup Vault Lock is currently protecting the backup vault. True means that Vault Lock causes delete or update operations on the recovery points stored in the vault to fail.
Optional Boolean. If this is true, this setting will instruct your backup plan to transition supported resources to archive (cold) storage tier in accordance with your lifecycle settings.
", "ListBackupPlansInput$IncludeDeleted": "A Boolean value with a default value of FALSE that returns deleted backup plans when set to TRUE.
Contains DeleteAt and MoveToColdStorageAt timestamps, which are used to specify a lifecycle for 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.
", "refs": { "DescribeRecoveryPointOutput$CalculatedLifecycle": "A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.
A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.
A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.
The ID of the only Amazon Web Services resource that you want your control scope to contain.
" } }, "Condition": { "base": "Contains an array of triplets made up of a condition type (such as StringEquals), a key, and a value. Used to filter resources using their tags and assign them to a backup plan. Case sensitive.
The key in a key-value pair. For example, in the tag Department: Accounting, Department is the key.
The key in a key-value pair. For example, in the tag Department: Accounting, Department is the key.
Includes information about tags you define to assign tagged resources to a backup plan.
", "refs": { "ConditionParameters$member": null } }, "ConditionParameters": { "base": null, "refs": { "Conditions$StringEquals": "Filters the values of your tagged resources for only those resources that you tagged with the same value. Also called \"exact matching.\"
", "Conditions$StringNotEquals": "Filters the values of your tagged resources for only those resources that you tagged that do not have the same value. Also called \"negated matching.\"
", "Conditions$StringLike": "Filters the values of your tagged resources for matching tag values with the use of a wildcard character (*) anywhere in the string. For example, \"prod*\" or \"*rod*\" matches the tag value \"production\".
", "Conditions$StringNotLike": "Filters the values of your tagged resources for non-matching tag values with the use of a wildcard character (*) anywhere in the string.
" } }, "ConditionType": { "base": null, "refs": { "Condition$ConditionType": "An operation applied to a key-value pair used to assign resources to your backup plan. Condition only supports StringEquals. For more flexible assignment options, including StringLike and the ability to exclude resources from your backup plan, use Conditions (with an \"s\" on the end) for your BackupSelection .
The value in a key-value pair. For example, in the tag Department: Accounting, Accounting is the value.
The value in a key-value pair. For example, in the tag Department: Accounting, Accounting is the value.
Contains information about which resources to include or exclude from a backup plan using their tags. Conditions are case sensitive.
", "refs": { "BackupSelection$Conditions": "A list of conditions that you define to assign resources to your backup plans using tags. For example, \"StringEquals\": { \"Key\": \"aws:ResourceTag/CreatedByCryo\", \"Value\": \"true\" },. Condition operators are case sensitive.
Conditions differs from ListOfTags as follows:
When you specify more than one condition, you only assign the resources that match ALL conditions (using AND logic).
Conditions supports StringEquals, StringLike, StringNotEquals, and StringNotLike. ListOfTags only supports StringEquals.
Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.
", "refs": { } }, "ControlInputParameter": { "base": "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 daily and the retention period is at least 1 year\". The first parameter is daily. The second parameter is 1 year.
A list of ParameterName and ParameterValue pairs.
The name of a control. This name is between 1 and 256 characters.
" } }, "ControlScope": { "base": "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 ControlScope empty or do not pass it when calling CreateFramework.
The scope of a control. The control scope defines what the control will evaluate. Three examples of control scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans.
" } }, "CopyAction": { "base": "The details of the copy operation.
", "refs": { "CopyActions$member": null } }, "CopyActions": { "base": null, "refs": { "BackupRule$CopyActions": "An array of CopyAction objects, which contains the details of the copy operation.
An array of CopyAction objects, which contains the details of the copy operation.
Contains detailed information about a copy job.
", "refs": { "CopyJobsList$member": null, "DescribeCopyJobOutput$CopyJob": "Contains detailed information about a copy job.
" } }, "CopyJobChildJobsInState": { "base": null, "refs": { "CopyJob$ChildJobsInState": "This returns the statistics of the included child (nested) copy jobs.
" } }, "CopyJobState": { "base": null, "refs": { "CopyJob$State": "The current state of a copy job.
", "CopyJobChildJobsInState$key": null, "ListCopyJobsInput$ByState": "Returns only copy jobs that are in the specified state.
" } }, "CopyJobStatus": { "base": null, "refs": { "CopyJobSummary$State": "This value is job count for jobs with the specified state.
", "ListCopyJobSummariesInput$State": "This parameter returns the job count for jobs with the specified state.
The the value ANY returns count of all states.
AGGREGATE_ALL aggregates job counts for all states and returns the sum.
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.
", "refs": { "CopyJobSummaryList$member": null } }, "CopyJobSummaryList": { "base": null, "refs": { "ListCopyJobSummariesOutput$CopyJobSummaries": "This return shows a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
" } }, "CopyJobsList": { "base": null, "refs": { "ListCopyJobsOutput$CopyJobs": "An array of structures containing metadata about your copy jobs returned in JSON format.
" } }, "CreateBackupPlanInput": { "base": null, "refs": { } }, "CreateBackupPlanOutput": { "base": null, "refs": { } }, "CreateBackupSelectionInput": { "base": null, "refs": { } }, "CreateBackupSelectionOutput": { "base": null, "refs": { } }, "CreateBackupVaultInput": { "base": null, "refs": { } }, "CreateBackupVaultOutput": { "base": null, "refs": { } }, "CreateFrameworkInput": { "base": null, "refs": { } }, "CreateFrameworkOutput": { "base": null, "refs": { } }, "CreateLegalHoldInput": { "base": null, "refs": { } }, "CreateLegalHoldOutput": { "base": null, "refs": { } }, "CreateLogicallyAirGappedBackupVaultInput": { "base": null, "refs": { } }, "CreateLogicallyAirGappedBackupVaultOutput": { "base": null, "refs": { } }, "CreateReportPlanInput": { "base": null, "refs": { } }, "CreateReportPlanOutput": { "base": null, "refs": { } }, "CreateRestoreTestingPlanInput": { "base": null, "refs": { } }, "CreateRestoreTestingPlanOutput": { "base": null, "refs": { } }, "CreateRestoreTestingSelectionInput": { "base": null, "refs": { } }, "CreateRestoreTestingSelectionOutput": { "base": null, "refs": { } }, "CronExpression": { "base": null, "refs": { "BackupRule$ScheduleExpression": "A cron expression in UTC specifying when Backup initiates a backup job. For more information about Amazon Web Services cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.. Two examples of Amazon Web Services cron expressions are 15 * ? * * * (take a backup every hour at 15 minutes past the hour) and 0 12 * * ? * (take a backup every day at 12 noon UTC). For a table of examples, click the preceding link and scroll down the page.
A CRON expression in UTC specifying when Backup initiates a backup job.
" } }, "DateRange": { "base": "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.
", "refs": { "RecoveryPointSelection$DateRange": null } }, "DeleteBackupPlanInput": { "base": null, "refs": { } }, "DeleteBackupPlanOutput": { "base": null, "refs": { } }, "DeleteBackupSelectionInput": { "base": null, "refs": { } }, "DeleteBackupVaultAccessPolicyInput": { "base": null, "refs": { } }, "DeleteBackupVaultInput": { "base": null, "refs": { } }, "DeleteBackupVaultLockConfigurationInput": { "base": null, "refs": { } }, "DeleteBackupVaultNotificationsInput": { "base": null, "refs": { } }, "DeleteFrameworkInput": { "base": null, "refs": { } }, "DeleteRecoveryPointInput": { "base": null, "refs": { } }, "DeleteReportPlanInput": { "base": null, "refs": { } }, "DeleteRestoreTestingPlanInput": { "base": null, "refs": { } }, "DeleteRestoreTestingSelectionInput": { "base": null, "refs": { } }, "DependencyFailureException": { "base": "A dependent Amazon Web Services service or resource returned an error to the Backup service, and the action cannot be completed.
", "refs": { } }, "DescribeBackupJobInput": { "base": null, "refs": { } }, "DescribeBackupJobOutput": { "base": null, "refs": { } }, "DescribeBackupVaultInput": { "base": null, "refs": { } }, "DescribeBackupVaultOutput": { "base": null, "refs": { } }, "DescribeCopyJobInput": { "base": null, "refs": { } }, "DescribeCopyJobOutput": { "base": null, "refs": { } }, "DescribeFrameworkInput": { "base": null, "refs": { } }, "DescribeFrameworkOutput": { "base": null, "refs": { } }, "DescribeGlobalSettingsInput": { "base": null, "refs": { } }, "DescribeGlobalSettingsOutput": { "base": null, "refs": { } }, "DescribeProtectedResourceInput": { "base": null, "refs": { } }, "DescribeProtectedResourceOutput": { "base": null, "refs": { } }, "DescribeRecoveryPointInput": { "base": null, "refs": { } }, "DescribeRecoveryPointOutput": { "base": null, "refs": { } }, "DescribeRegionSettingsInput": { "base": null, "refs": { } }, "DescribeRegionSettingsOutput": { "base": null, "refs": { } }, "DescribeReportJobInput": { "base": null, "refs": { } }, "DescribeReportJobOutput": { "base": null, "refs": { } }, "DescribeReportPlanInput": { "base": null, "refs": { } }, "DescribeReportPlanOutput": { "base": null, "refs": { } }, "DescribeRestoreJobInput": { "base": null, "refs": { } }, "DescribeRestoreJobOutput": { "base": null, "refs": { } }, "DisassociateRecoveryPointFromParentInput": { "base": null, "refs": { } }, "DisassociateRecoveryPointInput": { "base": null, "refs": { } }, "ExportBackupPlanTemplateInput": { "base": null, "refs": { } }, "ExportBackupPlanTemplateOutput": { "base": null, "refs": { } }, "FormatList": { "base": null, "refs": { "ReportDeliveryChannel$Formats": "A list of the format of your reports: CSV, JSON, or both. If not specified, the default format is CSV.
Contains detailed information about a framework. Frameworks contain controls, which evaluate and report on your backup events and resources. Frameworks generate daily compliance results.
", "refs": { "FrameworkList$member": null } }, "FrameworkControl": { "base": "Contains detailed information about all of the controls of a framework. Each framework must contain at least one control.
", "refs": { "FrameworkControls$member": null } }, "FrameworkControls": { "base": null, "refs": { "CreateFrameworkInput$FrameworkControls": "A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.
", "DescribeFrameworkOutput$FrameworkControls": "A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.
", "UpdateFrameworkInput$FrameworkControls": "A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.
" } }, "FrameworkDescription": { "base": null, "refs": { "CreateFrameworkInput$FrameworkDescription": "An optional description of the framework with a maximum of 1,024 characters.
", "DescribeFrameworkOutput$FrameworkDescription": "An optional description of the framework.
", "Framework$FrameworkDescription": "An optional description of the framework with a maximum 1,024 characters.
", "UpdateFrameworkInput$FrameworkDescription": "An optional description of the framework with a maximum 1,024 characters.
" } }, "FrameworkList": { "base": null, "refs": { "ListFrameworksOutput$Frameworks": "A list of frameworks with details for each framework, including the framework name, Amazon Resource Name (ARN), description, number of controls, creation time, and deployment status.
" } }, "FrameworkName": { "base": null, "refs": { "CreateFrameworkInput$FrameworkName": "The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
", "CreateFrameworkOutput$FrameworkName": "The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
", "DeleteFrameworkInput$FrameworkName": "The unique name of a framework.
", "DescribeFrameworkInput$FrameworkName": "The unique name of a framework.
", "DescribeFrameworkOutput$FrameworkName": "The unique name of a framework.
", "Framework$FrameworkName": "The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
", "UpdateFrameworkInput$FrameworkName": "The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
", "UpdateFrameworkOutput$FrameworkName": "The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
" } }, "GetBackupPlanFromJSONInput": { "base": null, "refs": { } }, "GetBackupPlanFromJSONOutput": { "base": null, "refs": { } }, "GetBackupPlanFromTemplateInput": { "base": null, "refs": { } }, "GetBackupPlanFromTemplateOutput": { "base": null, "refs": { } }, "GetBackupPlanInput": { "base": null, "refs": { } }, "GetBackupPlanOutput": { "base": null, "refs": { } }, "GetBackupSelectionInput": { "base": null, "refs": { } }, "GetBackupSelectionOutput": { "base": null, "refs": { } }, "GetBackupVaultAccessPolicyInput": { "base": null, "refs": { } }, "GetBackupVaultAccessPolicyOutput": { "base": null, "refs": { } }, "GetBackupVaultNotificationsInput": { "base": null, "refs": { } }, "GetBackupVaultNotificationsOutput": { "base": null, "refs": { } }, "GetLegalHoldInput": { "base": null, "refs": { } }, "GetLegalHoldOutput": { "base": null, "refs": { } }, "GetRecoveryPointRestoreMetadataInput": { "base": null, "refs": { } }, "GetRecoveryPointRestoreMetadataOutput": { "base": null, "refs": { } }, "GetRestoreJobMetadataInput": { "base": null, "refs": { } }, "GetRestoreJobMetadataOutput": { "base": null, "refs": { } }, "GetRestoreTestingInferredMetadataInput": { "base": null, "refs": { } }, "GetRestoreTestingInferredMetadataOutput": { "base": null, "refs": { } }, "GetRestoreTestingPlanInput": { "base": null, "refs": { } }, "GetRestoreTestingPlanOutput": { "base": null, "refs": { } }, "GetRestoreTestingSelectionInput": { "base": null, "refs": { } }, "GetRestoreTestingSelectionOutput": { "base": null, "refs": { } }, "GetSupportedResourceTypesOutput": { "base": null, "refs": { } }, "GlobalSettings": { "base": null, "refs": { "DescribeGlobalSettingsOutput$GlobalSettings": "The status of the flag isCrossAccountBackupEnabled.
A value for isCrossAccountBackupEnabled and a Region. Example: update-global-settings --global-settings isCrossAccountBackupEnabled=false --region us-west-2.
The backup vault access policy document in JSON format.
", "PutBackupVaultAccessPolicyInput$Policy": "The backup vault access policy document in JSON format.
" } }, "IAMRoleArn": { "base": null, "refs": { "BackupJob$IamRoleArn": "Specifies the IAM role ARN used to create the target recovery point. IAM roles other than the default role must include either AWSBackup or AwsBackup in the role name. For example, arn:aws:iam::123456789012:role/AWSBackupRDSAccess. Role names without those strings lack permissions to perform backup jobs.
The ARN of the IAM role that Backup uses to authenticate when backing up the target resource; for example, arn:aws:iam::123456789012:role/S3Access.
Specifies the IAM role Amazon Resource Name (ARN) to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example: arn:aws:iam::123456789012:role/S3Access.
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
", "refs": { } }, "InvalidRequestException": { "base": "Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
", "refs": { } }, "InvalidResourceStateException": { "base": "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.
", "refs": { } }, "IsEnabled": { "base": null, "refs": { "ResourceTypeManagementPreference$value": null, "ResourceTypeOptInPreference$value": null } }, "KeyValue": { "base": "Pair of two related strings. Allowed characters are letters, white space, and numbers that can be represented in UTF-8 and the following characters: + - = . _ : /
Filters the values of your tagged resources for only those resources that you tagged with the same value. Also called \"exact matching.\"
", "ProtectedResourceConditions$StringNotEquals": "Filters the values of your tagged resources for only those resources that you tagged that do not have the same value. Also called \"negated matching.\"
" } }, "LegalHold": { "base": "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.
", "refs": { "LegalHoldsList$member": null } }, "LegalHoldStatus": { "base": null, "refs": { "CreateLegalHoldOutput$Status": "This displays the status of the legal hold returned after creating the legal hold. Statuses can be ACTIVE, PENDING, CANCELED, CANCELING, or FAILED.
This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED, and CANCELING.
This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED, and CANCELING.
This is an array of returned legal holds, both active and previous.
" } }, "Lifecycle": { "base": "Contains an array of Transition objects specifying how long in days before a recovery point transitions to cold storage or is deleted.
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.
", "refs": { "BackupRule$Lifecycle": "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.
", "BackupRuleInput$Lifecycle": "The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire 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 parameter has a maximum value of 100 years (36,500 days).
", "CopyAction$Lifecycle": null, "DescribeRecoveryPointOutput$Lifecycle": "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 that are 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.
", "RecoveryPointByBackupVault$Lifecycle": "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.
", "StartBackupJobInput$Lifecycle": "The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire 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 parameter has a maximum value of 100 years (36,500 days).
", "StartCopyJobInput$Lifecycle": null, "UpdateRecoveryPointLifecycleInput$Lifecycle": "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.
", "UpdateRecoveryPointLifecycleOutput$Lifecycle": "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.
" } }, "LimitExceededException": { "base": "A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
", "refs": { } }, "ListBackupJobSummariesInput": { "base": null, "refs": { } }, "ListBackupJobSummariesOutput": { "base": null, "refs": { } }, "ListBackupJobsInput": { "base": null, "refs": { } }, "ListBackupJobsOutput": { "base": null, "refs": { } }, "ListBackupPlanTemplatesInput": { "base": null, "refs": { } }, "ListBackupPlanTemplatesOutput": { "base": null, "refs": { } }, "ListBackupPlanVersionsInput": { "base": null, "refs": { } }, "ListBackupPlanVersionsOutput": { "base": null, "refs": { } }, "ListBackupPlansInput": { "base": null, "refs": { } }, "ListBackupPlansOutput": { "base": null, "refs": { } }, "ListBackupSelectionsInput": { "base": null, "refs": { } }, "ListBackupSelectionsOutput": { "base": null, "refs": { } }, "ListBackupVaultsInput": { "base": null, "refs": { } }, "ListBackupVaultsOutput": { "base": null, "refs": { } }, "ListCopyJobSummariesInput": { "base": null, "refs": { } }, "ListCopyJobSummariesOutput": { "base": null, "refs": { } }, "ListCopyJobsInput": { "base": null, "refs": { } }, "ListCopyJobsOutput": { "base": null, "refs": { } }, "ListFrameworksInput": { "base": null, "refs": { } }, "ListFrameworksOutput": { "base": null, "refs": { } }, "ListLegalHoldsInput": { "base": null, "refs": { } }, "ListLegalHoldsOutput": { "base": null, "refs": { } }, "ListOfTags": { "base": null, "refs": { "BackupSelection$ListOfTags": "A list of conditions that you define to assign resources to your backup plans using tags. For example, \"StringEquals\": { \"Key\": \"aws:ResourceTag/CreatedByCryo\", \"Value\": \"true\" },. Condition operators are case sensitive.
ListOfTags differs from Conditions as follows:
When you specify more than one condition, you assign all resources that match AT LEAST ONE condition (using OR logic).
ListOfTags only supports StringEquals. Conditions supports StringEquals, StringLike, StringNotEquals, and StringNotLike.
The maximum number of items to be returned.
" } }, "ListRestoreTestingPlansOutput": { "base": null, "refs": { } }, "ListRestoreTestingSelectionsInput": { "base": null, "refs": { } }, "ListRestoreTestingSelectionsInputMaxResultsInteger": { "base": null, "refs": { "ListRestoreTestingSelectionsInput$MaxResults": "The maximum number of items to be returned.
" } }, "ListRestoreTestingSelectionsOutput": { "base": null, "refs": { } }, "ListTagsInput": { "base": null, "refs": { } }, "ListTagsOutput": { "base": null, "refs": { } }, "Long": { "base": null, "refs": { "BackupJob$BackupSizeInBytes": "The size, in bytes, of a backup.
", "BackupJob$BytesTransferred": "The size in bytes transferred to a backup vault at the time that the job status was queried.
", "BackupJobChildJobsInState$value": null, "BackupVaultListMember$MinRetentionDays": "The Backup Vault Lock setting that specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a minimum retention period.
If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.
", "BackupVaultListMember$MaxRetentionDays": "The Backup Vault Lock setting that specifies the maximum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a maximum retention period on the recovery points in the vault (allowing indefinite storage).
If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.
", "CancelLegalHoldInput$RetainRecordInDays": "The integer amount in days specifying amount of days after this API operation to remove legal hold.
", "CopyJob$BackupSizeInBytes": "The size, in bytes, of a copy job.
", "CopyJob$NumberOfChildJobs": "This is the number of child (nested) copy jobs.
", "CopyJobChildJobsInState$value": null, "CreateLogicallyAirGappedBackupVaultInput$MinRetentionDays": "This setting specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, no minimum retention period is enforced.
If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If a job retention period is shorter than that minimum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault.
", "CreateLogicallyAirGappedBackupVaultInput$MaxRetentionDays": "This is the setting that specifies the maximum retention period that the vault retains its recovery points. If this parameter is not specified, Backup does not enforce a maximum retention period on the recovery points in the vault (allowing indefinite storage).
If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault.
", "DescribeBackupJobOutput$BackupSizeInBytes": "The size, in bytes, of a backup.
", "DescribeBackupJobOutput$BytesTransferred": "The size in bytes transferred to a backup vault at the time that the job status was queried.
", "DescribeBackupJobOutput$NumberOfChildJobs": "This returns the number of child (nested) backup jobs.
", "DescribeBackupVaultOutput$MinRetentionDays": "The Backup Vault Lock setting that specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a minimum retention period.
If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.
", "DescribeBackupVaultOutput$MaxRetentionDays": "The Backup Vault Lock setting that specifies the maximum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a maximum retention period on the recovery points in the vault (allowing indefinite storage).
If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.
", "DescribeProtectedResourceOutput$LatestRestoreExecutionTimeMinutes": "This is the time in minutes the most recent restore job took to complete.
", "DescribeRecoveryPointOutput$BackupSizeInBytes": "The size, in bytes, of a backup.
", "DescribeRestoreJobOutput$BackupSizeInBytes": "The size, in bytes, of the restored resource.
", "DescribeRestoreJobOutput$ExpectedCompletionTimeMinutes": "The amount of time in minutes that a job restoring a recovery point is expected to take.
", "Lifecycle$MoveToColdStorageAfterDays": "Specifies the number of days after creation that a recovery point is moved to cold storage.
", "Lifecycle$DeleteAfterDays": "Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.
The Backup Vault Lock configuration that specifies the minimum retention period that the vault retains its recovery points. This setting can be useful if, for example, your organization's policies require you to retain certain data for at least seven years (2555 days).
If this parameter is not specified, Vault Lock will not enforce a minimum retention period.
If this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails that backup or copy job, and you should either modify your lifecycle settings or use a different vault. The shortest minimum retention period you can specify is 1 day. Recovery points already saved in the vault prior to Vault Lock are not affected.
", "PutBackupVaultLockConfigurationInput$MaxRetentionDays": "The Backup Vault Lock configuration that specifies the maximum retention period that the vault retains its recovery points. This setting can be useful if, for example, your organization's policies require you to destroy certain data after retaining it for four years (1460 days).
If this parameter is not included, Vault Lock does not enforce a maximum retention period on the recovery points in the vault. If this parameter is included without a value, Vault Lock will not enforce a maximum retention period.
If this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. The longest maximum retention period you can specify is 36500 days (approximately 100 years). Recovery points already saved in the vault prior to Vault Lock are not affected.
", "PutBackupVaultLockConfigurationInput$ChangeableForDays": "The Backup Vault Lock configuration that specifies the number of days before the lock date. For example, setting ChangeableForDays to 30 on Jan. 1, 2022 at 8pm UTC will set the lock date to Jan. 31, 2022 at 8pm UTC.
Backup enforces a 72-hour cooling-off period before Vault Lock takes effect and becomes immutable. Therefore, you must set ChangeableForDays to 3 or greater.
Before the lock date, you can delete Vault Lock from the vault using DeleteBackupVaultLockConfiguration or change the Vault Lock configuration using PutBackupVaultLockConfiguration. On and after the lock date, the Vault Lock becomes immutable and cannot be changed or deleted.
If this parameter is not specified, you can delete Vault Lock from the vault using DeleteBackupVaultLockConfiguration or change the Vault Lock configuration using PutBackupVaultLockConfiguration at any time.
The size, in bytes, of a backup.
", "RecoveryPointByResource$BackupSizeBytes": "The size, in bytes, of a backup.
", "RestoreJobsListMember$BackupSizeInBytes": "The size, in bytes, of the restored resource.
", "RestoreJobsListMember$ExpectedCompletionTimeMinutes": "The amount of time in minutes that a job restoring a recovery point is expected to take.
" } }, "MaxFrameworkInputs": { "base": null, "refs": { "ListFrameworksInput$MaxResults": "The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.
" } }, "MaxResults": { "base": null, "refs": { "ListBackupJobSummariesInput$MaxResults": "This parameter sets the maximum number of items to be returned.
The value is an integer. Range of accepted values is from 1 to 500.
", "ListBackupJobsInput$MaxResults": "The maximum number of items to be returned.
", "ListBackupPlanTemplatesInput$MaxResults": "The maximum number of items to be returned.
", "ListBackupPlanVersionsInput$MaxResults": "The maximum number of items to be returned.
", "ListBackupPlansInput$MaxResults": "The maximum number of items to be returned.
", "ListBackupSelectionsInput$MaxResults": "The maximum number of items to be returned.
", "ListBackupVaultsInput$MaxResults": "The maximum number of items to be returned.
", "ListCopyJobSummariesInput$MaxResults": "This parameter sets the maximum number of items to be returned.
The value is an integer. Range of accepted values is from 1 to 500.
", "ListCopyJobsInput$MaxResults": "The maximum number of items to be returned.
", "ListLegalHoldsInput$MaxResults": "The maximum number of resource list items to be returned.
", "ListProtectedResourcesByBackupVaultInput$MaxResults": "The maximum number of items to be returned.
", "ListProtectedResourcesInput$MaxResults": "The maximum number of items to be returned.
", "ListRecoveryPointsByBackupVaultInput$MaxResults": "The maximum number of items to be returned.
", "ListRecoveryPointsByLegalHoldInput$MaxResults": "This is the maximum number of resource list items to be returned.
", "ListRecoveryPointsByResourceInput$MaxResults": "The maximum number of items to be returned.
Amazon RDS requires a value of at least 20.
The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.
", "ListReportPlansInput$MaxResults": "The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.
", "ListRestoreJobSummariesInput$MaxResults": "This parameter sets the maximum number of items to be returned.
The value is an integer. Range of accepted values is from 1 to 500.
", "ListRestoreJobsByProtectedResourceInput$MaxResults": "The maximum number of items to be returned.
", "ListRestoreJobsInput$MaxResults": "The maximum number of items to be returned.
", "ListTagsInput$MaxResults": "The maximum number of items to be returned.
" } }, "MessageCategory": { "base": null, "refs": { "BackupJobSummary$MessageCategory": "This parameter is the job count for the specified message category.
Example strings include AccessDenied, Success, and InvalidParameters. See Monitoring for a list of MessageCategory strings.
The the value ANY returns count of all message categories.
AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.
This parameter is the job count for the specified message category.
Example strings include AccessDenied, Success, and InvalidParameters. See Monitoring for a list of MessageCategory strings.
The the value ANY returns count of all message categories.
AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.
This parameter returns the job count for the specified message category.
Example accepted strings include AccessDenied, Success, and InvalidParameters. See Monitoring for a list of accepted MessageCategory strings.
The the value ANY returns count of all message categories.
AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.
This parameter returns the job count for the specified message category.
Example accepted strings include AccessDenied, Success, and InvalidParameters. See Monitoring for a list of accepted MessageCategory strings.
The the value ANY returns count of all message categories.
AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.
The set of metadata key-value pairs that describe the original configuration of the backed-up resource. These values vary depending on the service that is being restored.
", "GetRestoreJobMetadataOutput$Metadata": "This contains the metadata of the specified backup job.
", "StartRestoreJobInput$Metadata": "A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.
You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata. However, values in addition to those provided by GetRecoveryPointRestoreMetadata might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.
You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:
file-system-id: The ID of the Amazon EFS file system that is backed up by Backup. Returned in GetRecoveryPointRestoreMetadata.
Encrypted: A Boolean value that, if true, specifies that the file system is encrypted. If KmsKeyId is specified, Encrypted must be set to true.
KmsKeyId: Specifies the Amazon Web Services KMS key that is used to encrypt the restored file system. You can specify a key from another Amazon Web Services account provided that key it is properly shared with your account via Amazon Web Services KMS.
PerformanceMode: Specifies the throughput mode of the file system.
CreationToken: A user-supplied value that ensures the uniqueness (idempotency) of the request.
newFileSystem: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.
ItemsToRestore: An array of one to five strings where each string is a file path. Use ItemsToRestore to restore specific files or directories rather than the entire file system. This parameter is optional. For example, \"itemsToRestore\":\"[\\\"/my.test\\\"]\".
Indicates that a required parameter is missing.
", "refs": { } }, "ParameterName": { "base": null, "refs": { "ControlInputParameter$ParameterName": "The name of a parameter, for example, BackupPlanFrequency.
The value of parameter, for example, hourly.
A structure that contains information about a backed-up resource.
", "refs": { "ProtectedResourcesList$member": null } }, "ProtectedResourceConditions": { "base": "A list of conditions that you define for resources in your restore testing plan using tags.
For example, \"StringEquals\": { \"Key\": \"aws:ResourceTag/CreatedByCryo\", \"Value\": \"true\" },. Condition operators are case sensitive.
If you have included the wildcard in ProtectedResourceArns, you can include resource conditions, such as ProtectedResourceConditions: { StringEquals: [{ key: \"XXXX\", value: \"YYYY\" }].
In a resource testing selection, this parameter filters by specific conditions such as StringEquals or StringNotEquals.
A list of conditions that you define for resources in your restore testing plan using tags.
For example, \"StringEquals\": { \"Key\": \"aws:ResourceTag/CreatedByCryo\", \"Value\": \"true\" },. Condition operators are case sensitive.
These are the results returned for the request ListProtectedResourcesByBackupVault.
", "ListProtectedResourcesOutput$Results": "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.
" } }, "PutBackupVaultAccessPolicyInput": { "base": null, "refs": { } }, "PutBackupVaultLockConfigurationInput": { "base": null, "refs": { } }, "PutBackupVaultNotificationsInput": { "base": null, "refs": { } }, "PutRestoreValidationResultInput": { "base": null, "refs": { } }, "RecoveryPointByBackupVault": { "base": "Contains detailed information about the recovery points stored in a backup vault.
", "refs": { "RecoveryPointByBackupVaultList$member": null } }, "RecoveryPointByBackupVaultList": { "base": null, "refs": { "ListRecoveryPointsByBackupVaultOutput$RecoveryPoints": "An array of objects that contain detailed information about recovery points saved in a backup vault.
" } }, "RecoveryPointByResource": { "base": "Contains detailed information about a saved recovery point.
", "refs": { "RecoveryPointByResourceList$member": null } }, "RecoveryPointByResourceList": { "base": null, "refs": { "ListRecoveryPointsByResourceOutput$RecoveryPoints": "An array of objects that contain detailed information about recovery points of the specified resource type.
Only Amazon EFS and Amazon EC2 recovery points return BackupVaultName.
Contains information about the backup plan and rule that Backup used to initiate the recovery point backup.
", "refs": { "BackupJob$CreatedBy": "Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.
Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it.
Contains identifying information about the creation of a recovery point, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.
Contains identifying information about the creation of a recovery point, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it.
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.
", "refs": { "RecoveryPointsList$member": null } }, "RecoveryPointSelection": { "base": "This specifies criteria to assign a set of resources, such as resource types or backup vaults.
", "refs": { "CreateLegalHoldInput$RecoveryPointSelection": "This specifies criteria to assign a set of resources, such as resource types or backup vaults.
", "CreateLegalHoldOutput$RecoveryPointSelection": "This specifies criteria to assign a set of resources, such as resource types or backup vaults.
", "GetLegalHoldOutput$RecoveryPointSelection": "This specifies criteria to assign a set of resources, such as resource types or backup vaults.
" } }, "RecoveryPointStatus": { "base": null, "refs": { "DescribeRecoveryPointOutput$Status": "A status code specifying the state of the recovery point.
PARTIAL status indicates Backup could not create the recovery point before the backup window closed. To increase your backup plan window using the API, see UpdateBackupPlan. You can also increase your backup plan window using the Console by choosing and editing your backup plan.
EXPIRED status indicates that the recovery point has exceeded its retention period, but Backup lacks permission or is otherwise unable to delete it. To manually delete these recovery points, see Step 3: Delete the recovery points in the Clean up resources section of Getting started.
STOPPED status occurs on a continuous backup where a user has taken some action that causes the continuous backup to be disabled. This can be caused by the removal of permissions, turning off versioning, turning off events being sent to EventBridge, or disabling the EventBridge rules that are put in place by Backup.
To resolve STOPPED status, ensure that all requested permissions are in place and that versioning is enabled on the S3 bucket. Once these conditions are met, the next instance of a backup rule running will result in a new continuous recovery point being created. The recovery points with STOPPED status do not need to be deleted.
For SAP HANA on Amazon EC2 STOPPED status occurs due to user action, application misconfiguration, or backup failure. To ensure that future continuous backups succeed, refer to the recovery point status and check SAP HANA for details.
A status code specifying the state of the recovery point.
", "RecoveryPointByResource$Status": "A status code specifying the state of the recovery point.
" } }, "RecoveryPointsList": { "base": null, "refs": { "ListRecoveryPointsByLegalHoldOutput$RecoveryPoints": "This is a list of the recovery points returned by ListRecoveryPointsByLegalHold.
The Amazon Web Services Regions within the job summary.
", "CopyJobSummary$Region": "This is the Amazon Web Services Regions within the job summary.
", "RestoreJobSummary$Region": "The Amazon Web Services Regions within the job summary.
" } }, "ReportDeliveryChannel": { "base": "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.
", "refs": { "CreateReportPlanInput$ReportDeliveryChannel": "A structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
", "ReportPlan$ReportDeliveryChannel": "Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
", "UpdateReportPlanInput$ReportDeliveryChannel": "A structure that contains information about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
" } }, "ReportDestination": { "base": "Contains information from your report job about your report destination.
", "refs": { "ReportJob$ReportDestination": "The S3 bucket name and S3 keys for the destination where the report job publishes the report.
" } }, "ReportJob": { "base": "Contains detailed information about a report job. A report job compiles a report based on a report plan and publishes it to Amazon S3.
", "refs": { "DescribeReportJobOutput$ReportJob": "A list of information about a report job, including its completion and creation times, report destination, unique report job ID, Amazon Resource Name (ARN), report template, status, and status message.
", "ReportJobList$member": null } }, "ReportJobId": { "base": null, "refs": { "DescribeReportJobInput$ReportJobId": "The identifier of the report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. The report job ID cannot be edited.
", "ReportJob$ReportJobId": "The identifier for a report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. Report job IDs cannot be edited.
", "StartReportJobOutput$ReportJobId": "The identifier of the report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. The report job ID cannot be edited.
" } }, "ReportJobList": { "base": null, "refs": { "ListReportJobsOutput$ReportJobs": "Details about your report jobs in JSON format.
" } }, "ReportPlan": { "base": "Contains detailed information about a report plan.
", "refs": { "DescribeReportPlanOutput$ReportPlan": "Returns details about the report plan that is specified by its name. These details include the report plan's Amazon Resource Name (ARN), description, settings, delivery channel, deployment status, creation time, and last attempted and successful run times.
", "ReportPlanList$member": null } }, "ReportPlanDescription": { "base": null, "refs": { "CreateReportPlanInput$ReportPlanDescription": "An optional description of the report plan with a maximum of 1,024 characters.
", "ReportPlan$ReportPlanDescription": "An optional description of the report plan with a maximum 1,024 characters.
", "UpdateReportPlanInput$ReportPlanDescription": "An optional description of the report plan with a maximum 1,024 characters.
" } }, "ReportPlanList": { "base": null, "refs": { "ListReportPlansOutput$ReportPlans": "A list of your report plans with detailed information for each plan. This information includes the Amazon Resource Name (ARN), report plan name, description, settings, delivery channel, deployment status, creation time, and last times the report plan attempted to and successfully ran.
" } }, "ReportPlanName": { "base": null, "refs": { "CreateReportPlanInput$ReportPlanName": "The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
", "CreateReportPlanOutput$ReportPlanName": "The unique name of the report plan.
", "DeleteReportPlanInput$ReportPlanName": "The unique name of a report plan.
", "DescribeReportPlanInput$ReportPlanName": "The unique name of a report plan.
", "ListReportJobsInput$ByReportPlanName": "Returns only report jobs with the specified report plan name.
", "ReportPlan$ReportPlanName": "The unique name of the report plan. This name is between 1 and 256 characters starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
", "StartReportJobInput$ReportPlanName": "The unique name of a report plan.
", "UpdateReportPlanInput$ReportPlanName": "The unique name of the report plan. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
", "UpdateReportPlanOutput$ReportPlanName": "The unique name of the report plan.
" } }, "ReportSetting": { "base": "Contains detailed information about a report setting.
", "refs": { "CreateReportPlanInput$ReportSetting": "Identifies the report template for the report. Reports are built using a report template. The report templates are:
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.
Identifies the report template for the report. Reports are built using a report template. The report templates are:
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.
Identifies the report template for the report. Reports are built using a report template. The report templates are:
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.
A list of Amazon Resource Names (ARNs) to assign to a backup plan. The maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards.
If you need to assign many resources to a backup plan, consider a different resource selection strategy, such as assigning all resources of a resource type or refining your resource selection using tags.
", "BackupSelection$NotResources": "A list of Amazon Resource Names (ARNs) to exclude from a backup plan. The maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards.
If you need to exclude many resources from a backup plan, consider a different resource selection strategy, such as assigning only one or a few resource types or refining your resource selection using tags.
" } }, "ResourceIdentifiers": { "base": null, "refs": { "RecoveryPointSelection$ResourceIdentifiers": "These are the resources included in the resource selection (including type of resources and vaults).
" } }, "ResourceNotFoundException": { "base": "A resource that is required for the action doesn't exist.
", "refs": { } }, "ResourceType": { "base": null, "refs": { "AdvancedBackupSetting$ResourceType": "Specifies an object containing resource type and backup options. The only supported resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service (VSS). For a CloudFormation example, see the sample CloudFormation template to enable Windows VSS in the Backup User Guide.
Valid values: EC2.
The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.
", "BackupJobSummary$ResourceType": "This value is the job count for the specified resource type. The request GetSupportedResourceTypes returns strings for supported resource types.
The type of Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
", "CopyJobSummary$ResourceType": "This value is the job count for the specified resource type. The request GetSupportedResourceTypes returns strings for supported resource types
The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
", "DescribeProtectedResourceOutput$ResourceType": "The type of Amazon Web Services resource saved as a recovery point; for example, an Amazon EBS volume or an Amazon RDS database.
", "DescribeRecoveryPointOutput$ResourceType": "The type of Amazon Web Services resource to save as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
", "DescribeRestoreJobOutput$ResourceType": "Returns metadata associated with a restore job listed by resource type.
", "GetRecoveryPointRestoreMetadataOutput$ResourceType": "This is the resource type associated with the recovery point.
", "ListBackupJobSummariesInput$ResourceType": "Returns the job count for the specified resource type. Use request GetSupportedResourceTypes to obtain strings for supported resource types.
The the value ANY returns count of all resource types.
AGGREGATE_ALL aggregates job counts for all resource types and returns the sum.
The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
", "ListBackupJobsInput$ByResourceType": "Returns only backup jobs for the specified resources:
Aurora for Amazon Aurora
CloudFormation for CloudFormation
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSx for Amazon FSx
Neptune for Amazon Neptune
Redshift for Amazon Redshift
RDS for Amazon Relational Database Service
SAP HANA on Amazon EC2 for SAP HANA databases
Storage Gateway for Storage Gateway
S3 for Amazon S3
Timestream for Amazon Timestream
VirtualMachine for virtual machines
Returns the job count for the specified resource type. Use request GetSupportedResourceTypes to obtain strings for supported resource types.
The the value ANY returns count of all resource types.
AGGREGATE_ALL aggregates job counts for all resource types and returns the sum.
The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
", "ListCopyJobsInput$ByResourceType": "Returns only backup jobs for the specified resources:
Aurora for Amazon Aurora
CloudFormation for CloudFormation
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSx for Amazon FSx
Neptune for Amazon Neptune
Redshift for Amazon Redshift
RDS for Amazon Relational Database Service
SAP HANA on Amazon EC2 for SAP HANA databases
Storage Gateway for Storage Gateway
S3 for Amazon S3
Timestream for Amazon Timestream
VirtualMachine for virtual machines
Returns only recovery points that match the specified resource type(s):
Aurora for Amazon Aurora
CloudFormation for CloudFormation
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSx for Amazon FSx
Neptune for Amazon Neptune
Redshift for Amazon Redshift
RDS for Amazon Relational Database Service
SAP HANA on Amazon EC2 for SAP HANA databases
Storage Gateway for Storage Gateway
S3 for Amazon S3
Timestream for Amazon Timestream
VirtualMachine for virtual machines
Returns the job count for the specified resource type. Use request GetSupportedResourceTypes to obtain strings for supported resource types.
The the value ANY returns count of all resource types.
AGGREGATE_ALL aggregates job counts for all resource types and returns the sum.
The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
", "ListRestoreJobsInput$ByResourceType": "Include this parameter to return only restore jobs for the specified resources:
Aurora for Amazon Aurora
CloudFormation for CloudFormation
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSx for Amazon FSx
Neptune for Amazon Neptune
Redshift for Amazon Redshift
RDS for Amazon Relational Database Service
SAP HANA on Amazon EC2 for SAP HANA databases
Storage Gateway for Storage Gateway
S3 for Amazon S3
Timestream for Amazon Timestream
VirtualMachine for virtual machines
The type of Amazon Web Services resource; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.
", "RecoveryPointByBackupVault$ResourceType": "The type of Amazon Web Services resource saved as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.
", "RecoveryPointMember$ResourceType": "This is the Amazon Web Services resource type that is saved as a recovery point.
", "ResourceTypeManagementPreference$key": null, "ResourceTypeOptInPreference$key": null, "ResourceTypes$member": null, "RestoreJobSummary$ResourceType": "This value is the job count for the specified resource type. The request GetSupportedResourceTypes returns strings for supported resource types.
The resource type of the listed restore jobs; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.
", "StartRestoreJobInput$ResourceType": "Starts a job to restore a recovery point for one of the following resources:
Aurora for Amazon Aurora
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
CloudFormation for CloudFormation
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSx for Amazon FSx
Neptune for Amazon Neptune
RDS for Amazon Relational Database Service
Redshift for Amazon Redshift
Storage Gateway for Storage Gateway
S3 for Amazon S3
Timestream for Amazon Timestream
VirtualMachine for virtual machines
Describes whether the control scope includes one or more types of resources, such as EFS or RDS.
Returns whether Backup fully manages the backups for a resource type.
For the benefits of full Backup management, see Full Backup management.
For a list of resource types and whether each supports full Backup management, see the Feature availability by resource table.
If \"DynamoDB\":false, you can enable full Backup management for DynamoDB backup by enabling Backup's advanced DynamoDB backup features.
Enables or disables full Backup management of backups for a resource type. To enable full Backup management for DynamoDB along with Backup's advanced DynamoDB backup features, follow the procedure to enable advanced DynamoDB backup programmatically.
" } }, "ResourceTypeOptInPreference": { "base": null, "refs": { "DescribeRegionSettingsOutput$ResourceTypeOptInPreference": "Returns a list of all services along with the opt-in preferences in the Region.
", "UpdateRegionSettingsInput$ResourceTypeOptInPreference": "Updates the list of services along with the opt-in preferences for the Region.
If resource assignments are only based on tags, then service opt-in settings are applied. If a resource type is explicitly assigned to a backup plan, such as Amazon S3, Amazon EC2, or Amazon RDS, it will be included in the backup even if the opt-in is not enabled for that particular service. If both a resource type and tags are specified in a resource assignment, the resource type specified in the backup plan takes priority over the tag condition. Service opt-in settings are disregarded in this situation.
" } }, "ResourceTypes": { "base": null, "refs": { "GetSupportedResourceTypesOutput$ResourceTypes": "Contains a string with the supported Amazon Web Services resource types:
Aurora for Amazon Aurora
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSX for Amazon FSx
RDS for Amazon Relational Database Service
Storage Gateway for Storage Gateway
DocDB for Amazon DocumentDB (with MongoDB compatibility)
Neptune for Amazon Neptune
This notes the status of the data generated by the restore test. The status may be Deleting, Failed, or Successful.
This notes the status of the data generated by the restore test. The status may be Deleting, Failed, or Successful.
Contains information about the restore testing plan that Backup used to initiate the restore job.
", "refs": { "DescribeRestoreJobOutput$CreatedBy": "Contains identifying information about the creation of a restore job.
", "RestoreJobsListMember$CreatedBy": "Contains identifying information about the creation of a restore job.
" } }, "RestoreJobId": { "base": null, "refs": { "DescribeRestoreJobInput$RestoreJobId": "Uniquely identifies the job that restores a recovery point.
", "GetRestoreJobMetadataInput$RestoreJobId": "This is a unique identifier of a restore job within Backup.
", "GetRestoreJobMetadataOutput$RestoreJobId": "This is a unique identifier of a restore job within Backup.
", "PutRestoreValidationResultInput$RestoreJobId": "This is a unique identifier of a restore job within Backup.
", "StartRestoreJobOutput$RestoreJobId": "Uniquely identifies the job that restores a recovery point.
" } }, "RestoreJobState": { "base": null, "refs": { "ListRestoreJobSummariesInput$State": "This parameter returns the job count for jobs with the specified state.
The the value ANY returns count of all states.
AGGREGATE_ALL aggregates job counts for all states and returns the sum.
This value is job count for jobs with the specified state.
" } }, "RestoreJobStatus": { "base": null, "refs": { "DescribeRestoreJobOutput$Status": "Status code specifying the state of the job that is initiated by Backup to restore a recovery point.
", "ListRestoreJobsByProtectedResourceInput$ByStatus": "Returns only restore jobs associated with the specified job status.
", "ListRestoreJobsInput$ByStatus": "Returns only restore jobs associated with the specified job status.
", "RestoreJobsListMember$Status": "A status code specifying the state of the job initiated by Backup to restore a recovery point.
" } }, "RestoreJobSummary": { "base": "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.
", "refs": { "RestoreJobSummaryList$member": null } }, "RestoreJobSummaryList": { "base": null, "refs": { "ListRestoreJobSummariesOutput$RestoreJobSummaries": "This return contains a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
" } }, "RestoreJobsList": { "base": null, "refs": { "ListRestoreJobsByProtectedResourceOutput$RestoreJobs": "An array of objects that contain detailed information about jobs to restore saved resources.>
", "ListRestoreJobsOutput$RestoreJobs": "An array of objects that contain detailed information about jobs to restore saved resources.
" } }, "RestoreJobsListMember": { "base": "Contains metadata about a restore job.
", "refs": { "RestoreJobsList$member": null } }, "RestoreTestingPlanForCreate": { "base": "This contains metadata about a restore testing plan.
", "refs": { "CreateRestoreTestingPlanInput$RestoreTestingPlan": "A restore testing plan must contain a unique RestoreTestingPlanName string you create and must contain a ScheduleExpression cron. You may optionally include a StartWindowHours integer and a CreatorRequestId string.
The RestoreTestingPlanName is a unique string that is the name of the restore testing plan. This cannot be changed after creation, and it must consist of only alphanumeric characters and underscores.
This contains metadata about a restore testing plan.
", "refs": { "GetRestoreTestingPlanOutput$RestoreTestingPlan": "Specifies the body of a restore testing plan. Includes RestoreTestingPlanName.
This contains metadata about a restore testing plan.
", "refs": { "RestoreTestingPlans$member": null } }, "RestoreTestingPlanForUpdate": { "base": "This contains metadata about a restore testing plan.
", "refs": { "UpdateRestoreTestingPlanInput$RestoreTestingPlan": "Specifies the body of a restore testing plan.
" } }, "RestoreTestingPlans": { "base": null, "refs": { "ListRestoreTestingPlansOutput$RestoreTestingPlans": "This is a returned list of restore testing plans.
" } }, "RestoreTestingRecoveryPointSelection": { "base": "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.
", "refs": { "RestoreTestingPlanForCreate$RecoveryPointSelection": "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.
", "RestoreTestingPlanForGet$RecoveryPointSelection": "The specified criteria to assign a set of resources, such as recovery point types or backup vaults.
", "RestoreTestingPlanForUpdate$RecoveryPointSelection": "Required: Algorithm; RecoveryPointTypes; IncludeVaults (one or more).
Optional: SelectionWindowDays ('30' if not specified); ExcludeVaults (defaults to empty list if not listed).
Acceptable values include \"LATEST_WITHIN_WINDOW\" or \"RANDOM_WITHIN_WINDOW\"
" } }, "RestoreTestingRecoveryPointType": { "base": null, "refs": { "RestoreTestingRecoveryPointTypeList$member": null } }, "RestoreTestingRecoveryPointTypeList": { "base": null, "refs": { "RestoreTestingRecoveryPointSelection$RecoveryPointTypes": "These are the types of recovery points.
" } }, "RestoreTestingSelectionForCreate": { "base": "This contains metadata about a specific restore testing selection.
ProtectedResourceType is required, such as Amazon EBS or Amazon EC2.
This consists of RestoreTestingSelectionName, ProtectedResourceType, and one of the following:
ProtectedResourceArns
ProtectedResourceConditions
Each protected resource type can have one single value.
A restore testing selection can include a wildcard value (\"*\") for ProtectedResourceArns along with ProtectedResourceConditions. Alternatively, you can include up to 30 specific protected resource ARNs in ProtectedResourceArns.
ProtectedResourceConditions examples include as StringEquals and StringNotEquals.
This consists of RestoreTestingSelectionName, ProtectedResourceType, and one of the following:
ProtectedResourceArns
ProtectedResourceConditions
Each protected resource type can have one single value.
A restore testing selection can include a wildcard value (\"*\") for ProtectedResourceArns along with ProtectedResourceConditions. Alternatively, you can include up to 30 specific protected resource ARNs in ProtectedResourceArns.
This contains metadata about a restore testing selection.
", "refs": { "GetRestoreTestingSelectionOutput$RestoreTestingSelection": "Unique name of the restore testing selection.
" } }, "RestoreTestingSelectionForList": { "base": "This contains metadata about a restore testing selection.
", "refs": { "RestoreTestingSelections$member": null } }, "RestoreTestingSelectionForUpdate": { "base": "This contains metadata about a restore testing selection.
", "refs": { "UpdateRestoreTestingSelectionInput$RestoreTestingSelection": "To update your restore testing selection, you can use either protected resource ARNs or conditions, but not both. That is, if your selection has ProtectedResourceArns, requesting an update with the parameter ProtectedResourceConditions will be unsuccessful.
The returned restore testing selections associated with the restore testing plan.
" } }, "RestoreValidationStatus": { "base": null, "refs": { "DescribeRestoreJobOutput$ValidationStatus": "This is the status of validation run on the indicated restore job.
", "PutRestoreValidationResultInput$ValidationStatus": "This is the status of your restore validation.
", "RestoreJobsListMember$ValidationStatus": "This is the status of validation run on the indicated restore job.
" } }, "SensitiveStringMap": { "base": null, "refs": { "CreateRestoreTestingPlanInput$Tags": "Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters,numbers, spaces, and the following characters: + - = . _ : /.
", "RestoreTestingSelectionForCreate$RestoreMetadataOverrides": "You can override certain restore metadata keys by including the parameter RestoreMetadataOverrides in the body of RestoreTestingSelection. Key values are not case sensitive.
See the complete list of restore testing inferred metadata.
", "RestoreTestingSelectionForGet$RestoreMetadataOverrides": "You can override certain restore metadata keys by including the parameter RestoreMetadataOverrides in the body of RestoreTestingSelection. Key values are not case sensitive.
See the complete list of restore testing inferred metadata.
", "RestoreTestingSelectionForUpdate$RestoreMetadataOverrides": "You can override certain restore metadata keys by including the parameter RestoreMetadataOverrides in the body of RestoreTestingSelection. Key values are not case sensitive.
See the complete list of restore testing inferred metadata.
" } }, "ServiceUnavailableException": { "base": "The request failed due to a temporary failure of the server.
", "refs": { } }, "StartBackupJobInput": { "base": null, "refs": { } }, "StartBackupJobOutput": { "base": null, "refs": { } }, "StartCopyJobInput": { "base": null, "refs": { } }, "StartCopyJobOutput": { "base": null, "refs": { } }, "StartReportJobInput": { "base": null, "refs": { } }, "StartReportJobOutput": { "base": null, "refs": { } }, "StartRestoreJobInput": { "base": null, "refs": { } }, "StartRestoreJobOutput": { "base": null, "refs": { } }, "StopBackupJobInput": { "base": null, "refs": { } }, "StorageClass": { "base": null, "refs": { "DescribeRecoveryPointOutput$StorageClass": "Specifies the storage class of the recovery point. Valid values are WARM or COLD.
This is a unique string that identifies the request and allows failed requests to be retriedwithout the risk of running the operation twice. This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
", "CreateRestoreTestingPlanOutput$RestoreTestingPlanArn": "An Amazon Resource Name (ARN) that uniquely identifies the created restore testing plan.
", "CreateRestoreTestingPlanOutput$RestoreTestingPlanName": "This unique string is the name of the restore testing plan.
The name cannot be changed after creation. The name consists of only alphanumeric characters and underscores. Maximum length is 50.
", "CreateRestoreTestingSelectionInput$CreatorRequestId": "This is an optional unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
", "CreateRestoreTestingSelectionInput$RestoreTestingPlanName": "Input the restore testing plan name that was returned from the related CreateRestoreTestingPlan request.
", "CreateRestoreTestingSelectionOutput$RestoreTestingPlanArn": "This is the ARN of the restore testing plan with which the restore testing selection is associated.
", "CreateRestoreTestingSelectionOutput$RestoreTestingPlanName": "Unique string that is the name of the restore testing plan.
The name cannot be changed after creation. The name consists of only alphanumeric characters and underscores. Maximum length is 50.
", "CreateRestoreTestingSelectionOutput$RestoreTestingSelectionName": "This is the unique name of the restore testing selection that belongs to the related restore testing plan.
", "DeleteRestoreTestingPlanInput$RestoreTestingPlanName": "Required unique name of the restore testing plan you wish to delete.
", "DeleteRestoreTestingSelectionInput$RestoreTestingPlanName": "Required unique name of the restore testing plan that contains the restore testing selection you wish to delete.
", "DeleteRestoreTestingSelectionInput$RestoreTestingSelectionName": "Required unique name of the restore testing selection you wish to delete.
", "GetRestoreTestingInferredMetadataInput$BackupVaultAccountId": "This is the account ID of the specified backup vault.
", "GetRestoreTestingInferredMetadataInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web ServicesRegion where they are created. They consist of letters, numbers, and hyphens.
", "GetRestoreTestingInferredMetadataInput$RecoveryPointArn": "An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
Required unique name of the restore testing plan.
", "GetRestoreTestingSelectionInput$RestoreTestingPlanName": "Required unique name of the restore testing plan.
", "GetRestoreTestingSelectionInput$RestoreTestingSelectionName": "Required unique name of the restore testing selection.
", "KeyValue$Key": "The tag key (String). The key can't start with aws:.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: ^(?![aA]{1}[wW]{1}[sS]{1}:)([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]+)$
The value of the key.
Length Constraints: Maximum length of 256.
Pattern: ^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the nexttoken.
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the nexttoken.
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the nexttoken.
Returns restore testing selections by the specified restore testing plan name.
", "ListRestoreTestingSelectionsOutput$NextToken": "The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the nexttoken.
The RestoreTestingPlanName is a unique string that is the name of the restore testing plan. This cannot be changed after creation, and it must consist of only alphanumeric characters and underscores.
", "RestoreTestingPlanForCreate$ScheduleExpression": "A CRON expression in specified timezone when a restore testing plan is executed.
", "RestoreTestingPlanForCreate$ScheduleExpressionTimezone": "Optional. This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
", "RestoreTestingPlanForGet$CreatorRequestId": "This identifies the request and allows failed requests to be retried without the risk of running the operation twice. If the request includes a CreatorRequestId that matches an existing backup plan, that plan is returned. This parameter is optional.
If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
", "RestoreTestingPlanForGet$RestoreTestingPlanArn": "An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.
", "RestoreTestingPlanForGet$RestoreTestingPlanName": "This is the restore testing plan name.
", "RestoreTestingPlanForGet$ScheduleExpression": "A CRON expression in specified timezone when a restore testing plan is executed.
", "RestoreTestingPlanForGet$ScheduleExpressionTimezone": "Optional. This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
", "RestoreTestingPlanForList$RestoreTestingPlanArn": "An Amazon Resource Name (ARN) that uniquely identifiesa restore testing plan.
", "RestoreTestingPlanForList$RestoreTestingPlanName": "This is the restore testing plan name.
", "RestoreTestingPlanForList$ScheduleExpression": "A CRON expression in specified timezone when a restore testing plan is executed.
", "RestoreTestingPlanForList$ScheduleExpressionTimezone": "Optional. This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
", "RestoreTestingPlanForUpdate$ScheduleExpression": "A CRON expression in specified timezone when a restore testing plan is executed.
", "RestoreTestingPlanForUpdate$ScheduleExpressionTimezone": "Optional. This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
", "RestoreTestingSelectionForCreate$IamRoleArn": "The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example: arn:aws:iam::123456789012:role/S3Access.
The type of Amazon Web Services resource included in a restore testing selection; for example, an Amazon EBS volume or an Amazon RDS database.
Supported resource types accepted include:
Aurora for Amazon Aurora
DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
DynamoDB for Amazon DynamoDB
EBS for Amazon Elastic Block Store
EC2 for Amazon Elastic Compute Cloud
EFS for Amazon Elastic File System
FSx for Amazon FSx
Neptune for Amazon Neptune
RDS for Amazon Relational Database Service
S3 for Amazon S3
This is the unique name of the restore testing selection that belongs to the related restore testing plan.
", "RestoreTestingSelectionForGet$CreatorRequestId": "This identifies the request and allows failed requests to be retried without the risk of running the operation twice. If the request includes a CreatorRequestId that matches an existing backup plan, that plan is returned. This parameter is optional.
If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
", "RestoreTestingSelectionForGet$IamRoleArn": "The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example:arn:aws:iam::123456789012:role/S3Access.
The type of Amazon Web Services resource included in a resource testing selection; for example, an Amazon EBS volume or an Amazon RDS database.
", "RestoreTestingSelectionForGet$RestoreTestingPlanName": "The RestoreTestingPlanName is a unique string that is the name of the restore testing plan.
", "RestoreTestingSelectionForGet$RestoreTestingSelectionName": "This is the unique name of the restore testing selection that belongs to the related restore testing plan.
", "RestoreTestingSelectionForList$IamRoleArn": "The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example: arn:aws:iam::123456789012:role/S3Access.
The type of Amazon Web Services resource included in a restore testing selection; for example, an Amazon EBS volume or an Amazon RDS database.
", "RestoreTestingSelectionForList$RestoreTestingPlanName": "Unique string that is the name of the restore testing plan.
The name cannot be changed after creation. The name must consist of only alphanumeric characters and underscores. Maximum length is 50.
", "RestoreTestingSelectionForList$RestoreTestingSelectionName": "Unique name of a restore testing selection.
", "RestoreTestingSelectionForUpdate$IamRoleArn": "The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example: arn:aws:iam::123456789012:role/S3Access.
This is the restore testing plan name you wish to update.
", "UpdateRestoreTestingPlanOutput$RestoreTestingPlanArn": "Unique ARN (Amazon Resource Name) of the restore testing plan.
", "UpdateRestoreTestingPlanOutput$RestoreTestingPlanName": "The name cannot be changed after creation. The name consists of only alphanumeric characters and underscores. Maximum length is 50.
", "UpdateRestoreTestingSelectionInput$RestoreTestingPlanName": "The restore testing plan name is required to update the indicated testing plan.
", "UpdateRestoreTestingSelectionInput$RestoreTestingSelectionName": "This is the required restore testing selection name of the restore testing selection you wish to update.
", "UpdateRestoreTestingSelectionOutput$RestoreTestingPlanArn": "Unique string that is the name of the restore testing plan.
", "UpdateRestoreTestingSelectionOutput$RestoreTestingPlanName": "This is the restore testing plan with which the updated restore testing selection is associated.
", "UpdateRestoreTestingSelectionOutput$RestoreTestingSelectionName": "This is the returned restore testing selection name.
" } }, "TagKey": { "base": null, "refs": { "Tags$key": null } }, "TagKeyList": { "base": null, "refs": { "UntagResourceInput$TagKeyList": "A list of keys to identify which key-value tags to remove from a resource.
" } }, "TagResourceInput": { "base": null, "refs": { } }, "TagValue": { "base": null, "refs": { "Tags$value": null } }, "Tags": { "base": null, "refs": { "BackupRule$RecoveryPointTags": "An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.
", "BackupRuleInput$RecoveryPointTags": "To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.
", "CreateBackupPlanInput$BackupPlanTags": "To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan.
", "CreateBackupVaultInput$BackupVaultTags": "Metadata that you can assign to help organize the resources that you create. Each tag is a key-value pair.
", "CreateLegalHoldInput$Tags": "Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.
", "CreateLogicallyAirGappedBackupVaultInput$BackupVaultTags": "These are the tags that will be included in the newly-created vault.
", "ListTagsOutput$Tags": "To help organize your resources, you can assign your own metadata to the resources you create. Each tag is a key-value pair.
", "StartBackupJobInput$RecoveryPointTags": "To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.
", "TagResourceInput$Tags": "Key-value pairs that are used to help organize your resources. You can assign your own metadata to the resources you create. For clarity, this is the structure to assign tags: [{\"Key\":\"string\",\"Value\":\"string\"}].
The date and time a restore testing plan was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087AM.
This is the time the resource testing selection was created successfully.
", "RestoreTestingPlanForGet$CreationTime": "The date and time that a restore testing plan was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The last time a restore test was run with the specified restore testing plan. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time that the restore testing plan was updated. This update is in Unix format and Coordinated Universal Time (UTC). The value of LastUpdateTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time that a restore testing plan was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The last time a restore test was run with the specified restore testing plan. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time that the restore testing plan was updated. This update is in Unix format and Coordinated Universal Time (UTC). The value of LastUpdateTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time that a restore testing selection was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 201812:11:30.087 AM.
This is the date and time that a restore testing selection was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26,2018 12:11:30.087 AM.
This is the time the resource testing plan was created.
", "UpdateRestoreTestingPlanOutput$UpdateTime": "This is the time the update completed for the restore testing plan.
", "UpdateRestoreTestingSelectionOutput$CreationTime": "This is the time the resource testing selection was updated successfully.
", "UpdateRestoreTestingSelectionOutput$UpdateTime": "This is the time the update completed for the restore testing selection.
" } }, "Timezone": { "base": null, "refs": { "BackupRule$ScheduleExpressionTimezone": "This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
", "BackupRuleInput$ScheduleExpressionTimezone": "This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
" } }, "UntagResourceInput": { "base": null, "refs": { } }, "UpdateBackupPlanInput": { "base": null, "refs": { } }, "UpdateBackupPlanOutput": { "base": null, "refs": { } }, "UpdateFrameworkInput": { "base": null, "refs": { } }, "UpdateFrameworkOutput": { "base": null, "refs": { } }, "UpdateGlobalSettingsInput": { "base": null, "refs": { } }, "UpdateRecoveryPointLifecycleInput": { "base": null, "refs": { } }, "UpdateRecoveryPointLifecycleOutput": { "base": null, "refs": { } }, "UpdateRegionSettingsInput": { "base": null, "refs": { } }, "UpdateReportPlanInput": { "base": null, "refs": { } }, "UpdateReportPlanOutput": { "base": null, "refs": { } }, "UpdateRestoreTestingPlanInput": { "base": null, "refs": { } }, "UpdateRestoreTestingPlanOutput": { "base": null, "refs": { } }, "UpdateRestoreTestingSelectionInput": { "base": null, "refs": { } }, "UpdateRestoreTestingSelectionOutput": { "base": null, "refs": { } }, "VaultNames": { "base": null, "refs": { "RecoveryPointSelection$VaultNames": "These are the names of the vaults in which the selected recovery points are contained.
" } }, "VaultState": { "base": null, "refs": { "CreateLogicallyAirGappedBackupVaultOutput$VaultState": "This is the current state of the vault.
" } }, "VaultType": { "base": null, "refs": { "DescribeBackupVaultOutput$VaultType": "This is the type of vault described.
", "DescribeRecoveryPointOutput$VaultType": "This is the type of vault in which the described recovery point is stored.
", "ListBackupVaultsInput$ByVaultType": "This parameter will sort the list of vaults by vault type.
", "RecoveryPointByBackupVault$VaultType": "This is the type of vault in which the described recovery point is stored.
" } }, "WindowMinutes": { "base": null, "refs": { "BackupRule$StartWindowMinutes": "A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, it must be at least 60 minutes to avoid errors.
During the start window, the backup job status remains in CREATED status until it has successfully begun or until the start window time has run out. If within the start window time Backup receives an error that allows the job to be retried, Backup will automatically retry to begin the job at least every 10 minutes until the backup successfully begins (the job status changes to RUNNING) or until the job status changes to EXPIRED (which is expected to occur when the start window time is over).
A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by Backup. This value is optional.
", "BackupRuleInput$StartWindowMinutes": "A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, it must be at least 60 minutes to avoid errors.
This parameter has a maximum value of 100 years (52,560,000 minutes).
During the start window, the backup job status remains in CREATED status until it has successfully begun or until the start window time has run out. If within the start window time Backup receives an error that allows the job to be retried, Backup will automatically retry to begin the job at least every 10 minutes until the backup successfully begins (the job status changes to RUNNING) or until the job status changes to EXPIRED (which is expected to occur when the start window time is over).
A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by Backup. This value is optional.
", "StartBackupJobInput$StartWindowMinutes": "A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional, and the default is 8 hours. If this value is included, it must be at least 60 minutes to avoid errors.
This parameter has a maximum value of 100 years (52,560,000 minutes).
During the start window, the backup job status remains in CREATED status until it has successfully begun or until the start window time has run out. If within the start window time Backup receives an error that allows the job to be retried, Backup will automatically retry to begin the job at least every 10 minutes until the backup successfully begins (the job status changes to RUNNING) or until the job status changes to EXPIRED (which is expected to occur when the start window time is over).
A value in minutes during which a successfully started backup must complete, or else Backup will cancel the job. This value is optional. This value begins counting down from when the backup was scheduled. It does not add additional time for StartWindowMinutes, or if the backup started later than scheduled.
Like StartWindowMinutes, this parameter has a maximum value of 100 years (52,560,000 minutes).
This is a boolean value indicating this is a parent (composite) backup job.
", "CopyJob$IsParent": "This is a boolean value indicating this is a parent (composite) copy job.
", "DescribeBackupJobOutput$IsParent": "This returns the boolean value that a backup job is a parent (composite) job.
", "DescribeRecoveryPointOutput$IsEncrypted": "A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or FALSE if the recovery point is not encrypted.
This returns the boolean value that a recovery point is a parent (composite) job.
", "ListBackupVaultsInput$ByShared": "This parameter will sort the list of vaults by shared vaults.
", "RecoveryPointByBackupVault$IsEncrypted": "A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or FALSE if the recovery point is not encrypted.
This is a boolean value indicating this is a parent (composite) recovery point.
", "RecoveryPointByResource$IsParent": "This is a boolean value indicating this is a parent (composite) recovery point.
", "StartBackupJobOutput$IsParent": "This is a returned boolean value indicating this is a parent (composite) backup job.
", "StartCopyJobOutput$IsParent": "This is a returned boolean value indicating this is a parent (composite) copy job.
", "StartRestoreJobInput$CopySourceTagsToRestoredResource": "This is an optional parameter. If this equals True, tags included in the backup will be copied to the restored resource.
This can only be applied to backups created through Backup.
" } }, "integer": { "base": null, "refs": { "BackupJobSummary$Count": "The value as a number of jobs in a job summary.
", "CopyJobSummary$Count": "The value as a number of jobs in a job summary.
", "Framework$NumberOfControls": "The number of controls contained by the framework.
", "ReportSetting$NumberOfFrameworks": "The number of frameworks a report covers.
", "RestoreJobSummary$Count": "The value as a number of jobs in a job summary.
", "RestoreTestingPlanForCreate$StartWindowHours": "Defaults to 24 hours.
A value in hours after a restore test is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, this parameter has a maximum value of 168 hours (one week).
", "RestoreTestingPlanForGet$StartWindowHours": "Defaults to 24 hours.
A value in hours after a restore test is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, this parameter has a maximum value of 168 hours (one week).
", "RestoreTestingPlanForList$StartWindowHours": "Defaults to 24 hours.
A value in hours after a restore test is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, this parameter has a maximum value of 168 hours (one week).
", "RestoreTestingPlanForUpdate$StartWindowHours": "Defaults to 24 hours.
A value in hours after a restore test is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, this parameter has a maximum value of 168 hours (one week).
", "RestoreTestingRecoveryPointSelection$SelectionWindowDays": "Accepted values are integers from 1 to 365.
", "RestoreTestingSelectionForCreate$ValidationWindowHours": "This is amount of hours (1 to 168) available to run a validation script on the data. The data will be deleted upon the completion of the validation script or the end of the specified retention period, whichever comes first.
", "RestoreTestingSelectionForGet$ValidationWindowHours": "This is amount of hours (1 to 168) available to run a validation script on the data. The data will be deleted upon the completion of the validation script or the end of the specified retention period, whichever comes first.
", "RestoreTestingSelectionForList$ValidationWindowHours": "This value represents the time, in hours, data is retained after a restore test so that optional validation can be completed.
Accepted value is an integer between 0 and 168 (the hourly equivalent of seven days).
", "RestoreTestingSelectionForUpdate$ValidationWindowHours": "This value represents the time, in hours, data is retained after a restore test so that optional validation can be completed.
Accepted value is an integer between 0 and 168 (the hourly equivalent of seven days).
" } }, "long": { "base": null, "refs": { "BackupVaultListMember$NumberOfRecoveryPoints": "The number of recovery points that are stored in a backup vault.
", "DescribeBackupVaultOutput$NumberOfRecoveryPoints": "The number of recovery points that are stored in a backup vault.
" } }, "string": { "base": null, "refs": { "AlreadyExistsException$Code": null, "AlreadyExistsException$Message": null, "AlreadyExistsException$CreatorRequestId": "", "AlreadyExistsException$Arn": "", "AlreadyExistsException$Type": "", "AlreadyExistsException$Context": "", "BackupJob$BackupJobId": "Uniquely identifies a request to Backup to back up a resource.
", "BackupJob$StatusMessage": "A detailed message explaining the status of the job to back up a resource.
", "BackupJob$PercentDone": "Contains an estimated percentage complete of a job at the time the job status was queried.
", "BackupJob$BackupType": "Represents the type of backup for a backup job.
", "BackupJob$ParentJobId": "This uniquely identifies a request to Backup to back up a resource. The return will be the parent (composite) job ID.
", "BackupJob$ResourceName": "This is the non-unique name of the resource that belongs to the specified backup.
", "BackupJob$MessageCategory": "This parameter is the job count for the specified message category.
Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS. See Monitoring for a list of MessageCategory strings.
The the value ANY returns count of all message categories.
AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.
Uniquely identifies a stored backup plan template.
", "BackupPlanTemplatesListMember$BackupPlanTemplateName": "The optional display name of a backup plan template.
", "BackupPlansListMember$BackupPlanId": "Uniquely identifies a backup plan.
", "BackupPlansListMember$VersionId": "Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.
", "BackupPlansListMember$CreatorRequestId": "A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.
If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
", "BackupRule$RuleId": "Uniquely identifies a rule that is used to schedule the backup of a selection of resources.
", "BackupSelectionsListMember$SelectionId": "Uniquely identifies a request to assign a set of resources to a backup plan.
", "BackupSelectionsListMember$BackupPlanId": "Uniquely identifies a backup plan.
", "BackupSelectionsListMember$CreatorRequestId": "A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.
If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
", "BackupVaultListMember$CreatorRequestId": "A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.
If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
", "CancelLegalHoldInput$LegalHoldId": "Legal hold ID required to remove the specified legal hold on a recovery point.
", "CancelLegalHoldInput$CancelDescription": "String describing the reason for removing the legal hold.
", "ComplianceResourceIdList$member": null, "ConflictException$Code": null, "ConflictException$Message": null, "ConflictException$Type": "", "ConflictException$Context": "", "CopyJob$CopyJobId": "Uniquely identifies a copy job.
", "CopyJob$StatusMessage": "A detailed message explaining the status of the job to copy a resource.
", "CopyJob$ParentJobId": "This uniquely identifies a request to Backup to copy a resource. The return will be the parent (composite) job ID.
", "CopyJob$CompositeMemberIdentifier": "This is the identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.
", "CopyJob$ResourceName": "This is the non-unique name of the resource that belongs to the specified backup.
", "CopyJob$MessageCategory": "This parameter is the job count for the specified message category.
Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and InvalidParameters. See Monitoring for a list of MessageCategory strings.
The the value ANY returns count of all message categories.
AGGREGATE_ALL aggregates job counts for all message categories and returns the sum
Identifies the request and allows failed requests to be retried without the risk of running the operation twice. If the request includes a CreatorRequestId that matches an existing backup plan, that plan is returned. This parameter is optional.
If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
", "CreateBackupPlanOutput$BackupPlanId": "Uniquely identifies a backup plan.
", "CreateBackupPlanOutput$VersionId": "Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.
", "CreateBackupSelectionInput$BackupPlanId": "Uniquely identifies the backup plan to be associated with the selection of resources.
", "CreateBackupSelectionInput$CreatorRequestId": "A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.
If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
", "CreateBackupSelectionOutput$SelectionId": "Uniquely identifies the body of a request to assign a set of resources to a backup plan.
", "CreateBackupSelectionOutput$BackupPlanId": "Uniquely identifies a backup plan.
", "CreateBackupVaultInput$CreatorRequestId": "A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.
If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
", "CreateFrameworkInput$IdempotencyToken": "A customer-chosen string that you can use to distinguish between otherwise identical calls to CreateFrameworkInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.
This is the string title of the legal hold.
", "CreateLegalHoldInput$Description": "This is the string description of the legal hold.
", "CreateLegalHoldInput$IdempotencyToken": "This is a user-chosen string used to distinguish between otherwise identical calls. Retrying a successful request with the same idempotency token results in a success message with no action taken.
", "CreateLegalHoldOutput$Title": "This is the string title of the legal hold returned after creating the legal hold.
", "CreateLegalHoldOutput$Description": "This is the returned string description of the legal hold.
", "CreateLegalHoldOutput$LegalHoldId": "Legal hold ID returned for the specified legal hold on a recovery point.
", "CreateLogicallyAirGappedBackupVaultInput$CreatorRequestId": "This is the ID of the creation request.
This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
", "CreateReportPlanInput$IdempotencyToken": "A customer-chosen string that you can use to distinguish between otherwise identical calls to CreateReportPlanInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.
Uniquely identifies a backup plan.
", "DeleteBackupPlanOutput$BackupPlanId": "Uniquely identifies a backup plan.
", "DeleteBackupPlanOutput$VersionId": "Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.
", "DeleteBackupSelectionInput$BackupPlanId": "Uniquely identifies a backup plan.
", "DeleteBackupSelectionInput$SelectionId": "Uniquely identifies the body of a request to assign a set of resources to a backup plan.
", "DeleteBackupVaultInput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", "DependencyFailureException$Code": null, "DependencyFailureException$Message": null, "DependencyFailureException$Type": "", "DependencyFailureException$Context": "", "DescribeBackupJobInput$BackupJobId": "Uniquely identifies a request to Backup to back up a resource.
", "DescribeBackupJobOutput$BackupJobId": "Uniquely identifies a request to Backup to back up a resource.
", "DescribeBackupJobOutput$StatusMessage": "A detailed message explaining the status of the job to back up a resource.
", "DescribeBackupJobOutput$PercentDone": "Contains an estimated percentage that is complete of a job at the time the job status was queried.
", "DescribeBackupJobOutput$BackupType": "Represents the actual backup type selected for a backup job. For example, if a successful Windows Volume Shadow Copy Service (VSS) backup was taken, BackupType returns \"WindowsVSS\". If BackupType is empty, then the backup type was a regular backup.
This returns the parent (composite) resource backup job ID.
", "DescribeBackupJobOutput$ResourceName": "This is the non-unique name of the resource that belongs to the specified backup.
", "DescribeBackupJobOutput$MessageCategory": "This is the job count for the specified message category.
Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS. View Monitoring for a list of accepted MessageCategory strings.
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", "DescribeBackupVaultInput$BackupVaultAccountId": "This is the account ID of the specified backup vault.
", "DescribeBackupVaultOutput$BackupVaultName": "The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
", "DescribeBackupVaultOutput$CreatorRequestId": "A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
", "DescribeCopyJobInput$CopyJobId": "Uniquely identifies a copy job.
", "DescribeFrameworkOutput$DeploymentStatus": "The deployment status of a framework. The statuses are:
CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED
A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn Config recording on or off for each resource. The statuses are:
ACTIVE when recording is turned on for all resources governed by the framework.
PARTIALLY_ACTIVE when recording is turned off for at least one resource governed by the framework.
INACTIVE when recording is turned off for all resources governed by the framework.
UNAVAILABLE when Backup is unable to validate recording status at this time.
A customer-chosen string that you can use to distinguish between otherwise identical calls to DescribeFrameworkOutput. Retrying a successful request with the same idempotency token results in a success message with no action taken.
This is the non-unique name of the resource that belongs to the specified backup.
", "DescribeRecoveryPointOutput$StatusMessage": "A status message explaining the status of the recovery point.
", "DescribeRecoveryPointOutput$CompositeMemberIdentifier": "This is the identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.
", "DescribeRecoveryPointOutput$ResourceName": "This is the non-unique name of the resource that belongs to the specified backup.
", "DescribeRestoreJobOutput$RestoreJobId": "Uniquely identifies the job that restores a recovery point.
", "DescribeRestoreJobOutput$StatusMessage": "A message showing the status of a job to restore a recovery point.
", "DescribeRestoreJobOutput$PercentDone": "Contains an estimated percentage that is complete of a job at the time the job status was queried.
", "DescribeRestoreJobOutput$ValidationStatusMessage": "This describes the status of validation run on the indicated restore job.
", "DescribeRestoreJobOutput$DeletionStatusMessage": "This describes the restore job deletion status.
", "ExportBackupPlanTemplateInput$BackupPlanId": "Uniquely identifies a backup plan.
", "ExportBackupPlanTemplateOutput$BackupPlanTemplateJson": "The body of a backup plan template in JSON format.
This is a signed JSON document that cannot be modified before being passed to GetBackupPlanFromJSON.
The deployment status of a framework. The statuses are:
CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED
A customer-supplied backup plan document in JSON format.
", "GetBackupPlanFromTemplateInput$BackupPlanTemplateId": "Uniquely identifies a stored backup plan template.
", "GetBackupPlanInput$BackupPlanId": "Uniquely identifies a backup plan.
", "GetBackupPlanInput$VersionId": "Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.
", "GetBackupPlanOutput$BackupPlanId": "Uniquely identifies a backup plan.
", "GetBackupPlanOutput$VersionId": "Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.
", "GetBackupPlanOutput$CreatorRequestId": "A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.
", "GetBackupSelectionInput$BackupPlanId": "Uniquely identifies a backup plan.
", "GetBackupSelectionInput$SelectionId": "Uniquely identifies the body of a request to assign a set of resources to a backup plan.
", "GetBackupSelectionOutput$SelectionId": "Uniquely identifies the body of a request to assign a set of resources to a backup plan.
", "GetBackupSelectionOutput$BackupPlanId": "Uniquely identifies a backup plan.
", "GetBackupSelectionOutput$CreatorRequestId": "A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.
", "GetLegalHoldInput$LegalHoldId": "This is the ID required to use GetLegalHold. This unique ID is associated with a specific legal hold.
This is the string title of the legal hold.
", "GetLegalHoldOutput$Description": "This is the returned string description of the legal hold.
", "GetLegalHoldOutput$CancelDescription": "String describing the reason for removing the legal hold.
", "GetLegalHoldOutput$LegalHoldId": "This is the returned ID associated with a specified legal hold.
", "InvalidParameterValueException$Code": null, "InvalidParameterValueException$Message": null, "InvalidParameterValueException$Type": "", "InvalidParameterValueException$Context": "", "InvalidRequestException$Code": null, "InvalidRequestException$Message": null, "InvalidRequestException$Type": "", "InvalidRequestException$Context": "", "InvalidResourceStateException$Code": null, "InvalidResourceStateException$Message": null, "InvalidResourceStateException$Type": "", "InvalidResourceStateException$Context": "", "LegalHold$Title": "This is the title of a legal hold.
", "LegalHold$Description": "This is the description of a legal hold.
", "LegalHold$LegalHoldId": "ID of specific legal hold on one or more recovery points.
", "LimitExceededException$Code": null, "LimitExceededException$Message": null, "LimitExceededException$Type": "", "LimitExceededException$Context": "", "ListBackupJobSummariesInput$NextToken": "The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
This is the period that sets the boundaries for returned results.
ONE_DAY for daily job count for the prior 14 days.
SEVEN_DAYS for the aggregated job count for the prior 7 days.
FOURTEEN_DAYS for aggregated job count for prior 14 days.
The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
This is a filter to list child (nested) jobs based on parent job ID.
", "ListBackupJobsInput$ByMessageCategory": "This is an optional parameter that can be used to filter out jobs with a MessageCategory which matches the value you input.
Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and InvalidParameters.
View Monitoring
The wildcard () returns count of all message categories.
AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
Uniquely identifies a backup plan.
", "ListBackupPlanVersionsInput$NextToken": "The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
Uniquely identifies a backup plan.
", "ListBackupSelectionsInput$NextToken": "The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
This is the period that sets the boundaries for returned results.
ONE_DAY for daily job count for the prior 14 days.
SEVEN_DAYS for the aggregated job count for the prior 7 days.
FOURTEEN_DAYS for aggregated job count for prior 14 days.
The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
", "ListCopyJobsInput$ByDestinationVaultArn": "An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
This is a filter to list child (nested) jobs based on parent job ID.
", "ListCopyJobsInput$ByMessageCategory": "This is an optional parameter that can be used to filter out jobs with a MessageCategory which matches the value you input.
Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS.
View Monitoring for a list of accepted strings.
The the value ANY returns count of all message categories.
AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
", "ListFrameworksInput$NextToken": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
", "ListFrameworksOutput$NextToken": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
", "ListLegalHoldsInput$NextToken": "The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
Returns only recovery points that match the specified backup plan ID.
", "ListRecoveryPointsByBackupVaultOutput$NextToken": "The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
This is the ID of the legal hold.
", "ListRecoveryPointsByLegalHoldInput$NextToken": "This is the next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
This return is the next item following a partial list of returned resources.
", "ListRecoveryPointsByResourceInput$NextToken": "The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
Returns only report jobs that are in the specified status. The statuses are:
CREATED | RUNNING | COMPLETED | FAILED
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
", "ListReportJobsOutput$NextToken": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
", "ListReportPlansInput$NextToken": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
", "ListReportPlansOutput$NextToken": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
", "ListRestoreJobSummariesInput$NextToken": "The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
This is the period that sets the boundaries for returned results.
ONE_DAY for daily job count for the prior 14 days.
SEVEN_DAYS for the aggregated job count for the prior 7 days.
FOURTEEN_DAYS for aggregated job count for prior 14 days.
The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
The next item following a partial list of returned items. For example, if a request ismade to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows youto return more items in your list starting at the location pointed to by the next token
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
This is the non-unique name of the resource that belongs to the specified backup.
", "PutRestoreValidationResultInput$ValidationStatusMessage": "This is an optional message string you can input to describe the validation status for the restore test validation.
", "RecoveryPointByBackupVault$StatusMessage": "A message explaining the reason of the recovery point deletion failure.
", "RecoveryPointByBackupVault$CompositeMemberIdentifier": "This is the identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.
", "RecoveryPointByBackupVault$ResourceName": "This is the non-unique name of the resource that belongs to the specified backup.
", "RecoveryPointByResource$StatusMessage": "A message explaining the reason of the recovery point deletion failure.
", "RecoveryPointByResource$ResourceName": "This is the non-unique name of the resource that belongs to the specified backup.
", "RecoveryPointCreator$BackupPlanId": "Uniquely identifies a backup plan.
", "RecoveryPointCreator$BackupPlanVersion": "Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.
", "RecoveryPointCreator$BackupRuleId": "Uniquely identifies a rule used to schedule the backup of a selection of resources.
", "ReportDeliveryChannel$S3BucketName": "The unique name of the S3 bucket that receives your reports.
", "ReportDeliveryChannel$S3KeyPrefix": "The prefix for where Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.
The unique name of the Amazon S3 bucket that receives your reports.
", "ReportJob$ReportTemplate": "Identifies the report template for the report. Reports are built using a report template. The report templates are:
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
The status of a report job. The statuses are:
CREATED | RUNNING | COMPLETED | FAILED
COMPLETED means that the report is available for your review at your designated destination. If the status is FAILED, review the StatusMessage for the reason.
A message explaining the status of the report job.
", "ReportPlan$DeploymentStatus": "The deployment status of a report plan. The statuses are:
CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED
Identifies the report template for the report. Reports are built using a report template. The report templates are:
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
Uniquely identifies the job that restores a recovery point.
", "RestoreJobsListMember$StatusMessage": "A detailed message explaining the status of the job to restore a recovery point.
", "RestoreJobsListMember$PercentDone": "Contains an estimated percentage complete of a job at the time the job status was queried.
", "RestoreJobsListMember$ValidationStatusMessage": "This describes the status of validation run on the indicated restore job.
", "RestoreJobsListMember$DeletionStatusMessage": "This describes the restore job deletion status.
", "ServiceUnavailableException$Code": null, "ServiceUnavailableException$Message": null, "ServiceUnavailableException$Type": "", "ServiceUnavailableException$Context": "", "StartBackupJobInput$IdempotencyToken": "A customer-chosen string that you can use to distinguish between otherwise identical calls to StartBackupJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.
Uniquely identifies a request to Backup to back up a resource.
", "StartCopyJobInput$IdempotencyToken": "A customer-chosen string that you can use to distinguish between otherwise identical calls to StartCopyJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.
Uniquely identifies a copy job.
", "StartReportJobInput$IdempotencyToken": "A customer-chosen string that you can use to distinguish between otherwise identical calls to StartReportJobInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.
A customer-chosen string that you can use to distinguish between otherwise identical calls to StartRestoreJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.
Uniquely identifies a request to Backup to back up a resource.
", "TagKeyList$member": null, "UpdateBackupPlanInput$BackupPlanId": "Uniquely identifies a backup plan.
", "UpdateBackupPlanOutput$BackupPlanId": "Uniquely identifies a backup plan.
", "UpdateBackupPlanOutput$VersionId": "Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version Ids cannot be edited.
", "UpdateFrameworkInput$IdempotencyToken": "A customer-chosen string that you can use to distinguish between otherwise identical calls to UpdateFrameworkInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.
A customer-chosen string that you can use to distinguish between otherwise identical calls to UpdateReportPlanInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.
The object key that uniquely identifies your reports in your S3 bucket.
", "ReportSetting$FrameworkArns": "The Amazon Resource Names (ARNs) of the frameworks a report covers.
", "ReportSetting$Accounts": "These are the accounts to be included in the report.
", "ReportSetting$OrganizationUnits": "These are the Organizational Units to be included in the report.
", "ReportSetting$Regions": "These are the Regions to be included in the report.
", "RestoreTestingRecoveryPointSelection$ExcludeVaults": "Accepted values include specific ARNs or list of selectors. Defaults to empty list if not listed.
", "RestoreTestingRecoveryPointSelection$IncludeVaults": "Accepted values include wildcard [\"*\"] or by specific ARNs or ARN wilcard replacement [\"arn:aws:backup:us-west-2:123456789012:backup-vault:asdf\", ...] [\"arn:aws:backup:*:*:backup-vault:asdf-*\", ...]
", "RestoreTestingSelectionForCreate$ProtectedResourceArns": "Each protected resource can be filtered by its specific ARNs, such as ProtectedResourceArns: [\"arn:aws:...\", \"arn:aws:...\"] or by a wildcard: ProtectedResourceArns: [\"*\"], but not both.
You can include specific ARNs, such as ProtectedResourceArns: [\"arn:aws:...\", \"arn:aws:...\"] or you can include a wildcard: ProtectedResourceArns: [\"*\"], but not both.
You can include a list of specific ARNs, such as ProtectedResourceArns: [\"arn:aws:...\", \"arn:aws:...\"] or you can include a wildcard: ProtectedResourceArns: [\"*\"], but not both.
The tag key-value pair applied to those Amazon Web Services resources that you want to trigger an evaluation for a rule. A maximum of one key-value pair can be provided. The tag value is optional, but it cannot be an empty string. The structure to assign a tag is: [{\"Key\":\"string\",\"Value\":\"string\"}].
Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
", "CreateReportPlanInput$ReportPlanTags": "Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.
", "GetRestoreTestingInferredMetadataOutput$InferredMetadata": "This is a string map of the metadata inferred from the request.
" } }, "timestamp": { "base": null, "refs": { "BackupJob$CreationDate": "The date and time a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
This is the date on which the backup job was initiated.
", "BackupJobSummary$StartTime": "The value of time in number format of a job start time.
This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
", "BackupJobSummary$EndTime": "The value of time in number format of a job end time.
This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
", "BackupPlansListMember$CreationDate": "The date and time a resource backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The last time a job to back up resources was run with this rule. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time a resource backup is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time when Backup Vault Lock configuration becomes immutable, meaning it cannot be changed or deleted.
If you applied Vault Lock to your vault without specifying a lock date, you can change your Vault Lock settings, or delete Vault Lock from the vault entirely, at any time.
This value is in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
", "CalculatedLifecycle$MoveToColdStorageAt": "A timestamp that specifies when to transition a recovery point to cold storage.
", "CalculatedLifecycle$DeleteAt": "A timestamp that specifies when to delete a recovery point.
", "CopyJob$CreationDate": "The date and time a copy job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time a copy job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The value of time in number format of a job start time.
This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
", "CopyJobSummary$EndTime": "The value of time in number format of a job end time.
This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
", "CreateBackupPlanOutput$CreationDate": "The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time a backup selection is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Time in number format when legal hold was created.
", "CreateLogicallyAirGappedBackupVaultOutput$CreationDate": "The date and time when the vault was created.
This value is in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
", "CreateReportPlanOutput$CreationTime": "The date and time a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
This value is the beginning date, inclusive.
The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds (milliseconds are optional).
", "DateRange$ToDate": "This value is the end date, inclusive.
The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds (milliseconds are optional).
", "DeleteBackupPlanOutput$DeletionDate": "The date and time a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time that a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time that a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
This is the date a backup job was initiated.
", "DescribeBackupVaultOutput$CreationDate": "The date and time that a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time when Backup Vault Lock configuration cannot be changed or deleted.
If you applied Vault Lock to your vault without specifying a lock date, you can change any of your Vault Lock settings, or delete Vault Lock from the vault entirely, at any time.
This value is in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
", "DescribeFrameworkOutput$CreationTime": "The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.
The date and time that the flag isCrossAccountBackupEnabled was last updated. This update is in Unix format and Coordinated Universal Time (UTC). The value of LastUpdateTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time that a resource was last backed up, in Unix format and Coordinated Universal Time (UTC). The value of LastBackupTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
This is the creation date of the most recent restore job.
", "DescribeProtectedResourceOutput$LatestRestoreRecoveryPointCreationDate": "This is the date the most recent recovery point was created.
", "DescribeRecoveryPointOutput$CreationDate": "The date and time that a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time that a job to create a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time that a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time that a restore job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time that a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
This is the creation date of the recovery point made by the specifed restore job.
", "Framework$CreationTime": "The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.
The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The last time a job to back up resources was run with this backup plan. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time a backup selection is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Time in number format when legal hold was created.
", "GetLegalHoldOutput$CancellationDate": "Time in number when legal hold was cancelled.
", "GetLegalHoldOutput$RetainRecordUntil": "This is the date and time until which the legal hold record will be retained.
", "LegalHold$CreationDate": "This is the time in number format when legal hold was created.
", "LegalHold$CancellationDate": "This is the time in number format when legal hold was cancelled.
", "ListBackupJobsInput$ByCreatedBefore": "Returns only backup jobs that were created before the specified date.
", "ListBackupJobsInput$ByCreatedAfter": "Returns only backup jobs that were created after the specified date.
", "ListBackupJobsInput$ByCompleteAfter": "Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).
", "ListBackupJobsInput$ByCompleteBefore": "Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
", "ListCopyJobsInput$ByCreatedBefore": "Returns only copy jobs that were created before the specified date.
", "ListCopyJobsInput$ByCreatedAfter": "Returns only copy jobs that were created after the specified date.
", "ListCopyJobsInput$ByCompleteBefore": "Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
", "ListCopyJobsInput$ByCompleteAfter": "Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).
", "ListRecoveryPointsByBackupVaultInput$ByCreatedBefore": "Returns only recovery points that were created before the specified timestamp.
", "ListRecoveryPointsByBackupVaultInput$ByCreatedAfter": "Returns only recovery points that were created after the specified timestamp.
", "ListReportJobsInput$ByCreationBefore": "Returns only report jobs that were created before the date and time specified in Unix format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents Friday, January 26, 2018 12:11:30 AM.
", "ListReportJobsInput$ByCreationAfter": "Returns only report jobs that were created after the date and time specified in Unix format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents Friday, January 26, 2018 12:11:30 AM.
", "ListRestoreJobsByProtectedResourceInput$ByRecoveryPointCreationDateAfter": "Returns only restore jobs of recovery points that were created after the specified date.
", "ListRestoreJobsByProtectedResourceInput$ByRecoveryPointCreationDateBefore": "Returns only restore jobs of recovery points that were created before the specified date.
", "ListRestoreJobsInput$ByCreatedBefore": "Returns only restore jobs that were created before the specified date.
", "ListRestoreJobsInput$ByCreatedAfter": "Returns only restore jobs that were created after the specified date.
", "ListRestoreJobsInput$ByCompleteBefore": "Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
", "ListRestoreJobsInput$ByCompleteAfter": "Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).
", "ProtectedResource$LastBackupTime": "The date and time a resource was last backed up, in Unix format and Coordinated Universal Time (UTC). The value of LastBackupTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time that a report job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time that a report job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time that a report job associated with this report plan last attempted to run, in Unix format and Coordinated Universal Time (UTC). The value of LastAttemptedExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time that a report job associated with this report plan last successfully ran, in Unix format and Coordinated Universal Time (UTC). The value of LastSuccessfulExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The value of time in number format of a job start time.
This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
", "RestoreJobSummary$EndTime": "The value of time in number format of a job end time.
This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
", "RestoreJobsListMember$CreationDate": "The date and time a restore job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date on which a recovery point was created.
", "StartBackupJobOutput$CreationDate": "The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time that a copy job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.
The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.