Skip to content

Commit e6b79ce

Browse files
author
AWS
committed
AWS Backup Gateway Update: Changes include: new GetVirtualMachineApi to fetch a single user's VM, improving ListVirtualMachines to fetch filtered VMs as well as all VMs, and improving GetGatewayApi to now also return the gateway's MaintenanceStartTime.
1 parent da00d51 commit e6b79ce

File tree

2 files changed

+154
-18
lines changed

2 files changed

+154
-18
lines changed

‎.changes/next-release/feature-AWSBackupGateway-3cfabad.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS Backup Gateway",
4+
"contributor": "",
5+
"description": "Changes include: new GetVirtualMachineApi to fetch a single user's VM, improving ListVirtualMachines to fetch filtered VMs as well as all VMs, and improving GetGatewayApi to now also return the gateway's MaintenanceStartTime."
6+
}

‎services/backupgateway/src/main/resources/codegen-resources/service-2.json

Lines changed: 148 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@
2424
"errors":[
2525
{"shape":"ValidationException"},
2626
{"shape":"ConflictException"},
27-
{"shape":"InternalServerException"}
27+
{"shape":"InternalServerException"},
28+
{"shape":"ThrottlingException"}
2829
],
2930
"documentation":"<p>Associates a backup gateway with your server. After you complete the association process, you can back up and restore your VMs through the gateway.</p>"
3031
},
@@ -38,7 +39,8 @@
3839
"output":{"shape":"CreateGatewayOutput"},
3940
"errors":[
4041
{"shape":"ValidationException"},
41-
{"shape":"InternalServerException"}
42+
{"shape":"InternalServerException"},
43+
{"shape":"ThrottlingException"}
4244
],
4345
"documentation":"<p>Creates a backup gateway. After you create a gateway, you can associate it with a server using the <code>AssociateGatewayToServer</code> operation.</p>"
4446
},
@@ -53,7 +55,8 @@
5355
"errors":[
5456
{"shape":"ValidationException"},
5557
{"shape":"InternalServerException"},
56-
{"shape":"ResourceNotFoundException"}
58+
{"shape":"ResourceNotFoundException"},
59+
{"shape":"ThrottlingException"}
5760
],
5861
"documentation":"<p>Deletes a backup gateway.</p>",
5962
"idempotent":true
@@ -70,7 +73,8 @@
7073
{"shape":"ValidationException"},
7174
{"shape":"InternalServerException"},
7275
{"shape":"AccessDeniedException"},
73-
{"shape":"ResourceNotFoundException"}
76+
{"shape":"ResourceNotFoundException"},
77+
{"shape":"ThrottlingException"}
7478
],
7579
"documentation":"<p>Deletes a hypervisor.</p>",
7680
"idempotent":true
@@ -87,7 +91,8 @@
8791
{"shape":"ValidationException"},
8892
{"shape":"ConflictException"},
8993
{"shape":"InternalServerException"},
90-
{"shape":"ResourceNotFoundException"}
94+
{"shape":"ResourceNotFoundException"},
95+
{"shape":"ThrottlingException"}
9196
],
9297
"documentation":"<p>Disassociates a backup gateway from the specified server. After the disassociation process finishes, the gateway can no longer access the virtual machines on the server.</p>"
9398
},
@@ -102,10 +107,27 @@
102107
"errors":[
103108
{"shape":"ValidationException"},
104109
{"shape":"InternalServerException"},
105-
{"shape":"ResourceNotFoundException"}
110+
{"shape":"ResourceNotFoundException"},
111+
{"shape":"ThrottlingException"}
106112
],
107113
"documentation":"<p>By providing the ARN (Amazon Resource Name), this API returns the gateway.</p>"
108114
},
115+
"GetVirtualMachine":{
116+
"name":"GetVirtualMachine",
117+
"http":{
118+
"method":"POST",
119+
"requestUri":"/"
120+
},
121+
"input":{"shape":"GetVirtualMachineInput"},
122+
"output":{"shape":"GetVirtualMachineOutput"},
123+
"errors":[
124+
{"shape":"ValidationException"},
125+
{"shape":"InternalServerException"},
126+
{"shape":"ResourceNotFoundException"},
127+
{"shape":"ThrottlingException"}
128+
],
129+
"documentation":"<p>By providing the ARN (Amazon Resource Name), this API returns the virtual machine.</p>"
130+
},
109131
"ImportHypervisorConfiguration":{
110132
"name":"ImportHypervisorConfiguration",
111133
"http":{
@@ -117,7 +139,8 @@
117139
"errors":[
118140
{"shape":"ValidationException"},
119141
{"shape":"InternalServerException"},
120-
{"shape":"AccessDeniedException"}
142+
{"shape":"AccessDeniedException"},
143+
{"shape":"ThrottlingException"}
121144
],
122145
"documentation":"<p>Connect to a hypervisor by importing its configuration.</p>"
123146
},
@@ -131,7 +154,8 @@
131154
"output":{"shape":"ListGatewaysOutput"},
132155
"errors":[
133156
{"shape":"ValidationException"},
134-
{"shape":"InternalServerException"}
157+
{"shape":"InternalServerException"},
158+
{"shape":"ThrottlingException"}
135159
],
136160
"documentation":"<p>Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region. The returned list is ordered by gateway Amazon Resource Name (ARN).</p>"
137161
},
@@ -145,7 +169,8 @@
145169
"output":{"shape":"ListHypervisorsOutput"},
146170
"errors":[
147171
{"shape":"ValidationException"},
148-
{"shape":"InternalServerException"}
172+
{"shape":"InternalServerException"},
173+
{"shape":"ThrottlingException"}
149174
],
150175
"documentation":"<p>Lists your hypervisors.</p>"
151176
},
@@ -160,7 +185,8 @@
160185
"errors":[
161186
{"shape":"ValidationException"},
162187
{"shape":"InternalServerException"},
163-
{"shape":"ResourceNotFoundException"}
188+
{"shape":"ResourceNotFoundException"},
189+
{"shape":"ThrottlingException"}
164190
],
165191
"documentation":"<p>Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).</p>"
166192
},
@@ -174,7 +200,8 @@
174200
"output":{"shape":"ListVirtualMachinesOutput"},
175201
"errors":[
176202
{"shape":"ValidationException"},
177-
{"shape":"InternalServerException"}
203+
{"shape":"InternalServerException"},
204+
{"shape":"ThrottlingException"}
178205
],
179206
"documentation":"<p>Lists your virtual machines.</p>"
180207
},
@@ -190,7 +217,8 @@
190217
{"shape":"ValidationException"},
191218
{"shape":"ConflictException"},
192219
{"shape":"InternalServerException"},
193-
{"shape":"ResourceNotFoundException"}
220+
{"shape":"ResourceNotFoundException"},
221+
{"shape":"ThrottlingException"}
194222
],
195223
"documentation":"<p>Set the maintenance start time for a gateway.</p>"
196224
},
@@ -205,7 +233,8 @@
205233
"errors":[
206234
{"shape":"ValidationException"},
207235
{"shape":"InternalServerException"},
208-
{"shape":"ResourceNotFoundException"}
236+
{"shape":"ResourceNotFoundException"},
237+
{"shape":"ThrottlingException"}
209238
],
210239
"documentation":"<p>Tag the resource.</p>"
211240
},
@@ -221,7 +250,8 @@
221250
{"shape":"ValidationException"},
222251
{"shape":"ConflictException"},
223252
{"shape":"InternalServerException"},
224-
{"shape":"ResourceNotFoundException"}
253+
{"shape":"ResourceNotFoundException"},
254+
{"shape":"ThrottlingException"}
225255
],
226256
"documentation":"<p>Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.</p>"
227257
},
@@ -236,7 +266,8 @@
236266
"errors":[
237267
{"shape":"ValidationException"},
238268
{"shape":"InternalServerException"},
239-
{"shape":"ResourceNotFoundException"}
269+
{"shape":"ResourceNotFoundException"},
270+
{"shape":"ThrottlingException"}
240271
],
241272
"documentation":"<p>Removes tags from the resource.</p>"
242273
},
@@ -252,7 +283,8 @@
252283
{"shape":"ValidationException"},
253284
{"shape":"ConflictException"},
254285
{"shape":"InternalServerException"},
255-
{"shape":"ResourceNotFoundException"}
286+
{"shape":"ResourceNotFoundException"},
287+
{"shape":"ThrottlingException"}
256288
],
257289
"documentation":"<p>Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request.</p>"
258290
},
@@ -267,7 +299,8 @@
267299
"errors":[
268300
{"shape":"ValidationException"},
269301
{"shape":"InternalServerException"},
270-
{"shape":"ResourceNotFoundException"}
302+
{"shape":"ResourceNotFoundException"},
303+
{"shape":"ThrottlingException"}
271304
],
272305
"documentation":"<p>Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.</p> <note> <p>When you make this request, you get a <code>200 OK</code> success response immediately. However, it might take some time for the update to complete.</p> </note>"
273306
},
@@ -283,7 +316,8 @@
283316
{"shape":"ValidationException"},
284317
{"shape":"InternalServerException"},
285318
{"shape":"AccessDeniedException"},
286-
{"shape":"ResourceNotFoundException"}
319+
{"shape":"ResourceNotFoundException"},
320+
{"shape":"ThrottlingException"}
287321
],
288322
"documentation":"<p>Updates a hypervisor metadata, including its host, username, and password. Specify which hypervisor to update using the Amazon Resource Name (ARN) of the hypervisor in your request.</p>"
289323
}
@@ -506,6 +540,10 @@
506540
"shape":"Time",
507541
"documentation":"<p>Details showing the last time Backup gateway communicated with the cloud, in Unix format and UTC time.</p>"
508542
},
543+
"MaintenanceStartTime":{
544+
"shape":"MaintenanceStartTime",
545+
"documentation":"<p>Returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone. Can be weekly or monthly.</p>"
546+
},
509547
"NextUpdateAvailabilityTime":{
510548
"shape":"Time",
511549
"documentation":"<p>Details showing the next update availability time of the gateway.</p>"
@@ -544,6 +582,25 @@
544582
}
545583
}
546584
},
585+
"GetVirtualMachineInput":{
586+
"type":"structure",
587+
"required":["ResourceArn"],
588+
"members":{
589+
"ResourceArn":{
590+
"shape":"ResourceArn",
591+
"documentation":"<p>The Amazon Resource Name (ARN) of the virtual machine.</p>"
592+
}
593+
}
594+
},
595+
"GetVirtualMachineOutput":{
596+
"type":"structure",
597+
"members":{
598+
"VirtualMachine":{
599+
"shape":"VirtualMachineDetails",
600+
"documentation":"<p>This object contains the basic attributes of <code>VirtualMachine</code> contained by the output of <code>GetVirtualMachine</code> </p>"
601+
}
602+
}
603+
},
547604
"Host":{
548605
"type":"string",
549606
"max":128,
@@ -739,6 +796,10 @@
739796
"ListVirtualMachinesInput":{
740797
"type":"structure",
741798
"members":{
799+
"HypervisorArn":{
800+
"shape":"ServerArn",
801+
"documentation":"<p>The Amazon Resource Name (ARN) of the hypervisor connected to your virtual machine.</p>"
802+
},
742803
"MaxResults":{
743804
"shape":"MaxResults",
744805
"documentation":"<p>The maximum number of virtual machines to list.</p>"
@@ -762,6 +823,32 @@
762823
}
763824
}
764825
},
826+
"MaintenanceStartTime":{
827+
"type":"structure",
828+
"required":[
829+
"HourOfDay",
830+
"MinuteOfHour"
831+
],
832+
"members":{
833+
"DayOfMonth":{
834+
"shape":"DayOfMonth",
835+
"documentation":"<p>The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month and 28 represents the last day of the month.</p>"
836+
},
837+
"DayOfWeek":{
838+
"shape":"DayOfWeek",
839+
"documentation":"<p>An ordinal number between 0 and 6 that represents the day of the week, where 0 represents Sunday and 6 represents Saturday. The day of week is in the time zone of the gateway.</p>"
840+
},
841+
"HourOfDay":{
842+
"shape":"HourOfDay",
843+
"documentation":"<p>The hour component of the maintenance start time represented as <i>hh</i>, where <i>hh</i> is the hour (0 to 23). The hour of the day is in the time zone of the gateway.</p>"
844+
},
845+
"MinuteOfHour":{
846+
"shape":"MinuteOfHour",
847+
"documentation":"<p>The minute component of the maintenance start time represented as <i>mm</i>, where <i>mm</i> is the minute (0 to 59). The minute of the hour is in the time zone of the gateway.</p>"
848+
}
849+
},
850+
"documentation":"<p>This is your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone. Can be weekly or monthly.</p>"
851+
},
765852
"MaxResults":{
766853
"type":"integer",
767854
"box":true,
@@ -955,6 +1042,19 @@
9551042
"members":{
9561043
}
9571044
},
1045+
"ThrottlingException":{
1046+
"type":"structure",
1047+
"required":["ErrorCode"],
1048+
"members":{
1049+
"ErrorCode":{
1050+
"shape":"string",
1051+
"documentation":"<p>Error: TPS has been limited to protect against intentional or unintentional high request volumes.</p>"
1052+
},
1053+
"Message":{"shape":"string"}
1054+
},
1055+
"documentation":"<p>TPS has been limited to protect against intentional or unintentional high request volumes.</p>",
1056+
"exception":true
1057+
},
9581058
"Time":{"type":"timestamp"},
9591059
"UntagResourceInput":{
9601060
"type":"structure",
@@ -1108,6 +1208,36 @@
11081208
},
11091209
"documentation":"<p>A virtual machine that is on a hypervisor.</p>"
11101210
},
1211+
"VirtualMachineDetails":{
1212+
"type":"structure",
1213+
"members":{
1214+
"HostName":{
1215+
"shape":"Name",
1216+
"documentation":"<p>The host name of the virtual machine.</p>"
1217+
},
1218+
"HypervisorId":{
1219+
"shape":"string",
1220+
"documentation":"<p>The ID of the virtual machine's hypervisor.</p>"
1221+
},
1222+
"LastBackupDate":{
1223+
"shape":"Time",
1224+
"documentation":"<p>The most recent date a virtual machine was backed up, in Unix format and UTC time.</p>"
1225+
},
1226+
"Name":{
1227+
"shape":"Name",
1228+
"documentation":"<p>The name of the virtual machine.</p>"
1229+
},
1230+
"Path":{
1231+
"shape":"Path",
1232+
"documentation":"<p>The path of the virtual machine.</p>"
1233+
},
1234+
"ResourceArn":{
1235+
"shape":"ResourceArn",
1236+
"documentation":"<p>The Amazon Resource Name (ARN) of the virtual machine. For example, <code>arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL</code>.</p>"
1237+
}
1238+
},
1239+
"documentation":"<p>Your <code>VirtualMachine</code> objects, ordered by their Amazon Resource Names (ARNs).</p>"
1240+
},
11111241
"VirtualMachines":{
11121242
"type":"list",
11131243
"member":{"shape":"VirtualMachine"}

0 commit comments

Comments
 (0)