|
47 | 47 | },
|
48 | 48 | "com.amazonaws.connectparticipant#AmazonConnectParticipantServiceLambda": {
|
49 | 49 | "type": "service",
|
| 50 | + "traits": { |
| 51 | + "aws.api#service": { |
| 52 | + "sdkId": "ConnectParticipant", |
| 53 | + "arnNamespace": "connect", |
| 54 | + "cloudFormationName": "ConnectParticipant", |
| 55 | + "cloudTrailEventSource": "connectparticipant.amazonaws.com", |
| 56 | + "endpointPrefix": "participant.connect" |
| 57 | + }, |
| 58 | + "aws.auth#sigv4": { |
| 59 | + "name": "execute-api" |
| 60 | + }, |
| 61 | + "aws.protocols#restJson1": {}, |
| 62 | + "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>", |
| 63 | + "smithy.api#title": "Amazon Connect Participant Service" |
| 64 | + }, |
50 | 65 | "version": "2018-09-07",
|
51 | 66 | "operations": [
|
52 | 67 | {
|
|
73 | 88 | {
|
74 | 89 | "target": "com.amazonaws.connectparticipant#StartAttachmentUpload"
|
75 | 90 | }
|
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 |
| - } |
| 91 | + ] |
92 | 92 | },
|
93 | 93 | "com.amazonaws.connectparticipant#ArtifactId": {
|
94 | 94 | "type": "string",
|
|
185 | 185 | "target": "com.amazonaws.connectparticipant#AttachmentItem"
|
186 | 186 | }
|
187 | 187 | },
|
| 188 | + "com.amazonaws.connectparticipant#Bool": { |
| 189 | + "type": "boolean", |
| 190 | + "traits": { |
| 191 | + "smithy.api#box": {} |
| 192 | + } |
| 193 | + }, |
188 | 194 | "com.amazonaws.connectparticipant#ChatContent": {
|
189 | 195 | "type": "string",
|
190 | 196 | "traits": {
|
|
255 | 261 | {
|
256 | 262 | "value": "CONNECTION_ACK",
|
257 | 263 | "name": "CONNECTION_ACK"
|
| 264 | + }, |
| 265 | + { |
| 266 | + "value": "PARTICIPANT_ACTIVE", |
| 267 | + "name": "PARTICIPANT_ACTIVE" |
| 268 | + }, |
| 269 | + { |
| 270 | + "value": "PARTICIPANT_INACTIVE", |
| 271 | + "name": "PARTICIPANT_INACTIVE" |
| 272 | + }, |
| 273 | + { |
| 274 | + "value": "PARTICIPANT_ENGAGED", |
| 275 | + "name": "PARTICIPANT_ENGAGED" |
| 276 | + }, |
| 277 | + { |
| 278 | + "value": "PARTICIPANT_DISENGAGED", |
| 279 | + "name": "PARTICIPANT_DISENGAGED" |
258 | 280 | }
|
259 | 281 | ]
|
260 | 282 | }
|
|
297 | 319 | }
|
298 | 320 | ],
|
299 | 321 | "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>", |
| 322 | + "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> \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>", |
301 | 323 | "smithy.api#http": {
|
302 | 324 | "method": "POST",
|
303 | 325 | "uri": "/participant/complete-attachment-upload",
|
|
440 | 462 | }
|
441 | 463 | ],
|
442 | 464 | "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>", |
| 465 | + "smithy.api#documentation": "<p>Creates the participant's connection. Note that ParticipantToken is used for invoking this API instead of\n ConnectionToken.</p>\n <p>The participant token is valid for the lifetime of the participant –\n until they are 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 <p>\n <code>{\"topic\":\"aws/subscribe\",\"content\":{\"topics\":[\"aws/chat\"]}}</code>\n </p>\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 <p>\n <b>Message streaming support</b>: This API can also be used together with the\n <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_StartContactStreaming.html\">StartContactStreaming</a>\n API to create a participant connection for chat contacts that are\n not using a websocket. For more information about message streaming, <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/chat-message-streaming.html\">Enable real-time chat message streaming</a> in the <i>Amazon Connect\n Administrator Guide</i>.</p>\n <p>\n <b>Feature specifications</b>: For information about feature specifications, such as the allowed number of open\n websocket connections per participant, 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\n Guide</i>. </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>", |
444 | 466 | "smithy.api#http": {
|
445 | 467 | "method": "POST",
|
446 | 468 | "uri": "/participant/connection",
|
|
461 | 483 | "ParticipantToken": {
|
462 | 484 | "target": "com.amazonaws.connectparticipant#ParticipantToken",
|
463 | 485 | "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>", |
| 486 | + "smithy.api#documentation": "<p>This is a header parameter.</p>\n <p>The ParticipantToken as obtained from <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_StartChatContact.html\">StartChatContact</a>\n API response.</p>", |
465 | 487 | "smithy.api#httpHeader": "X-Amz-Bearer",
|
466 | 488 | "smithy.api#required": {}
|
467 | 489 | }
|
| 490 | + }, |
| 491 | + "ConnectParticipant": { |
| 492 | + "target": "com.amazonaws.connectparticipant#Bool", |
| 493 | + "traits": { |
| 494 | + "smithy.api#documentation": "<p>Amazon Connect Participant is used to mark the participant as connected for message\n streaming.</p>" |
| 495 | + } |
468 | 496 | }
|
469 | 497 | }
|
470 | 498 | },
|
|
508 | 536 | }
|
509 | 537 | ],
|
510 | 538 | "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>", |
| 539 | + "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 | 540 | "smithy.api#http": {
|
513 | 541 | "method": "POST",
|
514 | 542 | "uri": "/participant/disconnect",
|
|
572 | 600 | }
|
573 | 601 | ],
|
574 | 602 | "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>", |
| 603 | + "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> \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>", |
576 | 604 | "smithy.api#http": {
|
577 | 605 | "method": "POST",
|
578 | 606 | "uri": "/participant/attachment",
|
|
606 | 634 | "Url": {
|
607 | 635 | "target": "com.amazonaws.connectparticipant#PreSignedAttachmentUrl",
|
608 | 636 | "traits": {
|
609 |
| - "smithy.api#documentation": "<p>The pre-signed URL using which file would be downloaded from Amazon S3 by the API caller.</p>" |
| 637 | + "smithy.api#documentation": "<p>This is the pre-signed URL that can be used for uploading the file to Amazon S3 when used in response \nto <a href=\"https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_StartAttachmentUpload.html\">StartAttachmentUpload</a>.</p>" |
610 | 638 | }
|
611 | 639 | },
|
612 | 640 | "UrlExpiry": {
|
|
640 | 668 | }
|
641 | 669 | ],
|
642 | 670 | "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>", |
| 671 | + "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 | 672 | "smithy.api#http": {
|
645 | 673 | "method": "POST",
|
646 | 674 | "uri": "/participant/transcript",
|
|
957 | 985 | }
|
958 | 986 | ],
|
959 | 987 | "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>", |
| 988 | + "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 | 989 | "smithy.api#http": {
|
962 | 990 | "method": "POST",
|
963 | 991 | "uri": "/participant/event",
|
|
1038 | 1066 | }
|
1039 | 1067 | ],
|
1040 | 1068 | "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>", |
| 1069 | + "smithy.api#documentation": "<p>Sends a message. 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>", |
1042 | 1070 | "smithy.api#http": {
|
1043 | 1071 | "method": "POST",
|
1044 | 1072 | "uri": "/participant/message",
|
|
1154 | 1182 | }
|
1155 | 1183 | ],
|
1156 | 1184 | "traits": {
|
1157 |
| - "smithy.api#documentation": "<p>Provides a pre-signed Amazon S3 URL in response for uploading the file directly to\n S3.</p>", |
| 1185 | + "smithy.api#documentation": "<p>Provides a pre-signed Amazon S3 URL in response for uploading the file directly to\n S3.</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>", |
1158 | 1186 | "smithy.api#http": {
|
1159 | 1187 | "method": "POST",
|
1160 | 1188 | "uri": "/participant/start-attachment-upload",
|
|
1275 | 1303 | "Url": {
|
1276 | 1304 | "target": "com.amazonaws.connectparticipant#UploadMetadataUrl",
|
1277 | 1305 | "traits": {
|
1278 |
| - "smithy.api#documentation": "<p>The pre-signed URL using which file would be downloaded from Amazon S3 by the API caller.</p>" |
| 1306 | + "smithy.api#documentation": "<p>This is the pre-signed URL that can be used for uploading the file to Amazon S3 when used in response \nto <a href=\"https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_StartAttachmentUpload.html\">StartAttachmentUpload</a>.</p>" |
1279 | 1307 | }
|
1280 | 1308 | },
|
1281 | 1309 | "UrlExpiry": {
|
|
0 commit comments