1{ 2 "version":"2.0", 3 "metadata":{ 4 "apiVersion":"2020-07-13", 5 "endpointPrefix":"finspace-api", 6 "jsonVersion":"1.1", 7 "protocol":"rest-json", 8 "serviceAbbreviation":"FinSpace Data", 9 "serviceFullName":"FinSpace Public API", 10 "serviceId":"finspace data", 11 "signatureVersion":"v4", 12 "signingName":"finspace-api", 13 "uid":"finspace-2020-07-13" 14 }, 15 "operations":{ 16 "AssociateUserToPermissionGroup":{ 17 "name":"AssociateUserToPermissionGroup", 18 "http":{ 19 "method":"POST", 20 "requestUri":"/permission-group/{permissionGroupId}/users/{userId}" 21 }, 22 "input":{"shape":"AssociateUserToPermissionGroupRequest"}, 23 "output":{"shape":"AssociateUserToPermissionGroupResponse"}, 24 "errors":[ 25 {"shape":"InternalServerException"}, 26 {"shape":"ValidationException"}, 27 {"shape":"ThrottlingException"}, 28 {"shape":"AccessDeniedException"}, 29 {"shape":"ResourceNotFoundException"}, 30 {"shape":"ConflictException"} 31 ], 32 "documentation":"<p>Adds a user to a permission group to grant permissions for actions a user can perform in FinSpace.</p>", 33 "deprecated":true, 34 "deprecatedMessage":"This method will be discontinued." 35 }, 36 "CreateChangeset":{ 37 "name":"CreateChangeset", 38 "http":{ 39 "method":"POST", 40 "requestUri":"/datasets/{datasetId}/changesetsv2" 41 }, 42 "input":{"shape":"CreateChangesetRequest"}, 43 "output":{"shape":"CreateChangesetResponse"}, 44 "errors":[ 45 {"shape":"ResourceNotFoundException"}, 46 {"shape":"InternalServerException"}, 47 {"shape":"ValidationException"}, 48 {"shape":"ThrottlingException"}, 49 {"shape":"AccessDeniedException"}, 50 {"shape":"LimitExceededException"}, 51 {"shape":"ConflictException"} 52 ], 53 "documentation":"<p>Creates a new Changeset in a FinSpace Dataset.</p>", 54 "deprecated":true, 55 "deprecatedMessage":"This method will be discontinued." 56 }, 57 "CreateDataView":{ 58 "name":"CreateDataView", 59 "http":{ 60 "method":"POST", 61 "requestUri":"/datasets/{datasetId}/dataviewsv2" 62 }, 63 "input":{"shape":"CreateDataViewRequest"}, 64 "output":{"shape":"CreateDataViewResponse"}, 65 "errors":[ 66 {"shape":"InternalServerException"}, 67 {"shape":"ThrottlingException"}, 68 {"shape":"ValidationException"}, 69 {"shape":"LimitExceededException"}, 70 {"shape":"ConflictException"}, 71 {"shape":"ResourceNotFoundException"} 72 ], 73 "documentation":"<p>Creates a Dataview for a Dataset.</p>", 74 "deprecated":true, 75 "deprecatedMessage":"This method will be discontinued." 76 }, 77 "CreateDataset":{ 78 "name":"CreateDataset", 79 "http":{ 80 "method":"POST", 81 "requestUri":"/datasetsv2" 82 }, 83 "input":{"shape":"CreateDatasetRequest"}, 84 "output":{"shape":"CreateDatasetResponse"}, 85 "errors":[ 86 {"shape":"InternalServerException"}, 87 {"shape":"ValidationException"}, 88 {"shape":"ThrottlingException"}, 89 {"shape":"AccessDeniedException"}, 90 {"shape":"LimitExceededException"}, 91 {"shape":"ConflictException"}, 92 {"shape":"ResourceNotFoundException"} 93 ], 94 "documentation":"<p>Creates a new FinSpace Dataset.</p>", 95 "deprecated":true, 96 "deprecatedMessage":"This method will be discontinued." 97 }, 98 "CreatePermissionGroup":{ 99 "name":"CreatePermissionGroup", 100 "http":{ 101 "method":"POST", 102 "requestUri":"/permission-group" 103 }, 104 "input":{"shape":"CreatePermissionGroupRequest"}, 105 "output":{"shape":"CreatePermissionGroupResponse"}, 106 "errors":[ 107 {"shape":"InternalServerException"}, 108 {"shape":"ValidationException"}, 109 {"shape":"ThrottlingException"}, 110 {"shape":"AccessDeniedException"}, 111 {"shape":"LimitExceededException"}, 112 {"shape":"ConflictException"} 113 ], 114 "documentation":"<p>Creates a group of permissions for various actions that a user can perform in FinSpace.</p>", 115 "deprecated":true, 116 "deprecatedMessage":"This method will be discontinued." 117 }, 118 "CreateUser":{ 119 "name":"CreateUser", 120 "http":{ 121 "method":"POST", 122 "requestUri":"/user" 123 }, 124 "input":{"shape":"CreateUserRequest"}, 125 "output":{"shape":"CreateUserResponse"}, 126 "errors":[ 127 {"shape":"InternalServerException"}, 128 {"shape":"ValidationException"}, 129 {"shape":"ThrottlingException"}, 130 {"shape":"AccessDeniedException"}, 131 {"shape":"LimitExceededException"}, 132 {"shape":"ConflictException"} 133 ], 134 "documentation":"<p>Creates a new user in FinSpace.</p>", 135 "deprecated":true, 136 "deprecatedMessage":"This method will be discontinued." 137 }, 138 "DeleteDataset":{ 139 "name":"DeleteDataset", 140 "http":{ 141 "method":"DELETE", 142 "requestUri":"/datasetsv2/{datasetId}" 143 }, 144 "input":{"shape":"DeleteDatasetRequest"}, 145 "output":{"shape":"DeleteDatasetResponse"}, 146 "errors":[ 147 {"shape":"InternalServerException"}, 148 {"shape":"ValidationException"}, 149 {"shape":"ThrottlingException"}, 150 {"shape":"AccessDeniedException"}, 151 {"shape":"ResourceNotFoundException"}, 152 {"shape":"LimitExceededException"}, 153 {"shape":"ConflictException"} 154 ], 155 "documentation":"<p>Deletes a FinSpace Dataset.</p>", 156 "deprecated":true, 157 "deprecatedMessage":"This method will be discontinued." 158 }, 159 "DeletePermissionGroup":{ 160 "name":"DeletePermissionGroup", 161 "http":{ 162 "method":"DELETE", 163 "requestUri":"/permission-group/{permissionGroupId}" 164 }, 165 "input":{"shape":"DeletePermissionGroupRequest"}, 166 "output":{"shape":"DeletePermissionGroupResponse"}, 167 "errors":[ 168 {"shape":"InternalServerException"}, 169 {"shape":"ValidationException"}, 170 {"shape":"ThrottlingException"}, 171 {"shape":"AccessDeniedException"}, 172 {"shape":"ResourceNotFoundException"}, 173 {"shape":"LimitExceededException"}, 174 {"shape":"ConflictException"} 175 ], 176 "documentation":"<p>Deletes a permission group. This action is irreversible.</p>", 177 "deprecated":true, 178 "deprecatedMessage":"This method will be discontinued." 179 }, 180 "DisableUser":{ 181 "name":"DisableUser", 182 "http":{ 183 "method":"POST", 184 "requestUri":"/user/{userId}/disable" 185 }, 186 "input":{"shape":"DisableUserRequest"}, 187 "output":{"shape":"DisableUserResponse"}, 188 "errors":[ 189 {"shape":"InternalServerException"}, 190 {"shape":"ValidationException"}, 191 {"shape":"ThrottlingException"}, 192 {"shape":"AccessDeniedException"}, 193 {"shape":"ResourceNotFoundException"}, 194 {"shape":"ConflictException"} 195 ], 196 "documentation":"<p>Denies access to the FinSpace web application and API for the specified user.</p>", 197 "deprecated":true, 198 "deprecatedMessage":"This method will be discontinued." 199 }, 200 "DisassociateUserFromPermissionGroup":{ 201 "name":"DisassociateUserFromPermissionGroup", 202 "http":{ 203 "method":"DELETE", 204 "requestUri":"/permission-group/{permissionGroupId}/users/{userId}" 205 }, 206 "input":{"shape":"DisassociateUserFromPermissionGroupRequest"}, 207 "output":{"shape":"DisassociateUserFromPermissionGroupResponse"}, 208 "errors":[ 209 {"shape":"InternalServerException"}, 210 {"shape":"ValidationException"}, 211 {"shape":"ThrottlingException"}, 212 {"shape":"AccessDeniedException"}, 213 {"shape":"ResourceNotFoundException"}, 214 {"shape":"ConflictException"} 215 ], 216 "documentation":"<p>Removes a user from a permission group.</p>", 217 "deprecated":true, 218 "deprecatedMessage":"This method will be discontinued." 219 }, 220 "EnableUser":{ 221 "name":"EnableUser", 222 "http":{ 223 "method":"POST", 224 "requestUri":"/user/{userId}/enable" 225 }, 226 "input":{"shape":"EnableUserRequest"}, 227 "output":{"shape":"EnableUserResponse"}, 228 "errors":[ 229 {"shape":"InternalServerException"}, 230 {"shape":"ValidationException"}, 231 {"shape":"ThrottlingException"}, 232 {"shape":"AccessDeniedException"}, 233 {"shape":"ResourceNotFoundException"}, 234 {"shape":"LimitExceededException"}, 235 {"shape":"ConflictException"} 236 ], 237 "documentation":"<p> Allows the specified user to access the FinSpace web application and API.</p>", 238 "deprecated":true, 239 "deprecatedMessage":"This method will be discontinued." 240 }, 241 "GetChangeset":{ 242 "name":"GetChangeset", 243 "http":{ 244 "method":"GET", 245 "requestUri":"/datasets/{datasetId}/changesetsv2/{changesetId}" 246 }, 247 "input":{"shape":"GetChangesetRequest"}, 248 "output":{"shape":"GetChangesetResponse"}, 249 "errors":[ 250 {"shape":"ResourceNotFoundException"}, 251 {"shape":"InternalServerException"}, 252 {"shape":"ValidationException"}, 253 {"shape":"ThrottlingException"}, 254 {"shape":"AccessDeniedException"}, 255 {"shape":"ConflictException"} 256 ], 257 "documentation":"<p>Get information about a Changeset.</p>", 258 "deprecated":true, 259 "deprecatedMessage":"This method will be discontinued." 260 }, 261 "GetDataView":{ 262 "name":"GetDataView", 263 "http":{ 264 "method":"GET", 265 "requestUri":"/datasets/{datasetId}/dataviewsv2/{dataviewId}" 266 }, 267 "input":{"shape":"GetDataViewRequest"}, 268 "output":{"shape":"GetDataViewResponse"}, 269 "errors":[ 270 {"shape":"ResourceNotFoundException"}, 271 {"shape":"InternalServerException"}, 272 {"shape":"ThrottlingException"}, 273 {"shape":"ValidationException"}, 274 {"shape":"ConflictException"} 275 ], 276 "documentation":"<p>Gets information about a Dataview.</p>", 277 "deprecated":true, 278 "deprecatedMessage":"This method will be discontinued." 279 }, 280 "GetDataset":{ 281 "name":"GetDataset", 282 "http":{ 283 "method":"GET", 284 "requestUri":"/datasetsv2/{datasetId}" 285 }, 286 "input":{"shape":"GetDatasetRequest"}, 287 "output":{"shape":"GetDatasetResponse"}, 288 "errors":[ 289 {"shape":"InternalServerException"}, 290 {"shape":"ValidationException"}, 291 {"shape":"ThrottlingException"}, 292 {"shape":"AccessDeniedException"}, 293 {"shape":"ResourceNotFoundException"}, 294 {"shape":"ConflictException"} 295 ], 296 "documentation":"<p>Returns information about a Dataset.</p>", 297 "deprecated":true, 298 "deprecatedMessage":"This method will be discontinued." 299 }, 300 "GetExternalDataViewAccessDetails":{ 301 "name":"GetExternalDataViewAccessDetails", 302 "http":{ 303 "method":"POST", 304 "requestUri":"/datasets/{datasetId}/dataviewsv2/{dataviewId}/external-access-details" 305 }, 306 "input":{"shape":"GetExternalDataViewAccessDetailsRequest"}, 307 "output":{"shape":"GetExternalDataViewAccessDetailsResponse"}, 308 "errors":[ 309 {"shape":"ResourceNotFoundException"}, 310 {"shape":"InternalServerException"}, 311 {"shape":"ThrottlingException"}, 312 {"shape":"ValidationException"}, 313 {"shape":"AccessDeniedException"} 314 ], 315 "documentation":"<p>Returns the credentials to access the external Dataview from an S3 location. To call this API:</p> <ul> <li> <p>You must retrieve the programmatic credentials.</p> </li> <li> <p>You must be a member of a FinSpace user group, where the dataset that you want to access has <code>Read Dataset Data</code> permissions.</p> </li> </ul>", 316 "deprecated":true, 317 "deprecatedMessage":"This method will be discontinued." 318 }, 319 "GetPermissionGroup":{ 320 "name":"GetPermissionGroup", 321 "http":{ 322 "method":"GET", 323 "requestUri":"/permission-group/{permissionGroupId}" 324 }, 325 "input":{"shape":"GetPermissionGroupRequest"}, 326 "output":{"shape":"GetPermissionGroupResponse"}, 327 "errors":[ 328 {"shape":"InternalServerException"}, 329 {"shape":"ValidationException"}, 330 {"shape":"ThrottlingException"}, 331 {"shape":"AccessDeniedException"}, 332 {"shape":"ResourceNotFoundException"} 333 ], 334 "documentation":"<p>Retrieves the details of a specific permission group.</p>", 335 "deprecated":true, 336 "deprecatedMessage":"This method will be discontinued." 337 }, 338 "GetProgrammaticAccessCredentials":{ 339 "name":"GetProgrammaticAccessCredentials", 340 "http":{ 341 "method":"GET", 342 "requestUri":"/credentials/programmatic" 343 }, 344 "input":{"shape":"GetProgrammaticAccessCredentialsRequest"}, 345 "output":{"shape":"GetProgrammaticAccessCredentialsResponse"}, 346 "errors":[ 347 {"shape":"InternalServerException"}, 348 {"shape":"ValidationException"}, 349 {"shape":"ThrottlingException"}, 350 {"shape":"AccessDeniedException"} 351 ], 352 "documentation":"<p>Request programmatic credentials to use with FinSpace SDK. For more information, see <a href=\"https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#accessing-credentials\">Step 2. Access credentials programmatically using IAM access key id and secret access key</a>.</p>", 353 "deprecated":true, 354 "deprecatedMessage":"This method will be discontinued." 355 }, 356 "GetUser":{ 357 "name":"GetUser", 358 "http":{ 359 "method":"GET", 360 "requestUri":"/user/{userId}" 361 }, 362 "input":{"shape":"GetUserRequest"}, 363 "output":{"shape":"GetUserResponse"}, 364 "errors":[ 365 {"shape":"InternalServerException"}, 366 {"shape":"ValidationException"}, 367 {"shape":"ThrottlingException"}, 368 {"shape":"AccessDeniedException"}, 369 {"shape":"ResourceNotFoundException"} 370 ], 371 "documentation":"<p>Retrieves details for a specific user.</p>", 372 "deprecated":true, 373 "deprecatedMessage":"This method will be discontinued." 374 }, 375 "GetWorkingLocation":{ 376 "name":"GetWorkingLocation", 377 "http":{ 378 "method":"POST", 379 "requestUri":"/workingLocationV1" 380 }, 381 "input":{"shape":"GetWorkingLocationRequest"}, 382 "output":{"shape":"GetWorkingLocationResponse"}, 383 "errors":[ 384 {"shape":"InternalServerException"}, 385 {"shape":"AccessDeniedException"}, 386 {"shape":"ThrottlingException"}, 387 {"shape":"ValidationException"} 388 ], 389 "documentation":"<p>A temporary Amazon S3 location, where you can copy your files from a source location to stage or use as a scratch space in FinSpace notebook.</p>", 390 "deprecated":true, 391 "deprecatedMessage":"This method will be discontinued." 392 }, 393 "ListChangesets":{ 394 "name":"ListChangesets", 395 "http":{ 396 "method":"GET", 397 "requestUri":"/datasets/{datasetId}/changesetsv2" 398 }, 399 "input":{"shape":"ListChangesetsRequest"}, 400 "output":{"shape":"ListChangesetsResponse"}, 401 "errors":[ 402 {"shape":"ResourceNotFoundException"}, 403 {"shape":"InternalServerException"}, 404 {"shape":"ValidationException"}, 405 {"shape":"ThrottlingException"}, 406 {"shape":"AccessDeniedException"}, 407 {"shape":"ConflictException"} 408 ], 409 "documentation":"<p>Lists the FinSpace Changesets for a Dataset.</p>", 410 "deprecated":true, 411 "deprecatedMessage":"This method will be discontinued." 412 }, 413 "ListDataViews":{ 414 "name":"ListDataViews", 415 "http":{ 416 "method":"GET", 417 "requestUri":"/datasets/{datasetId}/dataviewsv2" 418 }, 419 "input":{"shape":"ListDataViewsRequest"}, 420 "output":{"shape":"ListDataViewsResponse"}, 421 "errors":[ 422 {"shape":"ResourceNotFoundException"}, 423 {"shape":"InternalServerException"}, 424 {"shape":"ThrottlingException"}, 425 {"shape":"ValidationException"}, 426 {"shape":"ConflictException"} 427 ], 428 "documentation":"<p>Lists all available Dataviews for a Dataset.</p>", 429 "deprecated":true, 430 "deprecatedMessage":"This method will be discontinued." 431 }, 432 "ListDatasets":{ 433 "name":"ListDatasets", 434 "http":{ 435 "method":"GET", 436 "requestUri":"/datasetsv2" 437 }, 438 "input":{"shape":"ListDatasetsRequest"}, 439 "output":{"shape":"ListDatasetsResponse"}, 440 "errors":[ 441 {"shape":"InternalServerException"}, 442 {"shape":"ThrottlingException"}, 443 {"shape":"ValidationException"}, 444 {"shape":"ConflictException"}, 445 {"shape":"ResourceNotFoundException"} 446 ], 447 "documentation":"<p>Lists all of the active Datasets that a user has access to.</p>", 448 "deprecated":true, 449 "deprecatedMessage":"This method will be discontinued." 450 }, 451 "ListPermissionGroups":{ 452 "name":"ListPermissionGroups", 453 "http":{ 454 "method":"GET", 455 "requestUri":"/permission-group" 456 }, 457 "input":{"shape":"ListPermissionGroupsRequest"}, 458 "output":{"shape":"ListPermissionGroupsResponse"}, 459 "errors":[ 460 {"shape":"InternalServerException"}, 461 {"shape":"ValidationException"}, 462 {"shape":"ThrottlingException"}, 463 {"shape":"AccessDeniedException"} 464 ], 465 "documentation":"<p>Lists all available permission groups in FinSpace.</p>", 466 "deprecated":true, 467 "deprecatedMessage":"This method will be discontinued." 468 }, 469 "ListPermissionGroupsByUser":{ 470 "name":"ListPermissionGroupsByUser", 471 "http":{ 472 "method":"GET", 473 "requestUri":"/user/{userId}/permission-groups" 474 }, 475 "input":{"shape":"ListPermissionGroupsByUserRequest"}, 476 "output":{"shape":"ListPermissionGroupsByUserResponse"}, 477 "errors":[ 478 {"shape":"InternalServerException"}, 479 {"shape":"ValidationException"}, 480 {"shape":"ThrottlingException"}, 481 {"shape":"AccessDeniedException"}, 482 {"shape":"ResourceNotFoundException"} 483 ], 484 "documentation":"<p>Lists all the permission groups that are associated with a specific user.</p>", 485 "deprecated":true, 486 "deprecatedMessage":"This method will be discontinued." 487 }, 488 "ListUsers":{ 489 "name":"ListUsers", 490 "http":{ 491 "method":"GET", 492 "requestUri":"/user" 493 }, 494 "input":{"shape":"ListUsersRequest"}, 495 "output":{"shape":"ListUsersResponse"}, 496 "errors":[ 497 {"shape":"InternalServerException"}, 498 {"shape":"ValidationException"}, 499 {"shape":"ThrottlingException"}, 500 {"shape":"AccessDeniedException"} 501 ], 502 "documentation":"<p>Lists all available users in FinSpace.</p>", 503 "deprecated":true, 504 "deprecatedMessage":"This method will be discontinued." 505 }, 506 "ListUsersByPermissionGroup":{ 507 "name":"ListUsersByPermissionGroup", 508 "http":{ 509 "method":"GET", 510 "requestUri":"/permission-group/{permissionGroupId}/users" 511 }, 512 "input":{"shape":"ListUsersByPermissionGroupRequest"}, 513 "output":{"shape":"ListUsersByPermissionGroupResponse"}, 514 "errors":[ 515 {"shape":"InternalServerException"}, 516 {"shape":"ValidationException"}, 517 {"shape":"ThrottlingException"}, 518 {"shape":"AccessDeniedException"}, 519 {"shape":"ResourceNotFoundException"} 520 ], 521 "documentation":"<p>Lists details of all the users in a specific permission group.</p>", 522 "deprecated":true, 523 "deprecatedMessage":"This method will be discontinued." 524 }, 525 "ResetUserPassword":{ 526 "name":"ResetUserPassword", 527 "http":{ 528 "method":"POST", 529 "requestUri":"/user/{userId}/password" 530 }, 531 "input":{"shape":"ResetUserPasswordRequest"}, 532 "output":{"shape":"ResetUserPasswordResponse"}, 533 "errors":[ 534 {"shape":"InternalServerException"}, 535 {"shape":"ValidationException"}, 536 {"shape":"ThrottlingException"}, 537 {"shape":"AccessDeniedException"}, 538 {"shape":"ResourceNotFoundException"}, 539 {"shape":"ConflictException"} 540 ], 541 "documentation":"<p>Resets the password for a specified user ID and generates a temporary one. Only a superuser can reset password for other users. Resetting the password immediately invalidates the previous password associated with the user.</p>", 542 "deprecated":true, 543 "deprecatedMessage":"This method will be discontinued." 544 }, 545 "UpdateChangeset":{ 546 "name":"UpdateChangeset", 547 "http":{ 548 "method":"PUT", 549 "requestUri":"/datasets/{datasetId}/changesetsv2/{changesetId}" 550 }, 551 "input":{"shape":"UpdateChangesetRequest"}, 552 "output":{"shape":"UpdateChangesetResponse"}, 553 "errors":[ 554 {"shape":"ResourceNotFoundException"}, 555 {"shape":"InternalServerException"}, 556 {"shape":"ValidationException"}, 557 {"shape":"ThrottlingException"}, 558 {"shape":"AccessDeniedException"}, 559 {"shape":"ConflictException"} 560 ], 561 "documentation":"<p>Updates a FinSpace Changeset.</p>", 562 "deprecated":true, 563 "deprecatedMessage":"This method will be discontinued." 564 }, 565 "UpdateDataset":{ 566 "name":"UpdateDataset", 567 "http":{ 568 "method":"PUT", 569 "requestUri":"/datasetsv2/{datasetId}" 570 }, 571 "input":{"shape":"UpdateDatasetRequest"}, 572 "output":{"shape":"UpdateDatasetResponse"}, 573 "errors":[ 574 {"shape":"InternalServerException"}, 575 {"shape":"ValidationException"}, 576 {"shape":"ThrottlingException"}, 577 {"shape":"AccessDeniedException"}, 578 {"shape":"ConflictException"}, 579 {"shape":"ResourceNotFoundException"} 580 ], 581 "documentation":"<p>Updates a FinSpace Dataset.</p>", 582 "deprecated":true, 583 "deprecatedMessage":"This method will be discontinued." 584 }, 585 "UpdatePermissionGroup":{ 586 "name":"UpdatePermissionGroup", 587 "http":{ 588 "method":"PUT", 589 "requestUri":"/permission-group/{permissionGroupId}" 590 }, 591 "input":{"shape":"UpdatePermissionGroupRequest"}, 592 "output":{"shape":"UpdatePermissionGroupResponse"}, 593 "errors":[ 594 {"shape":"InternalServerException"}, 595 {"shape":"ValidationException"}, 596 {"shape":"ThrottlingException"}, 597 {"shape":"AccessDeniedException"}, 598 {"shape":"ResourceNotFoundException"}, 599 {"shape":"ConflictException"} 600 ], 601 "documentation":"<p>Modifies the details of a permission group. You cannot modify a <code>permissionGroupID</code>.</p>", 602 "deprecated":true, 603 "deprecatedMessage":"This method will be discontinued." 604 }, 605 "UpdateUser":{ 606 "name":"UpdateUser", 607 "http":{ 608 "method":"PUT", 609 "requestUri":"/user/{userId}" 610 }, 611 "input":{"shape":"UpdateUserRequest"}, 612 "output":{"shape":"UpdateUserResponse"}, 613 "errors":[ 614 {"shape":"InternalServerException"}, 615 {"shape":"ValidationException"}, 616 {"shape":"ThrottlingException"}, 617 {"shape":"AccessDeniedException"}, 618 {"shape":"ResourceNotFoundException"}, 619 {"shape":"ConflictException"} 620 ], 621 "documentation":"<p>Modifies the details of the specified user. You cannot update the <code>userId</code> for a user.</p>", 622 "deprecated":true, 623 "deprecatedMessage":"This method will be discontinued." 624 } 625 }, 626 "shapes":{ 627 "AccessDeniedException":{ 628 "type":"structure", 629 "members":{ 630 "message":{"shape":"errorMessage"} 631 }, 632 "documentation":"<p>You do not have sufficient access to perform this action.</p>", 633 "error":{"httpStatusCode":403}, 634 "exception":true 635 }, 636 "AccessKeyId":{ 637 "type":"string", 638 "max":255, 639 "min":1, 640 "pattern":"[\\s\\S]*\\S[\\s\\S]*" 641 }, 642 "AliasString":{ 643 "type":"string", 644 "max":255, 645 "min":1, 646 "pattern":"^alias\\/\\S+" 647 }, 648 "ApiAccess":{ 649 "type":"string", 650 "enum":[ 651 "ENABLED", 652 "DISABLED" 653 ] 654 }, 655 "ApplicationPermission":{ 656 "type":"string", 657 "enum":[ 658 "CreateDataset", 659 "ManageClusters", 660 "ManageUsersAndGroups", 661 "ManageAttributeSets", 662 "ViewAuditData", 663 "AccessNotebooks", 664 "GetTemporaryCredentials" 665 ] 666 }, 667 "ApplicationPermissionList":{ 668 "type":"list", 669 "member":{"shape":"ApplicationPermission"} 670 }, 671 "AssociateUserToPermissionGroupRequest":{ 672 "type":"structure", 673 "required":[ 674 "permissionGroupId", 675 "userId" 676 ], 677 "members":{ 678 "permissionGroupId":{ 679 "shape":"PermissionGroupId", 680 "documentation":"<p>The unique identifier for the permission group.</p>", 681 "location":"uri", 682 "locationName":"permissionGroupId" 683 }, 684 "userId":{ 685 "shape":"UserId", 686 "documentation":"<p>The unique identifier for the user.</p>", 687 "location":"uri", 688 "locationName":"userId" 689 }, 690 "clientToken":{ 691 "shape":"ClientToken", 692 "documentation":"<p>A token that ensures idempotency. This token expires in 10 minutes.</p>", 693 "idempotencyToken":true 694 } 695 } 696 }, 697 "AssociateUserToPermissionGroupResponse":{ 698 "type":"structure", 699 "members":{ 700 "statusCode":{ 701 "shape":"StatusCode", 702 "documentation":"<p>The returned status code of the response.</p>", 703 "location":"statusCode" 704 } 705 } 706 }, 707 "AwsCredentials":{ 708 "type":"structure", 709 "members":{ 710 "accessKeyId":{ 711 "shape":"AccessKeyId", 712 "documentation":"<p> The unique identifier for the security credentials.</p>" 713 }, 714 "secretAccessKey":{ 715 "shape":"SecretAccessKey", 716 "documentation":"<p> The secret access key that can be used to sign requests.</p>" 717 }, 718 "sessionToken":{ 719 "shape":"SessionToken", 720 "documentation":"<p> The token that users must pass to use the credentials.</p>" 721 }, 722 "expiration":{ 723 "shape":"TimestampEpoch", 724 "documentation":"<p> The Epoch time when the current credentials expire.</p>" 725 } 726 }, 727 "documentation":"<p> The credentials required to access the external Dataview from the S3 location.</p>", 728 "sensitive":true 729 }, 730 "Boolean":{ 731 "type":"boolean", 732 "documentation":"Common Boolean data type" 733 }, 734 "ChangeType":{ 735 "type":"string", 736 "documentation":"Indicates how the given change will be applied to the dataset.", 737 "enum":[ 738 "REPLACE", 739 "APPEND", 740 "MODIFY" 741 ] 742 }, 743 "ChangesetArn":{ 744 "type":"string", 745 "documentation":"Arn for a given Changeset" 746 }, 747 "ChangesetErrorInfo":{ 748 "type":"structure", 749 "members":{ 750 "errorMessage":{ 751 "shape":"ErrorMessage", 752 "documentation":"<p>The text of the error message.</p>" 753 }, 754 "errorCategory":{ 755 "shape":"ErrorCategory", 756 "documentation":"<p>The category of the error.</p> <ul> <li> <p> <code>VALIDATION</code> – The inputs to this request are invalid.</p> </li> <li> <p> <code>SERVICE_QUOTA_EXCEEDED</code> – Service quotas have been exceeded. Please contact AWS support to increase quotas.</p> </li> <li> <p> <code>ACCESS_DENIED</code> – Missing required permission to perform this request.</p> </li> <li> <p> <code>RESOURCE_NOT_FOUND</code> – One or more inputs to this request were not found.</p> </li> <li> <p> <code>THROTTLING</code> – The system temporarily lacks sufficient resources to process the request.</p> </li> <li> <p> <code>INTERNAL_SERVICE_EXCEPTION</code> – An internal service error has occurred.</p> </li> <li> <p> <code>CANCELLED</code> – Cancelled.</p> </li> <li> <p> <code>USER_RECOVERABLE</code> – A user recoverable error has occurred.</p> </li> </ul>" 757 } 758 }, 759 "documentation":"<p>The structure with error messages.</p>" 760 }, 761 "ChangesetId":{ 762 "type":"string", 763 "documentation":"ID used to identify a Changeset", 764 "max":26, 765 "min":1 766 }, 767 "ChangesetList":{ 768 "type":"list", 769 "member":{"shape":"ChangesetSummary"}, 770 "documentation":"List of Changeset Summaries" 771 }, 772 "ChangesetSummary":{ 773 "type":"structure", 774 "members":{ 775 "changesetId":{ 776 "shape":"ChangesetId", 777 "documentation":"<p>The unique identifier for a Changeset.</p>" 778 }, 779 "changesetArn":{ 780 "shape":"ChangesetArn", 781 "documentation":"<p>The ARN identifier of the Changeset.</p>" 782 }, 783 "datasetId":{ 784 "shape":"DatasetId", 785 "documentation":"<p>The unique identifier for the FinSpace Dataset in which the Changeset is created.</p>" 786 }, 787 "changeType":{ 788 "shape":"ChangeType", 789 "documentation":"<p>Type that indicates how a Changeset is applied to a Dataset.</p> <ul> <li> <p> <code>REPLACE</code> – Changeset is considered as a replacement to all prior loaded Changesets.</p> </li> <li> <p> <code>APPEND</code> – Changeset is considered as an addition to the end of all prior loaded Changesets.</p> </li> <li> <p> <code>MODIFY</code> – Changeset is considered as a replacement to a specific prior ingested Changeset.</p> </li> </ul>" 790 }, 791 "sourceParams":{ 792 "shape":"SourceParams", 793 "documentation":"<p>Options that define the location of the data being ingested.</p>" 794 }, 795 "formatParams":{ 796 "shape":"FormatParams", 797 "documentation":"<p>Options that define the structure of the source file(s).</p>" 798 }, 799 "createTime":{ 800 "shape":"TimestampEpoch", 801 "documentation":"<p>The timestamp at which the Changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>" 802 }, 803 "status":{ 804 "shape":"IngestionStatus", 805 "documentation":"<p>Status of the Changeset ingestion.</p> <ul> <li> <p> <code>PENDING</code> – Changeset is pending creation.</p> </li> <li> <p> <code>FAILED</code> – Changeset creation has failed.</p> </li> <li> <p> <code>SUCCESS</code> – Changeset creation has succeeded.</p> </li> <li> <p> <code>RUNNING</code> – Changeset creation is running.</p> </li> <li> <p> <code>STOP_REQUESTED</code> – User requested Changeset creation to stop.</p> </li> </ul>" 806 }, 807 "errorInfo":{ 808 "shape":"ChangesetErrorInfo", 809 "documentation":"<p>The structure with error messages.</p>" 810 }, 811 "activeUntilTimestamp":{ 812 "shape":"TimestampEpoch", 813 "documentation":"<p>Time until which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>", 814 "box":true 815 }, 816 "activeFromTimestamp":{ 817 "shape":"TimestampEpoch", 818 "documentation":"<p>Beginning time from which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>", 819 "box":true 820 }, 821 "updatesChangesetId":{ 822 "shape":"ChangesetId", 823 "documentation":"<p>The unique identifier of the Changeset that is updated.</p>" 824 }, 825 "updatedByChangesetId":{ 826 "shape":"ChangesetId", 827 "documentation":"<p>The unique identifier of the updated Changeset.</p>" 828 } 829 }, 830 "documentation":"<p>A Changeset is unit of data in a Dataset.</p>" 831 }, 832 "ClientToken":{ 833 "type":"string", 834 "documentation":"Idempotence Token for API operations", 835 "max":128, 836 "min":1, 837 "pattern":".*\\S.*" 838 }, 839 "ColumnDataType":{ 840 "type":"string", 841 "documentation":"Data type of a column.", 842 "enum":[ 843 "STRING", 844 "CHAR", 845 "INTEGER", 846 "TINYINT", 847 "SMALLINT", 848 "BIGINT", 849 "FLOAT", 850 "DOUBLE", 851 "DATE", 852 "DATETIME", 853 "BOOLEAN", 854 "BINARY" 855 ] 856 }, 857 "ColumnDefinition":{ 858 "type":"structure", 859 "members":{ 860 "dataType":{ 861 "shape":"ColumnDataType", 862 "documentation":"<p>Data type of a column.</p> <ul> <li> <p> <code>STRING</code> – A String data type.</p> <p> <code>CHAR</code> – A char data type.</p> <p> <code>INTEGER</code> – An integer data type.</p> <p> <code>TINYINT</code> – A tinyint data type.</p> <p> <code>SMALLINT</code> – A smallint data type.</p> <p> <code>BIGINT</code> – A bigint data type.</p> <p> <code>FLOAT</code> – A float data type.</p> <p> <code>DOUBLE</code> – A double data type.</p> <p> <code>DATE</code> – A date data type.</p> <p> <code>DATETIME</code> – A datetime data type.</p> <p> <code>BOOLEAN</code> – A boolean data type.</p> <p> <code>BINARY</code> – A binary data type.</p> </li> </ul>" 863 }, 864 "columnName":{ 865 "shape":"ColumnName", 866 "documentation":"<p>The name of a column.</p>" 867 }, 868 "columnDescription":{ 869 "shape":"ColumnDescription", 870 "documentation":"<p>Description for a column.</p>" 871 } 872 }, 873 "documentation":"<p>The definition of a column in a tabular Dataset.</p>" 874 }, 875 "ColumnDescription":{ 876 "type":"string", 877 "documentation":"Column Description", 878 "max":512, 879 "pattern":"[\\s\\S]*" 880 }, 881 "ColumnList":{ 882 "type":"list", 883 "member":{"shape":"ColumnDefinition"}, 884 "documentation":"List of Column Definitions" 885 }, 886 "ColumnName":{ 887 "type":"string", 888 "documentation":"Column Name", 889 "max":126, 890 "pattern":".*\\S.*" 891 }, 892 "ColumnNameList":{ 893 "type":"list", 894 "member":{"shape":"ColumnName"}, 895 "documentation":"List of Column Names" 896 }, 897 "ConflictException":{ 898 "type":"structure", 899 "members":{ 900 "message":{"shape":"errorMessage"}, 901 "reason":{"shape":"errorMessage"} 902 }, 903 "documentation":"<p>The request conflicts with an existing resource.</p>", 904 "error":{"httpStatusCode":409}, 905 "exception":true 906 }, 907 "CreateChangesetRequest":{ 908 "type":"structure", 909 "required":[ 910 "datasetId", 911 "changeType", 912 "sourceParams", 913 "formatParams" 914 ], 915 "members":{ 916 "clientToken":{ 917 "shape":"ClientToken", 918 "documentation":"<p>A token that ensures idempotency. This token expires in 10 minutes.</p>", 919 "idempotencyToken":true 920 }, 921 "datasetId":{ 922 "shape":"DatasetId", 923 "documentation":"<p>The unique identifier for the FinSpace Dataset where the Changeset will be created. </p>", 924 "location":"uri", 925 "locationName":"datasetId" 926 }, 927 "changeType":{ 928 "shape":"ChangeType", 929 "documentation":"<p>The option to indicate how a Changeset will be applied to a Dataset.</p> <ul> <li> <p> <code>REPLACE</code> – Changeset will be considered as a replacement to all prior loaded Changesets.</p> </li> <li> <p> <code>APPEND</code> – Changeset will be considered as an addition to the end of all prior loaded Changesets.</p> </li> <li> <p> <code>MODIFY</code> – Changeset is considered as a replacement to a specific prior ingested Changeset.</p> </li> </ul>" 930 }, 931 "sourceParams":{ 932 "shape":"SourceParams", 933 "documentation":"<p>Options that define the location of the data being ingested (<code>s3SourcePath</code>) and the source of the changeset (<code>sourceType</code>).</p> <p>Both <code>s3SourcePath</code> and <code>sourceType</code> are required attributes.</p> <p>Here is an example of how you could specify the <code>sourceParams</code>:</p> <p> <code> \"sourceParams\": { \"s3SourcePath\": \"s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv\", \"sourceType\": \"S3\" } </code> </p> <p>The S3 path that you specify must allow the FinSpace role access. To do that, you first need to configure the IAM policy on S3 bucket. For more information, see <a href=\"https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#access-s3-buckets\">Loading data from an Amazon S3 Bucket using the FinSpace API</a> section.</p>" 934 }, 935 "formatParams":{ 936 "shape":"FormatParams", 937 "documentation":"<p>Options that define the structure of the source file(s) including the format type (<code>formatType</code>), header row (<code>withHeader</code>), data separation character (<code>separator</code>) and the type of compression (<code>compression</code>). </p> <p> <code>formatType</code> is a required attribute and can have the following values: </p> <ul> <li> <p> <code>PARQUET</code> – Parquet source file format.</p> </li> <li> <p> <code>CSV</code> – CSV source file format.</p> </li> <li> <p> <code>JSON</code> – JSON source file format.</p> </li> <li> <p> <code>XML</code> – XML source file format.</p> </li> </ul> <p>Here is an example of how you could specify the <code>formatParams</code>:</p> <p> <code> \"formatParams\": { \"formatType\": \"CSV\", \"withHeader\": \"true\", \"separator\": \",\", \"compression\":\"None\" } </code> </p> <p>Note that if you only provide <code>formatType</code> as <code>CSV</code>, the rest of the attributes will automatically default to CSV values as following:</p> <p> <code> { \"withHeader\": \"true\", \"separator\": \",\" } </code> </p> <p> For more information about supported file formats, see <a href=\"https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html\">Supported Data Types and File Formats</a> in the FinSpace User Guide.</p>" 938 } 939 }, 940 "documentation":"The request for a CreateChangeset operation." 941 }, 942 "CreateChangesetResponse":{ 943 "type":"structure", 944 "members":{ 945 "datasetId":{ 946 "shape":"DatasetId", 947 "documentation":"<p>The unique identifier for the FinSpace Dataset where the Changeset is created.</p>" 948 }, 949 "changesetId":{ 950 "shape":"ChangesetId", 951 "documentation":"<p>The unique identifier of the Changeset that is created.</p>" 952 } 953 }, 954 "documentation":"The response from a CreateChangeset operation." 955 }, 956 "CreateDataViewRequest":{ 957 "type":"structure", 958 "required":[ 959 "datasetId", 960 "destinationTypeParams" 961 ], 962 "members":{ 963 "clientToken":{ 964 "shape":"ClientToken", 965 "documentation":"<p>A token that ensures idempotency. This token expires in 10 minutes.</p>", 966 "idempotencyToken":true 967 }, 968 "datasetId":{ 969 "shape":"DatasetId", 970 "documentation":"<p>The unique Dataset identifier that is used to create a Dataview.</p>", 971 "location":"uri", 972 "locationName":"datasetId" 973 }, 974 "autoUpdate":{ 975 "shape":"Boolean", 976 "documentation":"<p>Flag to indicate Dataview should be updated automatically.</p>" 977 }, 978 "sortColumns":{ 979 "shape":"SortColumnList", 980 "documentation":"<p>Columns to be used for sorting the data.</p>" 981 }, 982 "partitionColumns":{ 983 "shape":"PartitionColumnList", 984 "documentation":"<p>Ordered set of column names used to partition data.</p>" 985 }, 986 "asOfTimestamp":{ 987 "shape":"TimestampEpoch", 988 "documentation":"<p>Beginning time to use for the Dataview. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>", 989 "box":true 990 }, 991 "destinationTypeParams":{ 992 "shape":"DataViewDestinationTypeParams", 993 "documentation":"<p>Options that define the destination type for the Dataview.</p>" 994 } 995 }, 996 "documentation":"Request for creating a data view." 997 }, 998 "CreateDataViewResponse":{ 999 "type":"structure", 1000 "members":{ 1001 "datasetId":{ 1002 "shape":"DatasetId", 1003 "documentation":"<p>The unique identifier of the Dataset used for the Dataview.</p>" 1004 }, 1005 "dataViewId":{ 1006 "shape":"DataViewId", 1007 "documentation":"<p>The unique identifier for the created Dataview.</p>" 1008 } 1009 }, 1010 "documentation":"Response for creating a data view." 1011 }, 1012 "CreateDatasetRequest":{ 1013 "type":"structure", 1014 "required":[ 1015 "datasetTitle", 1016 "kind", 1017 "permissionGroupParams" 1018 ], 1019 "members":{ 1020 "clientToken":{ 1021 "shape":"ClientToken", 1022 "documentation":"<p>A token that ensures idempotency. This token expires in 10 minutes.</p>", 1023 "idempotencyToken":true 1024 }, 1025 "datasetTitle":{ 1026 "shape":"DatasetTitle", 1027 "documentation":"<p>Display title for a FinSpace Dataset.</p>" 1028 }, 1029 "kind":{ 1030 "shape":"DatasetKind", 1031 "documentation":"<p>The format in which Dataset data is structured.</p> <ul> <li> <p> <code>TABULAR</code> – Data is structured in a tabular format.</p> </li> <li> <p> <code>NON_TABULAR</code> – Data is structured in a non-tabular format.</p> </li> </ul>" 1032 }, 1033 "datasetDescription":{ 1034 "shape":"DatasetDescription", 1035 "documentation":"<p>Description of a Dataset.</p>" 1036 }, 1037 "ownerInfo":{ 1038 "shape":"DatasetOwnerInfo", 1039 "documentation":"<p>Contact information for a Dataset owner.</p>" 1040 }, 1041 "permissionGroupParams":{ 1042 "shape":"PermissionGroupParams", 1043 "documentation":"<p>Permission group parameters for Dataset permissions.</p>" 1044 }, 1045 "alias":{ 1046 "shape":"AliasString", 1047 "documentation":"<p>The unique resource identifier for a Dataset.</p>" 1048 }, 1049 "schemaDefinition":{ 1050 "shape":"SchemaUnion", 1051 "documentation":"<p>Definition for a schema on a tabular Dataset.</p>" 1052 } 1053 }, 1054 "documentation":"The request for a CreateDataset operation" 1055 }, 1056 "CreateDatasetResponse":{ 1057 "type":"structure", 1058 "members":{ 1059 "datasetId":{ 1060 "shape":"DatasetId", 1061 "documentation":"<p>The unique identifier for the created Dataset.</p>" 1062 } 1063 }, 1064 "documentation":"The response from a CreateDataset operation" 1065 }, 1066 "CreatePermissionGroupRequest":{ 1067 "type":"structure", 1068 "required":[ 1069 "name", 1070 "applicationPermissions" 1071 ], 1072 "members":{ 1073 "name":{ 1074 "shape":"PermissionGroupName", 1075 "documentation":"<p>The name of the permission group.</p>" 1076 }, 1077 "description":{ 1078 "shape":"PermissionGroupDescription", 1079 "documentation":"<p>A brief description for the permission group.</p>" 1080 }, 1081 "applicationPermissions":{ 1082 "shape":"ApplicationPermissionList", 1083 "documentation":"<p>The option to indicate FinSpace application permissions that are granted to a specific group.</p> <important> <p>When assigning application permissions, be aware that the permission <code>ManageUsersAndGroups</code> allows users to grant themselves or others access to any functionality in their FinSpace environment's application. It should only be granted to trusted users.</p> </important> <ul> <li> <p> <code>CreateDataset</code> – Group members can create new datasets.</p> </li> <li> <p> <code>ManageClusters</code> – Group members can manage Apache Spark clusters from FinSpace notebooks.</p> </li> <li> <p> <code>ManageUsersAndGroups</code> – Group members can manage users and permission groups. This is a privileged permission that allows users to grant themselves or others access to any functionality in the application. It should only be granted to trusted users.</p> </li> <li> <p> <code>ManageAttributeSets</code> – Group members can manage attribute sets.</p> </li> <li> <p> <code>ViewAuditData</code> – Group members can view audit data.</p> </li> <li> <p> <code>AccessNotebooks</code> – Group members will have access to FinSpace notebooks.</p> </li> <li> <p> <code>GetTemporaryCredentials</code> – Group members can get temporary API credentials.</p> </li> </ul>" 1084 }, 1085 "clientToken":{ 1086 "shape":"ClientToken", 1087 "documentation":"<p>A token that ensures idempotency. This token expires in 10 minutes.</p>", 1088 "idempotencyToken":true 1089 } 1090 } 1091 }, 1092 "CreatePermissionGroupResponse":{ 1093 "type":"structure", 1094 "members":{ 1095 "permissionGroupId":{ 1096 "shape":"PermissionGroupId", 1097 "documentation":"<p>The unique identifier for the permission group.</p>" 1098 } 1099 } 1100 }, 1101 "CreateUserRequest":{ 1102 "type":"structure", 1103 "required":[ 1104 "emailAddress", 1105 "type" 1106 ], 1107 "members":{ 1108 "emailAddress":{ 1109 "shape":"Email", 1110 "documentation":"<p>The email address of the user that you want to register. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.</p>" 1111 }, 1112 "type":{ 1113 "shape":"UserType", 1114 "documentation":"<p>The option to indicate the type of user. Use one of the following options to specify this parameter:</p> <ul> <li> <p> <code>SUPER_USER</code> – A user with permission to all the functionality and data in FinSpace.</p> </li> <li> <p> <code>APP_USER</code> – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.</p> </li> </ul>" 1115 }, 1116 "firstName":{ 1117 "shape":"FirstName", 1118 "documentation":"<p>The first name of the user that you want to register.</p>" 1119 }, 1120 "lastName":{ 1121 "shape":"LastName", 1122 "documentation":"<p>The last name of the user that you want to register.</p>" 1123 }, 1124 "apiAccess":{ 1125 "shape":"ApiAccess", 1126 "documentation":"<p>The option to indicate whether the user can use the <code>GetProgrammaticAccessCredentials</code> API to obtain credentials that can then be used to access other FinSpace Data API operations.</p> <ul> <li> <p> <code>ENABLED</code> – The user has permissions to use the APIs.</p> </li> <li> <p> <code>DISABLED</code> – The user does not have permissions to use any APIs.</p> </li> </ul>" 1127 }, 1128 "apiAccessPrincipalArn":{ 1129 "shape":"RoleArn", 1130 "documentation":"<p>The ARN identifier of an AWS user or role that is allowed to call the <code>GetProgrammaticAccessCredentials</code> API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.</p>" 1131 }, 1132 "clientToken":{ 1133 "shape":"ClientToken", 1134 "documentation":"<p>A token that ensures idempotency. This token expires in 10 minutes.</p>", 1135 "idempotencyToken":true 1136 } 1137 } 1138 }, 1139 "CreateUserResponse":{ 1140 "type":"structure", 1141 "members":{ 1142 "userId":{ 1143 "shape":"UserId", 1144 "documentation":"<p>The unique identifier for the user.</p>" 1145 } 1146 } 1147 }, 1148 "Credentials":{ 1149 "type":"structure", 1150 "members":{ 1151 "accessKeyId":{ 1152 "shape":"stringValueLength1to255", 1153 "documentation":"<p>The access key identifier.</p>" 1154 }, 1155 "secretAccessKey":{ 1156 "shape":"stringValueMaxLength1000", 1157 "documentation":"<p>The access key.</p>" 1158 }, 1159 "sessionToken":{ 1160 "shape":"stringValueMaxLength1000", 1161 "documentation":"<p>The session token.</p>" 1162 } 1163 }, 1164 "documentation":"<p>Short term API credentials.</p>", 1165 "sensitive":true 1166 }, 1167 "DataViewArn":{ 1168 "type":"string", 1169 "documentation":"Arn of a DataView" 1170 }, 1171 "DataViewDestinationType":{ 1172 "type":"string", 1173 "documentation":"DataView Destination Type" 1174 }, 1175 "DataViewDestinationTypeParams":{ 1176 "type":"structure", 1177 "required":["destinationType"], 1178 "members":{ 1179 "destinationType":{ 1180 "shape":"DataViewDestinationType", 1181 "documentation":"<p>Destination type for a Dataview.</p> <ul> <li> <p> <code>GLUE_TABLE</code> – Glue table destination type.</p> </li> <li> <p> <code>S3</code> – S3 destination type.</p> </li> </ul>" 1182 }, 1183 "s3DestinationExportFileFormat":{ 1184 "shape":"ExportFileFormat", 1185 "documentation":"<p>Dataview export file format.</p> <ul> <li> <p> <code>PARQUET</code> – Parquet export file format.</p> </li> <li> <p> <code>DELIMITED_TEXT</code> – Delimited text export file format.</p> </li> </ul>" 1186 }, 1187 "s3DestinationExportFileFormatOptions":{ 1188 "shape":"S3DestinationFormatOptions", 1189 "documentation":"<p>Format Options for S3 Destination type.</p> <p>Here is an example of how you could specify the <code>s3DestinationExportFileFormatOptions</code> </p> <p> <code> { \"header\": \"true\", \"delimiter\": \",\", \"compression\": \"gzip\" }</code> </p>" 1190 } 1191 }, 1192 "documentation":"<p>Structure for the Dataview destination type parameters.</p>" 1193 }, 1194 "DataViewErrorInfo":{ 1195 "type":"structure", 1196 "members":{ 1197 "errorMessage":{ 1198 "shape":"ErrorMessage", 1199 "documentation":"<p>The text of the error message.</p>" 1200 }, 1201 "errorCategory":{ 1202 "shape":"ErrorCategory", 1203 "documentation":"<p>The category of the error.</p> <ul> <li> <p> <code>VALIDATION</code> – The inputs to this request are invalid.</p> </li> <li> <p> <code>SERVICE_QUOTA_EXCEEDED</code> – Service quotas have been exceeded. Please contact AWS support to increase quotas.</p> </li> <li> <p> <code>ACCESS_DENIED</code> – Missing required permission to perform this request.</p> </li> <li> <p> <code>RESOURCE_NOT_FOUND</code> – One or more inputs to this request were not found.</p> </li> <li> <p> <code>THROTTLING</code> – The system temporarily lacks sufficient resources to process the request.</p> </li> <li> <p> <code>INTERNAL_SERVICE_EXCEPTION</code> – An internal service error has occurred.</p> </li> <li> <p> <code>CANCELLED</code> – Cancelled.</p> </li> <li> <p> <code>USER_RECOVERABLE</code> – A user recoverable error has occurred.</p> </li> </ul>" 1204 } 1205 }, 1206 "documentation":"<p>The structure with error messages.</p>" 1207 }, 1208 "DataViewId":{ 1209 "type":"string", 1210 "documentation":"DataView ID", 1211 "max":26, 1212 "min":1 1213 }, 1214 "DataViewList":{ 1215 "type":"list", 1216 "member":{"shape":"DataViewSummary"}, 1217 "documentation":"List of Data Views" 1218 }, 1219 "DataViewStatus":{ 1220 "type":"string", 1221 "documentation":"Status of a DataView", 1222 "enum":[ 1223 "RUNNING", 1224 "STARTING", 1225 "FAILED", 1226 "CANCELLED", 1227 "TIMEOUT", 1228 "SUCCESS", 1229 "PENDING", 1230 "FAILED_CLEANUP_FAILED" 1231 ] 1232 }, 1233 "DataViewSummary":{ 1234 "type":"structure", 1235 "members":{ 1236 "dataViewId":{ 1237 "shape":"DataViewId", 1238 "documentation":"<p>The unique identifier for the Dataview.</p>" 1239 }, 1240 "dataViewArn":{ 1241 "shape":"DataViewArn", 1242 "documentation":"<p>The ARN identifier of the Dataview.</p>" 1243 }, 1244 "datasetId":{ 1245 "shape":"DatasetId", 1246 "documentation":"<p>Th unique identifier for the Dataview Dataset.</p>" 1247 }, 1248 "asOfTimestamp":{ 1249 "shape":"TimestampEpoch", 1250 "documentation":"<p>Time range to use for the Dataview. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>", 1251 "box":true 1252 }, 1253 "partitionColumns":{ 1254 "shape":"PartitionColumnList", 1255 "documentation":"<p>Ordered set of column names used to partition data.</p>" 1256 }, 1257 "sortColumns":{ 1258 "shape":"SortColumnList", 1259 "documentation":"<p>Columns to be used for sorting the data.</p>" 1260 }, 1261 "status":{ 1262 "shape":"DataViewStatus", 1263 "documentation":"<p>The status of a Dataview creation.</p> <ul> <li> <p> <code>RUNNING</code> – Dataview creation is running.</p> </li> <li> <p> <code>STARTING</code> – Dataview creation is starting.</p> </li> <li> <p> <code>FAILED</code> – Dataview creation has failed.</p> </li> <li> <p> <code>CANCELLED</code> – Dataview creation has been cancelled.</p> </li> <li> <p> <code>TIMEOUT</code> – Dataview creation has timed out.</p> </li> <li> <p> <code>SUCCESS</code> – Dataview creation has succeeded.</p> </li> <li> <p> <code>PENDING</code> – Dataview creation is pending.</p> </li> <li> <p> <code>FAILED_CLEANUP_FAILED</code> – Dataview creation failed and resource cleanup failed.</p> </li> </ul>" 1264 }, 1265 "errorInfo":{ 1266 "shape":"DataViewErrorInfo", 1267 "documentation":"<p>The structure with error messages.</p>" 1268 }, 1269 "destinationTypeProperties":{ 1270 "shape":"DataViewDestinationTypeParams", 1271 "documentation":"<p>Information about the Dataview destination.</p>" 1272 }, 1273 "autoUpdate":{ 1274 "shape":"Boolean", 1275 "documentation":"<p>The flag to indicate Dataview should be updated automatically.</p>" 1276 }, 1277 "createTime":{ 1278 "shape":"TimestampEpoch", 1279 "documentation":"<p>The timestamp at which the Dataview was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>" 1280 }, 1281 "lastModifiedTime":{ 1282 "shape":"TimestampEpoch", 1283 "documentation":"<p>The last time that a Dataview was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>" 1284 } 1285 }, 1286 "documentation":"<p>Structure for the summary of a Dataview.</p>" 1287 }, 1288 "Dataset":{ 1289 "type":"structure", 1290 "members":{ 1291 "datasetId":{ 1292 "shape":"DatasetId", 1293 "documentation":"<p>An identifier for a Dataset.</p>" 1294 }, 1295 "datasetArn":{ 1296 "shape":"DatasetArn", 1297 "documentation":"<p>The ARN identifier of the Dataset.</p>" 1298 }, 1299 "datasetTitle":{ 1300 "shape":"DatasetTitle", 1301 "documentation":"<p>Display title for a Dataset.</p>" 1302 }, 1303 "kind":{ 1304 "shape":"DatasetKind", 1305 "documentation":"<p>The format in which Dataset data is structured.</p> <ul> <li> <p> <code>TABULAR</code> – Data is structured in a tabular format.</p> </li> <li> <p> <code>NON_TABULAR</code> – Data is structured in a non-tabular format.</p> </li> </ul>" 1306 }, 1307 "datasetDescription":{ 1308 "shape":"DatasetDescription", 1309 "documentation":"<p>Description for a Dataset.</p>" 1310 }, 1311 "ownerInfo":{ 1312 "shape":"DatasetOwnerInfo", 1313 "documentation":"<p>Contact information for a Dataset owner.</p>" 1314 }, 1315 "createTime":{ 1316 "shape":"TimestampEpoch", 1317 "documentation":"<p>The timestamp at which the Dataset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>" 1318 }, 1319 "lastModifiedTime":{ 1320 "shape":"TimestampEpoch", 1321 "documentation":"<p>The last time that the Dataset was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>" 1322 }, 1323 "schemaDefinition":{ 1324 "shape":"SchemaUnion", 1325 "documentation":"<p>Definition for a schema on a tabular Dataset.</p>" 1326 }, 1327 "alias":{ 1328 "shape":"AliasString", 1329 "documentation":"<p>The unique resource identifier for a Dataset.</p>" 1330 } 1331 }, 1332 "documentation":"<p>The structure for a Dataset.</p>" 1333 }, 1334 "DatasetArn":{ 1335 "type":"string", 1336 "documentation":"Arn of a Dataset" 1337 }, 1338 "DatasetDescription":{ 1339 "type":"string", 1340 "documentation":"Description of a dataset", 1341 "max":1000, 1342 "pattern":"[\\s\\S]*" 1343 }, 1344 "DatasetId":{ 1345 "type":"string", 1346 "documentation":"ID for a given Dataset", 1347 "max":26, 1348 "min":1 1349 }, 1350 "DatasetKind":{ 1351 "type":"string", 1352 "documentation":"Dataset Kind", 1353 "enum":[ 1354 "TABULAR", 1355 "NON_TABULAR" 1356 ] 1357 }, 1358 "DatasetList":{ 1359 "type":"list", 1360 "member":{"shape":"Dataset"}, 1361 "documentation":"List of Dataset structures" 1362 }, 1363 "DatasetOwnerInfo":{ 1364 "type":"structure", 1365 "members":{ 1366 "name":{ 1367 "shape":"OwnerName", 1368 "documentation":"<p>The name of the Dataset owner.</p>" 1369 }, 1370 "phoneNumber":{ 1371 "shape":"PhoneNumber", 1372 "documentation":"<p>Phone number for the Dataset owner.</p>" 1373 }, 1374 "email":{ 1375 "shape":"Email", 1376 "documentation":"<p>Email address for the Dataset owner.</p>" 1377 } 1378 }, 1379 "documentation":"<p>A structure for Dataset owner info.</p>" 1380 }, 1381 "DatasetStatus":{ 1382 "type":"string", 1383 "documentation":"Status of the dataset process returned from scheduler service.", 1384 "enum":[ 1385 "PENDING", 1386 "FAILED", 1387 "SUCCESS", 1388 "RUNNING" 1389 ] 1390 }, 1391 "DatasetTitle":{ 1392 "type":"string", 1393 "documentation":"Title for a given Dataset", 1394 "max":255, 1395 "min":1, 1396 "pattern":".*\\S.*" 1397 }, 1398 "DeleteDatasetRequest":{ 1399 "type":"structure", 1400 "required":["datasetId"], 1401 "members":{ 1402 "clientToken":{ 1403 "shape":"ClientToken", 1404 "documentation":"<p>A token that ensures idempotency. This token expires in 10 minutes.</p>", 1405 "idempotencyToken":true, 1406 "location":"querystring", 1407 "locationName":"clientToken" 1408 }, 1409 "datasetId":{ 1410 "shape":"DatasetId", 1411 "documentation":"<p>The unique identifier of the Dataset to be deleted.</p>", 1412 "location":"uri", 1413 "locationName":"datasetId" 1414 } 1415 }, 1416 "documentation":"The request for a DeleteDataset operation." 1417 }, 1418 "DeleteDatasetResponse":{ 1419 "type":"structure", 1420 "members":{ 1421 "datasetId":{ 1422 "shape":"DatasetId", 1423 "documentation":"<p>The unique identifier for the deleted Dataset.</p>" 1424 } 1425 }, 1426 "documentation":"The response from an DeleteDataset operation" 1427 }, 1428 "DeletePermissionGroupRequest":{ 1429 "type":"structure", 1430 "required":["permissionGroupId"], 1431 "members":{ 1432 "permissionGroupId":{ 1433 "shape":"PermissionGroupId", 1434 "documentation":"<p>The unique identifier for the permission group that you want to delete.</p>", 1435 "location":"uri", 1436 "locationName":"permissionGroupId" 1437 }, 1438 "clientToken":{ 1439 "shape":"ClientToken", 1440 "documentation":"<p>A token that ensures idempotency. This token expires in 10 minutes.</p>", 1441 "idempotencyToken":true, 1442 "location":"querystring", 1443 "locationName":"clientToken" 1444 } 1445 } 1446 }, 1447 "DeletePermissionGroupResponse":{ 1448 "type":"structure", 1449 "members":{ 1450 "permissionGroupId":{ 1451 "shape":"PermissionGroupId", 1452 "documentation":"<p>The unique identifier for the deleted permission group.</p>" 1453 } 1454 } 1455 }, 1456 "DisableUserRequest":{ 1457 "type":"structure", 1458 "required":["userId"], 1459 "members":{ 1460 "userId":{ 1461 "shape":"UserId", 1462 "documentation":"<p>The unique identifier for the user that you want to deactivate.</p>", 1463 "location":"uri", 1464 "locationName":"userId" 1465 }, 1466 "clientToken":{ 1467 "shape":"ClientToken", 1468 "documentation":"<p>A token that ensures idempotency. This token expires in 10 minutes.</p>", 1469 "idempotencyToken":true 1470 } 1471 } 1472 }, 1473 "DisableUserResponse":{ 1474 "type":"structure", 1475 "members":{ 1476 "userId":{ 1477 "shape":"UserId", 1478 "documentation":"<p>The unique identifier for the deactivated user.</p>" 1479 } 1480 } 1481 }, 1482 "DisassociateUserFromPermissionGroupRequest":{ 1483 "type":"structure", 1484 "required":[ 1485 "permissionGroupId", 1486 "userId" 1487 ], 1488 "members":{ 1489 "permissionGroupId":{ 1490 "shape":"PermissionGroupId", 1491 "documentation":"<p>The unique identifier for the permission group.</p>", 1492 "location":"uri", 1493 "locationName":"permissionGroupId" 1494 }, 1495 "userId":{ 1496 "shape":"UserId", 1497 "documentation":"<p>The unique identifier for the user.</p>", 1498 "location":"uri", 1499 "locationName":"userId" 1500 }, 1501 "clientToken":{ 1502 "shape":"ClientToken", 1503 "documentation":"<p>A token that ensures idempotency. This token expires in 10 minutes.</p>", 1504 "idempotencyToken":true, 1505 "location":"querystring", 1506 "locationName":"clientToken" 1507 } 1508 } 1509 }, 1510 "DisassociateUserFromPermissionGroupResponse":{ 1511 "type":"structure", 1512 "members":{ 1513 "statusCode":{ 1514 "shape":"StatusCode", 1515 "documentation":"<p>The returned status code of the response.</p>", 1516 "location":"statusCode" 1517 } 1518 } 1519 }, 1520 "Email":{ 1521 "type":"string", 1522 "max":320, 1523 "min":4, 1524 "pattern":"[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,4}", 1525 "sensitive":true 1526 }, 1527 "EnableUserRequest":{ 1528 "type":"structure", 1529 "required":["userId"], 1530 "members":{ 1531 "userId":{ 1532 "shape":"UserId", 1533 "documentation":"<p>The unique identifier for the user that you want to activate.</p>", 1534 "location":"uri", 1535 "locationName":"userId" 1536 }, 1537 "clientToken":{ 1538 "shape":"ClientToken", 1539 "documentation":"<p>A token that ensures idempotency. This token expires in 10 minutes.</p>", 1540 "idempotencyToken":true 1541 } 1542 } 1543 }, 1544 "EnableUserResponse":{ 1545 "type":"structure", 1546 "members":{ 1547 "userId":{ 1548 "shape":"UserId", 1549 "documentation":"<p>The unique identifier for the active user.</p>" 1550 } 1551 } 1552 }, 1553 "ErrorCategory":{ 1554 "type":"string", 1555 "documentation":"Changeset Error Category", 1556 "enum":[ 1557 "VALIDATION", 1558 "SERVICE_QUOTA_EXCEEDED", 1559 "ACCESS_DENIED", 1560 "RESOURCE_NOT_FOUND", 1561 "THROTTLING", 1562 "INTERNAL_SERVICE_EXCEPTION", 1563 "CANCELLED", 1564 "USER_RECOVERABLE" 1565 ] 1566 }, 1567 "ErrorMessage":{ 1568 "type":"string", 1569 "documentation":"Changeset Error Message", 1570 "max":1000 1571 }, 1572 "ExportFileFormat":{ 1573 "type":"string", 1574 "documentation":"Data View Export File Format", 1575 "enum":[ 1576 "PARQUET", 1577 "DELIMITED_TEXT" 1578 ] 1579 }, 1580 "FirstName":{ 1581 "type":"string", 1582 "max":50, 1583 "min":1, 1584 "pattern":".*\\S.*", 1585 "sensitive":true 1586 }, 1587 "FormatParams":{ 1588 "type":"map", 1589 "key":{"shape":"StringMapKey"}, 1590 "value":{"shape":"StringMapValue"}, 1591 "documentation":"Format Parameters of a Changeset" 1592 }, 1593 "GetChangesetRequest":{ 1594 "type":"structure", 1595 "required":[ 1596 "datasetId", 1597 "changesetId" 1598 ], 1599 "members":{ 1600 "datasetId":{ 1601 "shape":"DatasetId", 1602 "documentation":"<p>The unique identifier for the FinSpace Dataset where the Changeset is created.</p>", 1603 "location":"uri", 1604 "locationName":"datasetId" 1605 }, 1606 "changesetId":{ 1607 "shape":"ChangesetId", 1608 "documentation":"<p>The unique identifier of the Changeset for which to get data.</p>", 1609 "location":"uri", 1610 "locationName":"changesetId" 1611 } 1612 }, 1613 "documentation":"Request to describe a changeset." 1614 }, 1615 "GetChangesetResponse":{ 1616 "type":"structure", 1617 "members":{ 1618 "changesetId":{ 1619 "shape":"ChangesetId", 1620 "documentation":"<p>The unique identifier for a Changeset.</p>" 1621 }, 1622 "changesetArn":{ 1623 "shape":"ChangesetArn", 1624 "documentation":"<p>The ARN identifier of the Changeset.</p>" 1625 }, 1626 "datasetId":{ 1627 "shape":"DatasetId", 1628 "documentation":"<p>The unique identifier for the FinSpace Dataset where the Changeset is created.</p>" 1629 }, 1630 "changeType":{ 1631 "shape":"ChangeType", 1632 "documentation":"<p>Type that indicates how a Changeset is applied to a Dataset.</p> <ul> <li> <p> <code>REPLACE</code> – Changeset is considered as a replacement to all prior loaded Changesets.</p> </li> <li> <p> <code>APPEND</code> – Changeset is considered as an addition to the end of all prior loaded Changesets.</p> </li> <li> <p> <code>MODIFY</code> – Changeset is considered as a replacement to a specific prior ingested Changeset.</p> </li> </ul>" 1633 }, 1634 "sourceParams":{ 1635 "shape":"SourceParams", 1636 "documentation":"<p>Options that define the location of the data being ingested.</p>" 1637 }, 1638 "formatParams":{ 1639 "shape":"FormatParams", 1640 "documentation":"<p>Structure of the source file(s).</p>" 1641 }, 1642 "createTime":{ 1643 "shape":"TimestampEpoch", 1644 "documentation":"<p>The timestamp at which the Changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>" 1645 }, 1646 "status":{ 1647 "shape":"IngestionStatus", 1648 "documentation":"<p>The status of Changeset creation operation.</p>" 1649 }, 1650 "errorInfo":{ 1651 "shape":"ChangesetErrorInfo", 1652 "documentation":"<p>The structure with error messages.</p>" 1653 }, 1654 "activeUntilTimestamp":{ 1655 "shape":"TimestampEpoch", 1656 "documentation":"<p>Time until which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>", 1657 "box":true 1658 }, 1659 "activeFromTimestamp":{ 1660 "shape":"TimestampEpoch", 1661 "documentation":"<p>Beginning time from which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>", 1662 "box":true 1663 }, 1664 "updatesChangesetId":{ 1665 "shape":"ChangesetId", 1666 "documentation":"<p>The unique identifier of the Changeset that is being updated.</p>" 1667 }, 1668 "updatedByChangesetId":{ 1669 "shape":"ChangesetId", 1670 "documentation":"<p>The unique identifier of the updated Changeset.</p>" 1671 } 1672 }, 1673 "documentation":"The response from a describe changeset operation" 1674 }, 1675 "GetDataViewRequest":{ 1676 "type":"structure", 1677 "required":[ 1678 "dataViewId", 1679 "datasetId" 1680 ], 1681 "members":{ 1682 "dataViewId":{ 1683 "shape":"DataViewId", 1684 "documentation":"<p>The unique identifier for the Dataview.</p>", 1685 "location":"uri", 1686 "locationName":"dataviewId" 1687 }, 1688 "datasetId":{ 1689 "shape":"DatasetId", 1690 "documentation":"<p>The unique identifier for the Dataset used in the Dataview.</p>", 1691 "location":"uri", 1692 "locationName":"datasetId" 1693 } 1694 }, 1695 "documentation":"Request for retrieving a data view detail. Grouped / accessible within a dataset by its dataset id." 1696 }, 1697 "GetDataViewResponse":{ 1698 "type":"structure", 1699 "members":{ 1700 "autoUpdate":{ 1701 "shape":"Boolean", 1702 "documentation":"<p>Flag to indicate Dataview should be updated automatically.</p>" 1703 }, 1704 "partitionColumns":{ 1705 "shape":"PartitionColumnList", 1706 "documentation":"<p>Ordered set of column names used to partition data.</p>" 1707 }, 1708 "datasetId":{ 1709 "shape":"DatasetId", 1710 "documentation":"<p>The unique identifier for the Dataset used in the Dataview.</p>" 1711 }, 1712 "asOfTimestamp":{ 1713 "shape":"TimestampEpoch", 1714 "documentation":"<p>Time range to use for the Dataview. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>", 1715 "box":true 1716 }, 1717 "errorInfo":{ 1718 "shape":"DataViewErrorInfo", 1719 "documentation":"<p>Information about an error that occurred for the Dataview.</p>" 1720 }, 1721 "lastModifiedTime":{ 1722 "shape":"TimestampEpoch", 1723 "documentation":"<p>The last time that a Dataview was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>" 1724 }, 1725 "createTime":{ 1726 "shape":"TimestampEpoch", 1727 "documentation":"<p>The timestamp at which the Dataview was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>" 1728 }, 1729 "sortColumns":{ 1730 "shape":"SortColumnList", 1731 "documentation":"<p>Columns to be used for sorting the data.</p>" 1732 }, 1733 "dataViewId":{ 1734 "shape":"DataViewId", 1735 "documentation":"<p>The unique identifier for the Dataview.</p>" 1736 }, 1737 "dataViewArn":{ 1738 "shape":"DataViewArn", 1739 "documentation":"<p>The ARN identifier of the Dataview.</p>" 1740 }, 1741 "destinationTypeParams":{ 1742 "shape":"DataViewDestinationTypeParams", 1743 "documentation":"<p>Options that define the destination type for the Dataview.</p>" 1744 }, 1745 "status":{ 1746 "shape":"DataViewStatus", 1747 "documentation":"<p>The status of a Dataview creation.</p> <ul> <li> <p> <code>RUNNING</code> – Dataview creation is running.</p> </li> <li> <p> <code>STARTING</code> – Dataview creation is starting.</p> </li> <li> <p> <code>FAILED</code> – Dataview creation has failed.</p> </li> <li> <p> <code>CANCELLED</code> – Dataview creation has been cancelled.</p> </li> <li> <p> <code>TIMEOUT</code> – Dataview creation has timed out.</p> </li> <li> <p> <code>SUCCESS</code> – Dataview creation has succeeded.</p> </li> <li> <p> <code>PENDING</code> – Dataview creation is pending.</p> </li> <li> <p> <code>FAILED_CLEANUP_FAILED</code> – Dataview creation failed and resource cleanup failed.</p> </li> </ul>" 1748 } 1749 }, 1750 "documentation":"Response from retrieving a dataview, which includes details on the target database and table name" 1751 }, 1752 "GetDatasetRequest":{ 1753 "type":"structure", 1754 "required":["datasetId"], 1755 "members":{ 1756 "datasetId":{ 1757 "shape":"StringValueLength1to255", 1758 "documentation":"<p>The unique identifier for a Dataset.</p>", 1759 "location":"uri", 1760 "locationName":"datasetId" 1761 } 1762 }, 1763 "documentation":"Request for the GetDataset operation." 1764 }, 1765 "GetDatasetResponse":{ 1766 "type":"structure", 1767 "members":{ 1768 "datasetId":{ 1769 "shape":"DatasetId", 1770 "documentation":"<p>The unique identifier for a Dataset.</p>" 1771 }, 1772 "datasetArn":{ 1773 "shape":"DatasetArn", 1774 "documentation":"<p>The ARN identifier of the Dataset.</p>" 1775 }, 1776 "datasetTitle":{ 1777 "shape":"DatasetTitle", 1778 "documentation":"<p>Display title for a Dataset.</p>" 1779 }, 1780 "kind":{ 1781 "shape":"DatasetKind", 1782 "documentation":"<p>The format in which Dataset data is structured.</p> <ul> <li> <p> <code>TABULAR</code> – Data is structured in a tabular format.</p> </li> <li> <p> <code>NON_TABULAR</code> – Data is structured in a non-tabular format.</p> </li> </ul>" 1783 }, 1784 "datasetDescription":{ 1785 "shape":"DatasetDescription", 1786 "documentation":"<p>A description of the Dataset.</p>" 1787 }, 1788 "createTime":{ 1789 "shape":"TimestampEpoch", 1790 "documentation":"<p>The timestamp at which the Dataset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>" 1791 }, 1792 "lastModifiedTime":{ 1793 "shape":"TimestampEpoch", 1794 "documentation":"<p>The last time that the Dataset was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.</p>" 1795 }, 1796 "schemaDefinition":{ 1797 "shape":"SchemaUnion", 1798 "documentation":"<p>Definition for a schema on a tabular Dataset.</p>" 1799 }, 1800 "alias":{ 1801 "shape":"AliasString", 1802 "documentation":"<p>The unique resource identifier for a Dataset.</p>" 1803 }, 1804 "status":{ 1805 "shape":"DatasetStatus", 1806 "documentation":"<p>Status of the Dataset creation.</p> <ul> <li> <p> <code>PENDING</code> – Dataset is pending creation.</p> </li> <li> <p> <code>FAILED</code> – Dataset creation has failed.</p> </li> <li> <p> <code>SUCCESS</code> – Dataset creation has succeeded.</p> </li> <li> <p> <code>RUNNING</code> – Dataset creation is running.</p> </li> </ul>" 1807 } 1808 }, 1809 "documentation":"Response for the GetDataset operation" 1810 }, 1811 "GetExternalDataViewAccessDetailsRequest":{ 1812 "type":"structure", 1813 "required":[ 1814 "dataViewId", 1815 "datasetId" 1816 ], 1817 "members":{ 1818 "dataViewId":{ 1819 "shape":"DataViewId", 1820 "documentation":"<p>The unique identifier for the Dataview that you want to access.</p>", 1821 "location":"uri", 1822 "locationName":"dataviewId" 1823 }, 1824 "datasetId":{ 1825 "shape":"DatasetId", 1826 "documentation":"<p>The unique identifier for the Dataset.</p>", 1827 "location":"uri", 1828 "locationName":"datasetId" 1829 } 1830 } 1831 }, 1832 "GetExternalDataViewAccessDetailsResponse":{ 1833 "type":"structure", 1834 "members":{ 1835 "credentials":{ 1836 "shape":"AwsCredentials", 1837 "documentation":"<p>The credentials required to access the external Dataview from the S3 location.</p>" 1838 }, 1839 "s3Location":{ 1840 "shape":"S3Location", 1841 "documentation":"<p>The location where the external Dataview is stored.</p>" 1842 } 1843 } 1844 }, 1845 "GetPermissionGroupRequest":{ 1846 "type":"structure", 1847 "required":["permissionGroupId"], 1848 "members":{ 1849 "permissionGroupId":{ 1850 "shape":"PermissionGroupId", 1851 "documentation":"<p>The unique identifier for the permission group.</p>", 1852 "location":"uri", 1853 "locationName":"permissionGroupId" 1854 } 1855 } 1856 }, 1857 "GetPermissionGroupResponse":{ 1858 "type":"structure", 1859 "members":{ 1860 "permissionGroup":{"shape":"PermissionGroup"} 1861 } 1862 }, 1863 "GetProgrammaticAccessCredentialsRequest":{ 1864 "type":"structure", 1865 "required":["environmentId"], 1866 "members":{ 1867 "durationInMinutes":{ 1868 "shape":"SessionDuration", 1869 "documentation":"<p>The time duration in which the credentials remain valid. </p>", 1870 "location":"querystring", 1871 "locationName":"durationInMinutes" 1872 }, 1873 "environmentId":{ 1874 "shape":"IdType", 1875 "documentation":"<p>The FinSpace environment identifier.</p>", 1876 "location":"querystring", 1877 "locationName":"environmentId" 1878 } 1879 }, 1880 "documentation":"Request for GetProgrammaticAccessCredentials operation" 1881 }, 1882 "GetProgrammaticAccessCredentialsResponse":{ 1883 "type":"structure", 1884 "members":{ 1885 "credentials":{ 1886 "shape":"Credentials", 1887 "documentation":"<p>Returns the programmatic credentials.</p>" 1888 }, 1889 "durationInMinutes":{ 1890 "shape":"SessionDuration", 1891 "documentation":"<p>Returns the duration in which the credentials will remain valid.</p>" 1892 } 1893 }, 1894 "documentation":"Response for GetProgrammaticAccessCredentials operation" 1895 }, 1896 "GetUserRequest":{ 1897 "type":"structure", 1898 "required":["userId"], 1899 "members":{ 1900 "userId":{ 1901 "shape":"UserId", 1902 "documentation":"<p>The unique identifier of the user to get data for.</p>", 1903 "location":"uri", 1904 "locationName":"userId" 1905 } 1906 } 1907 }, 1908 "GetUserResponse":{ 1909 "type":"structure", 1910 "members":{ 1911 "userId":{ 1912 "shape":"UserId", 1913 "documentation":"<p>The unique identifier for the user that is retrieved.</p>" 1914 }, 1915 "status":{ 1916 "shape":"UserStatus", 1917 "documentation":"<p>The current status of the user. </p> <ul> <li> <p> <code>CREATING</code> – The creation is in progress.</p> </li> <li> <p> <code>ENABLED</code> – The user is created and is currently active.</p> </li> <li> <p> <code>DISABLED</code> – The user is currently inactive.</p> </li> </ul>" 1918 }, 1919 "firstName":{ 1920 "shape":"FirstName", 1921 "documentation":"<p>The first name of the user.</p>" 1922 }, 1923 "lastName":{ 1924 "shape":"LastName", 1925 "documentation":"<p>The last name of the user.</p>" 1926 }, 1927 "emailAddress":{ 1928 "shape":"Email", 1929 "documentation":"<p>The email address that is associated with the user.</p>" 1930 }, 1931 "type":{ 1932 "shape":"UserType", 1933 "documentation":"<p>Indicates the type of user. </p> <ul> <li> <p> <code>SUPER_USER</code> – A user with permission to all the functionality and data in FinSpace.</p> </li> </ul> <ul> <li> <p> <code>APP_USER</code> – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.</p> </li> </ul>" 1934 }, 1935 "apiAccess":{ 1936 "shape":"ApiAccess", 1937 "documentation":"<p>Indicates whether the user can use the <code>GetProgrammaticAccessCredentials</code> API to obtain credentials that can then be used to access other FinSpace Data API operations. </p> <ul> <li> <p> <code>ENABLED</code> – The user has permissions to use the APIs.</p> </li> <li> <p> <code>DISABLED</code> – The user does not have permissions to use any APIs.</p> </li> </ul>" 1938 }, 1939 "apiAccessPrincipalArn":{ 1940 "shape":"RoleArn", 1941 "documentation":"<p>The ARN identifier of an AWS user or role that is allowed to call the <code>GetProgrammaticAccessCredentials</code> API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.</p>" 1942 }, 1943 "createTime":{ 1944 "shape":"TimestampEpoch", 1945 "documentation":"<p>The timestamp at which the user was created in FinSpace. The value is determined as epoch time in milliseconds. </p>" 1946 }, 1947 "lastEnabledTime":{ 1948 "shape":"TimestampEpoch", 1949 "documentation":"<p>Describes the last time the user was activated. The value is determined as epoch time in milliseconds.</p>" 1950 }, 1951 "lastDisabledTime":{ 1952 "shape":"TimestampEpoch", 1953 "documentation":"<p>Describes the last time the user was deactivated. The value is determined as epoch time in milliseconds.</p>" 1954 }, 1955 "lastModifiedTime":{ 1956 "shape":"TimestampEpoch", 1957 "documentation":"<p>Describes the last time the user details were updated. The value is determined as epoch time in milliseconds.</p>" 1958 }, 1959 "lastLoginTime":{ 1960 "shape":"TimestampEpoch", 1961 "documentation":"<p>Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.</p>" 1962 } 1963 } 1964 }, 1965 "GetWorkingLocationRequest":{ 1966 "type":"structure", 1967 "members":{ 1968 "locationType":{ 1969 "shape":"locationType", 1970 "documentation":"<p>Specify the type of the working location.</p> <ul> <li> <p> <code>SAGEMAKER</code> – Use the Amazon S3 location as a temporary location to store data content when working with FinSpace Notebooks that run on SageMaker studio.</p> </li> <li> <p> <code>INGESTION</code> – Use the Amazon S3 location as a staging location to copy your data content and then use the location with the Changeset creation operation.</p> </li> </ul>" 1971 } 1972 } 1973 }, 1974 "GetWorkingLocationResponse":{ 1975 "type":"structure", 1976 "members":{ 1977 "s3Uri":{ 1978 "shape":"stringValueLength1to1024", 1979 "documentation":"<p>Returns the Amazon S3 URI for the working location.</p>" 1980 }, 1981 "s3Path":{ 1982 "shape":"stringValueLength1to1024", 1983 "documentation":"<p>Returns the Amazon S3 Path for the working location.</p>" 1984 }, 1985 "s3Bucket":{ 1986 "shape":"stringValueLength1to63", 1987 "documentation":"<p>Returns the Amazon S3 bucket name for the working location.</p>" 1988 } 1989 } 1990 }, 1991 "IdType":{ 1992 "type":"string", 1993 "max":26, 1994 "min":1 1995 }, 1996 "IngestionStatus":{ 1997 "type":"string", 1998 "documentation":"Status of the ingestion process returned from scheduler service.", 1999 "enum":[ 2000 "PENDING", 2001 "FAILED", 2002 "SUCCESS", 2003 "RUNNING", 2004 "STOP_REQUESTED" 2005 ] 2006 }, 2007 "InternalServerException":{ 2008 "type":"structure", 2009 "members":{ 2010 "message":{"shape":"errorMessage"} 2011 }, 2012 "documentation":"<p>The request processing has failed because of an unknown error, exception or failure.</p>", 2013 "error":{"httpStatusCode":500}, 2014 "exception":true 2015 }, 2016 "LastName":{ 2017 "type":"string", 2018 "max":50, 2019 "min":1, 2020 "pattern":".*\\S.*", 2021 "sensitive":true 2022 }, 2023 "LimitExceededException":{ 2024 "type":"structure", 2025 "members":{ 2026 "message":{"shape":"errorMessage"} 2027 }, 2028 "documentation":"<p>A limit has exceeded.</p>", 2029 "error":{"httpStatusCode":400}, 2030 "exception":true 2031 }, 2032 "ListChangesetsRequest":{ 2033 "type":"structure", 2034 "required":["datasetId"], 2035 "members":{ 2036 "datasetId":{ 2037 "shape":"DatasetId", 2038 "documentation":"<p>The unique identifier for the FinSpace Dataset to which the Changeset belongs.</p>", 2039 "location":"uri", 2040 "locationName":"datasetId" 2041 }, 2042 "maxResults":{ 2043 "shape":"ResultLimit", 2044 "documentation":"<p>The maximum number of results per page.</p>", 2045 "box":true, 2046 "location":"querystring", 2047 "locationName":"maxResults" 2048 }, 2049 "nextToken":{ 2050 "shape":"PaginationToken", 2051 "documentation":"<p>A token that indicates where a results page should begin.</p>", 2052 "location":"querystring", 2053 "locationName":"nextToken" 2054 } 2055 }, 2056 "documentation":"Request to ListChangesetsRequest. It exposes minimal query filters." 2057 }, 2058 "ListChangesetsResponse":{ 2059 "type":"structure", 2060 "members":{ 2061 "changesets":{ 2062 "shape":"ChangesetList", 2063 "documentation":"<p>List of Changesets found.</p>" 2064 }, 2065 "nextToken":{ 2066 "shape":"PaginationToken", 2067 "documentation":"<p>A token that indicates where a results page should begin.</p>" 2068 } 2069 }, 2070 "documentation":"Response to ListChangesetsResponse. This returns a list of dataset changesets that match the query criteria." 2071 }, 2072 "ListDataViewsRequest":{ 2073 "type":"structure", 2074 "required":["datasetId"], 2075 "members":{ 2076 "datasetId":{ 2077 "shape":"DatasetId", 2078 "documentation":"<p>The unique identifier of the Dataset for which to retrieve Dataviews.</p>", 2079 "location":"uri", 2080 "locationName":"datasetId" 2081 }, 2082 "nextToken":{ 2083 "shape":"PaginationToken", 2084 "documentation":"<p>A token that indicates where a results page should begin.</p>", 2085 "location":"querystring", 2086 "locationName":"nextToken" 2087 }, 2088 "maxResults":{ 2089 "shape":"ResultLimit", 2090 "documentation":"<p>The maximum number of results per page.</p>", 2091 "box":true, 2092 "location":"querystring", 2093 "locationName":"maxResults" 2094 } 2095 }, 2096 "documentation":"Request for a list data views." 2097 }, 2098 "ListDataViewsResponse":{ 2099 "type":"structure", 2100 "members":{ 2101 "nextToken":{ 2102 "shape":"PaginationToken", 2103 "documentation":"<p>A token that indicates where a results page should begin.</p>" 2104 }, 2105 "dataViews":{ 2106 "shape":"DataViewList", 2107 "documentation":"<p>A list of Dataviews.</p>" 2108 } 2109 } 2110 }, 2111 "ListDatasetsRequest":{ 2112 "type":"structure", 2113 "members":{ 2114 "nextToken":{ 2115 "shape":"PaginationToken", 2116 "documentation":"<p>A token that indicates where a results page should begin.</p>", 2117 "location":"querystring", 2118 "locationName":"nextToken" 2119 }, 2120 "maxResults":{ 2121 "shape":"ResultLimit", 2122 "documentation":"<p>The maximum number of results per page.</p>", 2123 "box":true, 2124 "location":"querystring", 2125 "locationName":"maxResults" 2126 } 2127 }, 2128 "documentation":"Request for the ListDatasets operation." 2129 }, 2130 "ListDatasetsResponse":{ 2131 "type":"structure", 2132 "members":{ 2133 "datasets":{ 2134 "shape":"DatasetList", 2135 "documentation":"<p>List of Datasets.</p>" 2136 }, 2137 "nextToken":{ 2138 "shape":"PaginationToken", 2139 "documentation":"<p>A token that indicates where a results page should begin.</p>" 2140 } 2141 }, 2142 "documentation":"Response for the ListDatasets operation" 2143 }, 2144 "ListPermissionGroupsByUserRequest":{ 2145 "type":"structure", 2146 "required":[ 2147 "userId", 2148 "maxResults" 2149 ], 2150 "members":{ 2151 "userId":{ 2152 "shape":"UserId", 2153 "documentation":"<p>The unique identifier for the user.</p>", 2154 "location":"uri", 2155 "locationName":"userId" 2156 }, 2157 "nextToken":{ 2158 "shape":"PaginationToken", 2159 "documentation":"<p>A token that indicates where a results page should begin.</p>", 2160 "location":"querystring", 2161 "locationName":"nextToken" 2162 }, 2163 "maxResults":{ 2164 "shape":"ResultLimit", 2165 "documentation":"<p>The maximum number of results per page.</p>", 2166 "location":"querystring", 2167 "locationName":"maxResults" 2168 } 2169 } 2170 }, 2171 "ListPermissionGroupsByUserResponse":{ 2172 "type":"structure", 2173 "members":{ 2174 "permissionGroups":{ 2175 "shape":"PermissionGroupByUserList", 2176 "documentation":"<p>A list of returned permission groups.</p>" 2177 }, 2178 "nextToken":{ 2179 "shape":"PaginationToken", 2180 "documentation":"<p>A token that indicates where a results page should begin.</p>" 2181 } 2182 } 2183 }, 2184 "ListPermissionGroupsRequest":{ 2185 "type":"structure", 2186 "required":["maxResults"], 2187 "members":{ 2188 "nextToken":{ 2189 "shape":"PaginationToken", 2190 "documentation":"<p>A token that indicates where a results page should begin.</p>", 2191 "location":"querystring", 2192 "locationName":"nextToken" 2193 }, 2194 "maxResults":{ 2195 "shape":"ResultLimit", 2196 "documentation":"<p>The maximum number of results per page.</p>", 2197 "location":"querystring", 2198 "locationName":"maxResults" 2199 } 2200 } 2201 }, 2202 "ListPermissionGroupsResponse":{ 2203 "type":"structure", 2204 "members":{ 2205 "permissionGroups":{ 2206 "shape":"PermissionGroupList", 2207 "documentation":"<p>A list of all the permission groups.</p>" 2208 }, 2209 "nextToken":{ 2210 "shape":"PaginationToken", 2211 "documentation":"<p>A token that indicates where a results page should begin.</p>" 2212 } 2213 } 2214 }, 2215 "ListUsersByPermissionGroupRequest":{ 2216 "type":"structure", 2217 "required":[ 2218 "permissionGroupId", 2219 "maxResults" 2220 ], 2221 "members":{ 2222 "permissionGroupId":{ 2223 "shape":"PermissionGroupId", 2224 "documentation":"<p>The unique identifier for the permission group.</p>", 2225 "location":"uri", 2226 "locationName":"permissionGroupId" 2227 }, 2228 "nextToken":{ 2229 "shape":"PaginationToken", 2230 "documentation":"<p>A token that indicates where a results page should begin.</p>", 2231 "location":"querystring", 2232 "locationName":"nextToken" 2233 }, 2234 "maxResults":{ 2235 "shape":"ResultLimit", 2236 "documentation":"<p>The maximum number of results per page.</p>", 2237 "location":"querystring", 2238 "locationName":"maxResults" 2239 } 2240 } 2241 }, 2242 "ListUsersByPermissionGroupResponse":{ 2243 "type":"structure", 2244 "members":{ 2245 "users":{ 2246 "shape":"UserByPermissionGroupList", 2247 "documentation":"<p>Lists details of all users in a specific permission group.</p>" 2248 }, 2249 "nextToken":{ 2250 "shape":"PaginationToken", 2251 "documentation":"<p>A token that indicates where a results page should begin.</p>" 2252 } 2253 } 2254 }, 2255 "ListUsersRequest":{ 2256 "type":"structure", 2257 "required":["maxResults"], 2258 "members":{ 2259 "nextToken":{ 2260 "shape":"PaginationToken", 2261 "documentation":"<p>A token that indicates where a results page should begin.</p>", 2262 "location":"querystring", 2263 "locationName":"nextToken" 2264 }, 2265 "maxResults":{ 2266 "shape":"ResultLimit", 2267 "documentation":"<p>The maximum number of results per page.</p>", 2268 "location":"querystring", 2269 "locationName":"maxResults" 2270 } 2271 } 2272 }, 2273 "ListUsersResponse":{ 2274 "type":"structure", 2275 "members":{ 2276 "users":{ 2277 "shape":"UserList", 2278 "documentation":"<p>A list of all the users.</p>" 2279 }, 2280 "nextToken":{ 2281 "shape":"PaginationToken", 2282 "documentation":"<p>A token that indicates where a results page should begin.</p>" 2283 } 2284 } 2285 }, 2286 "OwnerName":{ 2287 "type":"string", 2288 "documentation":"1 - 250 character String", 2289 "max":250, 2290 "min":1, 2291 "pattern":".*\\S.*" 2292 }, 2293 "PaginationToken":{"type":"string"}, 2294 "PartitionColumnList":{ 2295 "type":"list", 2296 "member":{"shape":"StringValueLength1to255"}, 2297 "documentation":"DataView Partition Column List" 2298 }, 2299 "Password":{ 2300 "type":"string", 2301 "max":20, 2302 "min":8, 2303 "pattern":".*\\S.*", 2304 "sensitive":true 2305 }, 2306 "PermissionGroup":{ 2307 "type":"structure", 2308 "members":{ 2309 "permissionGroupId":{ 2310 "shape":"PermissionGroupId", 2311 "documentation":"<p> The unique identifier for the permission group.</p>" 2312 }, 2313 "name":{ 2314 "shape":"PermissionGroupName", 2315 "documentation":"<p>The name of the permission group.</p>" 2316 }, 2317 "description":{ 2318 "shape":"PermissionGroupDescription", 2319 "documentation":"<p> A brief description for the permission group.</p>" 2320 }, 2321 "applicationPermissions":{ 2322 "shape":"ApplicationPermissionList", 2323 "documentation":"<p>Indicates the permissions that are granted to a specific group for accessing the FinSpace application.</p> <important> <p>When assigning application permissions, be aware that the permission <code>ManageUsersAndGroups</code> allows users to grant themselves or others access to any functionality in their FinSpace environment's application. It should only be granted to trusted users.</p> </important> <ul> <li> <p> <code>CreateDataset</code> – Group members can create new datasets.</p> </li> <li> <p> <code>ManageClusters</code> – Group members can manage Apache Spark clusters from FinSpace notebooks.</p> </li> <li> <p> <code>ManageUsersAndGroups</code> – Group members can manage users and permission groups. This is a privileged permission that allows users to grant themselves or others access to any functionality in the application. It should only be granted to trusted users.</p> </li> <li> <p> <code>ManageAttributeSets</code> – Group members can manage attribute sets.</p> </li> <li> <p> <code>ViewAuditData</code> – Group members can view audit data.</p> </li> <li> <p> <code>AccessNotebooks</code> – Group members will have access to FinSpace notebooks.</p> </li> <li> <p> <code>GetTemporaryCredentials</code> – Group members can get temporary API credentials.</p> </li> </ul>" 2324 }, 2325 "createTime":{ 2326 "shape":"TimestampEpoch", 2327 "documentation":"<p>The timestamp at which the group was created in FinSpace. The value is determined as epoch time in milliseconds. </p>" 2328 }, 2329 "lastModifiedTime":{ 2330 "shape":"TimestampEpoch", 2331 "documentation":"<p>Describes the last time the permission group was updated. The value is determined as epoch time in milliseconds. </p>" 2332 }, 2333 "membershipStatus":{ 2334 "shape":"PermissionGroupMembershipStatus", 2335 "documentation":"<p>Indicates the status of the user within a permission group.</p> <ul> <li> <p> <code>ADDITION_IN_PROGRESS</code> – The user is currently being added to the permission group.</p> </li> <li> <p> <code>ADDITION_SUCCESS</code> – The user is successfully added to the permission group.</p> </li> <li> <p> <code>REMOVAL_IN_PROGRESS</code> – The user is currently being removed from the permission group.</p> </li> </ul>" 2336 } 2337 }, 2338 "documentation":"<p>The structure for a permission group.</p>" 2339 }, 2340 "PermissionGroupByUser":{ 2341 "type":"structure", 2342 "members":{ 2343 "permissionGroupId":{ 2344 "shape":"PermissionGroupId", 2345 "documentation":"<p>The unique identifier for the permission group.</p>" 2346 }, 2347 "name":{ 2348 "shape":"PermissionGroupName", 2349 "documentation":"<p>The name of the permission group.</p>" 2350 }, 2351 "membershipStatus":{ 2352 "shape":"PermissionGroupMembershipStatus", 2353 "documentation":"<p>Indicates the status of the user within a permission group.</p> <ul> <li> <p> <code>ADDITION_IN_PROGRESS</code> – The user is currently being added to the permission group.</p> </li> <li> <p> <code>ADDITION_SUCCESS</code> – The user is successfully added to the permission group.</p> </li> <li> <p> <code>REMOVAL_IN_PROGRESS</code> – The user is currently being removed from the permission group.</p> </li> </ul>" 2354 } 2355 }, 2356 "documentation":"<p>The structure of a permission group associated with a user.</p>" 2357 }, 2358 "PermissionGroupByUserList":{ 2359 "type":"list", 2360 "member":{"shape":"PermissionGroupByUser"} 2361 }, 2362 "PermissionGroupDescription":{ 2363 "type":"string", 2364 "max":4000, 2365 "min":1, 2366 "pattern":"[\\s\\S]*", 2367 "sensitive":true 2368 }, 2369 "PermissionGroupId":{ 2370 "type":"string", 2371 "max":26, 2372 "min":1, 2373 "pattern":".*\\S.*" 2374 }, 2375 "PermissionGroupList":{ 2376 "type":"list", 2377 "member":{"shape":"PermissionGroup"} 2378 }, 2379 "PermissionGroupMembershipStatus":{ 2380 "type":"string", 2381 "enum":[ 2382 "ADDITION_IN_PROGRESS", 2383 "ADDITION_SUCCESS", 2384 "REMOVAL_IN_PROGRESS" 2385 ] 2386 }, 2387 "PermissionGroupName":{ 2388 "type":"string", 2389 "max":255, 2390 "min":1, 2391 "pattern":".*\\S.*", 2392 "sensitive":true 2393 }, 2394 "PermissionGroupParams":{ 2395 "type":"structure", 2396 "members":{ 2397 "permissionGroupId":{ 2398 "shape":"PermissionGroupId", 2399 "documentation":"<p>The unique identifier for the <code>PermissionGroup</code>.</p>" 2400 }, 2401 "datasetPermissions":{ 2402 "shape":"ResourcePermissionsList", 2403 "documentation":"<p>List of resource permissions.</p>" 2404 } 2405 }, 2406 "documentation":"<p>Permission group parameters for Dataset permissions.</p> <p>Here is an example of how you could specify the <code>PermissionGroupParams</code>:</p> <p> <code> { \"permissionGroupId\": \"0r6fCRtSTUk4XPfXQe3M0g\", \"datasetPermissions\": [ {\"permission\": \"ViewDatasetDetails\"}, {\"permission\": \"AddDatasetData\"}, {\"permission\": \"EditDatasetMetadata\"}, {\"permission\": \"DeleteDataset\"} ] } </code> </p>" 2407 }, 2408 "PhoneNumber":{ 2409 "type":"string", 2410 "documentation":"PhoneNumber of Dataset Owner", 2411 "max":20, 2412 "min":10, 2413 "pattern":"^[\\+0-9\\#\\,\\(][\\+0-9\\-\\.\\/\\(\\)\\,\\#\\s]+$" 2414 }, 2415 "ResetUserPasswordRequest":{ 2416 "type":"structure", 2417 "required":["userId"], 2418 "members":{ 2419 "userId":{ 2420 "shape":"UserId", 2421 "documentation":"<p>The unique identifier of the user that a temporary password is requested for.</p>", 2422 "location":"uri", 2423 "locationName":"userId" 2424 }, 2425 "clientToken":{ 2426 "shape":"ClientToken", 2427 "documentation":"<p>A token that ensures idempotency. This token expires in 10 minutes.</p>", 2428 "idempotencyToken":true 2429 } 2430 } 2431 }, 2432 "ResetUserPasswordResponse":{ 2433 "type":"structure", 2434 "members":{ 2435 "userId":{ 2436 "shape":"UserId", 2437 "documentation":"<p>The unique identifier of the user that a new password is generated for.</p>" 2438 }, 2439 "temporaryPassword":{ 2440 "shape":"Password", 2441 "documentation":"<p>A randomly generated temporary password for the requested user. This password expires in 7 days.</p>" 2442 } 2443 } 2444 }, 2445 "ResourceNotFoundException":{ 2446 "type":"structure", 2447 "members":{ 2448 "message":{"shape":"errorMessage"}, 2449 "reason":{"shape":"errorMessage"} 2450 }, 2451 "documentation":"<p>One or more resources can't be found.</p>", 2452 "error":{"httpStatusCode":404}, 2453 "exception":true 2454 }, 2455 "ResourcePermission":{ 2456 "type":"structure", 2457 "members":{ 2458 "permission":{ 2459 "shape":"StringValueLength1to250", 2460 "documentation":"<p>Permission for a resource.</p>" 2461 } 2462 }, 2463 "documentation":"<p>Resource permission for a dataset. When you create a dataset, all the other members of the same user group inherit access to the dataset. You can only create a dataset if your user group has application permission for Create Datasets.</p> <p>The following is a list of valid dataset permissions that you can apply: </p> <ul> <li> <p> <code>ViewDatasetDetails</code> </p> </li> <li> <p> <code>ReadDatasetDetails</code> </p> </li> <li> <p> <code>AddDatasetData</code> </p> </li> <li> <p> <code>CreateDataView</code> </p> </li> <li> <p> <code>EditDatasetMetadata</code> </p> </li> <li> <p> <code>DeleteDataset</code> </p> </li> </ul> <p>For more information on the dataset permissions, see <a href=\"https://docs.aws.amazon.com/finspace/latest/userguide/managing-user-permissions.html#supported-dataset-permissions\">Supported Dataset Permissions</a> in the FinSpace User Guide.</p>" 2464 }, 2465 "ResourcePermissionsList":{ 2466 "type":"list", 2467 "member":{"shape":"ResourcePermission"}, 2468 "documentation":"List of Resource Permissions" 2469 }, 2470 "ResultLimit":{ 2471 "type":"integer", 2472 "max":100, 2473 "min":1 2474 }, 2475 "RoleArn":{ 2476 "type":"string", 2477 "max":2048, 2478 "min":20, 2479 "pattern":"^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$" 2480 }, 2481 "S3BucketName":{ 2482 "type":"string", 2483 "max":63, 2484 "min":1, 2485 "pattern":"^.*\\S.*$" 2486 }, 2487 "S3DestinationFormatOptions":{ 2488 "type":"map", 2489 "key":{"shape":"StringMapKey"}, 2490 "value":{"shape":"StringMapValue"} 2491 }, 2492 "S3Key":{ 2493 "type":"string", 2494 "max":1024, 2495 "min":1, 2496 "pattern":"^.*\\S.*$" 2497 }, 2498 "S3Location":{ 2499 "type":"structure", 2500 "required":[ 2501 "bucket", 2502 "key" 2503 ], 2504 "members":{ 2505 "bucket":{ 2506 "shape":"S3BucketName", 2507 "documentation":"<p> The name of the S3 bucket.</p>" 2508 }, 2509 "key":{ 2510 "shape":"S3Key", 2511 "documentation":"<p> The path of the folder, within the S3 bucket that contains the Dataset.</p>" 2512 } 2513 }, 2514 "documentation":"<p>The location of an external Dataview in an S3 bucket.</p>" 2515 }, 2516 "SchemaDefinition":{ 2517 "type":"structure", 2518 "members":{ 2519 "columns":{ 2520 "shape":"ColumnList", 2521 "documentation":"<p>List of column definitions.</p>" 2522 }, 2523 "primaryKeyColumns":{ 2524 "shape":"ColumnNameList", 2525 "documentation":"<p>List of column names used for primary key.</p>" 2526 } 2527 }, 2528 "documentation":"<p>Definition for a schema on a tabular Dataset.</p>" 2529 }, 2530 "SchemaUnion":{ 2531 "type":"structure", 2532 "members":{ 2533 "tabularSchemaConfig":{ 2534 "shape":"SchemaDefinition", 2535 "documentation":"<p>The configuration for a schema on a tabular Dataset.</p>" 2536 } 2537 }, 2538 "documentation":"<p>A union of schema types.</p>" 2539 }, 2540 "SecretAccessKey":{ 2541 "type":"string", 2542 "max":1000, 2543 "min":1, 2544 "pattern":"[\\s\\S]*\\S[\\s\\S]*", 2545 "sensitive":true 2546 }, 2547 "SessionDuration":{ 2548 "type":"long", 2549 "max":60, 2550 "min":1 2551 }, 2552 "SessionToken":{ 2553 "type":"string", 2554 "max":1000, 2555 "min":1, 2556 "pattern":"[\\s\\S]*\\S[\\s\\S]*", 2557 "sensitive":true 2558 }, 2559 "SortColumnList":{ 2560 "type":"list", 2561 "member":{"shape":"StringValueLength1to255"}, 2562 "documentation":"DataView Sort Column List" 2563 }, 2564 "SourceParams":{ 2565 "type":"map", 2566 "key":{"shape":"StringMapKey"}, 2567 "value":{"shape":"StringMapValue"}, 2568 "documentation":"Source Parameters of a Changeset" 2569 }, 2570 "StatusCode":{"type":"integer"}, 2571 "StringMapKey":{ 2572 "type":"string", 2573 "max":128, 2574 "pattern":"[\\s\\S]*\\S[\\s\\S]*" 2575 }, 2576 "StringMapValue":{ 2577 "type":"string", 2578 "max":1000, 2579 "pattern":"[\\s\\S]*\\S[\\s\\S]*" 2580 }, 2581 "StringValueLength1to250":{ 2582 "type":"string", 2583 "documentation":"1 - 250 character String", 2584 "max":250, 2585 "min":1, 2586 "pattern":"[\\s\\S]*\\S[\\s\\S]*" 2587 }, 2588 "StringValueLength1to255":{ 2589 "type":"string", 2590 "documentation":"1 - 255 character String", 2591 "max":255, 2592 "min":1, 2593 "pattern":"[\\s\\S]*\\S[\\s\\S]*" 2594 }, 2595 "ThrottlingException":{ 2596 "type":"structure", 2597 "members":{ 2598 }, 2599 "documentation":"<p>The request was denied due to request throttling.</p>", 2600 "error":{"httpStatusCode":429}, 2601 "exception":true 2602 }, 2603 "TimestampEpoch":{ 2604 "type":"long", 2605 "documentation":"Milliseconds since UTC epoch" 2606 }, 2607 "UpdateChangesetRequest":{ 2608 "type":"structure", 2609 "required":[ 2610 "datasetId", 2611 "changesetId", 2612 "sourceParams", 2613 "formatParams" 2614 ], 2615 "members":{ 2616 "clientToken":{ 2617 "shape":"ClientToken", 2618 "documentation":"<p>A token that ensures idempotency. This token expires in 10 minutes.</p>", 2619 "idempotencyToken":true 2620 }, 2621 "datasetId":{ 2622 "shape":"DatasetId", 2623 "documentation":"<p>The unique identifier for the FinSpace Dataset in which the Changeset is created.</p>", 2624 "location":"uri", 2625 "locationName":"datasetId" 2626 }, 2627 "changesetId":{ 2628 "shape":"ChangesetId", 2629 "documentation":"<p>The unique identifier for the Changeset to update.</p>", 2630 "location":"uri", 2631 "locationName":"changesetId" 2632 }, 2633 "sourceParams":{ 2634 "shape":"SourceParams", 2635 "documentation":"<p>Options that define the location of the data being ingested (<code>s3SourcePath</code>) and the source of the changeset (<code>sourceType</code>).</p> <p>Both <code>s3SourcePath</code> and <code>sourceType</code> are required attributes.</p> <p>Here is an example of how you could specify the <code>sourceParams</code>:</p> <p> <code> \"sourceParams\": { \"s3SourcePath\": \"s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv\", \"sourceType\": \"S3\" } </code> </p> <p>The S3 path that you specify must allow the FinSpace role access. To do that, you first need to configure the IAM policy on S3 bucket. For more information, see <a href=\"https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#access-s3-buckets\">Loading data from an Amazon S3 Bucket using the FinSpace API</a>section.</p>" 2636 }, 2637 "formatParams":{ 2638 "shape":"FormatParams", 2639 "documentation":"<p>Options that define the structure of the source file(s) including the format type (<code>formatType</code>), header row (<code>withHeader</code>), data separation character (<code>separator</code>) and the type of compression (<code>compression</code>). </p> <p> <code>formatType</code> is a required attribute and can have the following values: </p> <ul> <li> <p> <code>PARQUET</code> – Parquet source file format.</p> </li> <li> <p> <code>CSV</code> – CSV source file format.</p> </li> <li> <p> <code>JSON</code> – JSON source file format.</p> </li> <li> <p> <code>XML</code> – XML source file format.</p> </li> </ul> <p>Here is an example of how you could specify the <code>formatParams</code>:</p> <p> <code> \"formatParams\": { \"formatType\": \"CSV\", \"withHeader\": \"true\", \"separator\": \",\", \"compression\":\"None\" } </code> </p> <p>Note that if you only provide <code>formatType</code> as <code>CSV</code>, the rest of the attributes will automatically default to CSV values as following:</p> <p> <code> { \"withHeader\": \"true\", \"separator\": \",\" } </code> </p> <p> For more information about supported file formats, see <a href=\"https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html\">Supported Data Types and File Formats</a> in the FinSpace User Guide.</p>" 2640 } 2641 }, 2642 "documentation":"Request to update an existing changeset." 2643 }, 2644 "UpdateChangesetResponse":{ 2645 "type":"structure", 2646 "members":{ 2647 "changesetId":{ 2648 "shape":"ChangesetId", 2649 "documentation":"<p>The unique identifier for the Changeset to update.</p>" 2650 }, 2651 "datasetId":{ 2652 "shape":"DatasetId", 2653 "documentation":"<p>The unique identifier for the FinSpace Dataset in which the Changeset is created.</p>" 2654 } 2655 }, 2656 "documentation":"The response from a update changeset operation." 2657 }, 2658 "UpdateDatasetRequest":{ 2659 "type":"structure", 2660 "required":[ 2661 "datasetId", 2662 "datasetTitle", 2663 "kind" 2664 ], 2665 "members":{ 2666 "clientToken":{ 2667 "shape":"ClientToken", 2668 "documentation":"<p>A token that ensures idempotency. This token expires in 10 minutes.</p>", 2669 "idempotencyToken":true 2670 }, 2671 "datasetId":{ 2672 "shape":"DatasetId", 2673 "documentation":"<p>The unique identifier for the Dataset to update.</p>", 2674 "location":"uri", 2675 "locationName":"datasetId" 2676 }, 2677 "datasetTitle":{ 2678 "shape":"DatasetTitle", 2679 "documentation":"<p>A display title for the Dataset.</p>" 2680 }, 2681 "kind":{ 2682 "shape":"DatasetKind", 2683 "documentation":"<p>The format in which the Dataset data is structured.</p> <ul> <li> <p> <code>TABULAR</code> – Data is structured in a tabular format.</p> </li> <li> <p> <code>NON_TABULAR</code> – Data is structured in a non-tabular format.</p> </li> </ul>" 2684 }, 2685 "datasetDescription":{ 2686 "shape":"DatasetDescription", 2687 "documentation":"<p>A description for the Dataset.</p>" 2688 }, 2689 "alias":{ 2690 "shape":"AliasString", 2691 "documentation":"<p>The unique resource identifier for a Dataset.</p>" 2692 }, 2693 "schemaDefinition":{ 2694 "shape":"SchemaUnion", 2695 "documentation":"<p>Definition for a schema on a tabular Dataset.</p>" 2696 } 2697 }, 2698 "documentation":"The request for an UpdateDataset operation" 2699 }, 2700 "UpdateDatasetResponse":{ 2701 "type":"structure", 2702 "members":{ 2703 "datasetId":{ 2704 "shape":"DatasetId", 2705 "documentation":"<p>The unique identifier for updated Dataset.</p>" 2706 } 2707 }, 2708 "documentation":"The response from an UpdateDataset operation" 2709 }, 2710 "UpdatePermissionGroupRequest":{ 2711 "type":"structure", 2712 "required":["permissionGroupId"], 2713 "members":{ 2714 "permissionGroupId":{ 2715 "shape":"PermissionGroupId", 2716 "documentation":"<p>The unique identifier for the permission group to update.</p>", 2717 "location":"uri", 2718 "locationName":"permissionGroupId" 2719 }, 2720 "name":{ 2721 "shape":"PermissionGroupName", 2722 "documentation":"<p>The name of the permission group.</p>" 2723 }, 2724 "description":{ 2725 "shape":"PermissionGroupDescription", 2726 "documentation":"<p>A brief description for the permission group.</p>" 2727 }, 2728 "applicationPermissions":{ 2729 "shape":"ApplicationPermissionList", 2730 "documentation":"<p>The permissions that are granted to a specific group for accessing the FinSpace application.</p> <important> <p>When assigning application permissions, be aware that the permission <code>ManageUsersAndGroups</code> allows users to grant themselves or others access to any functionality in their FinSpace environment's application. It should only be granted to trusted users.</p> </important> <ul> <li> <p> <code>CreateDataset</code> – Group members can create new datasets.</p> </li> <li> <p> <code>ManageClusters</code> – Group members can manage Apache Spark clusters from FinSpace notebooks.</p> </li> <li> <p> <code>ManageUsersAndGroups</code> – Group members can manage users and permission groups. This is a privileged permission that allows users to grant themselves or others access to any functionality in the application. It should only be granted to trusted users.</p> </li> <li> <p> <code>ManageAttributeSets</code> – Group members can manage attribute sets.</p> </li> <li> <p> <code>ViewAuditData</code> – Group members can view audit data.</p> </li> <li> <p> <code>AccessNotebooks</code> – Group members will have access to FinSpace notebooks.</p> </li> <li> <p> <code>GetTemporaryCredentials</code> – Group members can get temporary API credentials.</p> </li> </ul>" 2731 }, 2732 "clientToken":{ 2733 "shape":"ClientToken", 2734 "documentation":"<p>A token that ensures idempotency. This token expires in 10 minutes.</p>", 2735 "idempotencyToken":true 2736 } 2737 } 2738 }, 2739 "UpdatePermissionGroupResponse":{ 2740 "type":"structure", 2741 "members":{ 2742 "permissionGroupId":{ 2743 "shape":"PermissionGroupId", 2744 "documentation":"<p>The unique identifier for the updated permission group.</p>" 2745 } 2746 } 2747 }, 2748 "UpdateUserRequest":{ 2749 "type":"structure", 2750 "required":["userId"], 2751 "members":{ 2752 "userId":{ 2753 "shape":"UserId", 2754 "documentation":"<p>The unique identifier for the user that you want to update.</p>", 2755 "location":"uri", 2756 "locationName":"userId" 2757 }, 2758 "type":{ 2759 "shape":"UserType", 2760 "documentation":"<p>The option to indicate the type of user.</p> <ul> <li> <p> <code>SUPER_USER</code>– A user with permission to all the functionality and data in FinSpace.</p> </li> <li> <p> <code>APP_USER</code> – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.</p> </li> </ul>" 2761 }, 2762 "firstName":{ 2763 "shape":"FirstName", 2764 "documentation":"<p>The first name of the user.</p>" 2765 }, 2766 "lastName":{ 2767 "shape":"LastName", 2768 "documentation":"<p>The last name of the user.</p>" 2769 }, 2770 "apiAccess":{ 2771 "shape":"ApiAccess", 2772 "documentation":"<p>The option to indicate whether the user can use the <code>GetProgrammaticAccessCredentials</code> API to obtain credentials that can then be used to access other FinSpace Data API operations.</p> <ul> <li> <p> <code>ENABLED</code> – The user has permissions to use the APIs.</p> </li> <li> <p> <code>DISABLED</code> – The user does not have permissions to use any APIs.</p> </li> </ul>" 2773 }, 2774 "apiAccessPrincipalArn":{ 2775 "shape":"RoleArn", 2776 "documentation":"<p>The ARN identifier of an AWS user or role that is allowed to call the <code>GetProgrammaticAccessCredentials</code> API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.</p>" 2777 }, 2778 "clientToken":{ 2779 "shape":"ClientToken", 2780 "documentation":"<p>A token that ensures idempotency. This token expires in 10 minutes.</p>", 2781 "idempotencyToken":true 2782 } 2783 } 2784 }, 2785 "UpdateUserResponse":{ 2786 "type":"structure", 2787 "members":{ 2788 "userId":{ 2789 "shape":"UserId", 2790 "documentation":"<p>The unique identifier of the updated user.</p>" 2791 } 2792 } 2793 }, 2794 "User":{ 2795 "type":"structure", 2796 "members":{ 2797 "userId":{ 2798 "shape":"UserId", 2799 "documentation":"<p>The unique identifier for the user.</p>" 2800 }, 2801 "status":{ 2802 "shape":"UserStatus", 2803 "documentation":"<p>The current status of the user. </p> <ul> <li> <p> <code>CREATING</code> – The user creation is in progress.</p> </li> <li> <p> <code>ENABLED</code> – The user is created and is currently active.</p> </li> <li> <p> <code>DISABLED</code> – The user is currently inactive.</p> </li> </ul>" 2804 }, 2805 "firstName":{ 2806 "shape":"FirstName", 2807 "documentation":"<p>The first name of the user.</p>" 2808 }, 2809 "lastName":{ 2810 "shape":"LastName", 2811 "documentation":"<p> The last name of the user.</p>" 2812 }, 2813 "emailAddress":{ 2814 "shape":"Email", 2815 "documentation":"<p>The email address of the user. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.</p>" 2816 }, 2817 "type":{ 2818 "shape":"UserType", 2819 "documentation":"<p> Indicates the type of user.</p> <ul> <li> <p> <code>SUPER_USER</code> – A user with permission to all the functionality and data in FinSpace.</p> </li> <li> <p> <code>APP_USER</code> – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.</p> </li> </ul>" 2820 }, 2821 "apiAccess":{ 2822 "shape":"ApiAccess", 2823 "documentation":"<p>Indicates whether the user can use the <code>GetProgrammaticAccessCredentials</code> API to obtain credentials that can then be used to access other FinSpace Data API operations.</p> <ul> <li> <p> <code>ENABLED</code> – The user has permissions to use the APIs.</p> </li> <li> <p> <code>DISABLED</code> – The user does not have permissions to use any APIs.</p> </li> </ul>" 2824 }, 2825 "apiAccessPrincipalArn":{ 2826 "shape":"RoleArn", 2827 "documentation":"<p>The ARN identifier of an AWS user or role that is allowed to call the <code>GetProgrammaticAccessCredentials</code> API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.</p>" 2828 }, 2829 "createTime":{ 2830 "shape":"TimestampEpoch", 2831 "documentation":"<p>The timestamp at which the user was created in FinSpace. The value is determined as epoch time in milliseconds. </p>" 2832 }, 2833 "lastEnabledTime":{ 2834 "shape":"TimestampEpoch", 2835 "documentation":"<p> Describes the last time the user was activated. The value is determined as epoch time in milliseconds. </p>" 2836 }, 2837 "lastDisabledTime":{ 2838 "shape":"TimestampEpoch", 2839 "documentation":"<p>Describes the last time the user was deactivated. The value is determined as epoch time in milliseconds.</p>" 2840 }, 2841 "lastModifiedTime":{ 2842 "shape":"TimestampEpoch", 2843 "documentation":"<p>Describes the last time the user was updated. The value is determined as epoch time in milliseconds. </p>" 2844 }, 2845 "lastLoginTime":{ 2846 "shape":"TimestampEpoch", 2847 "documentation":"<p>Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds. </p>" 2848 } 2849 }, 2850 "documentation":"<p>The details of the user.</p>" 2851 }, 2852 "UserByPermissionGroup":{ 2853 "type":"structure", 2854 "members":{ 2855 "userId":{ 2856 "shape":"UserId", 2857 "documentation":"<p>The unique identifier for the user.</p>" 2858 }, 2859 "status":{ 2860 "shape":"UserStatus", 2861 "documentation":"<p>The current status of the user. </p> <ul> <li> <p> <code>CREATING</code> – The user creation is in progress.</p> </li> <li> <p> <code>ENABLED</code> – The user is created and is currently active.</p> </li> <li> <p> <code>DISABLED</code> – The user is currently inactive.</p> </li> </ul>" 2862 }, 2863 "firstName":{ 2864 "shape":"FirstName", 2865 "documentation":"<p>The first name of the user.</p>" 2866 }, 2867 "lastName":{ 2868 "shape":"LastName", 2869 "documentation":"<p>The last name of the user.</p>" 2870 }, 2871 "emailAddress":{ 2872 "shape":"Email", 2873 "documentation":"<p>The email address of the user. The email address serves as a unique identifier for each user and cannot be changed after it's created.</p>" 2874 }, 2875 "type":{ 2876 "shape":"UserType", 2877 "documentation":"<p> Indicates the type of user.</p> <ul> <li> <p> <code>SUPER_USER</code> – A user with permission to all the functionality and data in FinSpace.</p> </li> <li> <p> <code>APP_USER</code> – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.</p> </li> </ul>" 2878 }, 2879 "apiAccess":{ 2880 "shape":"ApiAccess", 2881 "documentation":"<p>Indicates whether the user can access FinSpace API operations.</p> <ul> <li> <p> <code>ENABLED</code> – The user has permissions to use the API operations.</p> </li> <li> <p> <code>DISABLED</code> – The user does not have permissions to use any API operations.</p> </li> </ul>" 2882 }, 2883 "apiAccessPrincipalArn":{ 2884 "shape":"RoleArn", 2885 "documentation":"<p>The IAM ARN identifier that is attached to FinSpace API calls.</p>" 2886 }, 2887 "membershipStatus":{ 2888 "shape":"PermissionGroupMembershipStatus", 2889 "documentation":"<p>Indicates the status of the user within a permission group.</p> <ul> <li> <p> <code>ADDITION_IN_PROGRESS</code> – The user is currently being added to the permission group.</p> </li> <li> <p> <code>ADDITION_SUCCESS</code> – The user is successfully added to the permission group.</p> </li> <li> <p> <code>REMOVAL_IN_PROGRESS</code> – The user is currently being removed from the permission group.</p> </li> </ul>" 2890 } 2891 }, 2892 "documentation":"<p>The structure of a user associated with a permission group.</p>" 2893 }, 2894 "UserByPermissionGroupList":{ 2895 "type":"list", 2896 "member":{"shape":"UserByPermissionGroup"} 2897 }, 2898 "UserId":{ 2899 "type":"string", 2900 "max":26, 2901 "min":1, 2902 "pattern":".*\\S.*" 2903 }, 2904 "UserList":{ 2905 "type":"list", 2906 "member":{"shape":"User"} 2907 }, 2908 "UserStatus":{ 2909 "type":"string", 2910 "enum":[ 2911 "CREATING", 2912 "ENABLED", 2913 "DISABLED" 2914 ] 2915 }, 2916 "UserType":{ 2917 "type":"string", 2918 "enum":[ 2919 "SUPER_USER", 2920 "APP_USER" 2921 ] 2922 }, 2923 "ValidationException":{ 2924 "type":"structure", 2925 "members":{ 2926 "message":{"shape":"errorMessage"}, 2927 "reason":{"shape":"errorMessage"} 2928 }, 2929 "documentation":"<p>The input fails to satisfy the constraints specified by an AWS service.</p>", 2930 "error":{"httpStatusCode":400}, 2931 "exception":true 2932 }, 2933 "errorMessage":{"type":"string"}, 2934 "locationType":{ 2935 "type":"string", 2936 "enum":[ 2937 "INGESTION", 2938 "SAGEMAKER" 2939 ] 2940 }, 2941 "stringValueLength1to1024":{ 2942 "type":"string", 2943 "max":1024, 2944 "min":1, 2945 "pattern":".*\\S.*" 2946 }, 2947 "stringValueLength1to255":{ 2948 "type":"string", 2949 "max":255, 2950 "min":1 2951 }, 2952 "stringValueLength1to63":{ 2953 "type":"string", 2954 "max":63, 2955 "min":1, 2956 "pattern":".*\\S.*" 2957 }, 2958 "stringValueMaxLength1000":{ 2959 "type":"string", 2960 "max":1000 2961 } 2962 }, 2963 "documentation":"<p> The FinSpace APIs let you take actions inside the FinSpace.</p>" 2964} 2965