Skip to content

Commit 7077749

Browse files
author
awstools
committed
feat(client-backup): This release introduces a boolean attribute ManagedByAWSBackupOnly as part of ListRecoveryPointsByResource api to filter the recovery points based on ownership. This attribute can be used to filter out the recovery points protected by AWSBackup.
1 parent 1d943e0 commit 7077749

File tree

5 files changed

+71
-9
lines changed

5 files changed

+71
-9
lines changed

‎clients/client-backup/src/commands/ListRecoveryPointsByResourceCommand.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ export interface ListRecoveryPointsByResourceCommandOutput
4848
* ResourceArn: "STRING_VALUE", // required
4949
* NextToken: "STRING_VALUE",
5050
* MaxResults: Number("int"),
51+
* ManagedByAWSBackupOnly: true || false,
5152
* };
5253
* const command = new ListRecoveryPointsByResourceCommand(input);
5354
* const response = await client.send(command);
@@ -65,6 +66,7 @@ export interface ListRecoveryPointsByResourceCommandOutput
6566
* // IsParent: true || false,
6667
* // ParentRecoveryPointArn: "STRING_VALUE",
6768
* // ResourceName: "STRING_VALUE",
69+
* // VaultType: "BACKUP_VAULT" || "LOGICALLY_AIR_GAPPED_BACKUP_VAULT",
6870
* // },
6971
* // ],
7072
* // };

