|
8810 | 8810 | "target": "com.amazonaws.connect#CreateParticipantResponse" |
8811 | 8811 | }, |
8812 | 8812 | "errors": [ |
| 8813 | + { |
| 8814 | + "target": "com.amazonaws.connect#ConflictException" |
| 8815 | + }, |
8813 | 8816 | { |
8814 | 8817 | "target": "com.amazonaws.connect#InternalServiceException" |
8815 | 8818 | }, |
|
8827 | 8830 | } |
8828 | 8831 | ], |
8829 | 8832 | "traits": { |
8830 | | - "smithy.api#documentation": "<p>Adds a new participant into an on-going chat contact. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/chat-customize-flow.html\">Customize chat\n flow experiences by integrating custom participants</a>.</p>", |
| 8833 | + "smithy.api#documentation": "<p>Adds a new participant into an on-going chat contact or webRTC call. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/chat-customize-flow.html\">Customize chat\n flow experiences by integrating custom participants </a> \n or <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/enable-multiuser-inapp.html\">Enable multi-user web, in-app, and video calling</a>.</p>", |
8831 | 8834 | "smithy.api#http": { |
8832 | 8835 | "method": "POST", |
8833 | 8836 | "uri": "/contact/create-participant", |
|
8848 | 8851 | "ContactId": { |
8849 | 8852 | "target": "com.amazonaws.connect#ContactId", |
8850 | 8853 | "traits": { |
8851 | | - "smithy.api#documentation": "<p>The identifier of the contact in this instance of Amazon Connect. Only contacts in the CHAT channel are supported.</p>", |
| 8854 | + "smithy.api#documentation": "<p>The identifier of the contact in this instance of Amazon Connect. Supports contacts in the CHAT channel and VOICE (WebRTC) channels. \n For WebRTC calls, this should be the initial contact ID that was generated when \n the contact was first created (from the StartWebRTCContact API) in the VOICE channel</p>", |
8852 | 8855 | "smithy.api#required": {} |
8853 | 8856 | } |
8854 | 8857 | }, |
|
8862 | 8865 | "ParticipantDetails": { |
8863 | 8866 | "target": "com.amazonaws.connect#ParticipantDetailsToAdd", |
8864 | 8867 | "traits": { |
8865 | | - "smithy.api#documentation": "<p>Information identifying the participant.</p>\n <important>\n <p>The only Valid value for <code>ParticipantRole</code> is <code>CUSTOM_BOT</code>. </p>\n <p>\n <code>DisplayName</code> is <b>Required</b>.</p>\n </important>", |
| 8868 | + "smithy.api#documentation": "<p>Information identifying the participant.</p>\n <important>\n <p>The only valid value for <code>ParticipantRole</code> is <code>CUSTOM_BOT</code> \n for chat contact and <code>CUSTOMER</code> for voice contact.</p>\n </important>", |
8866 | 8869 | "smithy.api#required": {} |
8867 | 8870 | } |
8868 | 8871 | } |
|
19139 | 19142 | } |
19140 | 19143 | ], |
19141 | 19144 | "traits": { |
19142 | | - "smithy.api#documentation": "<p>Gets the real-time metric data from the specified Amazon Connect instance.</p>\n <p>For a description of each metric, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html\">Metrics definitions</a> in the\n <i>Amazon Connect Administrator Guide</i>.</p>\n <note>\n <p>When you make a successful API request, you can expect the following metric values in the response:</p>\n <ol>\n <li>\n <p>\n <b>Metric value is null</b>: The calculation cannot be performed due to divide by zero or insufficient data</p>\n </li>\n <li>\n <p>\n <b>Metric value is a number (including 0) of defined type</b>: The number provided is the calculation result</p>\n </li>\n <li>\n <p>\n <b>MetricResult list is empty</b>: The request cannot find any data in the system</p>\n </li>\n </ol>\n <p>The following guidelines can help you work with the API:</p>\n <ul>\n <li>\n <p>Each dimension in the metric response must contain a value</p>\n </li>\n <li>\n <p>Each item in MetricResult must include all requested metrics</p>\n </li>\n <li>\n <p>If the response is slow due to large result sets, try these approaches:</p>\n <ul>\n <li>\n <p>Narrow the time range of your request</p>\n </li>\n <li>\n <p>Add filters to reduce the amount of data returned</p>\n </li>\n </ul>\n </li>\n </ul>\n </note>", |
| 19145 | + "smithy.api#documentation": "<p>Gets the real-time metric data from the specified Amazon Connect instance.</p>\n <p>For a description of each metric, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html\">Metrics definitions</a> in the\n <i>Amazon Connect Administrator Guide</i>.</p>\n <note>\n <p>When you make a successful API request, you can expect the following metric values in the response:</p>\n <ol>\n <li>\n <p>\n <b>Metric value is null</b>: The calculation cannot be performed due to divide by zero or insufficient data</p>\n </li>\n <li>\n <p>\n <b>Metric value is a number (including 0) of defined type</b>: The number provided is the calculation result</p>\n </li>\n <li>\n <p>\n <b>MetricResult list is empty</b>: The request cannot find any data in the system</p>\n </li>\n </ol>\n <p>The following guidelines can help you work with the API:</p>\n <ul>\n <li>\n <p>Each dimension in the metric response must contain a value</p>\n </li>\n <li>\n <p>Each item in MetricResult must include all requested metrics</p>\n </li>\n <li>\n <p>If the response is slow due to large result sets, try these approaches:</p>\n <ul>\n <li>\n <p>Add filters to reduce the amount of data returned</p>\n </li>\n </ul>\n </li>\n </ul>\n </note>", |
19143 | 19146 | "smithy.api#http": { |
19144 | 19147 | "method": "POST", |
19145 | 19148 | "uri": "/metrics/current/{InstanceId}", |
|
28788 | 28791 | "traits": { |
28789 | 28792 | "smithy.api#documentation": "<p>The display name of the participant.</p>" |
28790 | 28793 | } |
| 28794 | + }, |
| 28795 | + "ParticipantCapabilities": { |
| 28796 | + "target": "com.amazonaws.connect#ParticipantCapabilities" |
28791 | 28797 | } |
28792 | 28798 | }, |
28793 | 28799 | "traits": { |
|
0 commit comments