1{ 2 "version":"2.0", 3 "metadata":{ 4 "apiVersion":"2016-11-01", 5 "endpointPrefix":"opsworks-cm", 6 "jsonVersion":"1.1", 7 "protocol":"json", 8 "serviceAbbreviation":"OpsWorksCM", 9 "serviceFullName":"AWS OpsWorks for Chef Automate", 10 "serviceId":"OpsWorksCM", 11 "signatureVersion":"v4", 12 "signingName":"opsworks-cm", 13 "targetPrefix":"OpsWorksCM_V2016_11_01", 14 "uid":"opsworkscm-2016-11-01" 15 }, 16 "operations":{ 17 "AssociateNode":{ 18 "name":"AssociateNode", 19 "http":{ 20 "method":"POST", 21 "requestUri":"/" 22 }, 23 "input":{"shape":"AssociateNodeRequest"}, 24 "output":{"shape":"AssociateNodeResponse"}, 25 "errors":[ 26 {"shape":"InvalidStateException"}, 27 {"shape":"ResourceNotFoundException"}, 28 {"shape":"ValidationException"} 29 ] 30 }, 31 "CreateBackup":{ 32 "name":"CreateBackup", 33 "http":{ 34 "method":"POST", 35 "requestUri":"/" 36 }, 37 "input":{"shape":"CreateBackupRequest"}, 38 "output":{"shape":"CreateBackupResponse"}, 39 "errors":[ 40 {"shape":"InvalidStateException"}, 41 {"shape":"LimitExceededException"}, 42 {"shape":"ResourceNotFoundException"}, 43 {"shape":"ValidationException"} 44 ] 45 }, 46 "CreateServer":{ 47 "name":"CreateServer", 48 "http":{ 49 "method":"POST", 50 "requestUri":"/" 51 }, 52 "input":{"shape":"CreateServerRequest"}, 53 "output":{"shape":"CreateServerResponse"}, 54 "errors":[ 55 {"shape":"LimitExceededException"}, 56 {"shape":"ResourceAlreadyExistsException"}, 57 {"shape":"ResourceNotFoundException"}, 58 {"shape":"ValidationException"} 59 ] 60 }, 61 "DeleteBackup":{ 62 "name":"DeleteBackup", 63 "http":{ 64 "method":"POST", 65 "requestUri":"/" 66 }, 67 "input":{"shape":"DeleteBackupRequest"}, 68 "output":{"shape":"DeleteBackupResponse"}, 69 "errors":[ 70 {"shape":"InvalidStateException"}, 71 {"shape":"ResourceNotFoundException"}, 72 {"shape":"ValidationException"} 73 ] 74 }, 75 "DeleteServer":{ 76 "name":"DeleteServer", 77 "http":{ 78 "method":"POST", 79 "requestUri":"/" 80 }, 81 "input":{"shape":"DeleteServerRequest"}, 82 "output":{"shape":"DeleteServerResponse"}, 83 "errors":[ 84 {"shape":"InvalidStateException"}, 85 {"shape":"ResourceNotFoundException"}, 86 {"shape":"ValidationException"} 87 ] 88 }, 89 "DescribeAccountAttributes":{ 90 "name":"DescribeAccountAttributes", 91 "http":{ 92 "method":"POST", 93 "requestUri":"/" 94 }, 95 "input":{"shape":"DescribeAccountAttributesRequest"}, 96 "output":{"shape":"DescribeAccountAttributesResponse"} 97 }, 98 "DescribeBackups":{ 99 "name":"DescribeBackups", 100 "http":{ 101 "method":"POST", 102 "requestUri":"/" 103 }, 104 "input":{"shape":"DescribeBackupsRequest"}, 105 "output":{"shape":"DescribeBackupsResponse"}, 106 "errors":[ 107 {"shape":"ValidationException"}, 108 {"shape":"ResourceNotFoundException"}, 109 {"shape":"InvalidNextTokenException"} 110 ] 111 }, 112 "DescribeEvents":{ 113 "name":"DescribeEvents", 114 "http":{ 115 "method":"POST", 116 "requestUri":"/" 117 }, 118 "input":{"shape":"DescribeEventsRequest"}, 119 "output":{"shape":"DescribeEventsResponse"}, 120 "errors":[ 121 {"shape":"ValidationException"}, 122 {"shape":"InvalidNextTokenException"}, 123 {"shape":"ResourceNotFoundException"} 124 ] 125 }, 126 "DescribeNodeAssociationStatus":{ 127 "name":"DescribeNodeAssociationStatus", 128 "http":{ 129 "method":"POST", 130 "requestUri":"/" 131 }, 132 "input":{"shape":"DescribeNodeAssociationStatusRequest"}, 133 "output":{"shape":"DescribeNodeAssociationStatusResponse"}, 134 "errors":[ 135 {"shape":"ResourceNotFoundException"}, 136 {"shape":"ValidationException"} 137 ] 138 }, 139 "DescribeServers":{ 140 "name":"DescribeServers", 141 "http":{ 142 "method":"POST", 143 "requestUri":"/" 144 }, 145 "input":{"shape":"DescribeServersRequest"}, 146 "output":{"shape":"DescribeServersResponse"}, 147 "errors":[ 148 {"shape":"ValidationException"}, 149 {"shape":"ResourceNotFoundException"}, 150 {"shape":"InvalidNextTokenException"} 151 ] 152 }, 153 "DisassociateNode":{ 154 "name":"DisassociateNode", 155 "http":{ 156 "method":"POST", 157 "requestUri":"/" 158 }, 159 "input":{"shape":"DisassociateNodeRequest"}, 160 "output":{"shape":"DisassociateNodeResponse"}, 161 "errors":[ 162 {"shape":"InvalidStateException"}, 163 {"shape":"ResourceNotFoundException"}, 164 {"shape":"ValidationException"} 165 ] 166 }, 167 "RestoreServer":{ 168 "name":"RestoreServer", 169 "http":{ 170 "method":"POST", 171 "requestUri":"/" 172 }, 173 "input":{"shape":"RestoreServerRequest"}, 174 "output":{"shape":"RestoreServerResponse"}, 175 "errors":[ 176 {"shape":"InvalidStateException"}, 177 {"shape":"ResourceNotFoundException"}, 178 {"shape":"ValidationException"} 179 ] 180 }, 181 "StartMaintenance":{ 182 "name":"StartMaintenance", 183 "http":{ 184 "method":"POST", 185 "requestUri":"/" 186 }, 187 "input":{"shape":"StartMaintenanceRequest"}, 188 "output":{"shape":"StartMaintenanceResponse"}, 189 "errors":[ 190 {"shape":"InvalidStateException"}, 191 {"shape":"ResourceNotFoundException"}, 192 {"shape":"ValidationException"} 193 ] 194 }, 195 "UpdateServer":{ 196 "name":"UpdateServer", 197 "http":{ 198 "method":"POST", 199 "requestUri":"/" 200 }, 201 "input":{"shape":"UpdateServerRequest"}, 202 "output":{"shape":"UpdateServerResponse"}, 203 "errors":[ 204 {"shape":"InvalidStateException"}, 205 {"shape":"ResourceNotFoundException"}, 206 {"shape":"ValidationException"} 207 ] 208 }, 209 "UpdateServerEngineAttributes":{ 210 "name":"UpdateServerEngineAttributes", 211 "http":{ 212 "method":"POST", 213 "requestUri":"/" 214 }, 215 "input":{"shape":"UpdateServerEngineAttributesRequest"}, 216 "output":{"shape":"UpdateServerEngineAttributesResponse"}, 217 "errors":[ 218 {"shape":"InvalidStateException"}, 219 {"shape":"ResourceNotFoundException"}, 220 {"shape":"ValidationException"} 221 ] 222 } 223 }, 224 "shapes":{ 225 "AccountAttribute":{ 226 "type":"structure", 227 "members":{ 228 "Name":{"shape":"String"}, 229 "Maximum":{"shape":"Integer"}, 230 "Used":{"shape":"Integer"} 231 } 232 }, 233 "AccountAttributes":{ 234 "type":"list", 235 "member":{"shape":"AccountAttribute"} 236 }, 237 "AssociateNodeRequest":{ 238 "type":"structure", 239 "required":[ 240 "ServerName", 241 "NodeName", 242 "EngineAttributes" 243 ], 244 "members":{ 245 "ServerName":{"shape":"ServerName"}, 246 "NodeName":{"shape":"NodeName"}, 247 "EngineAttributes":{"shape":"EngineAttributes"} 248 } 249 }, 250 "AssociateNodeResponse":{ 251 "type":"structure", 252 "members":{ 253 "NodeAssociationStatusToken":{"shape":"NodeAssociationStatusToken"} 254 } 255 }, 256 "AttributeName":{ 257 "type":"string", 258 "max":64, 259 "min":1, 260 "pattern":"[A-Z][A-Z0-9_]*" 261 }, 262 "AttributeValue":{"type":"string"}, 263 "Backup":{ 264 "type":"structure", 265 "members":{ 266 "BackupArn":{"shape":"String"}, 267 "BackupId":{"shape":"BackupId"}, 268 "BackupType":{"shape":"BackupType"}, 269 "CreatedAt":{"shape":"Timestamp"}, 270 "Description":{"shape":"String"}, 271 "Engine":{"shape":"String"}, 272 "EngineModel":{"shape":"String"}, 273 "EngineVersion":{"shape":"String"}, 274 "InstanceProfileArn":{"shape":"String"}, 275 "InstanceType":{"shape":"String"}, 276 "KeyPair":{"shape":"String"}, 277 "PreferredBackupWindow":{"shape":"TimeWindowDefinition"}, 278 "PreferredMaintenanceWindow":{"shape":"TimeWindowDefinition"}, 279 "S3DataSize":{ 280 "shape":"Integer", 281 "deprecated":true 282 }, 283 "S3DataUrl":{ 284 "shape":"String", 285 "deprecated":true 286 }, 287 "S3LogUrl":{"shape":"String"}, 288 "SecurityGroupIds":{"shape":"Strings"}, 289 "ServerName":{"shape":"ServerName"}, 290 "ServiceRoleArn":{"shape":"String"}, 291 "Status":{"shape":"BackupStatus"}, 292 "StatusDescription":{"shape":"String"}, 293 "SubnetIds":{"shape":"Strings"}, 294 "ToolsVersion":{"shape":"String"}, 295 "UserArn":{"shape":"String"} 296 } 297 }, 298 "BackupId":{ 299 "type":"string", 300 "max":79 301 }, 302 "BackupRetentionCountDefinition":{ 303 "type":"integer", 304 "min":1 305 }, 306 "BackupStatus":{ 307 "type":"string", 308 "enum":[ 309 "IN_PROGRESS", 310 "OK", 311 "FAILED", 312 "DELETING" 313 ] 314 }, 315 "BackupType":{ 316 "type":"string", 317 "enum":[ 318 "AUTOMATED", 319 "MANUAL" 320 ] 321 }, 322 "Backups":{ 323 "type":"list", 324 "member":{"shape":"Backup"} 325 }, 326 "Boolean":{"type":"boolean"}, 327 "CreateBackupRequest":{ 328 "type":"structure", 329 "required":["ServerName"], 330 "members":{ 331 "ServerName":{"shape":"ServerName"}, 332 "Description":{"shape":"String"} 333 } 334 }, 335 "CreateBackupResponse":{ 336 "type":"structure", 337 "members":{ 338 "Backup":{"shape":"Backup"} 339 } 340 }, 341 "CreateServerRequest":{ 342 "type":"structure", 343 "required":[ 344 "ServerName", 345 "InstanceProfileArn", 346 "InstanceType", 347 "ServiceRoleArn" 348 ], 349 "members":{ 350 "AssociatePublicIpAddress":{"shape":"Boolean"}, 351 "DisableAutomatedBackup":{"shape":"Boolean"}, 352 "Engine":{"shape":"String"}, 353 "EngineModel":{"shape":"String"}, 354 "EngineVersion":{"shape":"String"}, 355 "EngineAttributes":{"shape":"EngineAttributes"}, 356 "BackupRetentionCount":{"shape":"BackupRetentionCountDefinition"}, 357 "ServerName":{"shape":"ServerName"}, 358 "InstanceProfileArn":{"shape":"InstanceProfileArn"}, 359 "InstanceType":{"shape":"String"}, 360 "KeyPair":{"shape":"KeyPair"}, 361 "PreferredMaintenanceWindow":{"shape":"TimeWindowDefinition"}, 362 "PreferredBackupWindow":{"shape":"TimeWindowDefinition"}, 363 "SecurityGroupIds":{"shape":"Strings"}, 364 "ServiceRoleArn":{"shape":"ServiceRoleArn"}, 365 "SubnetIds":{"shape":"Strings"}, 366 "BackupId":{"shape":"BackupId"} 367 } 368 }, 369 "CreateServerResponse":{ 370 "type":"structure", 371 "members":{ 372 "Server":{"shape":"Server"} 373 } 374 }, 375 "DeleteBackupRequest":{ 376 "type":"structure", 377 "required":["BackupId"], 378 "members":{ 379 "BackupId":{"shape":"BackupId"} 380 } 381 }, 382 "DeleteBackupResponse":{ 383 "type":"structure", 384 "members":{ 385 } 386 }, 387 "DeleteServerRequest":{ 388 "type":"structure", 389 "required":["ServerName"], 390 "members":{ 391 "ServerName":{"shape":"ServerName"} 392 } 393 }, 394 "DeleteServerResponse":{ 395 "type":"structure", 396 "members":{ 397 } 398 }, 399 "DescribeAccountAttributesRequest":{ 400 "type":"structure", 401 "members":{ 402 } 403 }, 404 "DescribeAccountAttributesResponse":{ 405 "type":"structure", 406 "members":{ 407 "Attributes":{"shape":"AccountAttributes"} 408 } 409 }, 410 "DescribeBackupsRequest":{ 411 "type":"structure", 412 "members":{ 413 "BackupId":{"shape":"BackupId"}, 414 "ServerName":{"shape":"ServerName"}, 415 "NextToken":{"shape":"NextToken"}, 416 "MaxResults":{"shape":"MaxResults"} 417 } 418 }, 419 "DescribeBackupsResponse":{ 420 "type":"structure", 421 "members":{ 422 "Backups":{"shape":"Backups"}, 423 "NextToken":{"shape":"String"} 424 } 425 }, 426 "DescribeEventsRequest":{ 427 "type":"structure", 428 "required":["ServerName"], 429 "members":{ 430 "ServerName":{"shape":"ServerName"}, 431 "NextToken":{"shape":"NextToken"}, 432 "MaxResults":{"shape":"MaxResults"} 433 } 434 }, 435 "DescribeEventsResponse":{ 436 "type":"structure", 437 "members":{ 438 "ServerEvents":{"shape":"ServerEvents"}, 439 "NextToken":{"shape":"String"} 440 } 441 }, 442 "DescribeNodeAssociationStatusRequest":{ 443 "type":"structure", 444 "required":[ 445 "NodeAssociationStatusToken", 446 "ServerName" 447 ], 448 "members":{ 449 "NodeAssociationStatusToken":{"shape":"NodeAssociationStatusToken"}, 450 "ServerName":{"shape":"ServerName"} 451 } 452 }, 453 "DescribeNodeAssociationStatusResponse":{ 454 "type":"structure", 455 "members":{ 456 "NodeAssociationStatus":{"shape":"NodeAssociationStatus"}, 457 "EngineAttributes":{"shape":"EngineAttributes"} 458 } 459 }, 460 "DescribeServersRequest":{ 461 "type":"structure", 462 "members":{ 463 "ServerName":{"shape":"ServerName"}, 464 "NextToken":{"shape":"NextToken"}, 465 "MaxResults":{"shape":"MaxResults"} 466 } 467 }, 468 "DescribeServersResponse":{ 469 "type":"structure", 470 "members":{ 471 "Servers":{"shape":"Servers"}, 472 "NextToken":{"shape":"String"} 473 } 474 }, 475 "DisassociateNodeRequest":{ 476 "type":"structure", 477 "required":[ 478 "ServerName", 479 "NodeName" 480 ], 481 "members":{ 482 "ServerName":{"shape":"ServerName"}, 483 "NodeName":{"shape":"NodeName"}, 484 "EngineAttributes":{"shape":"EngineAttributes"} 485 } 486 }, 487 "DisassociateNodeResponse":{ 488 "type":"structure", 489 "members":{ 490 "NodeAssociationStatusToken":{"shape":"NodeAssociationStatusToken"} 491 } 492 }, 493 "EngineAttribute":{ 494 "type":"structure", 495 "members":{ 496 "Name":{"shape":"EngineAttributeName"}, 497 "Value":{"shape":"EngineAttributeValue"} 498 } 499 }, 500 "EngineAttributeName":{"type":"string"}, 501 "EngineAttributeValue":{ 502 "type":"string", 503 "sensitive":true 504 }, 505 "EngineAttributes":{ 506 "type":"list", 507 "member":{"shape":"EngineAttribute"} 508 }, 509 "InstanceProfileArn":{ 510 "type":"string", 511 "pattern":"arn:aws:iam::[0-9]{12}:instance-profile/.*" 512 }, 513 "Integer":{"type":"integer"}, 514 "InvalidNextTokenException":{ 515 "type":"structure", 516 "members":{ 517 "Message":{"shape":"String"} 518 }, 519 "exception":true 520 }, 521 "InvalidStateException":{ 522 "type":"structure", 523 "members":{ 524 "Message":{"shape":"String"} 525 }, 526 "exception":true 527 }, 528 "KeyPair":{"type":"string"}, 529 "LimitExceededException":{ 530 "type":"structure", 531 "members":{ 532 "Message":{"shape":"String"} 533 }, 534 "exception":true 535 }, 536 "MaintenanceStatus":{ 537 "type":"string", 538 "enum":[ 539 "SUCCESS", 540 "FAILED" 541 ] 542 }, 543 "MaxResults":{ 544 "type":"integer", 545 "min":1 546 }, 547 "NextToken":{"type":"string"}, 548 "NodeAssociationStatus":{ 549 "type":"string", 550 "enum":[ 551 "SUCCESS", 552 "FAILED", 553 "IN_PROGRESS" 554 ] 555 }, 556 "NodeAssociationStatusToken":{"type":"string"}, 557 "NodeName":{ 558 "type":"string", 559 "pattern":"^[\\-\\p{Alnum}_:.]+$" 560 }, 561 "ResourceAlreadyExistsException":{ 562 "type":"structure", 563 "members":{ 564 "Message":{"shape":"String"} 565 }, 566 "exception":true 567 }, 568 "ResourceNotFoundException":{ 569 "type":"structure", 570 "members":{ 571 "Message":{"shape":"String"} 572 }, 573 "exception":true 574 }, 575 "RestoreServerRequest":{ 576 "type":"structure", 577 "required":[ 578 "BackupId", 579 "ServerName" 580 ], 581 "members":{ 582 "BackupId":{"shape":"BackupId"}, 583 "ServerName":{"shape":"ServerName"}, 584 "InstanceType":{"shape":"String"}, 585 "KeyPair":{"shape":"KeyPair"} 586 } 587 }, 588 "RestoreServerResponse":{ 589 "type":"structure", 590 "members":{ 591 } 592 }, 593 "Server":{ 594 "type":"structure", 595 "members":{ 596 "AssociatePublicIpAddress":{"shape":"Boolean"}, 597 "BackupRetentionCount":{"shape":"Integer"}, 598 "ServerName":{"shape":"String"}, 599 "CreatedAt":{"shape":"Timestamp"}, 600 "CloudFormationStackArn":{"shape":"String"}, 601 "DisableAutomatedBackup":{"shape":"Boolean"}, 602 "Endpoint":{"shape":"String"}, 603 "Engine":{"shape":"String"}, 604 "EngineModel":{"shape":"String"}, 605 "EngineAttributes":{"shape":"EngineAttributes"}, 606 "EngineVersion":{"shape":"String"}, 607 "InstanceProfileArn":{"shape":"String"}, 608 "InstanceType":{"shape":"String"}, 609 "KeyPair":{"shape":"String"}, 610 "MaintenanceStatus":{"shape":"MaintenanceStatus"}, 611 "PreferredMaintenanceWindow":{"shape":"TimeWindowDefinition"}, 612 "PreferredBackupWindow":{"shape":"TimeWindowDefinition"}, 613 "SecurityGroupIds":{"shape":"Strings"}, 614 "ServiceRoleArn":{"shape":"String"}, 615 "Status":{"shape":"ServerStatus"}, 616 "StatusReason":{"shape":"String"}, 617 "SubnetIds":{"shape":"Strings"}, 618 "ServerArn":{"shape":"String"} 619 } 620 }, 621 "ServerEvent":{ 622 "type":"structure", 623 "members":{ 624 "CreatedAt":{"shape":"Timestamp"}, 625 "ServerName":{"shape":"String"}, 626 "Message":{"shape":"String"}, 627 "LogUrl":{"shape":"String"} 628 } 629 }, 630 "ServerEvents":{ 631 "type":"list", 632 "member":{"shape":"ServerEvent"} 633 }, 634 "ServerName":{ 635 "type":"string", 636 "max":40, 637 "min":1, 638 "pattern":"[a-zA-Z][a-zA-Z0-9\\-]*" 639 }, 640 "ServerStatus":{ 641 "type":"string", 642 "enum":[ 643 "BACKING_UP", 644 "CONNECTION_LOST", 645 "CREATING", 646 "DELETING", 647 "MODIFYING", 648 "FAILED", 649 "HEALTHY", 650 "RUNNING", 651 "RESTORING", 652 "SETUP", 653 "UNDER_MAINTENANCE", 654 "UNHEALTHY", 655 "TERMINATED" 656 ] 657 }, 658 "Servers":{ 659 "type":"list", 660 "member":{"shape":"Server"} 661 }, 662 "ServiceRoleArn":{ 663 "type":"string", 664 "pattern":"arn:aws:iam::[0-9]{12}:role/.*" 665 }, 666 "StartMaintenanceRequest":{ 667 "type":"structure", 668 "required":["ServerName"], 669 "members":{ 670 "ServerName":{"shape":"ServerName"}, 671 "EngineAttributes":{"shape":"EngineAttributes"} 672 } 673 }, 674 "StartMaintenanceResponse":{ 675 "type":"structure", 676 "members":{ 677 "Server":{"shape":"Server"} 678 } 679 }, 680 "String":{"type":"string"}, 681 "Strings":{ 682 "type":"list", 683 "member":{"shape":"String"} 684 }, 685 "TimeWindowDefinition":{ 686 "type":"string", 687 "pattern":"^((Mon|Tue|Wed|Thu|Fri|Sat|Sun):)?([0-1][0-9]|2[0-3]):[0-5][0-9]$" 688 }, 689 "Timestamp":{"type":"timestamp"}, 690 "UpdateServerEngineAttributesRequest":{ 691 "type":"structure", 692 "required":[ 693 "ServerName", 694 "AttributeName" 695 ], 696 "members":{ 697 "ServerName":{"shape":"ServerName"}, 698 "AttributeName":{"shape":"AttributeName"}, 699 "AttributeValue":{"shape":"AttributeValue"} 700 } 701 }, 702 "UpdateServerEngineAttributesResponse":{ 703 "type":"structure", 704 "members":{ 705 "Server":{"shape":"Server"} 706 } 707 }, 708 "UpdateServerRequest":{ 709 "type":"structure", 710 "required":["ServerName"], 711 "members":{ 712 "DisableAutomatedBackup":{"shape":"Boolean"}, 713 "BackupRetentionCount":{"shape":"Integer"}, 714 "ServerName":{"shape":"ServerName"}, 715 "PreferredMaintenanceWindow":{"shape":"TimeWindowDefinition"}, 716 "PreferredBackupWindow":{"shape":"TimeWindowDefinition"} 717 } 718 }, 719 "UpdateServerResponse":{ 720 "type":"structure", 721 "members":{ 722 "Server":{"shape":"Server"} 723 } 724 }, 725 "ValidationException":{ 726 "type":"structure", 727 "members":{ 728 "Message":{"shape":"String"} 729 }, 730 "exception":true 731 } 732 } 733} 734