github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/grafana/2020-08-18/api-2.json (about) 1 { 2 "version":"2.0", 3 "metadata":{ 4 "apiVersion":"2020-08-18", 5 "endpointPrefix":"grafana", 6 "jsonVersion":"1.1", 7 "protocol":"rest-json", 8 "serviceFullName":"Amazon Managed Grafana", 9 "serviceId":"grafana", 10 "signatureVersion":"v4", 11 "signingName":"grafana", 12 "uid":"grafana-2020-08-18" 13 }, 14 "operations":{ 15 "AssociateLicense":{ 16 "name":"AssociateLicense", 17 "http":{ 18 "method":"POST", 19 "requestUri":"/workspaces/{workspaceId}/licenses/{licenseType}", 20 "responseCode":202 21 }, 22 "input":{"shape":"AssociateLicenseRequest"}, 23 "output":{"shape":"AssociateLicenseResponse"}, 24 "errors":[ 25 {"shape":"ResourceNotFoundException"}, 26 {"shape":"ThrottlingException"}, 27 {"shape":"ValidationException"}, 28 {"shape":"AccessDeniedException"}, 29 {"shape":"InternalServerException"} 30 ] 31 }, 32 "CreateWorkspace":{ 33 "name":"CreateWorkspace", 34 "http":{ 35 "method":"POST", 36 "requestUri":"/workspaces", 37 "responseCode":202 38 }, 39 "input":{"shape":"CreateWorkspaceRequest"}, 40 "output":{"shape":"CreateWorkspaceResponse"}, 41 "errors":[ 42 {"shape":"ThrottlingException"}, 43 {"shape":"ConflictException"}, 44 {"shape":"ValidationException"}, 45 {"shape":"AccessDeniedException"}, 46 {"shape":"InternalServerException"}, 47 {"shape":"ServiceQuotaExceededException"} 48 ], 49 "idempotent":true 50 }, 51 "DeleteWorkspace":{ 52 "name":"DeleteWorkspace", 53 "http":{ 54 "method":"DELETE", 55 "requestUri":"/workspaces/{workspaceId}", 56 "responseCode":202 57 }, 58 "input":{"shape":"DeleteWorkspaceRequest"}, 59 "output":{"shape":"DeleteWorkspaceResponse"}, 60 "errors":[ 61 {"shape":"ResourceNotFoundException"}, 62 {"shape":"ThrottlingException"}, 63 {"shape":"ConflictException"}, 64 {"shape":"ValidationException"}, 65 {"shape":"AccessDeniedException"}, 66 {"shape":"InternalServerException"} 67 ], 68 "idempotent":true 69 }, 70 "DescribeWorkspace":{ 71 "name":"DescribeWorkspace", 72 "http":{ 73 "method":"GET", 74 "requestUri":"/workspaces/{workspaceId}", 75 "responseCode":200 76 }, 77 "input":{"shape":"DescribeWorkspaceRequest"}, 78 "output":{"shape":"DescribeWorkspaceResponse"}, 79 "errors":[ 80 {"shape":"ResourceNotFoundException"}, 81 {"shape":"ThrottlingException"}, 82 {"shape":"ValidationException"}, 83 {"shape":"AccessDeniedException"}, 84 {"shape":"InternalServerException"} 85 ] 86 }, 87 "DescribeWorkspaceAuthentication":{ 88 "name":"DescribeWorkspaceAuthentication", 89 "http":{ 90 "method":"GET", 91 "requestUri":"/workspaces/{workspaceId}/authentication", 92 "responseCode":200 93 }, 94 "input":{"shape":"DescribeWorkspaceAuthenticationRequest"}, 95 "output":{"shape":"DescribeWorkspaceAuthenticationResponse"}, 96 "errors":[ 97 {"shape":"ResourceNotFoundException"}, 98 {"shape":"ThrottlingException"}, 99 {"shape":"ValidationException"}, 100 {"shape":"AccessDeniedException"}, 101 {"shape":"InternalServerException"} 102 ] 103 }, 104 "DisassociateLicense":{ 105 "name":"DisassociateLicense", 106 "http":{ 107 "method":"DELETE", 108 "requestUri":"/workspaces/{workspaceId}/licenses/{licenseType}", 109 "responseCode":202 110 }, 111 "input":{"shape":"DisassociateLicenseRequest"}, 112 "output":{"shape":"DisassociateLicenseResponse"}, 113 "errors":[ 114 {"shape":"ResourceNotFoundException"}, 115 {"shape":"ThrottlingException"}, 116 {"shape":"ValidationException"}, 117 {"shape":"AccessDeniedException"}, 118 {"shape":"InternalServerException"} 119 ] 120 }, 121 "ListPermissions":{ 122 "name":"ListPermissions", 123 "http":{ 124 "method":"GET", 125 "requestUri":"/workspaces/{workspaceId}/permissions", 126 "responseCode":200 127 }, 128 "input":{"shape":"ListPermissionsRequest"}, 129 "output":{"shape":"ListPermissionsResponse"}, 130 "errors":[ 131 {"shape":"ResourceNotFoundException"}, 132 {"shape":"ThrottlingException"}, 133 {"shape":"ValidationException"}, 134 {"shape":"AccessDeniedException"}, 135 {"shape":"InternalServerException"} 136 ] 137 }, 138 "ListWorkspaces":{ 139 "name":"ListWorkspaces", 140 "http":{ 141 "method":"GET", 142 "requestUri":"/workspaces", 143 "responseCode":200 144 }, 145 "input":{"shape":"ListWorkspacesRequest"}, 146 "output":{"shape":"ListWorkspacesResponse"}, 147 "errors":[ 148 {"shape":"ThrottlingException"}, 149 {"shape":"AccessDeniedException"}, 150 {"shape":"InternalServerException"} 151 ] 152 }, 153 "UpdatePermissions":{ 154 "name":"UpdatePermissions", 155 "http":{ 156 "method":"PATCH", 157 "requestUri":"/workspaces/{workspaceId}/permissions", 158 "responseCode":200 159 }, 160 "input":{"shape":"UpdatePermissionsRequest"}, 161 "output":{"shape":"UpdatePermissionsResponse"}, 162 "errors":[ 163 {"shape":"ResourceNotFoundException"}, 164 {"shape":"ThrottlingException"}, 165 {"shape":"ValidationException"}, 166 {"shape":"AccessDeniedException"}, 167 {"shape":"InternalServerException"} 168 ] 169 }, 170 "UpdateWorkspace":{ 171 "name":"UpdateWorkspace", 172 "http":{ 173 "method":"PUT", 174 "requestUri":"/workspaces/{workspaceId}", 175 "responseCode":202 176 }, 177 "input":{"shape":"UpdateWorkspaceRequest"}, 178 "output":{"shape":"UpdateWorkspaceResponse"}, 179 "errors":[ 180 {"shape":"ResourceNotFoundException"}, 181 {"shape":"ThrottlingException"}, 182 {"shape":"ConflictException"}, 183 {"shape":"ValidationException"}, 184 {"shape":"AccessDeniedException"}, 185 {"shape":"InternalServerException"} 186 ] 187 }, 188 "UpdateWorkspaceAuthentication":{ 189 "name":"UpdateWorkspaceAuthentication", 190 "http":{ 191 "method":"POST", 192 "requestUri":"/workspaces/{workspaceId}/authentication", 193 "responseCode":200 194 }, 195 "input":{"shape":"UpdateWorkspaceAuthenticationRequest"}, 196 "output":{"shape":"UpdateWorkspaceAuthenticationResponse"}, 197 "errors":[ 198 {"shape":"ResourceNotFoundException"}, 199 {"shape":"ThrottlingException"}, 200 {"shape":"ConflictException"}, 201 {"shape":"ValidationException"}, 202 {"shape":"AccessDeniedException"}, 203 {"shape":"InternalServerException"} 204 ] 205 } 206 }, 207 "shapes":{ 208 "AccessDeniedException":{ 209 "type":"structure", 210 "required":["message"], 211 "members":{ 212 "message":{"shape":"String"} 213 }, 214 "error":{ 215 "httpStatusCode":403, 216 "senderFault":true 217 }, 218 "exception":true 219 }, 220 "AccountAccessType":{ 221 "type":"string", 222 "enum":[ 223 "CURRENT_ACCOUNT", 224 "ORGANIZATION" 225 ] 226 }, 227 "AllowedOrganization":{ 228 "type":"string", 229 "max":256, 230 "min":1 231 }, 232 "AllowedOrganizations":{ 233 "type":"list", 234 "member":{"shape":"AllowedOrganization"} 235 }, 236 "AssertionAttribute":{ 237 "type":"string", 238 "max":256, 239 "min":1 240 }, 241 "AssertionAttributes":{ 242 "type":"structure", 243 "members":{ 244 "email":{"shape":"AssertionAttribute"}, 245 "groups":{"shape":"AssertionAttribute"}, 246 "login":{"shape":"AssertionAttribute"}, 247 "name":{"shape":"AssertionAttribute"}, 248 "org":{"shape":"AssertionAttribute"}, 249 "role":{"shape":"AssertionAttribute"} 250 } 251 }, 252 "AssociateLicenseRequest":{ 253 "type":"structure", 254 "required":[ 255 "licenseType", 256 "workspaceId" 257 ], 258 "members":{ 259 "licenseType":{ 260 "shape":"LicenseType", 261 "location":"uri", 262 "locationName":"licenseType" 263 }, 264 "workspaceId":{ 265 "shape":"WorkspaceId", 266 "location":"uri", 267 "locationName":"workspaceId" 268 } 269 } 270 }, 271 "AssociateLicenseResponse":{ 272 "type":"structure", 273 "required":["workspace"], 274 "members":{ 275 "workspace":{"shape":"WorkspaceDescription"} 276 } 277 }, 278 "AuthenticationDescription":{ 279 "type":"structure", 280 "required":["providers"], 281 "members":{ 282 "awsSso":{"shape":"AwsSsoAuthentication"}, 283 "providers":{"shape":"AuthenticationProviders"}, 284 "saml":{"shape":"SamlAuthentication"} 285 } 286 }, 287 "AuthenticationProviderTypes":{ 288 "type":"string", 289 "enum":[ 290 "AWS_SSO", 291 "SAML" 292 ] 293 }, 294 "AuthenticationProviders":{ 295 "type":"list", 296 "member":{"shape":"AuthenticationProviderTypes"} 297 }, 298 "AuthenticationSummary":{ 299 "type":"structure", 300 "required":["providers"], 301 "members":{ 302 "providers":{"shape":"AuthenticationProviders"}, 303 "samlConfigurationStatus":{"shape":"SamlConfigurationStatus"} 304 } 305 }, 306 "AwsSsoAuthentication":{ 307 "type":"structure", 308 "members":{ 309 "ssoClientId":{"shape":"SSOClientId"} 310 } 311 }, 312 "Boolean":{ 313 "type":"boolean", 314 "box":true 315 }, 316 "ClientToken":{ 317 "type":"string", 318 "pattern":"^[!-~]{1,64}$" 319 }, 320 "ConflictException":{ 321 "type":"structure", 322 "required":[ 323 "message", 324 "resourceId", 325 "resourceType" 326 ], 327 "members":{ 328 "message":{"shape":"String"}, 329 "resourceId":{"shape":"String"}, 330 "resourceType":{"shape":"String"} 331 }, 332 "error":{ 333 "httpStatusCode":409, 334 "senderFault":true 335 }, 336 "exception":true 337 }, 338 "CreateWorkspaceRequest":{ 339 "type":"structure", 340 "required":[ 341 "accountAccessType", 342 "authenticationProviders", 343 "permissionType" 344 ], 345 "members":{ 346 "accountAccessType":{"shape":"AccountAccessType"}, 347 "authenticationProviders":{"shape":"AuthenticationProviders"}, 348 "clientToken":{ 349 "shape":"ClientToken", 350 "idempotencyToken":true 351 }, 352 "organizationRoleName":{"shape":"OrganizationRoleName"}, 353 "permissionType":{"shape":"PermissionType"}, 354 "stackSetName":{"shape":"StackSetName"}, 355 "workspaceDataSources":{"shape":"DataSourceTypesList"}, 356 "workspaceDescription":{"shape":"Description"}, 357 "workspaceName":{"shape":"WorkspaceName"}, 358 "workspaceNotificationDestinations":{"shape":"NotificationDestinationsList"}, 359 "workspaceOrganizationalUnits":{"shape":"OrganizationalUnitList"}, 360 "workspaceRoleArn":{"shape":"IamRoleArn"} 361 } 362 }, 363 "CreateWorkspaceResponse":{ 364 "type":"structure", 365 "required":["workspace"], 366 "members":{ 367 "workspace":{"shape":"WorkspaceDescription"} 368 } 369 }, 370 "DataSourceType":{ 371 "type":"string", 372 "enum":[ 373 "AMAZON_OPENSEARCH_SERVICE", 374 "CLOUDWATCH", 375 "PROMETHEUS", 376 "XRAY", 377 "TIMESTREAM", 378 "SITEWISE" 379 ] 380 }, 381 "DataSourceTypesList":{ 382 "type":"list", 383 "member":{"shape":"DataSourceType"} 384 }, 385 "DeleteWorkspaceRequest":{ 386 "type":"structure", 387 "required":["workspaceId"], 388 "members":{ 389 "workspaceId":{ 390 "shape":"WorkspaceId", 391 "location":"uri", 392 "locationName":"workspaceId" 393 } 394 } 395 }, 396 "DeleteWorkspaceResponse":{ 397 "type":"structure", 398 "required":["workspace"], 399 "members":{ 400 "workspace":{"shape":"WorkspaceDescription"} 401 } 402 }, 403 "DescribeWorkspaceAuthenticationRequest":{ 404 "type":"structure", 405 "required":["workspaceId"], 406 "members":{ 407 "workspaceId":{ 408 "shape":"WorkspaceId", 409 "location":"uri", 410 "locationName":"workspaceId" 411 } 412 } 413 }, 414 "DescribeWorkspaceAuthenticationResponse":{ 415 "type":"structure", 416 "required":["authentication"], 417 "members":{ 418 "authentication":{"shape":"AuthenticationDescription"} 419 } 420 }, 421 "DescribeWorkspaceRequest":{ 422 "type":"structure", 423 "required":["workspaceId"], 424 "members":{ 425 "workspaceId":{ 426 "shape":"WorkspaceId", 427 "location":"uri", 428 "locationName":"workspaceId" 429 } 430 } 431 }, 432 "DescribeWorkspaceResponse":{ 433 "type":"structure", 434 "required":["workspace"], 435 "members":{ 436 "workspace":{"shape":"WorkspaceDescription"} 437 } 438 }, 439 "Description":{ 440 "type":"string", 441 "max":2048, 442 "min":0, 443 "sensitive":true 444 }, 445 "DisassociateLicenseRequest":{ 446 "type":"structure", 447 "required":[ 448 "licenseType", 449 "workspaceId" 450 ], 451 "members":{ 452 "licenseType":{ 453 "shape":"LicenseType", 454 "location":"uri", 455 "locationName":"licenseType" 456 }, 457 "workspaceId":{ 458 "shape":"WorkspaceId", 459 "location":"uri", 460 "locationName":"workspaceId" 461 } 462 } 463 }, 464 "DisassociateLicenseResponse":{ 465 "type":"structure", 466 "required":["workspace"], 467 "members":{ 468 "workspace":{"shape":"WorkspaceDescription"} 469 } 470 }, 471 "Endpoint":{ 472 "type":"string", 473 "max":2048, 474 "min":1 475 }, 476 "GrafanaVersion":{ 477 "type":"string", 478 "max":255, 479 "min":1 480 }, 481 "IamRoleArn":{ 482 "type":"string", 483 "max":2048, 484 "min":1, 485 "sensitive":true 486 }, 487 "IdpMetadata":{ 488 "type":"structure", 489 "members":{ 490 "url":{"shape":"IdpMetadataUrl"}, 491 "xml":{"shape":"String"} 492 }, 493 "union":true 494 }, 495 "IdpMetadataUrl":{ 496 "type":"string", 497 "max":2048, 498 "min":1 499 }, 500 "Integer":{ 501 "type":"integer", 502 "box":true 503 }, 504 "InternalServerException":{ 505 "type":"structure", 506 "required":["message"], 507 "members":{ 508 "message":{"shape":"String"}, 509 "retryAfterSeconds":{ 510 "shape":"Integer", 511 "location":"header", 512 "locationName":"Retry-After" 513 } 514 }, 515 "error":{"httpStatusCode":500}, 516 "exception":true, 517 "fault":true, 518 "retryable":{"throttling":false} 519 }, 520 "LicenseType":{ 521 "type":"string", 522 "enum":[ 523 "ENTERPRISE", 524 "ENTERPRISE_FREE_TRIAL" 525 ] 526 }, 527 "ListPermissionsRequest":{ 528 "type":"structure", 529 "required":["workspaceId"], 530 "members":{ 531 "groupId":{ 532 "shape":"SsoId", 533 "location":"querystring", 534 "locationName":"groupId" 535 }, 536 "maxResults":{ 537 "shape":"ListPermissionsRequestMaxResultsInteger", 538 "location":"querystring", 539 "locationName":"maxResults" 540 }, 541 "nextToken":{ 542 "shape":"PaginationToken", 543 "location":"querystring", 544 "locationName":"nextToken" 545 }, 546 "userId":{ 547 "shape":"SsoId", 548 "location":"querystring", 549 "locationName":"userId" 550 }, 551 "userType":{ 552 "shape":"UserType", 553 "location":"querystring", 554 "locationName":"userType" 555 }, 556 "workspaceId":{ 557 "shape":"WorkspaceId", 558 "location":"uri", 559 "locationName":"workspaceId" 560 } 561 } 562 }, 563 "ListPermissionsRequestMaxResultsInteger":{ 564 "type":"integer", 565 "box":true, 566 "max":100, 567 "min":1 568 }, 569 "ListPermissionsResponse":{ 570 "type":"structure", 571 "required":["permissions"], 572 "members":{ 573 "nextToken":{"shape":"PaginationToken"}, 574 "permissions":{"shape":"PermissionEntryList"} 575 } 576 }, 577 "ListWorkspacesRequest":{ 578 "type":"structure", 579 "members":{ 580 "maxResults":{ 581 "shape":"ListWorkspacesRequestMaxResultsInteger", 582 "location":"querystring", 583 "locationName":"maxResults" 584 }, 585 "nextToken":{ 586 "shape":"PaginationToken", 587 "location":"querystring", 588 "locationName":"nextToken" 589 } 590 } 591 }, 592 "ListWorkspacesRequestMaxResultsInteger":{ 593 "type":"integer", 594 "box":true, 595 "max":100, 596 "min":1 597 }, 598 "ListWorkspacesResponse":{ 599 "type":"structure", 600 "required":["workspaces"], 601 "members":{ 602 "nextToken":{"shape":"PaginationToken"}, 603 "workspaces":{"shape":"WorkspaceList"} 604 } 605 }, 606 "LoginValidityDuration":{"type":"integer"}, 607 "NotificationDestinationType":{ 608 "type":"string", 609 "enum":["SNS"] 610 }, 611 "NotificationDestinationsList":{ 612 "type":"list", 613 "member":{"shape":"NotificationDestinationType"} 614 }, 615 "OrganizationRoleName":{ 616 "type":"string", 617 "max":2048, 618 "min":1, 619 "sensitive":true 620 }, 621 "OrganizationalUnit":{"type":"string"}, 622 "OrganizationalUnitList":{ 623 "type":"list", 624 "member":{"shape":"OrganizationalUnit"}, 625 "sensitive":true 626 }, 627 "PaginationToken":{"type":"string"}, 628 "PermissionEntry":{ 629 "type":"structure", 630 "required":[ 631 "role", 632 "user" 633 ], 634 "members":{ 635 "role":{"shape":"Role"}, 636 "user":{"shape":"User"} 637 } 638 }, 639 "PermissionEntryList":{ 640 "type":"list", 641 "member":{"shape":"PermissionEntry"} 642 }, 643 "PermissionType":{ 644 "type":"string", 645 "enum":[ 646 "CUSTOMER_MANAGED", 647 "SERVICE_MANAGED" 648 ] 649 }, 650 "ResourceNotFoundException":{ 651 "type":"structure", 652 "required":[ 653 "message", 654 "resourceId", 655 "resourceType" 656 ], 657 "members":{ 658 "message":{"shape":"String"}, 659 "resourceId":{"shape":"String"}, 660 "resourceType":{"shape":"String"} 661 }, 662 "error":{ 663 "httpStatusCode":404, 664 "senderFault":true 665 }, 666 "exception":true 667 }, 668 "Role":{ 669 "type":"string", 670 "enum":[ 671 "ADMIN", 672 "EDITOR" 673 ] 674 }, 675 "RoleValue":{ 676 "type":"string", 677 "max":256, 678 "min":1 679 }, 680 "RoleValueList":{ 681 "type":"list", 682 "member":{"shape":"RoleValue"} 683 }, 684 "RoleValues":{ 685 "type":"structure", 686 "members":{ 687 "admin":{"shape":"RoleValueList"}, 688 "editor":{"shape":"RoleValueList"} 689 } 690 }, 691 "SSOClientId":{"type":"string"}, 692 "SamlAuthentication":{ 693 "type":"structure", 694 "required":["status"], 695 "members":{ 696 "configuration":{"shape":"SamlConfiguration"}, 697 "status":{"shape":"SamlConfigurationStatus"} 698 } 699 }, 700 "SamlConfiguration":{ 701 "type":"structure", 702 "required":["idpMetadata"], 703 "members":{ 704 "allowedOrganizations":{"shape":"AllowedOrganizations"}, 705 "assertionAttributes":{"shape":"AssertionAttributes"}, 706 "idpMetadata":{"shape":"IdpMetadata"}, 707 "loginValidityDuration":{"shape":"LoginValidityDuration"}, 708 "roleValues":{"shape":"RoleValues"} 709 } 710 }, 711 "SamlConfigurationStatus":{ 712 "type":"string", 713 "enum":[ 714 "CONFIGURED", 715 "NOT_CONFIGURED" 716 ] 717 }, 718 "ServiceQuotaExceededException":{ 719 "type":"structure", 720 "required":[ 721 "message", 722 "quotaCode", 723 "resourceId", 724 "resourceType", 725 "serviceCode" 726 ], 727 "members":{ 728 "message":{"shape":"String"}, 729 "quotaCode":{"shape":"String"}, 730 "resourceId":{"shape":"String"}, 731 "resourceType":{"shape":"String"}, 732 "serviceCode":{"shape":"String"} 733 }, 734 "error":{ 735 "httpStatusCode":402, 736 "senderFault":true 737 }, 738 "exception":true 739 }, 740 "SsoId":{ 741 "type":"string", 742 "max":47, 743 "min":1 744 }, 745 "StackSetName":{"type":"string"}, 746 "String":{"type":"string"}, 747 "ThrottlingException":{ 748 "type":"structure", 749 "required":["message"], 750 "members":{ 751 "message":{"shape":"String"}, 752 "quotaCode":{"shape":"String"}, 753 "retryAfterSeconds":{ 754 "shape":"Integer", 755 "location":"header", 756 "locationName":"Retry-After" 757 }, 758 "serviceCode":{"shape":"String"} 759 }, 760 "error":{ 761 "httpStatusCode":429, 762 "senderFault":true 763 }, 764 "exception":true, 765 "retryable":{"throttling":false} 766 }, 767 "Timestamp":{"type":"timestamp"}, 768 "UpdateAction":{ 769 "type":"string", 770 "enum":[ 771 "ADD", 772 "REVOKE" 773 ] 774 }, 775 "UpdateError":{ 776 "type":"structure", 777 "required":[ 778 "causedBy", 779 "code", 780 "message" 781 ], 782 "members":{ 783 "causedBy":{"shape":"UpdateInstruction"}, 784 "code":{"shape":"UpdateErrorCodeInteger"}, 785 "message":{"shape":"String"} 786 } 787 }, 788 "UpdateErrorCodeInteger":{ 789 "type":"integer", 790 "box":true, 791 "max":999, 792 "min":100 793 }, 794 "UpdateErrorList":{ 795 "type":"list", 796 "member":{"shape":"UpdateError"} 797 }, 798 "UpdateInstruction":{ 799 "type":"structure", 800 "required":[ 801 "action", 802 "role", 803 "users" 804 ], 805 "members":{ 806 "action":{"shape":"UpdateAction"}, 807 "role":{"shape":"Role"}, 808 "users":{"shape":"UserList"} 809 } 810 }, 811 "UpdateInstructionBatch":{ 812 "type":"list", 813 "member":{"shape":"UpdateInstruction"}, 814 "max":20, 815 "min":0 816 }, 817 "UpdatePermissionsRequest":{ 818 "type":"structure", 819 "required":[ 820 "updateInstructionBatch", 821 "workspaceId" 822 ], 823 "members":{ 824 "updateInstructionBatch":{"shape":"UpdateInstructionBatch"}, 825 "workspaceId":{ 826 "shape":"WorkspaceId", 827 "location":"uri", 828 "locationName":"workspaceId" 829 } 830 } 831 }, 832 "UpdatePermissionsResponse":{ 833 "type":"structure", 834 "required":["errors"], 835 "members":{ 836 "errors":{"shape":"UpdateErrorList"} 837 } 838 }, 839 "UpdateWorkspaceAuthenticationRequest":{ 840 "type":"structure", 841 "required":[ 842 "authenticationProviders", 843 "workspaceId" 844 ], 845 "members":{ 846 "authenticationProviders":{"shape":"AuthenticationProviders"}, 847 "samlConfiguration":{"shape":"SamlConfiguration"}, 848 "workspaceId":{ 849 "shape":"WorkspaceId", 850 "location":"uri", 851 "locationName":"workspaceId" 852 } 853 } 854 }, 855 "UpdateWorkspaceAuthenticationResponse":{ 856 "type":"structure", 857 "required":["authentication"], 858 "members":{ 859 "authentication":{"shape":"AuthenticationDescription"} 860 } 861 }, 862 "UpdateWorkspaceRequest":{ 863 "type":"structure", 864 "required":["workspaceId"], 865 "members":{ 866 "accountAccessType":{"shape":"AccountAccessType"}, 867 "organizationRoleName":{"shape":"OrganizationRoleName"}, 868 "permissionType":{"shape":"PermissionType"}, 869 "stackSetName":{"shape":"StackSetName"}, 870 "workspaceDataSources":{"shape":"DataSourceTypesList"}, 871 "workspaceDescription":{"shape":"Description"}, 872 "workspaceId":{ 873 "shape":"WorkspaceId", 874 "location":"uri", 875 "locationName":"workspaceId" 876 }, 877 "workspaceName":{"shape":"WorkspaceName"}, 878 "workspaceNotificationDestinations":{"shape":"NotificationDestinationsList"}, 879 "workspaceOrganizationalUnits":{"shape":"OrganizationalUnitList"}, 880 "workspaceRoleArn":{"shape":"IamRoleArn"} 881 } 882 }, 883 "UpdateWorkspaceResponse":{ 884 "type":"structure", 885 "required":["workspace"], 886 "members":{ 887 "workspace":{"shape":"WorkspaceDescription"} 888 } 889 }, 890 "User":{ 891 "type":"structure", 892 "required":[ 893 "id", 894 "type" 895 ], 896 "members":{ 897 "id":{"shape":"SsoId"}, 898 "type":{"shape":"UserType"} 899 } 900 }, 901 "UserList":{ 902 "type":"list", 903 "member":{"shape":"User"} 904 }, 905 "UserType":{ 906 "type":"string", 907 "enum":[ 908 "SSO_USER", 909 "SSO_GROUP" 910 ] 911 }, 912 "ValidationException":{ 913 "type":"structure", 914 "required":[ 915 "message", 916 "reason" 917 ], 918 "members":{ 919 "fieldList":{"shape":"ValidationExceptionFieldList"}, 920 "message":{"shape":"String"}, 921 "reason":{"shape":"ValidationExceptionReason"} 922 }, 923 "error":{ 924 "httpStatusCode":400, 925 "senderFault":true 926 }, 927 "exception":true 928 }, 929 "ValidationExceptionField":{ 930 "type":"structure", 931 "required":[ 932 "message", 933 "name" 934 ], 935 "members":{ 936 "message":{"shape":"String"}, 937 "name":{"shape":"String"} 938 } 939 }, 940 "ValidationExceptionFieldList":{ 941 "type":"list", 942 "member":{"shape":"ValidationExceptionField"} 943 }, 944 "ValidationExceptionReason":{ 945 "type":"string", 946 "enum":[ 947 "UNKNOWN_OPERATION", 948 "CANNOT_PARSE", 949 "FIELD_VALIDATION_FAILED", 950 "OTHER" 951 ] 952 }, 953 "WorkspaceDescription":{ 954 "type":"structure", 955 "required":[ 956 "authentication", 957 "created", 958 "dataSources", 959 "endpoint", 960 "grafanaVersion", 961 "id", 962 "modified", 963 "status" 964 ], 965 "members":{ 966 "accountAccessType":{"shape":"AccountAccessType"}, 967 "authentication":{"shape":"AuthenticationSummary"}, 968 "created":{"shape":"Timestamp"}, 969 "dataSources":{"shape":"DataSourceTypesList"}, 970 "description":{"shape":"Description"}, 971 "endpoint":{"shape":"Endpoint"}, 972 "freeTrialConsumed":{"shape":"Boolean"}, 973 "freeTrialExpiration":{"shape":"Timestamp"}, 974 "grafanaVersion":{"shape":"GrafanaVersion"}, 975 "id":{"shape":"WorkspaceId"}, 976 "licenseExpiration":{"shape":"Timestamp"}, 977 "licenseType":{"shape":"LicenseType"}, 978 "modified":{"shape":"Timestamp"}, 979 "name":{"shape":"WorkspaceName"}, 980 "notificationDestinations":{"shape":"NotificationDestinationsList"}, 981 "organizationRoleName":{"shape":"OrganizationRoleName"}, 982 "organizationalUnits":{"shape":"OrganizationalUnitList"}, 983 "permissionType":{"shape":"PermissionType"}, 984 "stackSetName":{"shape":"StackSetName"}, 985 "status":{"shape":"WorkspaceStatus"}, 986 "workspaceRoleArn":{"shape":"IamRoleArn"} 987 } 988 }, 989 "WorkspaceId":{ 990 "type":"string", 991 "pattern":"^g-[0-9a-f]{10}$" 992 }, 993 "WorkspaceList":{ 994 "type":"list", 995 "member":{"shape":"WorkspaceSummary"} 996 }, 997 "WorkspaceName":{ 998 "type":"string", 999 "pattern":"^[a-zA-Z0-9-._~]{1,255}$", 1000 "sensitive":true 1001 }, 1002 "WorkspaceStatus":{ 1003 "type":"string", 1004 "enum":[ 1005 "ACTIVE", 1006 "CREATING", 1007 "DELETING", 1008 "FAILED", 1009 "UPDATING", 1010 "UPGRADING", 1011 "DELETION_FAILED", 1012 "CREATION_FAILED", 1013 "UPDATE_FAILED", 1014 "UPGRADE_FAILED", 1015 "LICENSE_REMOVAL_FAILED" 1016 ] 1017 }, 1018 "WorkspaceSummary":{ 1019 "type":"structure", 1020 "required":[ 1021 "authentication", 1022 "created", 1023 "endpoint", 1024 "grafanaVersion", 1025 "id", 1026 "modified", 1027 "status" 1028 ], 1029 "members":{ 1030 "authentication":{"shape":"AuthenticationSummary"}, 1031 "created":{"shape":"Timestamp"}, 1032 "description":{"shape":"Description"}, 1033 "endpoint":{"shape":"Endpoint"}, 1034 "grafanaVersion":{"shape":"GrafanaVersion"}, 1035 "id":{"shape":"WorkspaceId"}, 1036 "modified":{"shape":"Timestamp"}, 1037 "name":{"shape":"WorkspaceName"}, 1038 "notificationDestinations":{"shape":"NotificationDestinationsList"}, 1039 "status":{"shape":"WorkspaceStatus"} 1040 } 1041 } 1042 } 1043 }