|
82 | 82 | "StartCopyJob": "<p>Starts a job to create a one-time copy of the specified resource.</p> <p>Does not support continuous backups.</p>", |
83 | 83 | "StartReportJob": "<p>Starts an on-demand report job for the specified report plan.</p>", |
84 | 84 | "StartRestoreJob": "<p>Recovers the saved resource identified by an Amazon Resource Name (ARN).</p>", |
85 | | - "StopBackupJob": "<p>Attempts to cancel a job to create a one-time backup of a resource.</p> <p>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.</p>", |
| 85 | + "StopBackupJob": "<p>Attempts to cancel a job to create a one-time backup of a resource.</p> <p>This action is not supported for the following services: Amazon FSx for Windows File Server, Amazon FSx for Lustre, Amazon FSx for NetApp ONTAP , Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon Aurora, and Amazon Neptune.</p>", |
86 | 86 | "TagResource": "<p>Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).</p>", |
87 | 87 | "UntagResource": "<p>Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)</p>", |
88 | 88 | "UpdateBackupPlan": "<p>Updates an existing backup plan identified by its <code>backupPlanId</code> with the input document in JSON format. The new version is uniquely identified by a <code>VersionId</code>.</p>", |
|
267 | 267 | "BackupJob$State": "<p>The current state of a backup job.</p>", |
268 | 268 | "BackupJobChildJobsInState$key": null, |
269 | 269 | "DescribeBackupJobOutput$State": "<p>The current state of a backup job.</p>", |
270 | | - "ListBackupJobsInput$ByState": "<p>Returns only backup jobs that are in the specified state.</p>" |
| 270 | + "ListBackupJobsInput$ByState": "<p>Returns only backup jobs that are in the specified state.</p> <p> <code>Completed with issues</code> is a status found only in the Backup console. For API, this status refers to jobs with a state of <code>COMPLETED</code> and a <code>MessageCategory</code> with a value other than <code>SUCCESS</code>; that is, the status is completed but comes with a status message.</p> <p>To obtain the job count for <code>Completed with issues</code>, run two GET requests, and subtract the second, smaller number:</p> <p>GET /backup-jobs/?state=COMPLETED</p> <p>GET /backup-jobs/?messageCategory=SUCCESS&state=COMPLETED</p>" |
271 | 271 | } |
272 | 272 | }, |
273 | 273 | "BackupJobStatus": { |
274 | 274 | "base": null, |
275 | 275 | "refs": { |
276 | 276 | "BackupJobSummary$State": "<p>This value is job count for jobs with the specified state.</p>", |
277 | | - "ListBackupJobSummariesInput$State": "<p>This parameter returns the job count for jobs with the specified state.</p> <p>The the value ANY returns count of all states.</p> <p> <code>AGGREGATE_ALL</code> aggregates job counts for all states and returns the sum.</p>" |
| 277 | + "ListBackupJobSummariesInput$State": "<p>This parameter returns the job count for jobs with the specified state.</p> <p>The the value ANY returns count of all states.</p> <p> <code>AGGREGATE_ALL</code> aggregates job counts for all states and returns the sum.</p> <p> <code>Completed with issues</code> is a status found only in the Backup console. For API, this status refers to jobs with a state of <code>COMPLETED</code> and a <code>MessageCategory</code> with a value other than <code>SUCCESS</code>; that is, the status is completed but comes with a status message. To obtain the job count for <code>Completed with issues</code>, run two GET requests, and subtract the second, smaller number:</p> <p>GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&State=COMPLETED</p> <p>GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&MessageCategory=SUCCESS&State=COMPLETED</p>" |
278 | 278 | } |
279 | 279 | }, |
280 | 280 | "BackupJobSummary": { |
|
599 | 599 | "ControlScope": { |
600 | 600 | "base": "<p>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.</p> <note> <p>To set a control scope that includes all of a particular resource, leave the <code>ControlScope</code> empty or do not pass it when calling <code>CreateFramework</code>.</p> </note>", |
601 | 601 | "refs": { |
602 | | - "FrameworkControl$ControlScope": "<p>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.</p>" |
| 602 | + "FrameworkControl$ControlScope": "<p>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.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ControlScope.html\"> <code>ControlScope</code>.</a> </p>" |
603 | 603 | } |
604 | 604 | }, |
605 | 605 | "CopyAction": { |
|
2335 | 2335 | "DescribeBackupVaultOutput$VaultType": "<p>This is the type of vault described.</p>", |
2336 | 2336 | "DescribeRecoveryPointOutput$VaultType": "<p>This is the type of vault in which the described recovery point is stored.</p>", |
2337 | 2337 | "ListBackupVaultsInput$ByVaultType": "<p>This parameter will sort the list of vaults by vault type.</p>", |
2338 | | - "RecoveryPointByBackupVault$VaultType": "<p>This is the type of vault in which the described recovery point is stored.</p>" |
| 2338 | + "RecoveryPointByBackupVault$VaultType": "<p>This is the type of vault in which the described recovery point is stored.</p>", |
| 2339 | + "RecoveryPointByResource$VaultType": "<p>This is the type of vault in which the described recovery point is stored.</p>" |
2339 | 2340 | } |
2340 | 2341 | }, |
2341 | 2342 | "WindowMinutes": { |
|
2358 | 2359 | "DescribeRecoveryPointOutput$IsEncrypted": "<p>A Boolean value that is returned as <code>TRUE</code> if the specified recovery point is encrypted, or <code>FALSE</code> if the recovery point is not encrypted.</p>", |
2359 | 2360 | "DescribeRecoveryPointOutput$IsParent": "<p>This returns the boolean value that a recovery point is a parent (composite) job.</p>", |
2360 | 2361 | "ListBackupVaultsInput$ByShared": "<p>This parameter will sort the list of vaults by shared vaults.</p>", |
| 2362 | + "ListRecoveryPointsByResourceInput$ManagedByAWSBackupOnly": "<p>This attribute filters recovery points based on ownership.</p> <p>If this is set to <code>TRUE</code>, the response will contain recovery points associated with the selected resources that are managed by Backup.</p> <p>If this is set to <code>FALSE</code>, the response will contain all recovery points associated with the selected resource.</p> <p>Type: Boolean</p>", |
2361 | 2363 | "RecoveryPointByBackupVault$IsEncrypted": "<p>A Boolean value that is returned as <code>TRUE</code> if the specified recovery point is encrypted, or <code>FALSE</code> if the recovery point is not encrypted.</p>", |
2362 | 2364 | "RecoveryPointByBackupVault$IsParent": "<p>This is a boolean value indicating this is a parent (composite) recovery point.</p>", |
2363 | 2365 | "RecoveryPointByResource$IsParent": "<p>This is a boolean value indicating this is a parent (composite) recovery point.</p>", |
|
0 commit comments