1{ 2 "version":"2.0", 3 "metadata":{ 4 "apiVersion":"2023-05-19", 5 "endpointPrefix":"appfabric", 6 "jsonVersion":"1.1", 7 "protocol":"rest-json", 8 "serviceFullName":"AppFabric", 9 "serviceId":"AppFabric", 10 "signatureVersion":"v4", 11 "signingName":"appfabric", 12 "uid":"appfabric-2023-05-19" 13 }, 14 "operations":{ 15 "BatchGetUserAccessTasks":{ 16 "name":"BatchGetUserAccessTasks", 17 "http":{ 18 "method":"POST", 19 "requestUri":"/useraccess/batchget", 20 "responseCode":200 21 }, 22 "input":{"shape":"BatchGetUserAccessTasksRequest"}, 23 "output":{"shape":"BatchGetUserAccessTasksResponse"}, 24 "errors":[ 25 {"shape":"InternalServerException"}, 26 {"shape":"ThrottlingException"}, 27 {"shape":"ValidationException"}, 28 {"shape":"ResourceNotFoundException"}, 29 {"shape":"AccessDeniedException"} 30 ], 31 "documentation":"<p>Gets user access details in a batch request.</p> <p>This action polls data from the tasks that are kicked off by the <code>StartUserAccessTasks</code> action.</p>" 32 }, 33 "ConnectAppAuthorization":{ 34 "name":"ConnectAppAuthorization", 35 "http":{ 36 "method":"POST", 37 "requestUri":"/appbundles/{appBundleIdentifier}/appauthorizations/{appAuthorizationIdentifier}/connect", 38 "responseCode":200 39 }, 40 "input":{"shape":"ConnectAppAuthorizationRequest"}, 41 "output":{"shape":"ConnectAppAuthorizationResponse"}, 42 "errors":[ 43 {"shape":"InternalServerException"}, 44 {"shape":"ThrottlingException"}, 45 {"shape":"ValidationException"}, 46 {"shape":"ResourceNotFoundException"}, 47 {"shape":"AccessDeniedException"} 48 ], 49 "documentation":"<p>Establishes a connection between Amazon Web Services AppFabric and an application, which allows AppFabric to call the APIs of the application.</p>" 50 }, 51 "CreateAppAuthorization":{ 52 "name":"CreateAppAuthorization", 53 "http":{ 54 "method":"POST", 55 "requestUri":"/appbundles/{appBundleIdentifier}/appauthorizations", 56 "responseCode":201 57 }, 58 "input":{"shape":"CreateAppAuthorizationRequest"}, 59 "output":{"shape":"CreateAppAuthorizationResponse"}, 60 "errors":[ 61 {"shape":"InternalServerException"}, 62 {"shape":"ServiceQuotaExceededException"}, 63 {"shape":"ThrottlingException"}, 64 {"shape":"ConflictException"}, 65 {"shape":"ValidationException"}, 66 {"shape":"ResourceNotFoundException"}, 67 {"shape":"AccessDeniedException"} 68 ], 69 "documentation":"<p>Creates an app authorization within an app bundle, which allows AppFabric to connect to an application.</p>", 70 "idempotent":true 71 }, 72 "CreateAppBundle":{ 73 "name":"CreateAppBundle", 74 "http":{ 75 "method":"POST", 76 "requestUri":"/appbundles", 77 "responseCode":201 78 }, 79 "input":{"shape":"CreateAppBundleRequest"}, 80 "output":{"shape":"CreateAppBundleResponse"}, 81 "errors":[ 82 {"shape":"InternalServerException"}, 83 {"shape":"ServiceQuotaExceededException"}, 84 {"shape":"ThrottlingException"}, 85 {"shape":"ConflictException"}, 86 {"shape":"ValidationException"}, 87 {"shape":"AccessDeniedException"} 88 ], 89 "documentation":"<p>Creates an app bundle to collect data from an application using AppFabric.</p>", 90 "idempotent":true 91 }, 92 "CreateIngestion":{ 93 "name":"CreateIngestion", 94 "http":{ 95 "method":"POST", 96 "requestUri":"/appbundles/{appBundleIdentifier}/ingestions", 97 "responseCode":201 98 }, 99 "input":{"shape":"CreateIngestionRequest"}, 100 "output":{"shape":"CreateIngestionResponse"}, 101 "errors":[ 102 {"shape":"InternalServerException"}, 103 {"shape":"ServiceQuotaExceededException"}, 104 {"shape":"ThrottlingException"}, 105 {"shape":"ConflictException"}, 106 {"shape":"ValidationException"}, 107 {"shape":"AccessDeniedException"} 108 ], 109 "documentation":"<p>Creates a data ingestion for an application.</p>", 110 "idempotent":true 111 }, 112 "CreateIngestionDestination":{ 113 "name":"CreateIngestionDestination", 114 "http":{ 115 "method":"POST", 116 "requestUri":"/appbundles/{appBundleIdentifier}/ingestions/{ingestionIdentifier}/ingestiondestinations", 117 "responseCode":201 118 }, 119 "input":{"shape":"CreateIngestionDestinationRequest"}, 120 "output":{"shape":"CreateIngestionDestinationResponse"}, 121 "errors":[ 122 {"shape":"InternalServerException"}, 123 {"shape":"ServiceQuotaExceededException"}, 124 {"shape":"ThrottlingException"}, 125 {"shape":"ConflictException"}, 126 {"shape":"ValidationException"}, 127 {"shape":"AccessDeniedException"} 128 ], 129 "documentation":"<p>Creates an ingestion destination, which specifies how an application's ingested data is processed by Amazon Web Services AppFabric and where it's delivered.</p>", 130 "idempotent":true 131 }, 132 "DeleteAppAuthorization":{ 133 "name":"DeleteAppAuthorization", 134 "http":{ 135 "method":"DELETE", 136 "requestUri":"/appbundles/{appBundleIdentifier}/appauthorizations/{appAuthorizationIdentifier}", 137 "responseCode":204 138 }, 139 "input":{"shape":"DeleteAppAuthorizationRequest"}, 140 "output":{"shape":"DeleteAppAuthorizationResponse"}, 141 "errors":[ 142 {"shape":"InternalServerException"}, 143 {"shape":"ThrottlingException"}, 144 {"shape":"ValidationException"}, 145 {"shape":"ResourceNotFoundException"}, 146 {"shape":"AccessDeniedException"} 147 ], 148 "documentation":"<p>Deletes an app authorization. You must delete the associated ingestion before you can delete an app authorization.</p>", 149 "idempotent":true 150 }, 151 "DeleteAppBundle":{ 152 "name":"DeleteAppBundle", 153 "http":{ 154 "method":"DELETE", 155 "requestUri":"/appbundles/{appBundleIdentifier}", 156 "responseCode":204 157 }, 158 "input":{"shape":"DeleteAppBundleRequest"}, 159 "output":{"shape":"DeleteAppBundleResponse"}, 160 "errors":[ 161 {"shape":"InternalServerException"}, 162 {"shape":"ThrottlingException"}, 163 {"shape":"ConflictException"}, 164 {"shape":"ValidationException"}, 165 {"shape":"AccessDeniedException"} 166 ], 167 "documentation":"<p>Deletes an app bundle. You must delete all associated app authorizations before you can delete an app bundle.</p>", 168 "idempotent":true 169 }, 170 "DeleteIngestion":{ 171 "name":"DeleteIngestion", 172 "http":{ 173 "method":"DELETE", 174 "requestUri":"/appbundles/{appBundleIdentifier}/ingestions/{ingestionIdentifier}", 175 "responseCode":204 176 }, 177 "input":{"shape":"DeleteIngestionRequest"}, 178 "output":{"shape":"DeleteIngestionResponse"}, 179 "errors":[ 180 {"shape":"InternalServerException"}, 181 {"shape":"ThrottlingException"}, 182 {"shape":"ValidationException"}, 183 {"shape":"ResourceNotFoundException"}, 184 {"shape":"AccessDeniedException"} 185 ], 186 "documentation":"<p>Deletes an ingestion. You must stop (disable) the ingestion and you must delete all associated ingestion destinations before you can delete an app ingestion.</p>", 187 "idempotent":true 188 }, 189 "DeleteIngestionDestination":{ 190 "name":"DeleteIngestionDestination", 191 "http":{ 192 "method":"DELETE", 193 "requestUri":"/appbundles/{appBundleIdentifier}/ingestions/{ingestionIdentifier}/ingestiondestinations/{ingestionDestinationIdentifier}", 194 "responseCode":204 195 }, 196 "input":{"shape":"DeleteIngestionDestinationRequest"}, 197 "output":{"shape":"DeleteIngestionDestinationResponse"}, 198 "errors":[ 199 {"shape":"InternalServerException"}, 200 {"shape":"ThrottlingException"}, 201 {"shape":"ValidationException"}, 202 {"shape":"ResourceNotFoundException"}, 203 {"shape":"AccessDeniedException"} 204 ], 205 "documentation":"<p>Deletes an ingestion destination.</p> <p>This deletes the association between an ingestion and it's destination. It doesn't delete previously ingested data or the storage destination, such as the Amazon S3 bucket where the data is delivered. If the ingestion destination is deleted while the associated ingestion is enabled, the ingestion will fail and is eventually disabled.</p>", 206 "idempotent":true 207 }, 208 "GetAppAuthorization":{ 209 "name":"GetAppAuthorization", 210 "http":{ 211 "method":"GET", 212 "requestUri":"/appbundles/{appBundleIdentifier}/appauthorizations/{appAuthorizationIdentifier}", 213 "responseCode":200 214 }, 215 "input":{"shape":"GetAppAuthorizationRequest"}, 216 "output":{"shape":"GetAppAuthorizationResponse"}, 217 "errors":[ 218 {"shape":"InternalServerException"}, 219 {"shape":"ThrottlingException"}, 220 {"shape":"ValidationException"}, 221 {"shape":"ResourceNotFoundException"}, 222 {"shape":"AccessDeniedException"} 223 ], 224 "documentation":"<p>Returns information about an app authorization.</p>" 225 }, 226 "GetAppBundle":{ 227 "name":"GetAppBundle", 228 "http":{ 229 "method":"GET", 230 "requestUri":"/appbundles/{appBundleIdentifier}", 231 "responseCode":200 232 }, 233 "input":{"shape":"GetAppBundleRequest"}, 234 "output":{"shape":"GetAppBundleResponse"}, 235 "errors":[ 236 {"shape":"InternalServerException"}, 237 {"shape":"ThrottlingException"}, 238 {"shape":"ValidationException"}, 239 {"shape":"ResourceNotFoundException"}, 240 {"shape":"AccessDeniedException"} 241 ], 242 "documentation":"<p>Returns information about an app bundle.</p>" 243 }, 244 "GetIngestion":{ 245 "name":"GetIngestion", 246 "http":{ 247 "method":"GET", 248 "requestUri":"/appbundles/{appBundleIdentifier}/ingestions/{ingestionIdentifier}", 249 "responseCode":200 250 }, 251 "input":{"shape":"GetIngestionRequest"}, 252 "output":{"shape":"GetIngestionResponse"}, 253 "errors":[ 254 {"shape":"InternalServerException"}, 255 {"shape":"ThrottlingException"}, 256 {"shape":"ValidationException"}, 257 {"shape":"ResourceNotFoundException"}, 258 {"shape":"AccessDeniedException"} 259 ], 260 "documentation":"<p>Returns information about an ingestion.</p>" 261 }, 262 "GetIngestionDestination":{ 263 "name":"GetIngestionDestination", 264 "http":{ 265 "method":"GET", 266 "requestUri":"/appbundles/{appBundleIdentifier}/ingestions/{ingestionIdentifier}/ingestiondestinations/{ingestionDestinationIdentifier}", 267 "responseCode":200 268 }, 269 "input":{"shape":"GetIngestionDestinationRequest"}, 270 "output":{"shape":"GetIngestionDestinationResponse"}, 271 "errors":[ 272 {"shape":"InternalServerException"}, 273 {"shape":"ThrottlingException"}, 274 {"shape":"ValidationException"}, 275 {"shape":"ResourceNotFoundException"}, 276 {"shape":"AccessDeniedException"} 277 ], 278 "documentation":"<p>Returns information about an ingestion destination.</p>" 279 }, 280 "ListAppAuthorizations":{ 281 "name":"ListAppAuthorizations", 282 "http":{ 283 "method":"GET", 284 "requestUri":"/appbundles/{appBundleIdentifier}/appauthorizations", 285 "responseCode":200 286 }, 287 "input":{"shape":"ListAppAuthorizationsRequest"}, 288 "output":{"shape":"ListAppAuthorizationsResponse"}, 289 "errors":[ 290 {"shape":"InternalServerException"}, 291 {"shape":"ThrottlingException"}, 292 {"shape":"ValidationException"}, 293 {"shape":"ResourceNotFoundException"}, 294 {"shape":"AccessDeniedException"} 295 ], 296 "documentation":"<p>Returns a list of all app authorizations configured for an app bundle.</p>" 297 }, 298 "ListAppBundles":{ 299 "name":"ListAppBundles", 300 "http":{ 301 "method":"GET", 302 "requestUri":"/appbundles", 303 "responseCode":200 304 }, 305 "input":{"shape":"ListAppBundlesRequest"}, 306 "output":{"shape":"ListAppBundlesResponse"}, 307 "errors":[ 308 {"shape":"InternalServerException"}, 309 {"shape":"ThrottlingException"}, 310 {"shape":"ValidationException"}, 311 {"shape":"AccessDeniedException"} 312 ], 313 "documentation":"<p>Returns a list of app bundles.</p>" 314 }, 315 "ListIngestionDestinations":{ 316 "name":"ListIngestionDestinations", 317 "http":{ 318 "method":"GET", 319 "requestUri":"/appbundles/{appBundleIdentifier}/ingestions/{ingestionIdentifier}/ingestiondestinations", 320 "responseCode":200 321 }, 322 "input":{"shape":"ListIngestionDestinationsRequest"}, 323 "output":{"shape":"ListIngestionDestinationsResponse"}, 324 "errors":[ 325 {"shape":"InternalServerException"}, 326 {"shape":"ThrottlingException"}, 327 {"shape":"ValidationException"}, 328 {"shape":"ResourceNotFoundException"}, 329 {"shape":"AccessDeniedException"} 330 ], 331 "documentation":"<p>Returns a list of all ingestion destinations configured for an ingestion.</p>" 332 }, 333 "ListIngestions":{ 334 "name":"ListIngestions", 335 "http":{ 336 "method":"GET", 337 "requestUri":"/appbundles/{appBundleIdentifier}/ingestions", 338 "responseCode":200 339 }, 340 "input":{"shape":"ListIngestionsRequest"}, 341 "output":{"shape":"ListIngestionsResponse"}, 342 "errors":[ 343 {"shape":"InternalServerException"}, 344 {"shape":"ThrottlingException"}, 345 {"shape":"ValidationException"}, 346 {"shape":"ResourceNotFoundException"}, 347 {"shape":"AccessDeniedException"} 348 ], 349 "documentation":"<p>Returns a list of all ingestions configured for an app bundle.</p>" 350 }, 351 "ListTagsForResource":{ 352 "name":"ListTagsForResource", 353 "http":{ 354 "method":"GET", 355 "requestUri":"/tags/{resourceArn}", 356 "responseCode":200 357 }, 358 "input":{"shape":"ListTagsForResourceRequest"}, 359 "output":{"shape":"ListTagsForResourceResponse"}, 360 "errors":[ 361 {"shape":"InternalServerException"}, 362 {"shape":"ThrottlingException"}, 363 {"shape":"ValidationException"}, 364 {"shape":"ResourceNotFoundException"}, 365 {"shape":"AccessDeniedException"} 366 ], 367 "documentation":"<p>Returns a list of tags for a resource.</p>" 368 }, 369 "StartIngestion":{ 370 "name":"StartIngestion", 371 "http":{ 372 "method":"POST", 373 "requestUri":"/appbundles/{appBundleIdentifier}/ingestions/{ingestionIdentifier}/start", 374 "responseCode":200 375 }, 376 "input":{"shape":"StartIngestionRequest"}, 377 "output":{"shape":"StartIngestionResponse"}, 378 "errors":[ 379 {"shape":"InternalServerException"}, 380 {"shape":"ThrottlingException"}, 381 {"shape":"ConflictException"}, 382 {"shape":"ValidationException"}, 383 {"shape":"ResourceNotFoundException"}, 384 {"shape":"AccessDeniedException"} 385 ], 386 "documentation":"<p>Starts (enables) an ingestion, which collects data from an application.</p>" 387 }, 388 "StartUserAccessTasks":{ 389 "name":"StartUserAccessTasks", 390 "http":{ 391 "method":"POST", 392 "requestUri":"/useraccess/start", 393 "responseCode":201 394 }, 395 "input":{"shape":"StartUserAccessTasksRequest"}, 396 "output":{"shape":"StartUserAccessTasksResponse"}, 397 "errors":[ 398 {"shape":"InternalServerException"}, 399 {"shape":"ThrottlingException"}, 400 {"shape":"ValidationException"}, 401 {"shape":"ResourceNotFoundException"}, 402 {"shape":"AccessDeniedException"} 403 ], 404 "documentation":"<p>Starts the tasks to search user access status for a specific email address.</p> <p>The tasks are stopped when the user access status data is found. The tasks are terminated when the API calls to the application time out.</p>" 405 }, 406 "StopIngestion":{ 407 "name":"StopIngestion", 408 "http":{ 409 "method":"POST", 410 "requestUri":"/appbundles/{appBundleIdentifier}/ingestions/{ingestionIdentifier}/stop", 411 "responseCode":200 412 }, 413 "input":{"shape":"StopIngestionRequest"}, 414 "output":{"shape":"StopIngestionResponse"}, 415 "errors":[ 416 {"shape":"InternalServerException"}, 417 {"shape":"ThrottlingException"}, 418 {"shape":"ConflictException"}, 419 {"shape":"ValidationException"}, 420 {"shape":"ResourceNotFoundException"}, 421 {"shape":"AccessDeniedException"} 422 ], 423 "documentation":"<p>Stops (disables) an ingestion.</p>" 424 }, 425 "TagResource":{ 426 "name":"TagResource", 427 "http":{ 428 "method":"POST", 429 "requestUri":"/tags/{resourceArn}", 430 "responseCode":200 431 }, 432 "input":{"shape":"TagResourceRequest"}, 433 "output":{"shape":"TagResourceResponse"}, 434 "errors":[ 435 {"shape":"InternalServerException"}, 436 {"shape":"ThrottlingException"}, 437 {"shape":"ValidationException"}, 438 {"shape":"ResourceNotFoundException"}, 439 {"shape":"AccessDeniedException"} 440 ], 441 "documentation":"<p>Assigns one or more tags (key-value pairs) to the specified resource.</p>" 442 }, 443 "UntagResource":{ 444 "name":"UntagResource", 445 "http":{ 446 "method":"DELETE", 447 "requestUri":"/tags/{resourceArn}", 448 "responseCode":200 449 }, 450 "input":{"shape":"UntagResourceRequest"}, 451 "output":{"shape":"UntagResourceResponse"}, 452 "errors":[ 453 {"shape":"InternalServerException"}, 454 {"shape":"ThrottlingException"}, 455 {"shape":"ValidationException"}, 456 {"shape":"ResourceNotFoundException"}, 457 {"shape":"AccessDeniedException"} 458 ], 459 "documentation":"<p>Removes a tag or tags from a resource.</p>", 460 "idempotent":true 461 }, 462 "UpdateAppAuthorization":{ 463 "name":"UpdateAppAuthorization", 464 "http":{ 465 "method":"PATCH", 466 "requestUri":"/appbundles/{appBundleIdentifier}/appauthorizations/{appAuthorizationIdentifier}", 467 "responseCode":200 468 }, 469 "input":{"shape":"UpdateAppAuthorizationRequest"}, 470 "output":{"shape":"UpdateAppAuthorizationResponse"}, 471 "errors":[ 472 {"shape":"InternalServerException"}, 473 {"shape":"ThrottlingException"}, 474 {"shape":"ValidationException"}, 475 {"shape":"ResourceNotFoundException"}, 476 {"shape":"AccessDeniedException"} 477 ], 478 "documentation":"<p>Updates an app authorization within an app bundle, which allows AppFabric to connect to an application.</p> <p>If the app authorization was in a <code>connected</code> state, updating the app authorization will set it back to a <code>PendingConnect</code> state.</p>" 479 }, 480 "UpdateIngestionDestination":{ 481 "name":"UpdateIngestionDestination", 482 "http":{ 483 "method":"PATCH", 484 "requestUri":"/appbundles/{appBundleIdentifier}/ingestions/{ingestionIdentifier}/ingestiondestinations/{ingestionDestinationIdentifier}", 485 "responseCode":200 486 }, 487 "input":{"shape":"UpdateIngestionDestinationRequest"}, 488 "output":{"shape":"UpdateIngestionDestinationResponse"}, 489 "errors":[ 490 {"shape":"InternalServerException"}, 491 {"shape":"ServiceQuotaExceededException"}, 492 {"shape":"ThrottlingException"}, 493 {"shape":"ConflictException"}, 494 {"shape":"ValidationException"}, 495 {"shape":"ResourceNotFoundException"}, 496 {"shape":"AccessDeniedException"} 497 ], 498 "documentation":"<p>Updates an ingestion destination, which specifies how an application's ingested data is processed by Amazon Web Services AppFabric and where it's delivered.</p>" 499 } 500 }, 501 "shapes":{ 502 "AccessDeniedException":{ 503 "type":"structure", 504 "required":["message"], 505 "members":{ 506 "message":{"shape":"String"} 507 }, 508 "documentation":"<p>You are not authorized to perform this operation.</p>", 509 "error":{ 510 "httpStatusCode":403, 511 "senderFault":true 512 }, 513 "exception":true 514 }, 515 "ApiKeyCredential":{ 516 "type":"structure", 517 "required":["apiKey"], 518 "members":{ 519 "apiKey":{ 520 "shape":"SensitiveString2048", 521 "documentation":"<p>An API key for an application.</p>" 522 } 523 }, 524 "documentation":"<p>Contains API key credential information.</p>" 525 }, 526 "AppAuthorization":{ 527 "type":"structure", 528 "required":[ 529 "appAuthorizationArn", 530 "appBundleArn", 531 "app", 532 "tenant", 533 "authType", 534 "status", 535 "createdAt", 536 "updatedAt" 537 ], 538 "members":{ 539 "appAuthorizationArn":{ 540 "shape":"Arn", 541 "documentation":"<p>The Amazon Resource Name (ARN) of the app authorization.</p>" 542 }, 543 "appBundleArn":{ 544 "shape":"Arn", 545 "documentation":"<p>The Amazon Resource Name (ARN) of the app bundle for the app authorization.</p>" 546 }, 547 "app":{ 548 "shape":"String255", 549 "documentation":"<p>The name of the application.</p>" 550 }, 551 "tenant":{ 552 "shape":"Tenant", 553 "documentation":"<p>Contains information about an application tenant, such as the application display name and identifier.</p>" 554 }, 555 "authType":{ 556 "shape":"AuthType", 557 "documentation":"<p>The authorization type.</p>" 558 }, 559 "status":{ 560 "shape":"AppAuthorizationStatus", 561 "documentation":"<p>The state of the app authorization.</p> <p>The following states are possible:</p> <ul> <li> <p> <code>PendingConnect</code>: The initial state of the app authorization. The app authorization is created but not yet connected.</p> </li> <li> <p> <code>Connected</code>: The app authorization is connected to the application, and is ready to be used.</p> </li> <li> <p> <code>ConnectionValidationFailed</code>: The app authorization received a validation exception when trying to connect to the application. If the app authorization is in this state, you should verify the configured credentials and try to connect the app authorization again.</p> </li> <li> <p> <code>TokenAutoRotationFailed</code>: AppFabric failed to refresh the access token. If the app authorization is in this state, you should try to reconnect the app authorization.</p> </li> </ul>" 562 }, 563 "createdAt":{ 564 "shape":"DateTime", 565 "documentation":"<p>The timestamp of when the app authorization was created.</p>" 566 }, 567 "updatedAt":{ 568 "shape":"DateTime", 569 "documentation":"<p>The timestamp of when the app authorization was last updated.</p>" 570 }, 571 "persona":{ 572 "shape":"Persona", 573 "documentation":"<p>The user persona of the app authorization.</p> <p>This field should always be <code>admin</code>.</p>" 574 }, 575 "authUrl":{ 576 "shape":"String", 577 "documentation":"<p>The application URL for the OAuth flow.</p>" 578 } 579 }, 580 "documentation":"<p>Contains information about an app authorization.</p>" 581 }, 582 "AppAuthorizationStatus":{ 583 "type":"string", 584 "enum":[ 585 "PendingConnect", 586 "Connected", 587 "ConnectionValidationFailed", 588 "TokenAutoRotationFailed" 589 ] 590 }, 591 "AppAuthorizationSummary":{ 592 "type":"structure", 593 "required":[ 594 "appAuthorizationArn", 595 "appBundleArn", 596 "app", 597 "tenant", 598 "status", 599 "updatedAt" 600 ], 601 "members":{ 602 "appAuthorizationArn":{ 603 "shape":"Arn", 604 "documentation":"<p>The Amazon Resource Name (ARN) of the app authorization.</p>" 605 }, 606 "appBundleArn":{ 607 "shape":"Arn", 608 "documentation":"<p>The Amazon Resource Name (ARN) of the app bundle for the app authorization.</p>" 609 }, 610 "app":{ 611 "shape":"String255", 612 "documentation":"<p>The name of the application.</p>" 613 }, 614 "tenant":{ 615 "shape":"Tenant", 616 "documentation":"<p>Contains information about an application tenant, such as the application display name and identifier.</p>" 617 }, 618 "status":{ 619 "shape":"AppAuthorizationStatus", 620 "documentation":"<p>The state of the app authorization.</p> <p>The following states are possible:</p> <ul> <li> <p> <code>PendingConnect</code>: The initial state of the app authorization. The app authorization is created but not yet connected.</p> </li> <li> <p> <code>Connected</code>: The app authorization is connected to the application, and is ready to be used.</p> </li> <li> <p> <code>ConnectionValidationFailed</code>: The app authorization received a validation exception when trying to connect to the application. If the app authorization is in this state, you should verify the configured credentials and try to connect the app authorization again.</p> </li> <li> <p> <code>TokenAutoRotationFailed</code>: AppFabric failed to refresh the access token. If the app authorization is in this state, you should try to reconnect the app authorization.</p> </li> </ul>" 621 }, 622 "updatedAt":{ 623 "shape":"DateTime", 624 "documentation":"<p>Timestamp for when the app authorization was last updated.</p>" 625 } 626 }, 627 "documentation":"<p>Contains a summary of an app authorization.</p>" 628 }, 629 "AppAuthorizationSummaryList":{ 630 "type":"list", 631 "member":{"shape":"AppAuthorizationSummary"} 632 }, 633 "AppBundle":{ 634 "type":"structure", 635 "required":["arn"], 636 "members":{ 637 "arn":{ 638 "shape":"Arn", 639 "documentation":"<p>The Amazon Resource Name (ARN) of the app bundle.</p>" 640 }, 641 "customerManagedKeyArn":{ 642 "shape":"Arn", 643 "documentation":"<p>The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the application data.</p>" 644 } 645 }, 646 "documentation":"<p>Contains information about an app bundle.</p>" 647 }, 648 "AppBundleSummary":{ 649 "type":"structure", 650 "required":["arn"], 651 "members":{ 652 "arn":{ 653 "shape":"Arn", 654 "documentation":"<p>The Amazon Resource Name (ARN) of the app bundle.</p>" 655 } 656 }, 657 "documentation":"<p>Contains a summary of an app bundle.</p>" 658 }, 659 "AppBundleSummaryList":{ 660 "type":"list", 661 "member":{"shape":"AppBundleSummary"} 662 }, 663 "Arn":{ 664 "type":"string", 665 "max":1011, 666 "min":1, 667 "pattern":"arn:.+" 668 }, 669 "AuditLogDestinationConfiguration":{ 670 "type":"structure", 671 "required":["destination"], 672 "members":{ 673 "destination":{ 674 "shape":"Destination", 675 "documentation":"<p>Contains information about an audit log destination.</p>" 676 } 677 }, 678 "documentation":"<p>Contains information about an audit log destination configuration.</p>" 679 }, 680 "AuditLogProcessingConfiguration":{ 681 "type":"structure", 682 "required":[ 683 "schema", 684 "format" 685 ], 686 "members":{ 687 "schema":{ 688 "shape":"Schema", 689 "documentation":"<p>The event schema in which the audit logs need to be formatted.</p>" 690 }, 691 "format":{ 692 "shape":"Format", 693 "documentation":"<p>The format in which the audit logs need to be formatted.</p>" 694 } 695 }, 696 "documentation":"<p>Contains information about an audit log processing configuration.</p>" 697 }, 698 "AuthRequest":{ 699 "type":"structure", 700 "required":[ 701 "redirectUri", 702 "code" 703 ], 704 "members":{ 705 "redirectUri":{ 706 "shape":"RedirectUri", 707 "documentation":"<p>The redirect URL that is specified in the AuthURL and the application client.</p>" 708 }, 709 "code":{ 710 "shape":"SensitiveString2048", 711 "documentation":"<p>The authorization code returned by the application after permission is granted in the application OAuth page (after clicking on the AuthURL).</p>" 712 } 713 }, 714 "documentation":"<p>Contains authorization request information, which is required for Amazon Web Services AppFabric to get the OAuth2 access token for an application.</p>" 715 }, 716 "AuthType":{ 717 "type":"string", 718 "enum":[ 719 "oauth2", 720 "apiKey" 721 ] 722 }, 723 "BatchGetUserAccessTasksRequest":{ 724 "type":"structure", 725 "required":[ 726 "appBundleIdentifier", 727 "taskIdList" 728 ], 729 "members":{ 730 "appBundleIdentifier":{ 731 "shape":"Identifier", 732 "documentation":"<p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.</p>" 733 }, 734 "taskIdList":{ 735 "shape":"TaskIdList", 736 "documentation":"<p>The tasks IDs to use for the request.</p>" 737 } 738 } 739 }, 740 "BatchGetUserAccessTasksResponse":{ 741 "type":"structure", 742 "members":{ 743 "userAccessResultsList":{ 744 "shape":"UserAccessResultsList", 745 "documentation":"<p>Contains a list of user access results.</p>" 746 } 747 } 748 }, 749 "ConflictException":{ 750 "type":"structure", 751 "required":[ 752 "message", 753 "resourceId", 754 "resourceType" 755 ], 756 "members":{ 757 "message":{"shape":"String"}, 758 "resourceId":{ 759 "shape":"String", 760 "documentation":"<p>The resource ID.</p>" 761 }, 762 "resourceType":{ 763 "shape":"String", 764 "documentation":"<p>The resource type.</p>" 765 } 766 }, 767 "documentation":"<p>The request has created a conflict. Check the request parameters and try again.</p>", 768 "error":{ 769 "httpStatusCode":409, 770 "senderFault":true 771 }, 772 "exception":true 773 }, 774 "ConnectAppAuthorizationRequest":{ 775 "type":"structure", 776 "required":[ 777 "appBundleIdentifier", 778 "appAuthorizationIdentifier" 779 ], 780 "members":{ 781 "appBundleIdentifier":{ 782 "shape":"Identifier", 783 "documentation":"<p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle that contains the app authorization to use for the request.</p>", 784 "location":"uri", 785 "locationName":"appBundleIdentifier" 786 }, 787 "appAuthorizationIdentifier":{ 788 "shape":"Identifier", 789 "documentation":"<p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.</p>", 790 "location":"uri", 791 "locationName":"appAuthorizationIdentifier" 792 }, 793 "authRequest":{ 794 "shape":"AuthRequest", 795 "documentation":"<p>Contains OAuth2 authorization information.</p> <p>This is required if the app authorization for the request is configured with an OAuth2 (<code>oauth2</code>) authorization type.</p>" 796 } 797 } 798 }, 799 "ConnectAppAuthorizationResponse":{ 800 "type":"structure", 801 "required":["appAuthorizationSummary"], 802 "members":{ 803 "appAuthorizationSummary":{ 804 "shape":"AppAuthorizationSummary", 805 "documentation":"<p>Contains a summary of the app authorization.</p>" 806 } 807 } 808 }, 809 "CreateAppAuthorizationRequest":{ 810 "type":"structure", 811 "required":[ 812 "appBundleIdentifier", 813 "app", 814 "credential", 815 "tenant", 816 "authType" 817 ], 818 "members":{ 819 "appBundleIdentifier":{ 820 "shape":"Identifier", 821 "documentation":"<p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.</p>", 822 "location":"uri", 823 "locationName":"appBundleIdentifier" 824 }, 825 "app":{ 826 "shape":"String255", 827 "documentation":"<p>The name of the application.</p> <p>Valid values are:</p> <ul> <li> <p> <code>SLACK</code> </p> </li> <li> <p> <code>ASANA</code> </p> </li> <li> <p> <code>JIRA</code> </p> </li> <li> <p> <code>M365</code> </p> </li> <li> <p> <code>M365AUDITLOGS</code> </p> </li> <li> <p> <code>ZOOM</code> </p> </li> <li> <p> <code>ZENDESK</code> </p> </li> <li> <p> <code>OKTA</code> </p> </li> <li> <p> <code>GOOGLE</code> </p> </li> <li> <p> <code>DROPBOX</code> </p> </li> <li> <p> <code>SMARTSHEET</code> </p> </li> <li> <p> <code>CISCO</code> </p> </li> </ul>" 828 }, 829 "credential":{ 830 "shape":"Credential", 831 "documentation":"<p>Contains credentials for the application, such as an API key or OAuth2 client ID and secret.</p> <p>Specify credentials that match the authorization type for your request. For example, if the authorization type for your request is OAuth2 (<code>oauth2</code>), then you should provide only the OAuth2 credentials.</p>" 832 }, 833 "tenant":{ 834 "shape":"Tenant", 835 "documentation":"<p>Contains information about an application tenant, such as the application display name and identifier.</p>" 836 }, 837 "authType":{ 838 "shape":"AuthType", 839 "documentation":"<p>The authorization type for the app authorization.</p>" 840 }, 841 "clientToken":{ 842 "shape":"UUID", 843 "documentation":"<p>Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a <a href=\"https://wikipedia.org/wiki/Universally_unique_identifier\">UUID type of value</a>.</p> <p>If you don't provide this value, then Amazon Web Services generates a random one for you.</p> <p>If you retry the operation with the same <code>ClientToken</code>, but with different parameters, the retry fails with an <code>IdempotentParameterMismatch</code> error.</p>", 844 "idempotencyToken":true 845 }, 846 "tags":{ 847 "shape":"TagList", 848 "documentation":"<p>A map of the key-value pairs of the tag or tags to assign to the resource.</p>" 849 } 850 } 851 }, 852 "CreateAppAuthorizationResponse":{ 853 "type":"structure", 854 "required":["appAuthorization"], 855 "members":{ 856 "appAuthorization":{ 857 "shape":"AppAuthorization", 858 "documentation":"<p>Contains information about an app authorization.</p>" 859 } 860 } 861 }, 862 "CreateAppBundleRequest":{ 863 "type":"structure", 864 "members":{ 865 "clientToken":{ 866 "shape":"UUID", 867 "documentation":"<p>Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a <a href=\"https://wikipedia.org/wiki/Universally_unique_identifier\">UUID type of value</a>.</p> <p>If you don't provide this value, then Amazon Web Services generates a random one for you.</p> <p>If you retry the operation with the same <code>ClientToken</code>, but with different parameters, the retry fails with an <code>IdempotentParameterMismatch</code> error.</p>", 868 "idempotencyToken":true 869 }, 870 "customerManagedKeyIdentifier":{ 871 "shape":"Identifier", 872 "documentation":"<p>The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to use to encrypt the application data. If this is not specified, an Amazon Web Services owned key is used for encryption.</p>" 873 }, 874 "tags":{ 875 "shape":"TagList", 876 "documentation":"<p>A map of the key-value pairs of the tag or tags to assign to the resource.</p>" 877 } 878 } 879 }, 880 "CreateAppBundleResponse":{ 881 "type":"structure", 882 "required":["appBundle"], 883 "members":{ 884 "appBundle":{ 885 "shape":"AppBundle", 886 "documentation":"<p>Contains information about an app bundle.</p>" 887 } 888 } 889 }, 890 "CreateIngestionDestinationRequest":{ 891 "type":"structure", 892 "required":[ 893 "appBundleIdentifier", 894 "ingestionIdentifier", 895 "processingConfiguration", 896 "destinationConfiguration" 897 ], 898 "members":{ 899 "appBundleIdentifier":{ 900 "shape":"Identifier", 901 "documentation":"<p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.</p>", 902 "location":"uri", 903 "locationName":"appBundleIdentifier" 904 }, 905 "ingestionIdentifier":{ 906 "shape":"Identifier", 907 "documentation":"<p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.</p>", 908 "location":"uri", 909 "locationName":"ingestionIdentifier" 910 }, 911 "processingConfiguration":{ 912 "shape":"ProcessingConfiguration", 913 "documentation":"<p>Contains information about how ingested data is processed.</p>" 914 }, 915 "destinationConfiguration":{ 916 "shape":"DestinationConfiguration", 917 "documentation":"<p>Contains information about the destination of ingested data.</p>" 918 }, 919 "clientToken":{ 920 "shape":"UUID", 921 "documentation":"<p>Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a <a href=\"https://wikipedia.org/wiki/Universally_unique_identifier\">UUID type of value</a>.</p> <p>If you don't provide this value, then Amazon Web Services generates a random one for you.</p> <p>If you retry the operation with the same <code>ClientToken</code>, but with different parameters, the retry fails with an <code>IdempotentParameterMismatch</code> error.</p>", 922 "idempotencyToken":true 923 }, 924 "tags":{ 925 "shape":"TagList", 926 "documentation":"<p>A map of the key-value pairs of the tag or tags to assign to the resource.</p>" 927 } 928 } 929 }, 930 "CreateIngestionDestinationResponse":{ 931 "type":"structure", 932 "required":["ingestionDestination"], 933 "members":{ 934 "ingestionDestination":{ 935 "shape":"IngestionDestination", 936 "documentation":"<p>Contains information about an ingestion destination.</p>" 937 } 938 } 939 }, 940 "CreateIngestionRequest":{ 941 "type":"structure", 942 "required":[ 943 "appBundleIdentifier", 944 "app", 945 "tenantId", 946 "ingestionType" 947 ], 948 "members":{ 949 "appBundleIdentifier":{ 950 "shape":"Identifier", 951 "documentation":"<p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.</p>", 952 "location":"uri", 953 "locationName":"appBundleIdentifier" 954 }, 955 "app":{ 956 "shape":"String255", 957 "documentation":"<p>The name of the application.</p> <p>Valid values are:</p> <ul> <li> <p> <code>SLACK</code> </p> </li> <li> <p> <code>ASANA</code> </p> </li> <li> <p> <code>JIRA</code> </p> </li> <li> <p> <code>M365</code> </p> </li> <li> <p> <code>M365AUDITLOGS</code> </p> </li> <li> <p> <code>ZOOM</code> </p> </li> <li> <p> <code>ZENDESK</code> </p> </li> <li> <p> <code>OKTA</code> </p> </li> <li> <p> <code>GOOGLE</code> </p> </li> <li> <p> <code>DROPBOX</code> </p> </li> <li> <p> <code>SMARTSHEET</code> </p> </li> <li> <p> <code>CISCO</code> </p> </li> </ul>" 958 }, 959 "tenantId":{ 960 "shape":"TenantIdentifier", 961 "documentation":"<p>The ID of the application tenant.</p>" 962 }, 963 "ingestionType":{ 964 "shape":"IngestionType", 965 "documentation":"<p>The ingestion type.</p>" 966 }, 967 "clientToken":{ 968 "shape":"UUID", 969 "documentation":"<p>Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a <a href=\"https://wikipedia.org/wiki/Universally_unique_identifier\">UUID type of value</a>.</p> <p>If you don't provide this value, then Amazon Web Services generates a random one for you.</p> <p>If you retry the operation with the same <code>ClientToken</code>, but with different parameters, the retry fails with an <code>IdempotentParameterMismatch</code> error.</p>", 970 "idempotencyToken":true 971 }, 972 "tags":{ 973 "shape":"TagList", 974 "documentation":"<p>A map of the key-value pairs of the tag or tags to assign to the resource.</p>" 975 } 976 } 977 }, 978 "CreateIngestionResponse":{ 979 "type":"structure", 980 "required":["ingestion"], 981 "members":{ 982 "ingestion":{ 983 "shape":"Ingestion", 984 "documentation":"<p>Contains information about an ingestion.</p>" 985 } 986 } 987 }, 988 "Credential":{ 989 "type":"structure", 990 "members":{ 991 "oauth2Credential":{ 992 "shape":"Oauth2Credential", 993 "documentation":"<p>Contains OAuth2 client credential information.</p>" 994 }, 995 "apiKeyCredential":{ 996 "shape":"ApiKeyCredential", 997 "documentation":"<p>Contains API key credential information.</p>" 998 } 999 }, 1000 "documentation":"<p>Contains credential information for an application.</p>", 1001 "union":true 1002 }, 1003 "DateTime":{ 1004 "type":"timestamp", 1005 "timestampFormat":"iso8601" 1006 }, 1007 "DeleteAppAuthorizationRequest":{ 1008 "type":"structure", 1009 "required":[ 1010 "appBundleIdentifier", 1011 "appAuthorizationIdentifier" 1012 ], 1013 "members":{ 1014 "appBundleIdentifier":{ 1015 "shape":"Identifier", 1016 "documentation":"<p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.</p>", 1017 "location":"uri", 1018 "locationName":"appBundleIdentifier" 1019 }, 1020 "appAuthorizationIdentifier":{ 1021 "shape":"Identifier", 1022 "documentation":"<p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.</p>", 1023 "location":"uri", 1024 "locationName":"appAuthorizationIdentifier" 1025 } 1026 } 1027 }, 1028 "DeleteAppAuthorizationResponse":{ 1029 "type":"structure", 1030 "members":{ 1031 } 1032 }, 1033 "DeleteAppBundleRequest":{ 1034 "type":"structure", 1035 "required":["appBundleIdentifier"], 1036 "members":{ 1037 "appBundleIdentifier":{ 1038 "shape":"Identifier", 1039 "documentation":"<p>The ID or Amazon Resource Name (ARN) of the app bundle that needs to be deleted.</p>", 1040 "location":"uri", 1041 "locationName":"appBundleIdentifier" 1042 } 1043 } 1044 }, 1045 "DeleteAppBundleResponse":{ 1046 "type":"structure", 1047 "members":{ 1048 } 1049 }, 1050 "DeleteIngestionDestinationRequest":{ 1051 "type":"structure", 1052 "required":[ 1053 "appBundleIdentifier", 1054 "ingestionIdentifier", 1055 "ingestionDestinationIdentifier" 1056 ], 1057 "members":{ 1058 "appBundleIdentifier":{ 1059 "shape":"Identifier", 1060 "documentation":"<p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.</p>", 1061 "location":"uri", 1062 "locationName":"appBundleIdentifier" 1063 }, 1064 "ingestionIdentifier":{ 1065 "shape":"Identifier", 1066 "documentation":"<p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.</p>", 1067 "location":"uri", 1068 "locationName":"ingestionIdentifier" 1069 }, 1070 "ingestionDestinationIdentifier":{ 1071 "shape":"Identifier", 1072 "documentation":"<p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion destination to use for the request.</p>", 1073 "location":"uri", 1074 "locationName":"ingestionDestinationIdentifier" 1075 } 1076 } 1077 }, 1078 "DeleteIngestionDestinationResponse":{ 1079 "type":"structure", 1080 "members":{ 1081 } 1082 }, 1083 "DeleteIngestionRequest":{ 1084 "type":"structure", 1085 "required":[ 1086 "appBundleIdentifier", 1087 "ingestionIdentifier" 1088 ], 1089 "members":{ 1090 "appBundleIdentifier":{ 1091 "shape":"Identifier", 1092 "documentation":"<p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.</p>", 1093 "location":"uri", 1094 "locationName":"appBundleIdentifier" 1095 }, 1096 "ingestionIdentifier":{ 1097 "shape":"Identifier", 1098 "documentation":"<p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.</p>", 1099 "location":"uri", 1100 "locationName":"ingestionIdentifier" 1101 } 1102 } 1103 }, 1104 "DeleteIngestionResponse":{ 1105 "type":"structure", 1106 "members":{ 1107 } 1108 }, 1109 "Destination":{ 1110 "type":"structure", 1111 "members":{ 1112 "s3Bucket":{ 1113 "shape":"S3Bucket", 1114 "documentation":"<p>Contains information about an Amazon S3 bucket.</p>" 1115 }, 1116 "firehoseStream":{ 1117 "shape":"FirehoseStream", 1118 "documentation":"<p>Contains information about an Amazon Kinesis Data Firehose delivery stream.</p>" 1119 } 1120 }, 1121 "documentation":"<p>Contains information about an audit log destination.</p>", 1122 "union":true 1123 }, 1124 "DestinationConfiguration":{ 1125 "type":"structure", 1126 "members":{ 1127 "auditLog":{ 1128 "shape":"AuditLogDestinationConfiguration", 1129 "documentation":"<p>Contains information about an audit log destination configuration.</p>" 1130 } 1131 }, 1132 "documentation":"<p>Contains information about the destination of ingested data.</p>", 1133 "union":true 1134 }, 1135 "Email":{ 1136 "type":"string", 1137 "max":320, 1138 "min":0, 1139 "pattern":"[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*", 1140 "sensitive":true 1141 }, 1142 "FirehoseStream":{ 1143 "type":"structure", 1144 "required":["streamName"], 1145 "members":{ 1146 "streamName":{ 1147 "shape":"String64", 1148 "documentation":"<p>The name of the Amazon Kinesis Data Firehose delivery stream.</p>" 1149 } 1150 }, 1151 "documentation":"<p>Contains information about an Amazon Kinesis Data Firehose delivery stream.</p>" 1152 }, 1153 "Format":{ 1154 "type":"string", 1155 "enum":[ 1156 "json", 1157 "parquet" 1158 ] 1159 }, 1160 "GetAppAuthorizationRequest":{ 1161 "type":"structure", 1162 "required":[ 1163 "appBundleIdentifier", 1164 "appAuthorizationIdentifier" 1165 ], 1166 "members":{ 1167 "appBundleIdentifier":{ 1168 "shape":"Identifier", 1169 "documentation":"<p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.</p>", 1170 "location":"uri", 1171 "locationName":"appBundleIdentifier" 1172 }, 1173 "appAuthorizationIdentifier":{ 1174 "shape":"Identifier", 1175 "documentation":"<p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.</p>", 1176 "location":"uri", 1177 "locationName":"appAuthorizationIdentifier" 1178 } 1179 } 1180 }, 1181 "GetAppAuthorizationResponse":{ 1182 "type":"structure", 1183 "required":["appAuthorization"], 1184 "members":{ 1185 "appAuthorization":{ 1186 "shape":"AppAuthorization", 1187 "documentation":"<p>Contains information about an app authorization.</p>" 1188 } 1189 } 1190 }, 1191 "GetAppBundleRequest":{ 1192 "type":"structure", 1193 "required":["appBundleIdentifier"], 1194 "members":{ 1195 "appBundleIdentifier":{ 1196 "shape":"Identifier", 1197 "documentation":"<p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.</p>", 1198 "location":"uri", 1199 "locationName":"appBundleIdentifier" 1200 } 1201 } 1202 }, 1203 "GetAppBundleResponse":{ 1204 "type":"structure", 1205 "required":["appBundle"], 1206 "members":{ 1207 "appBundle":{ 1208 "shape":"AppBundle", 1209 "documentation":"<p>Contains information about an app bundle.</p>" 1210 } 1211 } 1212 }, 1213 "GetIngestionDestinationRequest":{ 1214 "type":"structure", 1215 "required":[ 1216 "appBundleIdentifier", 1217 "ingestionIdentifier", 1218 "ingestionDestinationIdentifier" 1219 ], 1220 "members":{ 1221 "appBundleIdentifier":{ 1222 "shape":"Identifier", 1223 "documentation":"<p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.</p>", 1224 "location":"uri", 1225 "locationName":"appBundleIdentifier" 1226 }, 1227 "ingestionIdentifier":{ 1228 "shape":"Identifier", 1229 "documentation":"<p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.</p>", 1230 "location":"uri", 1231 "locationName":"ingestionIdentifier" 1232 }, 1233 "ingestionDestinationIdentifier":{ 1234 "shape":"Identifier", 1235 "documentation":"<p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion destination to use for the request.</p>", 1236 "location":"uri", 1237 "locationName":"ingestionDestinationIdentifier" 1238 } 1239 } 1240 }, 1241 "GetIngestionDestinationResponse":{ 1242 "type":"structure", 1243 "required":["ingestionDestination"], 1244 "members":{ 1245 "ingestionDestination":{ 1246 "shape":"IngestionDestination", 1247 "documentation":"<p>Contains information about an ingestion destination.</p>" 1248 } 1249 } 1250 }, 1251 "GetIngestionRequest":{ 1252 "type":"structure", 1253 "required":[ 1254 "appBundleIdentifier", 1255 "ingestionIdentifier" 1256 ], 1257 "members":{ 1258 "appBundleIdentifier":{ 1259 "shape":"Identifier", 1260 "documentation":"<p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.</p>", 1261 "location":"uri", 1262 "locationName":"appBundleIdentifier" 1263 }, 1264 "ingestionIdentifier":{ 1265 "shape":"Identifier", 1266 "documentation":"<p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.</p>", 1267 "location":"uri", 1268 "locationName":"ingestionIdentifier" 1269 } 1270 } 1271 }, 1272 "GetIngestionResponse":{ 1273 "type":"structure", 1274 "required":["ingestion"], 1275 "members":{ 1276 "ingestion":{ 1277 "shape":"Ingestion", 1278 "documentation":"<p>Contains information about an ingestion.</p>" 1279 } 1280 } 1281 }, 1282 "Identifier":{ 1283 "type":"string", 1284 "max":1011, 1285 "min":1, 1286 "pattern":"arn:.+$|^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" 1287 }, 1288 "Ingestion":{ 1289 "type":"structure", 1290 "required":[ 1291 "arn", 1292 "appBundleArn", 1293 "app", 1294 "tenantId", 1295 "createdAt", 1296 "updatedAt", 1297 "state", 1298 "ingestionType" 1299 ], 1300 "members":{ 1301 "arn":{ 1302 "shape":"Arn", 1303 "documentation":"<p>The Amazon Resource Name (ARN) of the ingestion.</p>" 1304 }, 1305 "appBundleArn":{ 1306 "shape":"Arn", 1307 "documentation":"<p>The Amazon Resource Name (ARN) of the app bundle for the ingestion.</p>" 1308 }, 1309 "app":{ 1310 "shape":"String255", 1311 "documentation":"<p>The name of the application.</p>" 1312 }, 1313 "tenantId":{ 1314 "shape":"TenantIdentifier", 1315 "documentation":"<p>The ID of the application tenant.</p>" 1316 }, 1317 "createdAt":{ 1318 "shape":"DateTime", 1319 "documentation":"<p>The timestamp of when the ingestion was created.</p>" 1320 }, 1321 "updatedAt":{ 1322 "shape":"DateTime", 1323 "documentation":"<p>The timestamp of when the ingestion was last updated.</p>" 1324 }, 1325 "state":{ 1326 "shape":"IngestionState", 1327 "documentation":"<p>The status of the ingestion.</p>" 1328 }, 1329 "ingestionType":{ 1330 "shape":"IngestionType", 1331 "documentation":"<p>The type of the ingestion.</p>" 1332 } 1333 }, 1334 "documentation":"<p>Contains information about an ingestion.</p>" 1335 }, 1336 "IngestionDestination":{ 1337 "type":"structure", 1338 "required":[ 1339 "arn", 1340 "ingestionArn", 1341 "processingConfiguration", 1342 "destinationConfiguration" 1343 ], 1344 "members":{ 1345 "arn":{ 1346 "shape":"Arn", 1347 "documentation":"<p>The Amazon Resource Name (ARN) of the ingestion destination.</p>" 1348 }, 1349 "ingestionArn":{ 1350 "shape":"Arn", 1351 "documentation":"<p>The Amazon Resource Name (ARN) of the ingestion.</p>" 1352 }, 1353 "processingConfiguration":{ 1354 "shape":"ProcessingConfiguration", 1355 "documentation":"<p>Contains information about how ingested data is processed.</p>" 1356 }, 1357 "destinationConfiguration":{ 1358 "shape":"DestinationConfiguration", 1359 "documentation":"<p>Contains information about the destination of ingested data.</p>" 1360 }, 1361 "status":{ 1362 "shape":"IngestionDestinationStatus", 1363 "documentation":"<p>The state of the ingestion destination.</p> <p>The following states are possible:</p> <ul> <li> <p> <code>Active</code>: The ingestion destination is active and is ready to be used.</p> </li> <li> <p> <code>Failed</code>: The ingestion destination has failed. If the ingestion destination is in this state, you should verify the ingestion destination configuration and try again.</p> </li> </ul>" 1364 }, 1365 "statusReason":{ 1366 "shape":"String", 1367 "documentation":"<p>The reason for the current status of the ingestion destination.</p> <p>Only present when the <code>status</code> of ingestion destination is <code>Failed</code>.</p>" 1368 }, 1369 "createdAt":{ 1370 "shape":"DateTime", 1371 "documentation":"<p>The timestamp of when the ingestion destination was created.</p>" 1372 }, 1373 "updatedAt":{ 1374 "shape":"DateTime", 1375 "documentation":"<p>The timestamp of when the ingestion destination was last updated.</p>" 1376 } 1377 }, 1378 "documentation":"<p>Contains information about an ingestion destination.</p>" 1379 }, 1380 "IngestionDestinationList":{ 1381 "type":"list", 1382 "member":{"shape":"IngestionDestinationSummary"} 1383 }, 1384 "IngestionDestinationStatus":{ 1385 "type":"string", 1386 "enum":[ 1387 "Active", 1388 "Failed" 1389 ] 1390 }, 1391 "IngestionDestinationSummary":{ 1392 "type":"structure", 1393 "required":["arn"], 1394 "members":{ 1395 "arn":{ 1396 "shape":"Arn", 1397 "documentation":"<p>The Amazon Resource Name (ARN) of the ingestion destination.</p>" 1398 } 1399 }, 1400 "documentation":"<p>Contains a summary of an ingestion destination.</p>" 1401 }, 1402 "IngestionList":{ 1403 "type":"list", 1404 "member":{"shape":"IngestionSummary"} 1405 }, 1406 "IngestionState":{ 1407 "type":"string", 1408 "enum":[ 1409 "enabled", 1410 "disabled" 1411 ] 1412 }, 1413 "IngestionSummary":{ 1414 "type":"structure", 1415 "required":[ 1416 "arn", 1417 "app", 1418 "tenantId", 1419 "state" 1420 ], 1421 "members":{ 1422 "arn":{ 1423 "shape":"Arn", 1424 "documentation":"<p>The Amazon Resource Name (ARN) of the ingestion.</p>" 1425 }, 1426 "app":{ 1427 "shape":"String255", 1428 "documentation":"<p>The name of the application.</p>" 1429 }, 1430 "tenantId":{ 1431 "shape":"TenantIdentifier", 1432 "documentation":"<p>The ID of the application tenant.</p>" 1433 }, 1434 "state":{ 1435 "shape":"IngestionState", 1436 "documentation":"<p>The status of the ingestion.</p>" 1437 } 1438 }, 1439 "documentation":"<p>Contains a summary of an ingestion.</p>" 1440 }, 1441 "IngestionType":{ 1442 "type":"string", 1443 "enum":["auditLog"] 1444 }, 1445 "Integer":{ 1446 "type":"integer", 1447 "box":true 1448 }, 1449 "InternalServerException":{ 1450 "type":"structure", 1451 "required":["message"], 1452 "members":{ 1453 "message":{"shape":"String"}, 1454 "retryAfterSeconds":{ 1455 "shape":"Integer", 1456 "documentation":"<p>The period of time after which you should retry your request.</p>", 1457 "location":"header", 1458 "locationName":"Retry-After" 1459 } 1460 }, 1461 "documentation":"<p>The request processing has failed because of an unknown error, exception, or failure with an internal server.</p>", 1462 "error":{"httpStatusCode":500}, 1463 "exception":true, 1464 "fault":true, 1465 "retryable":{"throttling":false} 1466 }, 1467 "ListAppAuthorizationsRequest":{ 1468 "type":"structure", 1469 "required":["appBundleIdentifier"], 1470 "members":{ 1471 "appBundleIdentifier":{ 1472 "shape":"Identifier", 1473 "documentation":"<p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.</p>", 1474 "location":"uri", 1475 "locationName":"appBundleIdentifier" 1476 }, 1477 "maxResults":{ 1478 "shape":"MaxResults", 1479 "documentation":"<p>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results.</p> <p>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</p>", 1480 "location":"querystring", 1481 "locationName":"maxResults" 1482 }, 1483 "nextToken":{ 1484 "shape":"String2048", 1485 "documentation":"<p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken error</i>.</p>", 1486 "location":"querystring", 1487 "locationName":"nextToken" 1488 } 1489 } 1490 }, 1491 "ListAppAuthorizationsResponse":{ 1492 "type":"structure", 1493 "required":["appAuthorizationSummaryList"], 1494 "members":{ 1495 "appAuthorizationSummaryList":{ 1496 "shape":"AppAuthorizationSummaryList", 1497 "documentation":"<p>Contains a list of app authorization summaries.</p>" 1498 }, 1499 "nextToken":{ 1500 "shape":"String2048", 1501 "documentation":"<p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken error</i>.</p>" 1502 } 1503 } 1504 }, 1505 "ListAppBundlesRequest":{ 1506 "type":"structure", 1507 "members":{ 1508 "maxResults":{ 1509 "shape":"MaxResults", 1510 "documentation":"<p>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results.</p> <p>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</p>", 1511 "location":"querystring", 1512 "locationName":"maxResults" 1513 }, 1514 "nextToken":{ 1515 "shape":"String2048", 1516 "documentation":"<p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken error</i>.</p>", 1517 "location":"querystring", 1518 "locationName":"nextToken" 1519 } 1520 } 1521 }, 1522 "ListAppBundlesResponse":{ 1523 "type":"structure", 1524 "required":["appBundleSummaryList"], 1525 "members":{ 1526 "appBundleSummaryList":{ 1527 "shape":"AppBundleSummaryList", 1528 "documentation":"<p>Contains a list of app bundle summaries.</p>" 1529 }, 1530 "nextToken":{ 1531 "shape":"String2048", 1532 "documentation":"<p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken error</i>.</p>" 1533 } 1534 } 1535 }, 1536 "ListIngestionDestinationsRequest":{ 1537 "type":"structure", 1538 "required":[ 1539 "appBundleIdentifier", 1540 "ingestionIdentifier" 1541 ], 1542 "members":{ 1543 "appBundleIdentifier":{ 1544 "shape":"Identifier", 1545 "documentation":"<p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.</p>", 1546 "location":"uri", 1547 "locationName":"appBundleIdentifier" 1548 }, 1549 "ingestionIdentifier":{ 1550 "shape":"Identifier", 1551 "documentation":"<p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.</p>", 1552 "location":"uri", 1553 "locationName":"ingestionIdentifier" 1554 }, 1555 "maxResults":{ 1556 "shape":"MaxResults", 1557 "documentation":"<p>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results.</p> <p>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</p>", 1558 "location":"querystring", 1559 "locationName":"maxResults" 1560 }, 1561 "nextToken":{ 1562 "shape":"String", 1563 "documentation":"<p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken error</i>.</p>", 1564 "location":"querystring", 1565 "locationName":"nextToken" 1566 } 1567 } 1568 }, 1569 "ListIngestionDestinationsResponse":{ 1570 "type":"structure", 1571 "required":["ingestionDestinations"], 1572 "members":{ 1573 "ingestionDestinations":{ 1574 "shape":"IngestionDestinationList", 1575 "documentation":"<p>Contains a list of ingestion destination summaries.</p>" 1576 }, 1577 "nextToken":{ 1578 "shape":"String", 1579 "documentation":"<p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken error</i>.</p>" 1580 } 1581 } 1582 }, 1583 "ListIngestionsRequest":{ 1584 "type":"structure", 1585 "required":["appBundleIdentifier"], 1586 "members":{ 1587 "appBundleIdentifier":{ 1588 "shape":"Identifier", 1589 "documentation":"<p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.</p>", 1590 "location":"uri", 1591 "locationName":"appBundleIdentifier" 1592 }, 1593 "maxResults":{ 1594 "shape":"MaxResults", 1595 "documentation":"<p>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results.</p> <p>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</p>", 1596 "location":"querystring", 1597 "locationName":"maxResults" 1598 }, 1599 "nextToken":{ 1600 "shape":"String", 1601 "documentation":"<p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken error</i>.</p>", 1602 "location":"querystring", 1603 "locationName":"nextToken" 1604 } 1605 } 1606 }, 1607 "ListIngestionsResponse":{ 1608 "type":"structure", 1609 "required":["ingestions"], 1610 "members":{ 1611 "ingestions":{ 1612 "shape":"IngestionList", 1613 "documentation":"<p>Contains a list of ingestion summaries.</p>" 1614 }, 1615 "nextToken":{ 1616 "shape":"String", 1617 "documentation":"<p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken error</i>.</p>" 1618 } 1619 } 1620 }, 1621 "ListTagsForResourceRequest":{ 1622 "type":"structure", 1623 "required":["resourceArn"], 1624 "members":{ 1625 "resourceArn":{ 1626 "shape":"Arn", 1627 "documentation":"<p>The Amazon Resource Name (ARN) of the resource for which you want to retrieve tags.</p>", 1628 "location":"uri", 1629 "locationName":"resourceArn" 1630 } 1631 } 1632 }, 1633 "ListTagsForResourceResponse":{ 1634 "type":"structure", 1635 "members":{ 1636 "tags":{ 1637 "shape":"TagList", 1638 "documentation":"<p>A map of the key-value pairs for the tag or tags assigned to the specified resource.</p>" 1639 } 1640 } 1641 }, 1642 "MaxResults":{ 1643 "type":"integer", 1644 "box":true, 1645 "max":100, 1646 "min":1 1647 }, 1648 "Oauth2Credential":{ 1649 "type":"structure", 1650 "required":[ 1651 "clientId", 1652 "clientSecret" 1653 ], 1654 "members":{ 1655 "clientId":{ 1656 "shape":"String2048", 1657 "documentation":"<p>The client ID of the client application.</p>" 1658 }, 1659 "clientSecret":{ 1660 "shape":"SensitiveString2048", 1661 "documentation":"<p>The client secret of the client application.</p>" 1662 } 1663 }, 1664 "documentation":"<p>Contains OAuth2 client credential information.</p>" 1665 }, 1666 "Persona":{ 1667 "type":"string", 1668 "enum":[ 1669 "admin", 1670 "endUser" 1671 ] 1672 }, 1673 "ProcessingConfiguration":{ 1674 "type":"structure", 1675 "members":{ 1676 "auditLog":{ 1677 "shape":"AuditLogProcessingConfiguration", 1678 "documentation":"<p>Contains information about an audit log processing configuration.</p>" 1679 } 1680 }, 1681 "documentation":"<p>Contains information about how ingested data is processed.</p>", 1682 "union":true 1683 }, 1684 "RedirectUri":{ 1685 "type":"string", 1686 "max":1024, 1687 "min":0, 1688 "pattern":"https://[-a-zA-Z0-9-._~:/?#@!$&'()*+,;=]+" 1689 }, 1690 "ResourceNotFoundException":{ 1691 "type":"structure", 1692 "required":[ 1693 "message", 1694 "resourceId", 1695 "resourceType" 1696 ], 1697 "members":{ 1698 "message":{"shape":"String"}, 1699 "resourceId":{ 1700 "shape":"String", 1701 "documentation":"<p>The resource ID.</p>" 1702 }, 1703 "resourceType":{ 1704 "shape":"String", 1705 "documentation":"<p>The resource type.</p>" 1706 } 1707 }, 1708 "documentation":"<p>The specified resource does not exist.</p>", 1709 "error":{ 1710 "httpStatusCode":404, 1711 "senderFault":true 1712 }, 1713 "exception":true 1714 }, 1715 "ResultStatus":{ 1716 "type":"string", 1717 "enum":[ 1718 "IN_PROGRESS", 1719 "COMPLETED", 1720 "FAILED", 1721 "EXPIRED" 1722 ] 1723 }, 1724 "S3Bucket":{ 1725 "type":"structure", 1726 "required":["bucketName"], 1727 "members":{ 1728 "bucketName":{ 1729 "shape":"String63", 1730 "documentation":"<p>The name of the Amazon S3 bucket.</p>" 1731 }, 1732 "prefix":{ 1733 "shape":"String120", 1734 "documentation":"<p>The object key to use.</p>" 1735 } 1736 }, 1737 "documentation":"<p>Contains information about an Amazon S3 bucket.</p>" 1738 }, 1739 "Schema":{ 1740 "type":"string", 1741 "enum":[ 1742 "ocsf", 1743 "raw" 1744 ] 1745 }, 1746 "SensitiveString2048":{ 1747 "type":"string", 1748 "max":2048, 1749 "min":1, 1750 "sensitive":true 1751 }, 1752 "ServiceQuotaExceededException":{ 1753 "type":"structure", 1754 "required":[ 1755 "message", 1756 "resourceId", 1757 "resourceType", 1758 "serviceCode", 1759 "quotaCode" 1760 ], 1761 "members":{ 1762 "message":{"shape":"String"}, 1763 "resourceId":{ 1764 "shape":"String", 1765 "documentation":"<p>The resource ID.</p>" 1766 }, 1767 "resourceType":{ 1768 "shape":"String", 1769 "documentation":"<p>The resource type.</p>" 1770 }, 1771 "serviceCode":{ 1772 "shape":"String", 1773 "documentation":"<p>The code of the service.</p>" 1774 }, 1775 "quotaCode":{ 1776 "shape":"String", 1777 "documentation":"<p>The code for the quota exceeded.</p>" 1778 } 1779 }, 1780 "documentation":"<p>The request exceeds a service quota.</p>", 1781 "error":{ 1782 "httpStatusCode":402, 1783 "senderFault":true 1784 }, 1785 "exception":true 1786 }, 1787 "StartIngestionRequest":{ 1788 "type":"structure", 1789 "required":[ 1790 "ingestionIdentifier", 1791 "appBundleIdentifier" 1792 ], 1793 "members":{ 1794 "ingestionIdentifier":{ 1795 "shape":"Identifier", 1796 "documentation":"<p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.</p>", 1797 "location":"uri", 1798 "locationName":"ingestionIdentifier" 1799 }, 1800 "appBundleIdentifier":{ 1801 "shape":"Identifier", 1802 "documentation":"<p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.</p>", 1803 "location":"uri", 1804 "locationName":"appBundleIdentifier" 1805 } 1806 } 1807 }, 1808 "StartIngestionResponse":{ 1809 "type":"structure", 1810 "members":{ 1811 } 1812 }, 1813 "StartUserAccessTasksRequest":{ 1814 "type":"structure", 1815 "required":[ 1816 "appBundleIdentifier", 1817 "email" 1818 ], 1819 "members":{ 1820 "appBundleIdentifier":{ 1821 "shape":"Identifier", 1822 "documentation":"<p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.</p>" 1823 }, 1824 "email":{ 1825 "shape":"Email", 1826 "documentation":"<p>The email address of the target user.</p>" 1827 } 1828 } 1829 }, 1830 "StartUserAccessTasksResponse":{ 1831 "type":"structure", 1832 "members":{ 1833 "userAccessTasksList":{ 1834 "shape":"UserAccessTasksList", 1835 "documentation":"<p>Contains a list of user access task information.</p>" 1836 } 1837 } 1838 }, 1839 "StopIngestionRequest":{ 1840 "type":"structure", 1841 "required":[ 1842 "ingestionIdentifier", 1843 "appBundleIdentifier" 1844 ], 1845 "members":{ 1846 "ingestionIdentifier":{ 1847 "shape":"Identifier", 1848 "documentation":"<p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.</p>", 1849 "location":"uri", 1850 "locationName":"ingestionIdentifier" 1851 }, 1852 "appBundleIdentifier":{ 1853 "shape":"Identifier", 1854 "documentation":"<p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.</p>", 1855 "location":"uri", 1856 "locationName":"appBundleIdentifier" 1857 } 1858 } 1859 }, 1860 "StopIngestionResponse":{ 1861 "type":"structure", 1862 "members":{ 1863 } 1864 }, 1865 "String":{"type":"string"}, 1866 "String120":{ 1867 "type":"string", 1868 "max":120, 1869 "min":1 1870 }, 1871 "String2048":{ 1872 "type":"string", 1873 "max":2048, 1874 "min":1 1875 }, 1876 "String255":{ 1877 "type":"string", 1878 "max":255, 1879 "min":1 1880 }, 1881 "String63":{ 1882 "type":"string", 1883 "max":63, 1884 "min":3 1885 }, 1886 "String64":{ 1887 "type":"string", 1888 "max":64, 1889 "min":3 1890 }, 1891 "Tag":{ 1892 "type":"structure", 1893 "required":[ 1894 "key", 1895 "value" 1896 ], 1897 "members":{ 1898 "key":{ 1899 "shape":"TagKey", 1900 "documentation":"<p>Tag key.</p>" 1901 }, 1902 "value":{ 1903 "shape":"TagValue", 1904 "documentation":"<p>Tag value.</p>" 1905 } 1906 }, 1907 "documentation":"<p>The key or keys of the key-value pairs for the tag or tags assigned to a resource.</p>" 1908 }, 1909 "TagKey":{ 1910 "type":"string", 1911 "max":128, 1912 "min":1 1913 }, 1914 "TagKeyList":{ 1915 "type":"list", 1916 "member":{"shape":"TagKey"}, 1917 "max":200, 1918 "min":0 1919 }, 1920 "TagList":{ 1921 "type":"list", 1922 "member":{"shape":"Tag"}, 1923 "max":50, 1924 "min":0 1925 }, 1926 "TagResourceRequest":{ 1927 "type":"structure", 1928 "required":[ 1929 "resourceArn", 1930 "tags" 1931 ], 1932 "members":{ 1933 "resourceArn":{ 1934 "shape":"Arn", 1935 "documentation":"<p>The Amazon Resource Name (ARN) of the resource that you want to tag.</p>", 1936 "location":"uri", 1937 "locationName":"resourceArn" 1938 }, 1939 "tags":{ 1940 "shape":"TagList", 1941 "documentation":"<p>A map of the key-value pairs of the tag or tags to assign to the resource.</p>" 1942 } 1943 } 1944 }, 1945 "TagResourceResponse":{ 1946 "type":"structure", 1947 "members":{ 1948 } 1949 }, 1950 "TagValue":{ 1951 "type":"string", 1952 "max":256, 1953 "min":0 1954 }, 1955 "TaskError":{ 1956 "type":"structure", 1957 "members":{ 1958 "errorCode":{ 1959 "shape":"String", 1960 "documentation":"<p>The code of the error.</p>" 1961 }, 1962 "errorMessage":{ 1963 "shape":"String", 1964 "documentation":"<p>The message of the error.</p>" 1965 } 1966 }, 1967 "documentation":"<p>Contains information about an error returned from a user access task.</p>" 1968 }, 1969 "TaskIdList":{ 1970 "type":"list", 1971 "member":{"shape":"UUID"}, 1972 "max":50, 1973 "min":1 1974 }, 1975 "Tenant":{ 1976 "type":"structure", 1977 "required":[ 1978 "tenantIdentifier", 1979 "tenantDisplayName" 1980 ], 1981 "members":{ 1982 "tenantIdentifier":{ 1983 "shape":"TenantIdentifier", 1984 "documentation":"<p>The ID of the application tenant.</p>" 1985 }, 1986 "tenantDisplayName":{ 1987 "shape":"String2048", 1988 "documentation":"<p>The display name of the tenant.</p>" 1989 } 1990 }, 1991 "documentation":"<p>Contains information about an application tenant.</p>" 1992 }, 1993 "TenantIdentifier":{ 1994 "type":"string", 1995 "max":1024, 1996 "min":1 1997 }, 1998 "ThrottlingException":{ 1999 "type":"structure", 2000 "required":["message"], 2001 "members":{ 2002 "message":{"shape":"String"}, 2003 "serviceCode":{ 2004 "shape":"String", 2005 "documentation":"<p>The code of the service.</p>" 2006 }, 2007 "quotaCode":{ 2008 "shape":"String", 2009 "documentation":"<p>The code for the quota exceeded.</p>" 2010 }, 2011 "retryAfterSeconds":{ 2012 "shape":"Integer", 2013 "documentation":"<p>The period of time after which you should retry your request.</p>", 2014 "location":"header", 2015 "locationName":"Retry-After" 2016 } 2017 }, 2018 "documentation":"<p>The request rate exceeds the limit.</p>", 2019 "error":{ 2020 "httpStatusCode":429, 2021 "senderFault":true 2022 }, 2023 "exception":true, 2024 "retryable":{"throttling":true} 2025 }, 2026 "UUID":{ 2027 "type":"string", 2028 "pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" 2029 }, 2030 "UntagResourceRequest":{ 2031 "type":"structure", 2032 "required":[ 2033 "resourceArn", 2034 "tagKeys" 2035 ], 2036 "members":{ 2037 "resourceArn":{ 2038 "shape":"Arn", 2039 "documentation":"<p>The Amazon Resource Name (ARN) of the resource that you want to untag.</p>", 2040 "location":"uri", 2041 "locationName":"resourceArn" 2042 }, 2043 "tagKeys":{ 2044 "shape":"TagKeyList", 2045 "documentation":"<p>The keys of the key-value pairs for the tag or tags you want to remove from the specified resource.</p>", 2046 "location":"querystring", 2047 "locationName":"tagKeys" 2048 } 2049 } 2050 }, 2051 "UntagResourceResponse":{ 2052 "type":"structure", 2053 "members":{ 2054 } 2055 }, 2056 "UpdateAppAuthorizationRequest":{ 2057 "type":"structure", 2058 "required":[ 2059 "appBundleIdentifier", 2060 "appAuthorizationIdentifier" 2061 ], 2062 "members":{ 2063 "appBundleIdentifier":{ 2064 "shape":"Identifier", 2065 "documentation":"<p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.</p>", 2066 "location":"uri", 2067 "locationName":"appBundleIdentifier" 2068 }, 2069 "appAuthorizationIdentifier":{ 2070 "shape":"Identifier", 2071 "documentation":"<p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request.</p>", 2072 "location":"uri", 2073 "locationName":"appAuthorizationIdentifier" 2074 }, 2075 "credential":{ 2076 "shape":"Credential", 2077 "documentation":"<p>Contains credentials for the application, such as an API key or OAuth2 client ID and secret.</p> <p>Specify credentials that match the authorization type of the app authorization to update. For example, if the authorization type of the app authorization is OAuth2 (<code>oauth2</code>), then you should provide only the OAuth2 credentials.</p>" 2078 }, 2079 "tenant":{ 2080 "shape":"Tenant", 2081 "documentation":"<p>Contains information about an application tenant, such as the application display name and identifier.</p>" 2082 } 2083 } 2084 }, 2085 "UpdateAppAuthorizationResponse":{ 2086 "type":"structure", 2087 "required":["appAuthorization"], 2088 "members":{ 2089 "appAuthorization":{ 2090 "shape":"AppAuthorization", 2091 "documentation":"<p>Contains information about an app authorization.</p>" 2092 } 2093 } 2094 }, 2095 "UpdateIngestionDestinationRequest":{ 2096 "type":"structure", 2097 "required":[ 2098 "appBundleIdentifier", 2099 "ingestionIdentifier", 2100 "ingestionDestinationIdentifier", 2101 "destinationConfiguration" 2102 ], 2103 "members":{ 2104 "appBundleIdentifier":{ 2105 "shape":"Identifier", 2106 "documentation":"<p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.</p>", 2107 "location":"uri", 2108 "locationName":"appBundleIdentifier" 2109 }, 2110 "ingestionIdentifier":{ 2111 "shape":"Identifier", 2112 "documentation":"<p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion to use for the request.</p>", 2113 "location":"uri", 2114 "locationName":"ingestionIdentifier" 2115 }, 2116 "ingestionDestinationIdentifier":{ 2117 "shape":"Identifier", 2118 "documentation":"<p>The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the ingestion destination to use for the request.</p>", 2119 "location":"uri", 2120 "locationName":"ingestionDestinationIdentifier" 2121 }, 2122 "destinationConfiguration":{ 2123 "shape":"DestinationConfiguration", 2124 "documentation":"<p>Contains information about the destination of ingested data.</p>" 2125 } 2126 } 2127 }, 2128 "UpdateIngestionDestinationResponse":{ 2129 "type":"structure", 2130 "required":["ingestionDestination"], 2131 "members":{ 2132 "ingestionDestination":{ 2133 "shape":"IngestionDestination", 2134 "documentation":"<p>Contains information about an ingestion destination.</p>" 2135 } 2136 } 2137 }, 2138 "UserAccessResultItem":{ 2139 "type":"structure", 2140 "members":{ 2141 "app":{ 2142 "shape":"String255", 2143 "documentation":"<p>The name of the application.</p>" 2144 }, 2145 "tenantId":{ 2146 "shape":"TenantIdentifier", 2147 "documentation":"<p>The ID of the application tenant.</p>" 2148 }, 2149 "tenantDisplayName":{ 2150 "shape":"String2048", 2151 "documentation":"<p>The display name of the tenant.</p>" 2152 }, 2153 "taskId":{ 2154 "shape":"UUID", 2155 "documentation":"<p>The unique ID of the task.</p>" 2156 }, 2157 "resultStatus":{ 2158 "shape":"ResultStatus", 2159 "documentation":"<p>The status of the user access result item.</p> <p>The following states are possible:</p> <ul> <li> <p> <code>IN_PROGRESS</code>: The user access task is in progress.</p> </li> <li> <p> <code>COMPLETED</code>: The user access task completed successfully.</p> </li> <li> <p> <code>FAILED</code>: The user access task failed.</p> </li> <li> <p> <code>EXPIRED</code>: The user access task expired.</p> </li> </ul>" 2160 }, 2161 "email":{ 2162 "shape":"Email", 2163 "documentation":"<p>The email address of the target user.</p>" 2164 }, 2165 "userId":{ 2166 "shape":"SensitiveString2048", 2167 "documentation":"<p>The unique ID of user.</p>" 2168 }, 2169 "userFullName":{ 2170 "shape":"SensitiveString2048", 2171 "documentation":"<p>The full name of the user.</p>" 2172 }, 2173 "userFirstName":{ 2174 "shape":"SensitiveString2048", 2175 "documentation":"<p>The first name of the user.</p>" 2176 }, 2177 "userLastName":{ 2178 "shape":"SensitiveString2048", 2179 "documentation":"<p>The last name of the user.</p>" 2180 }, 2181 "userStatus":{ 2182 "shape":"String", 2183 "documentation":"<p>The status of the user returned by the application.</p>" 2184 }, 2185 "taskError":{ 2186 "shape":"TaskError", 2187 "documentation":"<p>Contains information about an error returned from a user access task.</p>" 2188 } 2189 }, 2190 "documentation":"<p>Contains information about a user's access to an application.</p>" 2191 }, 2192 "UserAccessResultsList":{ 2193 "type":"list", 2194 "member":{"shape":"UserAccessResultItem"} 2195 }, 2196 "UserAccessTaskItem":{ 2197 "type":"structure", 2198 "required":[ 2199 "app", 2200 "tenantId" 2201 ], 2202 "members":{ 2203 "app":{ 2204 "shape":"String255", 2205 "documentation":"<p>The name of the application.</p>" 2206 }, 2207 "tenantId":{ 2208 "shape":"TenantIdentifier", 2209 "documentation":"<p>The ID of the application tenant.</p>" 2210 }, 2211 "taskId":{ 2212 "shape":"UUID", 2213 "documentation":"<p>The unique ID of the task.</p>" 2214 }, 2215 "error":{ 2216 "shape":"TaskError", 2217 "documentation":"<p>Error from the task, if any.</p>" 2218 } 2219 }, 2220 "documentation":"<p>Contains information about a user access task.</p>" 2221 }, 2222 "UserAccessTasksList":{ 2223 "type":"list", 2224 "member":{"shape":"UserAccessTaskItem"} 2225 }, 2226 "ValidationException":{ 2227 "type":"structure", 2228 "required":[ 2229 "message", 2230 "reason" 2231 ], 2232 "members":{ 2233 "message":{"shape":"String"}, 2234 "reason":{ 2235 "shape":"ValidationExceptionReason", 2236 "documentation":"<p>The reason for the exception.</p>" 2237 }, 2238 "fieldList":{ 2239 "shape":"ValidationExceptionFieldList", 2240 "documentation":"<p>The field list.</p>" 2241 } 2242 }, 2243 "documentation":"<p>The request has invalid or missing parameters.</p>", 2244 "error":{ 2245 "httpStatusCode":400, 2246 "senderFault":true 2247 }, 2248 "exception":true 2249 }, 2250 "ValidationExceptionField":{ 2251 "type":"structure", 2252 "required":[ 2253 "name", 2254 "message" 2255 ], 2256 "members":{ 2257 "name":{ 2258 "shape":"String", 2259 "documentation":"<p>The field name where the invalid entry was detected.</p>" 2260 }, 2261 "message":{ 2262 "shape":"String", 2263 "documentation":"<p>A message about the validation exception.</p>" 2264 } 2265 }, 2266 "documentation":"<p>The input failed to meet the constraints specified by the Amazon Web Services service in a specified field.</p>" 2267 }, 2268 "ValidationExceptionFieldList":{ 2269 "type":"list", 2270 "member":{"shape":"ValidationExceptionField"} 2271 }, 2272 "ValidationExceptionReason":{ 2273 "type":"string", 2274 "enum":[ 2275 "unknownOperation", 2276 "cannotParse", 2277 "fieldValidationFailed", 2278 "other" 2279 ] 2280 } 2281 }, 2282 "documentation":"<p>Amazon Web Services AppFabric quickly connects software as a service (SaaS) applications across your organization. This allows IT and security teams to easily manage and secure applications using a standard schema, and employees can complete everyday tasks faster using generative artificial intelligence (AI). You can use these APIs to complete AppFabric tasks, such as setting up audit log ingestions or viewing user access. For more information about AppFabric, including the required permissions to use the service, see the <a href=\"https://docs.aws.amazon.com/appfabric/latest/adminguide/\">Amazon Web Services AppFabric Administration Guide</a>. For more information about using the Command Line Interface (CLI) to manage your AppFabric resources, see the <a href=\"https://docs.aws.amazon.com/cli/latest/reference/appfabric/index.html\">AppFabric section of the CLI Reference</a>.</p>" 2283} 2284