|
7 | 7 | "DeleteGateway": "<p>Deletes a backup gateway.</p>", |
8 | 8 | "DeleteHypervisor": "<p>Deletes a hypervisor.</p>", |
9 | 9 | "DisassociateGatewayFromServer": "<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>", |
| 10 | + "GetGateway": "<p>By providing the ARN (Amazon Resource Name), this API returns the gateway.</p>", |
10 | 11 | "ImportHypervisorConfiguration": "<p>Connect to a hypervisor by importing its configuration.</p>", |
11 | 12 | "ListGateways": "<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>", |
12 | 13 | "ListHypervisors": "<p>Lists your hypervisors.</p>", |
|
17 | 18 | "TestHypervisorConfiguration": "<p>Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.</p>", |
18 | 19 | "UntagResource": "<p>Removes tags from the resource.</p>", |
19 | 20 | "UpdateGatewayInformation": "<p>Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request.</p>", |
| 21 | + "UpdateGatewaySoftwareNow": "<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>", |
20 | 22 | "UpdateHypervisor": "<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>" |
21 | 23 | }, |
22 | 24 | "shapes": { |
|
115 | 117 | "DisassociateGatewayFromServerInput$GatewayArn": "<p>The Amazon Resource Name (ARN) of the gateway to disassociate.</p>", |
116 | 118 | "DisassociateGatewayFromServerOutput$GatewayArn": "<p>The Amazon Resource Name (ARN) of the gateway you disassociated.</p>", |
117 | 119 | "Gateway$GatewayArn": "<p>The Amazon Resource Name (ARN) of the gateway. Use the <code>ListGateways</code> operation to return a list of gateways for your account and Amazon Web Services Region.</p>", |
| 120 | + "GatewayDetails$GatewayArn": "<p>The Amazon Resource Name (ARN) of the gateway. Use the <code>ListGateways</code> operation to return a list of gateways for your account and Amazon Web Services Region.</p>", |
| 121 | + "GetGatewayInput$GatewayArn": "<p>The Amazon Resource Name (ARN) of the gateway.</p>", |
118 | 122 | "PutMaintenanceStartTimeInput$GatewayArn": "<p>The Amazon Resource Name (ARN) for the gateway, used to specify its maintenance start time.</p>", |
119 | 123 | "PutMaintenanceStartTimeOutput$GatewayArn": "<p>The Amazon Resource Name (ARN) of a gateway for which you set the maintenance start time.</p>", |
120 | 124 | "TestHypervisorConfigurationInput$GatewayArn": "<p>The Amazon Resource Name (ARN) of the gateway to the hypervisor to test.</p>", |
121 | 125 | "UpdateGatewayInformationInput$GatewayArn": "<p>The Amazon Resource Name (ARN) of the gateway to update.</p>", |
122 | | - "UpdateGatewayInformationOutput$GatewayArn": "<p>The Amazon Resource Name (ARN) of the gateway you updated.</p>" |
| 126 | + "UpdateGatewayInformationOutput$GatewayArn": "<p>The Amazon Resource Name (ARN) of the gateway you updated.</p>", |
| 127 | + "UpdateGatewaySoftwareNowInput$GatewayArn": "<p>The Amazon Resource Name (ARN) of the gateway to be updated.</p>", |
| 128 | + "UpdateGatewaySoftwareNowOutput$GatewayArn": "<p>The Amazon Resource Name (ARN) of the gateway you updated.</p>" |
| 129 | + } |
| 130 | + }, |
| 131 | + "GatewayDetails": { |
| 132 | + "base": "<p>The details of gateway.</p>", |
| 133 | + "refs": { |
| 134 | + "GetGatewayOutput$Gateway": "<p>By providing the ARN (Amazon Resource Name), this API returns the gateway.</p>" |
123 | 135 | } |
124 | 136 | }, |
125 | 137 | "GatewayType": { |
126 | 138 | "base": null, |
127 | 139 | "refs": { |
128 | 140 | "CreateGatewayInput$GatewayType": "<p>The type of created gateway.</p>", |
129 | | - "Gateway$GatewayType": "<p>The type of the gateway.</p>" |
| 141 | + "Gateway$GatewayType": "<p>The type of the gateway.</p>", |
| 142 | + "GatewayDetails$GatewayType": "<p>The type of the gateway type.</p>" |
130 | 143 | } |
131 | 144 | }, |
132 | 145 | "Gateways": { |
|
135 | 148 | "ListGatewaysOutput$Gateways": "<p>A list of your gateways.</p>" |
136 | 149 | } |
137 | 150 | }, |
| 151 | + "GetGatewayInput": { |
| 152 | + "base": null, |
| 153 | + "refs": { |
| 154 | + } |
| 155 | + }, |
| 156 | + "GetGatewayOutput": { |
| 157 | + "base": null, |
| 158 | + "refs": { |
| 159 | + } |
| 160 | + }, |
138 | 161 | "Host": { |
139 | 162 | "base": null, |
140 | 163 | "refs": { |
|
159 | 182 | "HypervisorId": { |
160 | 183 | "base": null, |
161 | 184 | "refs": { |
162 | | - "Gateway$HypervisorId": "<p>The hypervisor ID of the gateway.</p>" |
| 185 | + "Gateway$HypervisorId": "<p>The hypervisor ID of the gateway.</p>", |
| 186 | + "GatewayDetails$HypervisorId": "<p>The hypervisor ID of the gateway.</p>" |
163 | 187 | } |
164 | 188 | }, |
165 | 189 | "HypervisorState": { |
|
255 | 279 | "refs": { |
256 | 280 | "CreateGatewayInput$GatewayDisplayName": "<p>The display name of the created gateway.</p>", |
257 | 281 | "Gateway$GatewayDisplayName": "<p>The display name of the gateway.</p>", |
| 282 | + "GatewayDetails$GatewayDisplayName": "<p>The display name of the gateway.</p>", |
258 | 283 | "Hypervisor$Name": "<p>The name of the hypervisor.</p>", |
259 | 284 | "ImportHypervisorConfigurationInput$Name": "<p>The name of the hypervisor.</p>", |
260 | 285 | "UpdateGatewayInformationInput$GatewayDisplayName": "<p>The updated display name of the gateway.</p>", |
| 286 | + "UpdateHypervisorInput$Name": "<p>The updated name for the hypervisor</p>", |
261 | 287 | "VirtualMachine$HostName": "<p>The host name of the virtual machine.</p>", |
262 | 288 | "VirtualMachine$Name": "<p>The name of the virtual machine.</p>" |
263 | 289 | } |
|
306 | 332 | "TagResourceOutput$ResourceARN": "<p>The Amazon Resource Name (ARN) of the resource you tagged.</p>", |
307 | 333 | "UntagResourceInput$ResourceARN": "<p>The Amazon Resource Name (ARN) of the resource from which to remove tags.</p>", |
308 | 334 | "UntagResourceOutput$ResourceARN": "<p>The Amazon Resource Name (ARN) of the resource from which you removed tags.</p>", |
309 | | - "VirtualMachine$ResourceArn": "<p>The Amazon Resource Name (ARN) of the virtual machine.</p>" |
| 335 | + "VirtualMachine$ResourceArn": "<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>" |
310 | 336 | } |
311 | 337 | }, |
312 | 338 | "ResourceNotFoundException": { |
|
358 | 384 | "TagValue": { |
359 | 385 | "base": null, |
360 | 386 | "refs": { |
361 | | - "Tag$Value": "<p>The key part of a value's key-value pair.</p>" |
| 387 | + "Tag$Value": "<p>The value part of a tag's key-value pair.</p>" |
362 | 388 | } |
363 | 389 | }, |
364 | 390 | "Tags": { |
|
384 | 410 | "base": null, |
385 | 411 | "refs": { |
386 | 412 | "Gateway$LastSeenTime": "<p>The last time Backup gateway communicated with the gateway, in Unix format and UTC time.</p>", |
| 413 | + "GatewayDetails$LastSeenTime": "<p>Details showing the last time Backup gateway communicated with the cloud, in Unix format and UTC time.</p>", |
| 414 | + "GatewayDetails$NextUpdateAvailabilityTime": "<p>Details showing the next update availability time of the gateway.</p>", |
387 | 415 | "VirtualMachine$LastBackupDate": "<p>The most recent date a virtual machine was backed up, in Unix format and UTC time.</p>" |
388 | 416 | } |
389 | 417 | }, |
|
407 | 435 | "refs": { |
408 | 436 | } |
409 | 437 | }, |
| 438 | + "UpdateGatewaySoftwareNowInput": { |
| 439 | + "base": null, |
| 440 | + "refs": { |
| 441 | + } |
| 442 | + }, |
| 443 | + "UpdateGatewaySoftwareNowOutput": { |
| 444 | + "base": null, |
| 445 | + "refs": { |
| 446 | + } |
| 447 | + }, |
410 | 448 | "UpdateHypervisorInput": { |
411 | 449 | "base": null, |
412 | 450 | "refs": { |
|
442 | 480 | "ListVirtualMachinesOutput$VirtualMachines": "<p>A list of your <code>VirtualMachine</code> objects, ordered by their Amazon Resource Names (ARNs).</p>" |
443 | 481 | } |
444 | 482 | }, |
| 483 | + "VpcEndpoint": { |
| 484 | + "base": null, |
| 485 | + "refs": { |
| 486 | + "GatewayDetails$VpcEndpoint": "<p>The DNS name for the virtual private cloud (VPC) endpoint the gateway uses to connect to the cloud for backup gateway.</p>" |
| 487 | + } |
| 488 | + }, |
445 | 489 | "string": { |
446 | 490 | "base": null, |
447 | 491 | "refs": { |
|
0 commit comments