|
427 | 427 | "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\\/[a-zA-Z-0-9]+$" |
428 | 428 | } |
429 | 429 | }, |
| 430 | + "com.amazonaws.backupgateway#GatewayDetails": { |
| 431 | + "type": "structure", |
| 432 | + "members": { |
| 433 | + "GatewayArn": { |
| 434 | + "target": "com.amazonaws.backupgateway#GatewayArn", |
| 435 | + "traits": { |
| 436 | + "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the \n gateway. Use the <code>ListGateways</code> operation\n to return a list of gateways for your account and \n Amazon Web Services Region.</p>" |
| 437 | + } |
| 438 | + }, |
| 439 | + "GatewayDisplayName": { |
| 440 | + "target": "com.amazonaws.backupgateway#Name", |
| 441 | + "traits": { |
| 442 | + "smithy.api#documentation": "<p>The display name of the gateway.</p>" |
| 443 | + } |
| 444 | + }, |
| 445 | + "GatewayType": { |
| 446 | + "target": "com.amazonaws.backupgateway#GatewayType", |
| 447 | + "traits": { |
| 448 | + "smithy.api#documentation": "<p>The type of the gateway type.</p>" |
| 449 | + } |
| 450 | + }, |
| 451 | + "HypervisorId": { |
| 452 | + "target": "com.amazonaws.backupgateway#HypervisorId", |
| 453 | + "traits": { |
| 454 | + "smithy.api#documentation": "<p>The hypervisor ID of the gateway.</p>" |
| 455 | + } |
| 456 | + }, |
| 457 | + "LastSeenTime": { |
| 458 | + "target": "com.amazonaws.backupgateway#Time", |
| 459 | + "traits": { |
| 460 | + "smithy.api#documentation": "<p>Details showing the last time Backup gateway communicated\n with the cloud, in Unix format and UTC time.</p>" |
| 461 | + } |
| 462 | + }, |
| 463 | + "NextUpdateAvailabilityTime": { |
| 464 | + "target": "com.amazonaws.backupgateway#Time", |
| 465 | + "traits": { |
| 466 | + "smithy.api#documentation": "<p>Details showing the next update availability time of the \n gateway.</p>" |
| 467 | + } |
| 468 | + }, |
| 469 | + "VpcEndpoint": { |
| 470 | + "target": "com.amazonaws.backupgateway#VpcEndpoint", |
| 471 | + "traits": { |
| 472 | + "smithy.api#documentation": "<p>The DNS name for the virtual private cloud (VPC) endpoint the gateway \n uses to connect to the cloud for backup gateway.</p>" |
| 473 | + } |
| 474 | + } |
| 475 | + }, |
| 476 | + "traits": { |
| 477 | + "smithy.api#documentation": "<p>The details of gateway.</p>" |
| 478 | + } |
| 479 | + }, |
430 | 480 | "com.amazonaws.backupgateway#GatewayResource": { |
431 | 481 | "type": "resource", |
432 | 482 | "identifiers": { |
|
437 | 487 | "create": { |
438 | 488 | "target": "com.amazonaws.backupgateway#CreateGateway" |
439 | 489 | }, |
| 490 | + "read": { |
| 491 | + "target": "com.amazonaws.backupgateway#GetGateway" |
| 492 | + }, |
440 | 493 | "update": { |
441 | 494 | "target": "com.amazonaws.backupgateway#UpdateGatewayInformation" |
442 | 495 | }, |
|
458 | 511 | }, |
459 | 512 | { |
460 | 513 | "target": "com.amazonaws.backupgateway#TestHypervisorConfiguration" |
| 514 | + }, |
| 515 | + { |
| 516 | + "target": "com.amazonaws.backupgateway#UpdateGatewaySoftwareNow" |
461 | 517 | } |
462 | 518 | ], |
463 | 519 | "traits": { |
|
483 | 539 | "target": "com.amazonaws.backupgateway#Gateway" |
484 | 540 | } |
485 | 541 | }, |
| 542 | + "com.amazonaws.backupgateway#GetGateway": { |
| 543 | + "type": "operation", |
| 544 | + "input": { |
| 545 | + "target": "com.amazonaws.backupgateway#GetGatewayInput" |
| 546 | + }, |
| 547 | + "output": { |
| 548 | + "target": "com.amazonaws.backupgateway#GetGatewayOutput" |
| 549 | + }, |
| 550 | + "errors": [ |
| 551 | + { |
| 552 | + "target": "com.amazonaws.backupgateway#InternalServerException" |
| 553 | + }, |
| 554 | + { |
| 555 | + "target": "com.amazonaws.backupgateway#ResourceNotFoundException" |
| 556 | + }, |
| 557 | + { |
| 558 | + "target": "com.amazonaws.backupgateway#ValidationException" |
| 559 | + } |
| 560 | + ], |
| 561 | + "traits": { |
| 562 | + "smithy.api#documentation": "<p>By providing the ARN (Amazon Resource Name), this\n API returns the gateway.</p>", |
| 563 | + "smithy.api#readonly": {} |
| 564 | + } |
| 565 | + }, |
| 566 | + "com.amazonaws.backupgateway#GetGatewayInput": { |
| 567 | + "type": "structure", |
| 568 | + "members": { |
| 569 | + "GatewayArn": { |
| 570 | + "target": "com.amazonaws.backupgateway#GatewayArn", |
| 571 | + "traits": { |
| 572 | + "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the gateway.</p>", |
| 573 | + "smithy.api#required": {} |
| 574 | + } |
| 575 | + } |
| 576 | + } |
| 577 | + }, |
| 578 | + "com.amazonaws.backupgateway#GetGatewayOutput": { |
| 579 | + "type": "structure", |
| 580 | + "members": { |
| 581 | + "Gateway": { |
| 582 | + "target": "com.amazonaws.backupgateway#GatewayDetails", |
| 583 | + "traits": { |
| 584 | + "smithy.api#documentation": "<p>By providing the ARN (Amazon Resource Name), this\n API returns the gateway.</p>" |
| 585 | + } |
| 586 | + } |
| 587 | + } |
| 588 | + }, |
486 | 589 | "com.amazonaws.backupgateway#Host": { |
487 | 590 | "type": "string", |
488 | 591 | "traits": { |
|
1123 | 1226 | "Value": { |
1124 | 1227 | "target": "com.amazonaws.backupgateway#TagValue", |
1125 | 1228 | "traits": { |
1126 | | - "smithy.api#documentation": "<p>The key part of a value's key-value pair.</p>", |
| 1229 | + "smithy.api#documentation": "<p>The value part of a tag's key-value pair.</p>", |
1127 | 1230 | "smithy.api#required": {} |
1128 | 1231 | } |
1129 | 1232 | } |
|
1389 | 1492 | } |
1390 | 1493 | } |
1391 | 1494 | }, |
| 1495 | + "com.amazonaws.backupgateway#UpdateGatewaySoftwareNow": { |
| 1496 | + "type": "operation", |
| 1497 | + "input": { |
| 1498 | + "target": "com.amazonaws.backupgateway#UpdateGatewaySoftwareNowInput" |
| 1499 | + }, |
| 1500 | + "output": { |
| 1501 | + "target": "com.amazonaws.backupgateway#UpdateGatewaySoftwareNowOutput" |
| 1502 | + }, |
| 1503 | + "errors": [ |
| 1504 | + { |
| 1505 | + "target": "com.amazonaws.backupgateway#InternalServerException" |
| 1506 | + }, |
| 1507 | + { |
| 1508 | + "target": "com.amazonaws.backupgateway#ResourceNotFoundException" |
| 1509 | + }, |
| 1510 | + { |
| 1511 | + "target": "com.amazonaws.backupgateway#ValidationException" |
| 1512 | + } |
| 1513 | + ], |
| 1514 | + "traits": { |
| 1515 | + "smithy.api#documentation": "<p>Updates the gateway virtual machine (VM) software. \n The request immediately triggers the software update.</p>\n <note>\n <p>When you make this request, you get a <code>200 OK</code>\n success response immediately. However, it might take some \n time for the update to complete.</p>\n </note>" |
| 1516 | + } |
| 1517 | + }, |
| 1518 | + "com.amazonaws.backupgateway#UpdateGatewaySoftwareNowInput": { |
| 1519 | + "type": "structure", |
| 1520 | + "members": { |
| 1521 | + "GatewayArn": { |
| 1522 | + "target": "com.amazonaws.backupgateway#GatewayArn", |
| 1523 | + "traits": { |
| 1524 | + "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the gateway\n to be updated.</p>", |
| 1525 | + "smithy.api#required": {} |
| 1526 | + } |
| 1527 | + } |
| 1528 | + } |
| 1529 | + }, |
| 1530 | + "com.amazonaws.backupgateway#UpdateGatewaySoftwareNowOutput": { |
| 1531 | + "type": "structure", |
| 1532 | + "members": { |
| 1533 | + "GatewayArn": { |
| 1534 | + "target": "com.amazonaws.backupgateway#GatewayArn", |
| 1535 | + "traits": { |
| 1536 | + "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the gateway\n you updated.</p>" |
| 1537 | + } |
| 1538 | + } |
| 1539 | + } |
| 1540 | + }, |
1392 | 1541 | "com.amazonaws.backupgateway#UpdateHypervisor": { |
1393 | 1542 | "type": "operation", |
1394 | 1543 | "input": { |
|
1442 | 1591 | "traits": { |
1443 | 1592 | "smithy.api#documentation": "<p>The updated password for the hypervisor.</p>" |
1444 | 1593 | } |
| 1594 | + }, |
| 1595 | + "Name": { |
| 1596 | + "target": "com.amazonaws.backupgateway#Name", |
| 1597 | + "traits": { |
| 1598 | + "smithy.api#documentation": "<p>The updated name for the hypervisor</p>" |
| 1599 | + } |
1445 | 1600 | } |
1446 | 1601 | } |
1447 | 1602 | }, |
|
1516 | 1671 | "ResourceArn": { |
1517 | 1672 | "target": "com.amazonaws.backupgateway#ResourceArn", |
1518 | 1673 | "traits": { |
1519 | | - "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the virtual machine.</p>" |
| 1674 | + "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the virtual machine. For example,\n <code>arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL</code>.</p>" |
1520 | 1675 | } |
1521 | 1676 | }, |
1522 | 1677 | "LastBackupDate": { |
|
1536 | 1691 | "target": "com.amazonaws.backupgateway#VirtualMachine" |
1537 | 1692 | } |
1538 | 1693 | }, |
| 1694 | + "com.amazonaws.backupgateway#VpcEndpoint": { |
| 1695 | + "type": "string", |
| 1696 | + "traits": { |
| 1697 | + "smithy.api#length": { |
| 1698 | + "min": 1, |
| 1699 | + "max": 255 |
| 1700 | + } |
| 1701 | + } |
| 1702 | + }, |
1539 | 1703 | "com.amazonaws.backupgateway#string": { |
1540 | 1704 | "type": "string" |
1541 | 1705 | } |
|
0 commit comments