‎clients/client-backup/src/commands/StopBackupJobCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export interface StopBackupJobCommandOutput extends __MetadataBearer {}
2929
/**
3030
* <p>Attempts to cancel a job to create a one-time backup of a resource.</p>
3131
* <p>This action is not supported for the following services:
32-
* Amazon FSx for Windows File Server, Amazon FSx for Lustre, FSx for ONTAP
32+
* Amazon FSx for Windows File Server, Amazon FSx for Lustre, Amazon FSx for NetApp ONTAP
3333
* , Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon Aurora,
3434
* and Amazon Neptune.</p>
3535
* @example

‎clients/client-backup/src/models/models_0.ts

Lines changed: 46 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2136,6 +2136,9 @@ export interface FrameworkControl {
21362136
* <p>The scope of a control. The control scope defines what the control will evaluate. Three
21372137
* examples of control scopes are: a specific backup plan, all backup plans with a specific
21382138
* tag, or all backup plans.</p>
2139+
* <p>For more information, see <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ControlScope.html">
2140+
* <code>ControlScope</code>.</a>
2141+
* </p>
21392142
* @public
21402143
*/
21412144
ControlScope?: ControlScope;
@@ -5550,6 +5553,16 @@ export interface ListBackupJobsInput {
55505553

55515554
/**
55525555
* <p>Returns only backup jobs that are in the specified state.</p>
5556+
* <p>
5557+
* <code>Completed with issues</code> is a status found only in the Backup
5558+
* console. For API, this status refers to jobs with a state of <code>COMPLETED</code> and a
5559+
* <code>MessageCategory</code> with a value other than <code>SUCCESS</code>; that is, the
5560+
* status is completed but comes with a status message.</p>
5561+
* <p>To obtain the job count for
5562+
* <code>Completed with issues</code>, run two GET requests, and subtract the second,
5563+
* smaller number:</p>
5564+
* <p>GET /backup-jobs/?state=COMPLETED</p>
5565+
* <p>GET /backup-jobs/?messageCategory=SUCCESS&state=COMPLETED</p>
55535566
* @public
55545567
*/
55555568
ByState?: BackupJobState;
@@ -5736,12 +5749,22 @@ export interface ListBackupJobSummariesInput {
57365749
AccountId?: string;
57375750

57385751
/**
5739-
* <p>This parameter returns the job count for jobs
5740-
* with the specified state.</p>
5752+
* <p>This parameter returns the job count for jobs with the specified state.</p>
57415753
* <p>The the value ANY returns count of all states.</p>
57425754
* <p>
5743-
* <code>AGGREGATE_ALL</code> aggregates job counts
5744-
* for all states and returns the sum.</p>
5755+
* <code>AGGREGATE_ALL</code> aggregates job counts for all states and returns the
5756+
* sum.</p>
5757+
* <p>
5758+
* <code>Completed with issues</code> is a status found only in the Backup
5759+
* console. For API, this status refers to jobs with a state of <code>COMPLETED</code> and a
5760+
* <code>MessageCategory</code> with a value other than <code>SUCCESS</code>; that is, the
5761+
* status is completed but comes with a status message. To obtain the job count for
5762+
* <code>Completed with issues</code>, run two GET requests, and subtract the second,
5763+
* smaller number:</p>
5764+
* <p>GET
5765+
* /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&State=COMPLETED</p>
5766+
* <p>GET
5767+
* /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&MessageCategory=SUCCESS&State=COMPLETED</p>
57455768
* @public
57465769
*/
57475770
State?: BackupJobStatus;
@@ -7229,6 +7252,18 @@ export interface ListRecoveryPointsByResourceInput {
72297252
* @public
72307253
*/
72317254
MaxResults?: number;
7255+
7256+
/**
7257+
* <p>This attribute filters recovery points based on ownership.</p>
7258+
* <p>If this is
7259+
* set to <code>TRUE</code>, the response will contain recovery points associated
7260+
* with the selected resources that are managed by Backup.</p>
7261+
* <p>If this is set to <code>FALSE</code>, the response will contain all
7262+
* recovery points associated with the selected resource.</p>
7263+
* <p>Type: Boolean</p>
7264+
* @public
7265+
*/
7266+
ManagedByAWSBackupOnly?: boolean;
72327267
}
72337268

72347269
/**
@@ -7306,6 +7341,13 @@ export interface RecoveryPointByResource {
73067341
* @public
73077342
*/
73087343
ResourceName?: string;
7344+
7345+
/**
7346+
* <p>This is the type of vault in which the described recovery point is
7347+
* stored.</p>
7348+
* @public
7349+
*/
7350+
VaultType?: VaultType;
73097351
}
73107352

73117353
/**

‎clients/client-backup/src/protocols/Aws_restJson1.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1584,6 +1584,7 @@ export const se_ListRecoveryPointsByResourceCommand = async (
15841584
const query: any = map({
15851585
[_nT]: [, input[_NT]!],
15861586
[_mR]: [() => input.MaxResults !== void 0, () => input[_MR]!.toString()],
1587+
[_mBAWSBO]: [() => input.ManagedByAWSBackupOnly !== void 0, () => input[_MBAWSBO]!.toString()],
15871588
});
15881589
let body: any;
15891590
b.m("GET").h(headers).q(query).b(body);
@@ -5118,6 +5119,7 @@ const de_RecoveryPointByResource = (output: any, context: __SerdeContext): Recov
51185119
ResourceName: __expectString,
51195120
Status: __expectString,
51205121
StatusMessage: __expectString,
5122+
VaultType: __expectString,
51215123
}) as any;
51225124
};
51235125

@@ -5447,6 +5449,7 @@ const _CA = "CreationAfter";
54475449
const _CB = "CreationBefore";
54485450
const _CD = "CancelDescription";
54495451
const _ID = "IncludeDeleted";
5452+
const _MBAWSBO = "ManagedByAWSBackupOnly";
54505453
const _MC = "MessageCategory";
54515454
const _MR = "MaxResults";
54525455
const _NT = "NextToken";
@@ -5468,6 +5471,7 @@ const _cBo = "completeBefore";
54685471
const _cD = "cancelDescription";
54695472
const _dVA = "destinationVaultArn";
54705473
const _iD = "includeDeleted";
5474+
const _mBAWSBO = "managedByAWSBackupOnly";
54715475
const _mC = "messageCategory";
54725476
const _mR = "maxResults";
54735477
const _nT = "nextToken";

‎codegen/sdk-codegen/aws-models/backup.json

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6054,7 +6054,7 @@
60546054
"ControlScope": {
60556055
"target": "com.amazonaws.backup#ControlScope",
60566056
"traits": {
6057-
"smithy.api#documentation": "<p>The scope of a control. The control scope defines what the control will evaluate. Three\n examples of control scopes are: a specific backup plan, all backup plans with a specific\n tag, or all backup plans.</p>"
6057+
"smithy.api#documentation": "<p>The scope of a control. The control scope defines what the control will evaluate. Three\n examples of control scopes are: a specific backup plan, all backup plans with a specific\n tag, or all backup plans.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ControlScope.html\">\n <code>ControlScope</code>.</a>\n </p>"
60586058
}
60596059
}
60606060
},
@@ -7411,7 +7411,7 @@
74117411
"State": {
74127412
"target": "com.amazonaws.backup#BackupJobStatus",
74137413
"traits": {
7414-
"smithy.api#documentation": "<p>This parameter returns the job count for jobs \n with the specified state.</p>\n <p>The the value ANY returns count of all states.</p>\n <p>\n <code>AGGREGATE_ALL</code> aggregates job counts \n for all states and returns the sum.</p>",
7414+
"smithy.api#documentation": "<p>This parameter returns the job count for jobs with the specified state.</p>\n <p>The the value ANY returns count of all states.</p>\n <p>\n <code>AGGREGATE_ALL</code> aggregates job counts for all states and returns the\n sum.</p>\n <p>\n <code>Completed with issues</code> is a status found only in the Backup\n console. For API, this status refers to jobs with a state of <code>COMPLETED</code> and a\n <code>MessageCategory</code> with a value other than <code>SUCCESS</code>; that is, the\n status is completed but comes with a status message. To obtain the job count for\n <code>Completed with issues</code>, run two GET requests, and subtract the second,\n smaller number:</p>\n <p>GET\n /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&State=COMPLETED</p>\n <p>GET\n /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&MessageCategory=SUCCESS&State=COMPLETED</p>",
74157415
"smithy.api#httpQuery": "State"
74167416
}
74177417
},
@@ -7540,7 +7540,7 @@
75407540
"ByState": {
75417541
"target": "com.amazonaws.backup#BackupJobState",
75427542
"traits": {
7543-
"smithy.api#documentation": "<p>Returns only backup jobs that are in the specified state.</p>",
7543+
"smithy.api#documentation": "<p>Returns only backup jobs that are in the specified state.</p>\n <p>\n <code>Completed with issues</code> is a status found only in the Backup\n console. For API, this status refers to jobs with a state of <code>COMPLETED</code> and a\n <code>MessageCategory</code> with a value other than <code>SUCCESS</code>; that is, the\n status is completed but comes with a status message.</p>\n <p>To obtain the job count for\n <code>Completed with issues</code>, run two GET requests, and subtract the second,\n smaller number:</p>\n <p>GET /backup-jobs/?state=COMPLETED</p>\n <p>GET /backup-jobs/?messageCategory=SUCCESS&state=COMPLETED</p>",
75447544
"smithy.api#httpQuery": "state"
75457545
}
75467546
},
@@ -8933,6 +8933,14 @@
89338933
"smithy.api#documentation": "<p>The maximum number of items to be returned.</p>\n <note>\n <p>Amazon RDS requires a value of at least 20.</p>\n </note>",
89348934
"smithy.api#httpQuery": "maxResults"
89358935
}
8936+
},
8937+
"ManagedByAWSBackupOnly": {
8938+
"target": "com.amazonaws.backup#Boolean2",
8939+
"traits": {
8940+
"smithy.api#default": false,
8941+
"smithy.api#documentation": "<p>This attribute filters recovery points based on ownership.</p>\n <p>If this is \n set to <code>TRUE</code>, the response will contain recovery points associated \n with the selected resources that are managed by Backup.</p>\n <p>If this is set to <code>FALSE</code>, the response will contain all \n recovery points associated with the selected resource.</p>\n <p>Type: Boolean</p>",
8942+
"smithy.api#httpQuery": "managedByAWSBackupOnly"
8943+
}
89368944
}
89378945
},
89388946
"traits": {
@@ -10365,6 +10373,12 @@
1036510373
"traits": {
1036610374
"smithy.api#documentation": "<p>This is the non-unique name of the resource that \n belongs to the specified backup.</p>"
1036710375
}
10376+
},
10377+
"VaultType": {
10378+
"target": "com.amazonaws.backup#VaultType",
10379+
"traits": {
10380+
"smithy.api#documentation": "<p>This is the type of vault in which the described recovery point is \n stored.</p>"
10381+
}
1036810382
}
1036910383
},
1037010384
"traits": {
@@ -12159,7 +12173,7 @@
1215912173
}
1216012174
],
1216112175
"traits": {
12162-
"smithy.api#documentation": "<p>Attempts to cancel a job to create a one-time backup of a resource.</p>\n <p>This action is not supported for the following services:\n Amazon FSx for Windows File Server, Amazon FSx for Lustre, FSx for ONTAP\n , Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon Aurora, \n and Amazon Neptune.</p>",
12176+
"smithy.api#documentation": "<p>Attempts to cancel a job to create a one-time backup of a resource.</p>\n <p>This action is not supported for the following services:\n Amazon FSx for Windows File Server, Amazon FSx for Lustre, Amazon FSx for NetApp ONTAP\n , Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon Aurora, \n and Amazon Neptune.</p>",
1216312177
"smithy.api#http": {
1216412178
"method": "POST",
1216512179
"uri": "/backup-jobs/{BackupJobId}",

0 commit comments

Comments
 (0)