1{ 2 "smithy": "1.0", 3 "metadata": { 4 "suppressions": [ 5 { 6 "id": "HttpMethodSemantics", 7 "namespace": "*" 8 }, 9 { 10 "id": "HttpResponseCodeSemantics", 11 "namespace": "*" 12 }, 13 { 14 "id": "PaginatedTrait", 15 "namespace": "*" 16 }, 17 { 18 "id": "HttpHeaderTrait", 19 "namespace": "*" 20 }, 21 { 22 "id": "HttpUriConflict", 23 "namespace": "*" 24 }, 25 { 26 "id": "Service", 27 "namespace": "*" 28 } 29 ] 30 }, 31 "shapes": { 32 "com.amazonaws.connectparticipant#AccessDeniedException": { 33 "type": "structure", 34 "members": { 35 "Message": { 36 "target": "com.amazonaws.connectparticipant#Message", 37 "traits": { 38 "smithy.api#required": {} 39 } 40 } 41 }, 42 "traits": { 43 "smithy.api#documentation": "<p>You do not have sufficient access to perform this action.</p>", 44 "smithy.api#error": "client", 45 "smithy.api#httpError": 403 46 } 47 }, 48 "com.amazonaws.connectparticipant#AmazonConnectParticipantServiceLambda": { 49 "type": "service", 50 "version": "2018-09-07", 51 "operations": [ 52 { 53 "target": "com.amazonaws.connectparticipant#CompleteAttachmentUpload" 54 }, 55 { 56 "target": "com.amazonaws.connectparticipant#CreateParticipantConnection" 57 }, 58 { 59 "target": "com.amazonaws.connectparticipant#DisconnectParticipant" 60 }, 61 { 62 "target": "com.amazonaws.connectparticipant#GetAttachment" 63 }, 64 { 65 "target": "com.amazonaws.connectparticipant#GetTranscript" 66 }, 67 { 68 "target": "com.amazonaws.connectparticipant#SendEvent" 69 }, 70 { 71 "target": "com.amazonaws.connectparticipant#SendMessage" 72 }, 73 { 74 "target": "com.amazonaws.connectparticipant#StartAttachmentUpload" 75 } 76 ], 77 "traits": { 78 "aws.api#service": { 79 "sdkId": "ConnectParticipant", 80 "arnNamespace": "connect", 81 "cloudFormationName": "ConnectParticipant", 82 "cloudTrailEventSource": "connectparticipant.amazonaws.com", 83 "endpointPrefix": "participant.connect" 84 }, 85 "aws.auth#sigv4": { 86 "name": "execute-api" 87 }, 88 "aws.protocols#restJson1": {}, 89 "smithy.api#documentation": "<p>Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage\n a customer contact center and provide reliable customer engagement at any scale.</p>\n <p>Amazon Connect enables customer contacts through voice or chat.</p>\n\n <p>The APIs described here are used by chat participants, such as agents and\n customers.</p>", 90 "smithy.api#title": "Amazon Connect Participant Service" 91 } 92 }, 93 "com.amazonaws.connectparticipant#ArtifactId": { 94 "type": "string", 95 "traits": { 96 "smithy.api#length": { 97 "min": 1, 98 "max": 256 99 } 100 } 101 }, 102 "com.amazonaws.connectparticipant#ArtifactStatus": { 103 "type": "string", 104 "traits": { 105 "smithy.api#enum": [ 106 { 107 "value": "APPROVED", 108 "name": "APPROVED" 109 }, 110 { 111 "value": "REJECTED", 112 "name": "REJECTED" 113 }, 114 { 115 "value": "IN_PROGRESS", 116 "name": "IN_PROGRESS" 117 } 118 ] 119 } 120 }, 121 "com.amazonaws.connectparticipant#AttachmentIdList": { 122 "type": "list", 123 "member": { 124 "target": "com.amazonaws.connectparticipant#ArtifactId" 125 }, 126 "traits": { 127 "smithy.api#length": { 128 "min": 1, 129 "max": 1 130 } 131 } 132 }, 133 "com.amazonaws.connectparticipant#AttachmentItem": { 134 "type": "structure", 135 "members": { 136 "ContentType": { 137 "target": "com.amazonaws.connectparticipant#ContentType", 138 "traits": { 139 "smithy.api#documentation": "<p>Describes the MIME file type of the attachment. For a list of supported file types, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits\">Feature specifications</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" 140 } 141 }, 142 "AttachmentId": { 143 "target": "com.amazonaws.connectparticipant#ArtifactId", 144 "traits": { 145 "smithy.api#documentation": "<p>A unique identifier for the attachment.</p>" 146 } 147 }, 148 "AttachmentName": { 149 "target": "com.amazonaws.connectparticipant#AttachmentName", 150 "traits": { 151 "smithy.api#documentation": "<p>A case-sensitive name of the attachment being uploaded.</p>" 152 } 153 }, 154 "Status": { 155 "target": "com.amazonaws.connectparticipant#ArtifactStatus", 156 "traits": { 157 "smithy.api#documentation": "<p>Status of the attachment.</p>" 158 } 159 } 160 }, 161 "traits": { 162 "smithy.api#documentation": "<p>The case-insensitive input to indicate standard MIME type that describes the format of the file\n that will be uploaded.</p>" 163 } 164 }, 165 "com.amazonaws.connectparticipant#AttachmentName": { 166 "type": "string", 167 "traits": { 168 "smithy.api#length": { 169 "min": 1, 170 "max": 256 171 } 172 } 173 }, 174 "com.amazonaws.connectparticipant#AttachmentSizeInBytes": { 175 "type": "long", 176 "traits": { 177 "smithy.api#range": { 178 "min": 1 179 } 180 } 181 }, 182 "com.amazonaws.connectparticipant#Attachments": { 183 "type": "list", 184 "member": { 185 "target": "com.amazonaws.connectparticipant#AttachmentItem" 186 } 187 }, 188 "com.amazonaws.connectparticipant#ChatContent": { 189 "type": "string", 190 "traits": { 191 "smithy.api#length": { 192 "min": 1, 193 "max": 1024 194 } 195 } 196 }, 197 "com.amazonaws.connectparticipant#ChatContentType": { 198 "type": "string", 199 "traits": { 200 "smithy.api#length": { 201 "min": 1, 202 "max": 100 203 } 204 } 205 }, 206 "com.amazonaws.connectparticipant#ChatItemId": { 207 "type": "string", 208 "traits": { 209 "smithy.api#length": { 210 "min": 1, 211 "max": 256 212 } 213 } 214 }, 215 "com.amazonaws.connectparticipant#ChatItemType": { 216 "type": "string", 217 "traits": { 218 "smithy.api#enum": [ 219 { 220 "value": "TYPING", 221 "name": "TYPING" 222 }, 223 { 224 "value": "PARTICIPANT_JOINED", 225 "name": "PARTICIPANT_JOINED" 226 }, 227 { 228 "value": "PARTICIPANT_LEFT", 229 "name": "PARTICIPANT_LEFT" 230 }, 231 { 232 "value": "CHAT_ENDED", 233 "name": "CHAT_ENDED" 234 }, 235 { 236 "value": "TRANSFER_SUCCEEDED", 237 "name": "TRANSFER_SUCCEEDED" 238 }, 239 { 240 "value": "TRANSFER_FAILED", 241 "name": "TRANSFER_FAILED" 242 }, 243 { 244 "value": "MESSAGE", 245 "name": "MESSAGE" 246 }, 247 { 248 "value": "EVENT", 249 "name": "EVENT" 250 }, 251 { 252 "value": "ATTACHMENT", 253 "name": "ATTACHMENT" 254 }, 255 { 256 "value": "CONNECTION_ACK", 257 "name": "CONNECTION_ACK" 258 } 259 ] 260 } 261 }, 262 "com.amazonaws.connectparticipant#ClientToken": { 263 "type": "string", 264 "traits": { 265 "smithy.api#length": { 266 "min": 0, 267 "max": 500 268 } 269 } 270 }, 271 "com.amazonaws.connectparticipant#CompleteAttachmentUpload": { 272 "type": "operation", 273 "input": { 274 "target": "com.amazonaws.connectparticipant#CompleteAttachmentUploadRequest" 275 }, 276 "output": { 277 "target": "com.amazonaws.connectparticipant#CompleteAttachmentUploadResponse" 278 }, 279 "errors": [ 280 { 281 "target": "com.amazonaws.connectparticipant#AccessDeniedException" 282 }, 283 { 284 "target": "com.amazonaws.connectparticipant#ConflictException" 285 }, 286 { 287 "target": "com.amazonaws.connectparticipant#InternalServerException" 288 }, 289 { 290 "target": "com.amazonaws.connectparticipant#ServiceQuotaExceededException" 291 }, 292 { 293 "target": "com.amazonaws.connectparticipant#ThrottlingException" 294 }, 295 { 296 "target": "com.amazonaws.connectparticipant#ValidationException" 297 } 298 ], 299 "traits": { 300 "smithy.api#documentation": "<p>Allows you to confirm that the attachment has been uploaded using the pre-signed URL\n provided in StartAttachmentUpload API. </p>", 301 "smithy.api#http": { 302 "method": "POST", 303 "uri": "/participant/complete-attachment-upload", 304 "code": 200 305 } 306 } 307 }, 308 "com.amazonaws.connectparticipant#CompleteAttachmentUploadRequest": { 309 "type": "structure", 310 "members": { 311 "AttachmentIds": { 312 "target": "com.amazonaws.connectparticipant#AttachmentIdList", 313 "traits": { 314 "smithy.api#documentation": "<p>A list of unique identifiers for the attachments.</p>", 315 "smithy.api#required": {} 316 } 317 }, 318 "ClientToken": { 319 "target": "com.amazonaws.connectparticipant#NonEmptyClientToken", 320 "traits": { 321 "smithy.api#documentation": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.</p>", 322 "smithy.api#idempotencyToken": {}, 323 "smithy.api#required": {} 324 } 325 }, 326 "ConnectionToken": { 327 "target": "com.amazonaws.connectparticipant#ParticipantToken", 328 "traits": { 329 "smithy.api#documentation": "<p>The authentication token associated with the participant's connection.</p>", 330 "smithy.api#httpHeader": "X-Amz-Bearer", 331 "smithy.api#required": {} 332 } 333 } 334 } 335 }, 336 "com.amazonaws.connectparticipant#CompleteAttachmentUploadResponse": { 337 "type": "structure", 338 "members": {} 339 }, 340 "com.amazonaws.connectparticipant#ConflictException": { 341 "type": "structure", 342 "members": { 343 "Message": { 344 "target": "com.amazonaws.connectparticipant#Reason", 345 "traits": { 346 "smithy.api#required": {} 347 } 348 } 349 }, 350 "traits": { 351 "smithy.api#documentation": "<p>An attachment with that identifier is already being uploaded.</p>", 352 "smithy.api#error": "client", 353 "smithy.api#httpError": 409 354 } 355 }, 356 "com.amazonaws.connectparticipant#ConnectionCredentials": { 357 "type": "structure", 358 "members": { 359 "ConnectionToken": { 360 "target": "com.amazonaws.connectparticipant#ParticipantToken", 361 "traits": { 362 "smithy.api#documentation": "<p>The connection token.</p>" 363 } 364 }, 365 "Expiry": { 366 "target": "com.amazonaws.connectparticipant#ISO8601Datetime", 367 "traits": { 368 "smithy.api#documentation": "<p>The expiration of the token.</p>\n <p>It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,\n 2019-11-08T02:41:28.172Z.</p>" 369 } 370 } 371 }, 372 "traits": { 373 "smithy.api#documentation": "<p>Connection credentials. </p>" 374 } 375 }, 376 "com.amazonaws.connectparticipant#ConnectionType": { 377 "type": "string", 378 "traits": { 379 "smithy.api#enum": [ 380 { 381 "value": "WEBSOCKET", 382 "name": "WEBSOCKET" 383 }, 384 { 385 "value": "CONNECTION_CREDENTIALS", 386 "name": "CONNECTION_CREDENTIALS" 387 } 388 ] 389 } 390 }, 391 "com.amazonaws.connectparticipant#ConnectionTypeList": { 392 "type": "list", 393 "member": { 394 "target": "com.amazonaws.connectparticipant#ConnectionType" 395 }, 396 "traits": { 397 "smithy.api#length": { 398 "min": 1 399 } 400 } 401 }, 402 "com.amazonaws.connectparticipant#ContactId": { 403 "type": "string", 404 "traits": { 405 "smithy.api#length": { 406 "min": 1, 407 "max": 256 408 } 409 } 410 }, 411 "com.amazonaws.connectparticipant#ContentType": { 412 "type": "string", 413 "traits": { 414 "smithy.api#length": { 415 "min": 1, 416 "max": 255 417 } 418 } 419 }, 420 "com.amazonaws.connectparticipant#CreateParticipantConnection": { 421 "type": "operation", 422 "input": { 423 "target": "com.amazonaws.connectparticipant#CreateParticipantConnectionRequest" 424 }, 425 "output": { 426 "target": "com.amazonaws.connectparticipant#CreateParticipantConnectionResponse" 427 }, 428 "errors": [ 429 { 430 "target": "com.amazonaws.connectparticipant#AccessDeniedException" 431 }, 432 { 433 "target": "com.amazonaws.connectparticipant#InternalServerException" 434 }, 435 { 436 "target": "com.amazonaws.connectparticipant#ThrottlingException" 437 }, 438 { 439 "target": "com.amazonaws.connectparticipant#ValidationException" 440 } 441 ], 442 "traits": { 443 "smithy.api#documentation": "<p>Creates the participant's connection. Note that ParticipantToken is used for invoking\n this API instead of ConnectionToken.</p>\n <p>The participant token is valid for the lifetime of the participant – until they are\n part of a contact.</p>\n <p>The response URL for <code>WEBSOCKET</code> Type has a connect expiry timeout of 100s.\n Clients must manually connect to the returned websocket URL and subscribe to the desired\n topic. </p>\n <p>For chat, you need to publish the following on the established websocket\n connection:</p>\n\n\n <p>\n <code>{\"topic\":\"aws/subscribe\",\"content\":{\"topics\":[\"aws/chat\"]}}</code>\n </p>\n\n <p>Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter,\n clients need to call this API again to obtain a new websocket URL and perform the same\n steps as before.</p>\n\n <note>\n <p>The Amazon Connect Participant Service APIs do not use <a href=\"https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4\n authentication</a>.</p>\n </note>", 444 "smithy.api#http": { 445 "method": "POST", 446 "uri": "/participant/connection", 447 "code": 200 448 } 449 } 450 }, 451 "com.amazonaws.connectparticipant#CreateParticipantConnectionRequest": { 452 "type": "structure", 453 "members": { 454 "Type": { 455 "target": "com.amazonaws.connectparticipant#ConnectionTypeList", 456 "traits": { 457 "smithy.api#documentation": "<p>Type of connection information required.</p>", 458 "smithy.api#required": {} 459 } 460 }, 461 "ParticipantToken": { 462 "target": "com.amazonaws.connectparticipant#ParticipantToken", 463 "traits": { 464 "smithy.api#documentation": "<p>This is a header parameter.</p>\n <p>The Participant Token as obtained from <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_StartChatContact.html\">StartChatContact</a>\n API response.</p>", 465 "smithy.api#httpHeader": "X-Amz-Bearer", 466 "smithy.api#required": {} 467 } 468 } 469 } 470 }, 471 "com.amazonaws.connectparticipant#CreateParticipantConnectionResponse": { 472 "type": "structure", 473 "members": { 474 "Websocket": { 475 "target": "com.amazonaws.connectparticipant#Websocket", 476 "traits": { 477 "smithy.api#documentation": "<p>Creates the participant's websocket connection.</p>" 478 } 479 }, 480 "ConnectionCredentials": { 481 "target": "com.amazonaws.connectparticipant#ConnectionCredentials", 482 "traits": { 483 "smithy.api#documentation": "<p>Creates the participant's connection credentials. The authentication token associated\n with the participant's connection.</p>" 484 } 485 } 486 } 487 }, 488 "com.amazonaws.connectparticipant#DisconnectParticipant": { 489 "type": "operation", 490 "input": { 491 "target": "com.amazonaws.connectparticipant#DisconnectParticipantRequest" 492 }, 493 "output": { 494 "target": "com.amazonaws.connectparticipant#DisconnectParticipantResponse" 495 }, 496 "errors": [ 497 { 498 "target": "com.amazonaws.connectparticipant#AccessDeniedException" 499 }, 500 { 501 "target": "com.amazonaws.connectparticipant#InternalServerException" 502 }, 503 { 504 "target": "com.amazonaws.connectparticipant#ThrottlingException" 505 }, 506 { 507 "target": "com.amazonaws.connectparticipant#ValidationException" 508 } 509 ], 510 "traits": { 511 "smithy.api#documentation": "<p>Disconnects a participant. Note that ConnectionToken is used for invoking this API\n instead of ParticipantToken.</p>\n <p>The Amazon Connect Participant Service APIs do not use <a href=\"https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4\n authentication</a>.</p>", 512 "smithy.api#http": { 513 "method": "POST", 514 "uri": "/participant/disconnect", 515 "code": 200 516 } 517 } 518 }, 519 "com.amazonaws.connectparticipant#DisconnectParticipantRequest": { 520 "type": "structure", 521 "members": { 522 "ClientToken": { 523 "target": "com.amazonaws.connectparticipant#ClientToken", 524 "traits": { 525 "smithy.api#documentation": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.</p>", 526 "smithy.api#idempotencyToken": {} 527 } 528 }, 529 "ConnectionToken": { 530 "target": "com.amazonaws.connectparticipant#ParticipantToken", 531 "traits": { 532 "smithy.api#documentation": "<p>The authentication token associated with the participant's connection.</p>", 533 "smithy.api#httpHeader": "X-Amz-Bearer", 534 "smithy.api#required": {} 535 } 536 } 537 } 538 }, 539 "com.amazonaws.connectparticipant#DisconnectParticipantResponse": { 540 "type": "structure", 541 "members": {} 542 }, 543 "com.amazonaws.connectparticipant#DisplayName": { 544 "type": "string", 545 "traits": { 546 "smithy.api#length": { 547 "min": 1, 548 "max": 256 549 } 550 } 551 }, 552 "com.amazonaws.connectparticipant#GetAttachment": { 553 "type": "operation", 554 "input": { 555 "target": "com.amazonaws.connectparticipant#GetAttachmentRequest" 556 }, 557 "output": { 558 "target": "com.amazonaws.connectparticipant#GetAttachmentResponse" 559 }, 560 "errors": [ 561 { 562 "target": "com.amazonaws.connectparticipant#AccessDeniedException" 563 }, 564 { 565 "target": "com.amazonaws.connectparticipant#InternalServerException" 566 }, 567 { 568 "target": "com.amazonaws.connectparticipant#ThrottlingException" 569 }, 570 { 571 "target": "com.amazonaws.connectparticipant#ValidationException" 572 } 573 ], 574 "traits": { 575 "smithy.api#documentation": "<p>Provides a pre-signed URL for download of a completed attachment. This is an\n asynchronous API for use with active contacts.</p>", 576 "smithy.api#http": { 577 "method": "POST", 578 "uri": "/participant/attachment", 579 "code": 200 580 } 581 } 582 }, 583 "com.amazonaws.connectparticipant#GetAttachmentRequest": { 584 "type": "structure", 585 "members": { 586 "AttachmentId": { 587 "target": "com.amazonaws.connectparticipant#ArtifactId", 588 "traits": { 589 "smithy.api#documentation": "<p>A unique identifier for the attachment.</p>", 590 "smithy.api#required": {} 591 } 592 }, 593 "ConnectionToken": { 594 "target": "com.amazonaws.connectparticipant#ParticipantToken", 595 "traits": { 596 "smithy.api#documentation": "<p>The authentication token associated with the participant's connection.</p>", 597 "smithy.api#httpHeader": "X-Amz-Bearer", 598 "smithy.api#required": {} 599 } 600 } 601 } 602 }, 603 "com.amazonaws.connectparticipant#GetAttachmentResponse": { 604 "type": "structure", 605 "members": { 606 "Url": { 607 "target": "com.amazonaws.connectparticipant#PreSignedAttachmentUrl", 608 "traits": { 609 "smithy.api#documentation": "<p>The pre-signed URL using which file would be downloaded from Amazon S3 by the API caller.</p>" 610 } 611 }, 612 "UrlExpiry": { 613 "target": "com.amazonaws.connectparticipant#ISO8601Datetime", 614 "traits": { 615 "smithy.api#documentation": "<p>The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.</p>" 616 } 617 } 618 } 619 }, 620 "com.amazonaws.connectparticipant#GetTranscript": { 621 "type": "operation", 622 "input": { 623 "target": "com.amazonaws.connectparticipant#GetTranscriptRequest" 624 }, 625 "output": { 626 "target": "com.amazonaws.connectparticipant#GetTranscriptResponse" 627 }, 628 "errors": [ 629 { 630 "target": "com.amazonaws.connectparticipant#AccessDeniedException" 631 }, 632 { 633 "target": "com.amazonaws.connectparticipant#InternalServerException" 634 }, 635 { 636 "target": "com.amazonaws.connectparticipant#ThrottlingException" 637 }, 638 { 639 "target": "com.amazonaws.connectparticipant#ValidationException" 640 } 641 ], 642 "traits": { 643 "smithy.api#documentation": "<p>Retrieves a transcript of the session, including details about any attachments. Note\n that ConnectionToken is used for invoking this API instead of ParticipantToken.</p>\n <p>The Amazon Connect Participant Service APIs do not use <a href=\"https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4\n authentication</a>.</p>", 644 "smithy.api#http": { 645 "method": "POST", 646 "uri": "/participant/transcript", 647 "code": 200 648 }, 649 "smithy.api#paginated": { 650 "inputToken": "NextToken", 651 "outputToken": "NextToken", 652 "pageSize": "MaxResults" 653 } 654 } 655 }, 656 "com.amazonaws.connectparticipant#GetTranscriptRequest": { 657 "type": "structure", 658 "members": { 659 "ContactId": { 660 "target": "com.amazonaws.connectparticipant#ContactId", 661 "traits": { 662 "smithy.api#documentation": "<p>The contactId from the current contact chain for which transcript is needed.</p>" 663 } 664 }, 665 "MaxResults": { 666 "target": "com.amazonaws.connectparticipant#MaxResults", 667 "traits": { 668 "smithy.api#box": {}, 669 "smithy.api#documentation": "<p>The maximum number of results to return in the page. Default: 10. </p>" 670 } 671 }, 672 "NextToken": { 673 "target": "com.amazonaws.connectparticipant#NextToken", 674 "traits": { 675 "smithy.api#documentation": "<p>The pagination token. Use the value returned previously in the next subsequent request\n to retrieve the next set of results.</p>" 676 } 677 }, 678 "ScanDirection": { 679 "target": "com.amazonaws.connectparticipant#ScanDirection", 680 "traits": { 681 "smithy.api#documentation": "<p>The direction from StartPosition from which to retrieve message. Default: BACKWARD\n when no StartPosition is provided, FORWARD with StartPosition. </p>" 682 } 683 }, 684 "SortOrder": { 685 "target": "com.amazonaws.connectparticipant#SortKey", 686 "traits": { 687 "smithy.api#documentation": "<p>The sort order for the records. Default: DESCENDING.</p>" 688 } 689 }, 690 "StartPosition": { 691 "target": "com.amazonaws.connectparticipant#StartPosition", 692 "traits": { 693 "smithy.api#documentation": "<p>A filtering option for where to start.</p>" 694 } 695 }, 696 "ConnectionToken": { 697 "target": "com.amazonaws.connectparticipant#ParticipantToken", 698 "traits": { 699 "smithy.api#documentation": "<p>The authentication token associated with the participant's connection.</p>", 700 "smithy.api#httpHeader": "X-Amz-Bearer", 701 "smithy.api#required": {} 702 } 703 } 704 } 705 }, 706 "com.amazonaws.connectparticipant#GetTranscriptResponse": { 707 "type": "structure", 708 "members": { 709 "InitialContactId": { 710 "target": "com.amazonaws.connectparticipant#ContactId", 711 "traits": { 712 "smithy.api#documentation": "<p>The initial contact ID for the contact. </p>" 713 } 714 }, 715 "Transcript": { 716 "target": "com.amazonaws.connectparticipant#Transcript", 717 "traits": { 718 "smithy.api#documentation": "<p>The list of messages in the session.</p>" 719 } 720 }, 721 "NextToken": { 722 "target": "com.amazonaws.connectparticipant#NextToken", 723 "traits": { 724 "smithy.api#documentation": "<p>The pagination token. Use the value returned previously in the next subsequent request\n to retrieve the next set of results.</p>" 725 } 726 } 727 } 728 }, 729 "com.amazonaws.connectparticipant#ISO8601Datetime": { 730 "type": "string" 731 }, 732 "com.amazonaws.connectparticipant#Instant": { 733 "type": "string", 734 "traits": { 735 "smithy.api#length": { 736 "min": 1, 737 "max": 100 738 } 739 } 740 }, 741 "com.amazonaws.connectparticipant#InternalServerException": { 742 "type": "structure", 743 "members": { 744 "Message": { 745 "target": "com.amazonaws.connectparticipant#Message", 746 "traits": { 747 "smithy.api#required": {} 748 } 749 } 750 }, 751 "traits": { 752 "smithy.api#documentation": "<p>This exception occurs when there is an internal failure in the Amazon Connect service.</p>", 753 "smithy.api#error": "server", 754 "smithy.api#httpError": 500 755 } 756 }, 757 "com.amazonaws.connectparticipant#Item": { 758 "type": "structure", 759 "members": { 760 "AbsoluteTime": { 761 "target": "com.amazonaws.connectparticipant#Instant", 762 "traits": { 763 "smithy.api#documentation": "<p>The time when the message or event was sent.</p>\n <p>It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,\n 2019-11-08T02:41:28.172Z.</p>" 764 } 765 }, 766 "Content": { 767 "target": "com.amazonaws.connectparticipant#ChatContent", 768 "traits": { 769 "smithy.api#documentation": "<p>The content of the message or event.</p>" 770 } 771 }, 772 "ContentType": { 773 "target": "com.amazonaws.connectparticipant#ChatContentType", 774 "traits": { 775 "smithy.api#documentation": "<p>The type of content of the item.</p>" 776 } 777 }, 778 "Id": { 779 "target": "com.amazonaws.connectparticipant#ChatItemId", 780 "traits": { 781 "smithy.api#documentation": "<p>The ID of the item.</p>" 782 } 783 }, 784 "Type": { 785 "target": "com.amazonaws.connectparticipant#ChatItemType", 786 "traits": { 787 "smithy.api#documentation": "<p>Type of the item: message or event. </p>" 788 } 789 }, 790 "ParticipantId": { 791 "target": "com.amazonaws.connectparticipant#ParticipantId", 792 "traits": { 793 "smithy.api#documentation": "<p>The ID of the sender in the session.</p>" 794 } 795 }, 796 "DisplayName": { 797 "target": "com.amazonaws.connectparticipant#DisplayName", 798 "traits": { 799 "smithy.api#documentation": "<p>The chat display name of the sender.</p>" 800 } 801 }, 802 "ParticipantRole": { 803 "target": "com.amazonaws.connectparticipant#ParticipantRole", 804 "traits": { 805 "smithy.api#documentation": "<p>The role of the sender. For example, is it a customer, agent, or system.</p>" 806 } 807 }, 808 "Attachments": { 809 "target": "com.amazonaws.connectparticipant#Attachments", 810 "traits": { 811 "smithy.api#documentation": "<p>Provides information about the attachments.</p>" 812 } 813 } 814 }, 815 "traits": { 816 "smithy.api#documentation": "<p>An item - message or event - that has been sent. </p>" 817 } 818 }, 819 "com.amazonaws.connectparticipant#MaxResults": { 820 "type": "integer", 821 "traits": { 822 "smithy.api#range": { 823 "min": 0, 824 "max": 100 825 } 826 } 827 }, 828 "com.amazonaws.connectparticipant#Message": { 829 "type": "string" 830 }, 831 "com.amazonaws.connectparticipant#MostRecent": { 832 "type": "integer", 833 "traits": { 834 "smithy.api#range": { 835 "min": 0, 836 "max": 100 837 } 838 } 839 }, 840 "com.amazonaws.connectparticipant#NextToken": { 841 "type": "string", 842 "traits": { 843 "smithy.api#length": { 844 "min": 1, 845 "max": 1000 846 } 847 } 848 }, 849 "com.amazonaws.connectparticipant#NonEmptyClientToken": { 850 "type": "string", 851 "traits": { 852 "smithy.api#length": { 853 "min": 1, 854 "max": 500 855 } 856 } 857 }, 858 "com.amazonaws.connectparticipant#ParticipantId": { 859 "type": "string", 860 "traits": { 861 "smithy.api#length": { 862 "min": 1, 863 "max": 256 864 } 865 } 866 }, 867 "com.amazonaws.connectparticipant#ParticipantRole": { 868 "type": "string", 869 "traits": { 870 "smithy.api#enum": [ 871 { 872 "value": "AGENT", 873 "name": "AGENT" 874 }, 875 { 876 "value": "CUSTOMER", 877 "name": "CUSTOMER" 878 }, 879 { 880 "value": "SYSTEM", 881 "name": "SYSTEM" 882 } 883 ] 884 } 885 }, 886 "com.amazonaws.connectparticipant#ParticipantToken": { 887 "type": "string", 888 "traits": { 889 "smithy.api#length": { 890 "min": 1, 891 "max": 1000 892 } 893 } 894 }, 895 "com.amazonaws.connectparticipant#PreSignedAttachmentUrl": { 896 "type": "string", 897 "traits": { 898 "smithy.api#length": { 899 "min": 1, 900 "max": 2000 901 } 902 } 903 }, 904 "com.amazonaws.connectparticipant#PreSignedConnectionUrl": { 905 "type": "string", 906 "traits": { 907 "smithy.api#length": { 908 "min": 1, 909 "max": 2000 910 } 911 } 912 }, 913 "com.amazonaws.connectparticipant#Reason": { 914 "type": "string", 915 "traits": { 916 "smithy.api#length": { 917 "min": 1, 918 "max": 2000 919 } 920 } 921 }, 922 "com.amazonaws.connectparticipant#ScanDirection": { 923 "type": "string", 924 "traits": { 925 "smithy.api#enum": [ 926 { 927 "value": "FORWARD", 928 "name": "FORWARD" 929 }, 930 { 931 "value": "BACKWARD", 932 "name": "BACKWARD" 933 } 934 ] 935 } 936 }, 937 "com.amazonaws.connectparticipant#SendEvent": { 938 "type": "operation", 939 "input": { 940 "target": "com.amazonaws.connectparticipant#SendEventRequest" 941 }, 942 "output": { 943 "target": "com.amazonaws.connectparticipant#SendEventResponse" 944 }, 945 "errors": [ 946 { 947 "target": "com.amazonaws.connectparticipant#AccessDeniedException" 948 }, 949 { 950 "target": "com.amazonaws.connectparticipant#InternalServerException" 951 }, 952 { 953 "target": "com.amazonaws.connectparticipant#ThrottlingException" 954 }, 955 { 956 "target": "com.amazonaws.connectparticipant#ValidationException" 957 } 958 ], 959 "traits": { 960 "smithy.api#documentation": "<p>Sends an event. Note that ConnectionToken is used for invoking this API instead of\n ParticipantToken.</p>\n <p>The Amazon Connect Participant Service APIs do not use <a href=\"https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4\n authentication</a>.</p>", 961 "smithy.api#http": { 962 "method": "POST", 963 "uri": "/participant/event", 964 "code": 200 965 } 966 } 967 }, 968 "com.amazonaws.connectparticipant#SendEventRequest": { 969 "type": "structure", 970 "members": { 971 "ContentType": { 972 "target": "com.amazonaws.connectparticipant#ChatContentType", 973 "traits": { 974 "smithy.api#documentation": "<p>The content type of the request. Supported types are:</p>\n\n <ul>\n <li>\n <p>application/vnd.amazonaws.connect.event.typing</p>\n </li>\n <li>\n <p>application/vnd.amazonaws.connect.event.connection.acknowledged</p>\n </li>\n </ul>", 975 "smithy.api#required": {} 976 } 977 }, 978 "Content": { 979 "target": "com.amazonaws.connectparticipant#ChatContent", 980 "traits": { 981 "smithy.api#documentation": "<p>The content of the event to be sent (for example, message text). This is not yet\n supported.</p>" 982 } 983 }, 984 "ClientToken": { 985 "target": "com.amazonaws.connectparticipant#ClientToken", 986 "traits": { 987 "smithy.api#documentation": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.</p>", 988 "smithy.api#idempotencyToken": {} 989 } 990 }, 991 "ConnectionToken": { 992 "target": "com.amazonaws.connectparticipant#ParticipantToken", 993 "traits": { 994 "smithy.api#documentation": "<p>The authentication token associated with the participant's connection.</p>", 995 "smithy.api#httpHeader": "X-Amz-Bearer", 996 "smithy.api#required": {} 997 } 998 } 999 } 1000 }, 1001 "com.amazonaws.connectparticipant#SendEventResponse": { 1002 "type": "structure", 1003 "members": { 1004 "Id": { 1005 "target": "com.amazonaws.connectparticipant#ChatItemId", 1006 "traits": { 1007 "smithy.api#documentation": "<p>The ID of the response.</p>" 1008 } 1009 }, 1010 "AbsoluteTime": { 1011 "target": "com.amazonaws.connectparticipant#Instant", 1012 "traits": { 1013 "smithy.api#documentation": "<p>The time when the event was sent.</p>\n <p>It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,\n 2019-11-08T02:41:28.172Z.</p>" 1014 } 1015 } 1016 } 1017 }, 1018 "com.amazonaws.connectparticipant#SendMessage": { 1019 "type": "operation", 1020 "input": { 1021 "target": "com.amazonaws.connectparticipant#SendMessageRequest" 1022 }, 1023 "output": { 1024 "target": "com.amazonaws.connectparticipant#SendMessageResponse" 1025 }, 1026 "errors": [ 1027 { 1028 "target": "com.amazonaws.connectparticipant#AccessDeniedException" 1029 }, 1030 { 1031 "target": "com.amazonaws.connectparticipant#InternalServerException" 1032 }, 1033 { 1034 "target": "com.amazonaws.connectparticipant#ThrottlingException" 1035 }, 1036 { 1037 "target": "com.amazonaws.connectparticipant#ValidationException" 1038 } 1039 ], 1040 "traits": { 1041 "smithy.api#documentation": "<p>Sends a message. Note that ConnectionToken is used for invoking this API instead of\n ParticipantToken.</p>\n <note>\n <p>The Amazon Connect Participant Service APIs do not use <a href=\"https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4\n authentication</a>.</p>\n </note>", 1042 "smithy.api#http": { 1043 "method": "POST", 1044 "uri": "/participant/message", 1045 "code": 200 1046 } 1047 } 1048 }, 1049 "com.amazonaws.connectparticipant#SendMessageRequest": { 1050 "type": "structure", 1051 "members": { 1052 "ContentType": { 1053 "target": "com.amazonaws.connectparticipant#ChatContentType", 1054 "traits": { 1055 "smithy.api#documentation": "<p>The type of the content. Supported types are text/plain.</p>", 1056 "smithy.api#required": {} 1057 } 1058 }, 1059 "Content": { 1060 "target": "com.amazonaws.connectparticipant#ChatContent", 1061 "traits": { 1062 "smithy.api#documentation": "<p>The content of the message.</p>", 1063 "smithy.api#required": {} 1064 } 1065 }, 1066 "ClientToken": { 1067 "target": "com.amazonaws.connectparticipant#ClientToken", 1068 "traits": { 1069 "smithy.api#documentation": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.</p>", 1070 "smithy.api#idempotencyToken": {} 1071 } 1072 }, 1073 "ConnectionToken": { 1074 "target": "com.amazonaws.connectparticipant#ParticipantToken", 1075 "traits": { 1076 "smithy.api#documentation": "<p>The authentication token associated with the connection.</p>", 1077 "smithy.api#httpHeader": "X-Amz-Bearer", 1078 "smithy.api#required": {} 1079 } 1080 } 1081 } 1082 }, 1083 "com.amazonaws.connectparticipant#SendMessageResponse": { 1084 "type": "structure", 1085 "members": { 1086 "Id": { 1087 "target": "com.amazonaws.connectparticipant#ChatItemId", 1088 "traits": { 1089 "smithy.api#documentation": "<p>The ID of the message.</p>" 1090 } 1091 }, 1092 "AbsoluteTime": { 1093 "target": "com.amazonaws.connectparticipant#Instant", 1094 "traits": { 1095 "smithy.api#documentation": "<p>The time when the message was sent.</p>\n <p>It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,\n 2019-11-08T02:41:28.172Z.</p>" 1096 } 1097 } 1098 } 1099 }, 1100 "com.amazonaws.connectparticipant#ServiceQuotaExceededException": { 1101 "type": "structure", 1102 "members": { 1103 "Message": { 1104 "target": "com.amazonaws.connectparticipant#Message", 1105 "traits": { 1106 "smithy.api#required": {} 1107 } 1108 } 1109 }, 1110 "traits": { 1111 "smithy.api#documentation": "<p>The number of attachments per contact exceeds the quota.</p>", 1112 "smithy.api#error": "client", 1113 "smithy.api#httpError": 402 1114 } 1115 }, 1116 "com.amazonaws.connectparticipant#SortKey": { 1117 "type": "string", 1118 "traits": { 1119 "smithy.api#enum": [ 1120 { 1121 "value": "DESCENDING", 1122 "name": "DESCENDING" 1123 }, 1124 { 1125 "value": "ASCENDING", 1126 "name": "ASCENDING" 1127 } 1128 ] 1129 } 1130 }, 1131 "com.amazonaws.connectparticipant#StartAttachmentUpload": { 1132 "type": "operation", 1133 "input": { 1134 "target": "com.amazonaws.connectparticipant#StartAttachmentUploadRequest" 1135 }, 1136 "output": { 1137 "target": "com.amazonaws.connectparticipant#StartAttachmentUploadResponse" 1138 }, 1139 "errors": [ 1140 { 1141 "target": "com.amazonaws.connectparticipant#AccessDeniedException" 1142 }, 1143 { 1144 "target": "com.amazonaws.connectparticipant#InternalServerException" 1145 }, 1146 { 1147 "target": "com.amazonaws.connectparticipant#ServiceQuotaExceededException" 1148 }, 1149 { 1150 "target": "com.amazonaws.connectparticipant#ThrottlingException" 1151 }, 1152 { 1153 "target": "com.amazonaws.connectparticipant#ValidationException" 1154 } 1155 ], 1156 "traits": { 1157 "smithy.api#documentation": "<p>Provides a pre-signed Amazon S3 URL in response for uploading the file directly to\n S3.</p>", 1158 "smithy.api#http": { 1159 "method": "POST", 1160 "uri": "/participant/start-attachment-upload", 1161 "code": 200 1162 } 1163 } 1164 }, 1165 "com.amazonaws.connectparticipant#StartAttachmentUploadRequest": { 1166 "type": "structure", 1167 "members": { 1168 "ContentType": { 1169 "target": "com.amazonaws.connectparticipant#ContentType", 1170 "traits": { 1171 "smithy.api#documentation": "<p>Describes the MIME file type of the attachment. For a list of supported file types, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits\">Feature specifications</a> in the <i>Amazon Connect Administrator Guide</i>.</p>", 1172 "smithy.api#required": {} 1173 } 1174 }, 1175 "AttachmentSizeInBytes": { 1176 "target": "com.amazonaws.connectparticipant#AttachmentSizeInBytes", 1177 "traits": { 1178 "smithy.api#documentation": "<p>The size of the attachment in bytes.</p>", 1179 "smithy.api#required": {} 1180 } 1181 }, 1182 "AttachmentName": { 1183 "target": "com.amazonaws.connectparticipant#AttachmentName", 1184 "traits": { 1185 "smithy.api#documentation": "<p>A case-sensitive name of the attachment being uploaded.</p>", 1186 "smithy.api#required": {} 1187 } 1188 }, 1189 "ClientToken": { 1190 "target": "com.amazonaws.connectparticipant#NonEmptyClientToken", 1191 "traits": { 1192 "smithy.api#documentation": "<p>A unique case sensitive identifier to support idempotency of request.</p>", 1193 "smithy.api#idempotencyToken": {}, 1194 "smithy.api#required": {} 1195 } 1196 }, 1197 "ConnectionToken": { 1198 "target": "com.amazonaws.connectparticipant#ParticipantToken", 1199 "traits": { 1200 "smithy.api#documentation": "<p>The authentication token associated with the participant's connection.</p>", 1201 "smithy.api#httpHeader": "X-Amz-Bearer", 1202 "smithy.api#required": {} 1203 } 1204 } 1205 } 1206 }, 1207 "com.amazonaws.connectparticipant#StartAttachmentUploadResponse": { 1208 "type": "structure", 1209 "members": { 1210 "AttachmentId": { 1211 "target": "com.amazonaws.connectparticipant#ArtifactId", 1212 "traits": { 1213 "smithy.api#documentation": "<p>A unique identifier for the attachment.</p>" 1214 } 1215 }, 1216 "UploadMetadata": { 1217 "target": "com.amazonaws.connectparticipant#UploadMetadata", 1218 "traits": { 1219 "smithy.api#documentation": "<p>Fields to be used while uploading the attachment.</p>" 1220 } 1221 } 1222 } 1223 }, 1224 "com.amazonaws.connectparticipant#StartPosition": { 1225 "type": "structure", 1226 "members": { 1227 "Id": { 1228 "target": "com.amazonaws.connectparticipant#ChatItemId", 1229 "traits": { 1230 "smithy.api#documentation": "<p>The ID of the message or event where to start. </p>" 1231 } 1232 }, 1233 "AbsoluteTime": { 1234 "target": "com.amazonaws.connectparticipant#Instant", 1235 "traits": { 1236 "smithy.api#documentation": "<p>The time in ISO format where to start.</p>\n <p>It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,\n 2019-11-08T02:41:28.172Z.</p>" 1237 } 1238 }, 1239 "MostRecent": { 1240 "target": "com.amazonaws.connectparticipant#MostRecent", 1241 "traits": { 1242 "smithy.api#documentation": "<p>The start position of the most recent message where you want to start. </p>" 1243 } 1244 } 1245 }, 1246 "traits": { 1247 "smithy.api#documentation": "<p>A filtering option for where to start. For example, if you sent 100 messages, start\n with message 50. </p>" 1248 } 1249 }, 1250 "com.amazonaws.connectparticipant#ThrottlingException": { 1251 "type": "structure", 1252 "members": { 1253 "Message": { 1254 "target": "com.amazonaws.connectparticipant#Message", 1255 "traits": { 1256 "smithy.api#required": {} 1257 } 1258 } 1259 }, 1260 "traits": { 1261 "smithy.api#documentation": "<p>The request was denied due to request throttling.</p>", 1262 "smithy.api#error": "client", 1263 "smithy.api#httpError": 429 1264 } 1265 }, 1266 "com.amazonaws.connectparticipant#Transcript": { 1267 "type": "list", 1268 "member": { 1269 "target": "com.amazonaws.connectparticipant#Item" 1270 } 1271 }, 1272 "com.amazonaws.connectparticipant#UploadMetadata": { 1273 "type": "structure", 1274 "members": { 1275 "Url": { 1276 "target": "com.amazonaws.connectparticipant#UploadMetadataUrl", 1277 "traits": { 1278 "smithy.api#documentation": "<p>The pre-signed URL using which file would be downloaded from Amazon S3 by the API caller.</p>" 1279 } 1280 }, 1281 "UrlExpiry": { 1282 "target": "com.amazonaws.connectparticipant#ISO8601Datetime", 1283 "traits": { 1284 "smithy.api#documentation": "<p>The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.</p>" 1285 } 1286 }, 1287 "HeadersToInclude": { 1288 "target": "com.amazonaws.connectparticipant#UploadMetadataSignedHeaders", 1289 "traits": { 1290 "smithy.api#documentation": "<p>The headers to be provided while uploading the file to the URL.</p>" 1291 } 1292 } 1293 }, 1294 "traits": { 1295 "smithy.api#documentation": "<p>Fields to be used while uploading the attachment.</p>" 1296 } 1297 }, 1298 "com.amazonaws.connectparticipant#UploadMetadataSignedHeaders": { 1299 "type": "map", 1300 "key": { 1301 "target": "com.amazonaws.connectparticipant#UploadMetadataSignedHeadersKey" 1302 }, 1303 "value": { 1304 "target": "com.amazonaws.connectparticipant#UploadMetadataSignedHeadersValue" 1305 } 1306 }, 1307 "com.amazonaws.connectparticipant#UploadMetadataSignedHeadersKey": { 1308 "type": "string", 1309 "traits": { 1310 "smithy.api#length": { 1311 "min": 1, 1312 "max": 128 1313 } 1314 } 1315 }, 1316 "com.amazonaws.connectparticipant#UploadMetadataSignedHeadersValue": { 1317 "type": "string", 1318 "traits": { 1319 "smithy.api#length": { 1320 "min": 1, 1321 "max": 256 1322 } 1323 } 1324 }, 1325 "com.amazonaws.connectparticipant#UploadMetadataUrl": { 1326 "type": "string", 1327 "traits": { 1328 "smithy.api#length": { 1329 "min": 1, 1330 "max": 2000 1331 } 1332 } 1333 }, 1334 "com.amazonaws.connectparticipant#ValidationException": { 1335 "type": "structure", 1336 "members": { 1337 "Message": { 1338 "target": "com.amazonaws.connectparticipant#Reason", 1339 "traits": { 1340 "smithy.api#required": {} 1341 } 1342 } 1343 }, 1344 "traits": { 1345 "smithy.api#documentation": "<p>The input fails to satisfy the constraints specified by Amazon Connect.</p>", 1346 "smithy.api#error": "client", 1347 "smithy.api#httpError": 400 1348 } 1349 }, 1350 "com.amazonaws.connectparticipant#Websocket": { 1351 "type": "structure", 1352 "members": { 1353 "Url": { 1354 "target": "com.amazonaws.connectparticipant#PreSignedConnectionUrl", 1355 "traits": { 1356 "smithy.api#documentation": "<p>The URL of the websocket.</p>" 1357 } 1358 }, 1359 "ConnectionExpiry": { 1360 "target": "com.amazonaws.connectparticipant#ISO8601Datetime", 1361 "traits": { 1362 "smithy.api#documentation": "<p>The URL expiration timestamp in ISO date format.</p>\n <p>It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,\n 2019-11-08T02:41:28.172Z.</p>" 1363 } 1364 } 1365 }, 1366 "traits": { 1367 "smithy.api#documentation": "<p>The websocket for the participant's connection.</p>" 1368 } 1369 } 1370 } 1371} 1372