github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/connectparticipant/2018-09-07/docs-2.json (about)

     1  {
     2    "version": "2.0",
     3    "service": "<p>Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage a customer contact center and provide reliable customer engagement at any scale.</p> <p>Amazon Connect enables customer contacts through voice or chat.</p> <p>The APIs described here are used by chat participants, such as agents and customers.</p>",
     4    "operations": {
     5      "CompleteAttachmentUpload": "<p>Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API. </p>",
     6      "CreateParticipantConnection": "<p>Creates the participant's connection. Note that ParticipantToken is used for invoking this API instead of ConnectionToken.</p> <p>The participant token is valid for the lifetime of the participant – until they are part of a contact.</p> <p>The response URL for <code>WEBSOCKET</code> Type has a connect expiry timeout of 100s. Clients must manually connect to the returned websocket URL and subscribe to the desired topic. </p> <p>For chat, you need to publish the following on the established websocket connection:</p> <p> <code>{\"topic\":\"aws/subscribe\",\"content\":{\"topics\":[\"aws/chat\"]}}</code> </p> <p>Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter, clients need to call this API again to obtain a new websocket URL and perform the same steps as before.</p> <note> <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 authentication</a>.</p> </note>",
     7      "DisconnectParticipant": "<p>Disconnects a participant. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.</p> <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 authentication</a>.</p>",
     8      "GetAttachment": "<p>Provides a pre-signed URL for download of a completed attachment. This is an asynchronous API for use with active contacts.</p>",
     9      "GetTranscript": "<p>Retrieves a transcript of the session, including details about any attachments. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.</p> <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 authentication</a>.</p>",
    10      "SendEvent": "<p>Sends an event. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.</p> <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 authentication</a>.</p>",
    11      "SendMessage": "<p>Sends a message. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.</p> <note> <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 authentication</a>.</p> </note>",
    12      "StartAttachmentUpload": "<p>Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3.</p>"
    13    },
    14    "shapes": {
    15      "AccessDeniedException": {
    16        "base": "<p>You do not have sufficient access to perform this action.</p>",
    17        "refs": {
    18        }
    19      },
    20      "ArtifactId": {
    21        "base": null,
    22        "refs": {
    23          "AttachmentIdList$member": null,
    24          "AttachmentItem$AttachmentId": "<p>A unique identifier for the attachment.</p>",
    25          "GetAttachmentRequest$AttachmentId": "<p>A unique identifier for the attachment.</p>",
    26          "StartAttachmentUploadResponse$AttachmentId": "<p>A unique identifier for the attachment.</p>"
    27        }
    28      },
    29      "ArtifactStatus": {
    30        "base": null,
    31        "refs": {
    32          "AttachmentItem$Status": "<p>Status of the attachment.</p>"
    33        }
    34      },
    35      "AttachmentIdList": {
    36        "base": null,
    37        "refs": {
    38          "CompleteAttachmentUploadRequest$AttachmentIds": "<p>A list of unique identifiers for the attachments.</p>"
    39        }
    40      },
    41      "AttachmentItem": {
    42        "base": "<p>The case-insensitive input to indicate standard MIME type that describes the format of the file that will be uploaded.</p>",
    43        "refs": {
    44          "Attachments$member": null
    45        }
    46      },
    47      "AttachmentName": {
    48        "base": null,
    49        "refs": {
    50          "AttachmentItem$AttachmentName": "<p>A case-sensitive name of the attachment being uploaded.</p>",
    51          "StartAttachmentUploadRequest$AttachmentName": "<p>A case-sensitive name of the attachment being uploaded.</p>"
    52        }
    53      },
    54      "AttachmentSizeInBytes": {
    55        "base": null,
    56        "refs": {
    57          "StartAttachmentUploadRequest$AttachmentSizeInBytes": "<p>The size of the attachment in bytes.</p>"
    58        }
    59      },
    60      "Attachments": {
    61        "base": null,
    62        "refs": {
    63          "Item$Attachments": "<p>Provides information about the attachments.</p>"
    64        }
    65      },
    66      "ChatContent": {
    67        "base": null,
    68        "refs": {
    69          "Item$Content": "<p>The content of the message or event.</p>",
    70          "SendEventRequest$Content": "<p>The content of the event to be sent (for example, message text). This is not yet supported.</p>",
    71          "SendMessageRequest$Content": "<p>The content of the message.</p>"
    72        }
    73      },
    74      "ChatContentType": {
    75        "base": null,
    76        "refs": {
    77          "Item$ContentType": "<p>The type of content of the item.</p>",
    78          "SendEventRequest$ContentType": "<p>The content type of the request. Supported types are:</p> <ul> <li> <p>application/vnd.amazonaws.connect.event.typing</p> </li> <li> <p>application/vnd.amazonaws.connect.event.connection.acknowledged</p> </li> </ul>",
    79          "SendMessageRequest$ContentType": "<p>The type of the content. Supported types are text/plain.</p>"
    80        }
    81      },
    82      "ChatItemId": {
    83        "base": null,
    84        "refs": {
    85          "Item$Id": "<p>The ID of the item.</p>",
    86          "SendEventResponse$Id": "<p>The ID of the response.</p>",
    87          "SendMessageResponse$Id": "<p>The ID of the message.</p>",
    88          "StartPosition$Id": "<p>The ID of the message or event where to start. </p>"
    89        }
    90      },
    91      "ChatItemType": {
    92        "base": null,
    93        "refs": {
    94          "Item$Type": "<p>Type of the item: message or event. </p>"
    95        }
    96      },
    97      "ClientToken": {
    98        "base": null,
    99        "refs": {
   100          "DisconnectParticipantRequest$ClientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>",
   101          "SendEventRequest$ClientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>",
   102          "SendMessageRequest$ClientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>"
   103        }
   104      },
   105      "CompleteAttachmentUploadRequest": {
   106        "base": null,
   107        "refs": {
   108        }
   109      },
   110      "CompleteAttachmentUploadResponse": {
   111        "base": null,
   112        "refs": {
   113        }
   114      },
   115      "ConflictException": {
   116        "base": "<p>An attachment with that identifier is already being uploaded.</p>",
   117        "refs": {
   118        }
   119      },
   120      "ConnectionCredentials": {
   121        "base": "<p>Connection credentials. </p>",
   122        "refs": {
   123          "CreateParticipantConnectionResponse$ConnectionCredentials": "<p>Creates the participant's connection credentials. The authentication token associated with the participant's connection.</p>"
   124        }
   125      },
   126      "ConnectionType": {
   127        "base": null,
   128        "refs": {
   129          "ConnectionTypeList$member": null
   130        }
   131      },
   132      "ConnectionTypeList": {
   133        "base": null,
   134        "refs": {
   135          "CreateParticipantConnectionRequest$Type": "<p>Type of connection information required.</p>"
   136        }
   137      },
   138      "ContactId": {
   139        "base": null,
   140        "refs": {
   141          "GetTranscriptRequest$ContactId": "<p>The contactId from the current contact chain for which transcript is needed.</p>",
   142          "GetTranscriptResponse$InitialContactId": "<p>The initial contact ID for the contact. </p>"
   143        }
   144      },
   145      "ContentType": {
   146        "base": null,
   147        "refs": {
   148          "AttachmentItem$ContentType": "<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>",
   149          "StartAttachmentUploadRequest$ContentType": "<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>"
   150        }
   151      },
   152      "CreateParticipantConnectionRequest": {
   153        "base": null,
   154        "refs": {
   155        }
   156      },
   157      "CreateParticipantConnectionResponse": {
   158        "base": null,
   159        "refs": {
   160        }
   161      },
   162      "DisconnectParticipantRequest": {
   163        "base": null,
   164        "refs": {
   165        }
   166      },
   167      "DisconnectParticipantResponse": {
   168        "base": null,
   169        "refs": {
   170        }
   171      },
   172      "DisplayName": {
   173        "base": null,
   174        "refs": {
   175          "Item$DisplayName": "<p>The chat display name of the sender.</p>"
   176        }
   177      },
   178      "GetAttachmentRequest": {
   179        "base": null,
   180        "refs": {
   181        }
   182      },
   183      "GetAttachmentResponse": {
   184        "base": null,
   185        "refs": {
   186        }
   187      },
   188      "GetTranscriptRequest": {
   189        "base": null,
   190        "refs": {
   191        }
   192      },
   193      "GetTranscriptResponse": {
   194        "base": null,
   195        "refs": {
   196        }
   197      },
   198      "ISO8601Datetime": {
   199        "base": null,
   200        "refs": {
   201          "ConnectionCredentials$Expiry": "<p>The expiration of the token.</p> <p>It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.</p>",
   202          "GetAttachmentResponse$UrlExpiry": "<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>",
   203          "UploadMetadata$UrlExpiry": "<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>",
   204          "Websocket$ConnectionExpiry": "<p>The URL expiration timestamp in ISO date format.</p> <p>It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.</p>"
   205        }
   206      },
   207      "Instant": {
   208        "base": null,
   209        "refs": {
   210          "Item$AbsoluteTime": "<p>The time when the message or event was sent.</p> <p>It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.</p>",
   211          "SendEventResponse$AbsoluteTime": "<p>The time when the event was sent.</p> <p>It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.</p>",
   212          "SendMessageResponse$AbsoluteTime": "<p>The time when the message was sent.</p> <p>It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.</p>",
   213          "StartPosition$AbsoluteTime": "<p>The time in ISO format where to start.</p> <p>It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.</p>"
   214        }
   215      },
   216      "InternalServerException": {
   217        "base": "<p>This exception occurs when there is an internal failure in the Amazon Connect service.</p>",
   218        "refs": {
   219        }
   220      },
   221      "Item": {
   222        "base": "<p>An item - message or event - that has been sent. </p>",
   223        "refs": {
   224          "Transcript$member": null
   225        }
   226      },
   227      "MaxResults": {
   228        "base": null,
   229        "refs": {
   230          "GetTranscriptRequest$MaxResults": "<p>The maximum number of results to return in the page. Default: 10. </p>"
   231        }
   232      },
   233      "Message": {
   234        "base": null,
   235        "refs": {
   236          "AccessDeniedException$Message": null,
   237          "InternalServerException$Message": null,
   238          "ServiceQuotaExceededException$Message": null,
   239          "ThrottlingException$Message": null
   240        }
   241      },
   242      "MostRecent": {
   243        "base": null,
   244        "refs": {
   245          "StartPosition$MostRecent": "<p>The start position of the most recent message where you want to start. </p>"
   246        }
   247      },
   248      "NextToken": {
   249        "base": null,
   250        "refs": {
   251          "GetTranscriptRequest$NextToken": "<p>The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.</p>",
   252          "GetTranscriptResponse$NextToken": "<p>The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.</p>"
   253        }
   254      },
   255      "NonEmptyClientToken": {
   256        "base": null,
   257        "refs": {
   258          "CompleteAttachmentUploadRequest$ClientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>",
   259          "StartAttachmentUploadRequest$ClientToken": "<p>A unique case sensitive identifier to support idempotency of request.</p>"
   260        }
   261      },
   262      "ParticipantId": {
   263        "base": null,
   264        "refs": {
   265          "Item$ParticipantId": "<p>The ID of the sender in the session.</p>"
   266        }
   267      },
   268      "ParticipantRole": {
   269        "base": null,
   270        "refs": {
   271          "Item$ParticipantRole": "<p>The role of the sender. For example, is it a customer, agent, or system.</p>"
   272        }
   273      },
   274      "ParticipantToken": {
   275        "base": null,
   276        "refs": {
   277          "CompleteAttachmentUploadRequest$ConnectionToken": "<p>The authentication token associated with the participant's connection.</p>",
   278          "ConnectionCredentials$ConnectionToken": "<p>The connection token.</p>",
   279          "CreateParticipantConnectionRequest$ParticipantToken": "<p>This is a header parameter.</p> <p>The Participant Token as obtained from <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_StartChatContact.html\">StartChatContact</a> API response.</p>",
   280          "DisconnectParticipantRequest$ConnectionToken": "<p>The authentication token associated with the participant's connection.</p>",
   281          "GetAttachmentRequest$ConnectionToken": "<p>The authentication token associated with the participant's connection.</p>",
   282          "GetTranscriptRequest$ConnectionToken": "<p>The authentication token associated with the participant's connection.</p>",
   283          "SendEventRequest$ConnectionToken": "<p>The authentication token associated with the participant's connection.</p>",
   284          "SendMessageRequest$ConnectionToken": "<p>The authentication token associated with the connection.</p>",
   285          "StartAttachmentUploadRequest$ConnectionToken": "<p>The authentication token associated with the participant's connection.</p>"
   286        }
   287      },
   288      "PreSignedAttachmentUrl": {
   289        "base": null,
   290        "refs": {
   291          "GetAttachmentResponse$Url": "<p>The pre-signed URL using which file would be downloaded from Amazon S3 by the API caller.</p>"
   292        }
   293      },
   294      "PreSignedConnectionUrl": {
   295        "base": null,
   296        "refs": {
   297          "Websocket$Url": "<p>The URL of the websocket.</p>"
   298        }
   299      },
   300      "Reason": {
   301        "base": null,
   302        "refs": {
   303          "ConflictException$Message": null,
   304          "ValidationException$Message": null
   305        }
   306      },
   307      "ScanDirection": {
   308        "base": null,
   309        "refs": {
   310          "GetTranscriptRequest$ScanDirection": "<p>The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition. </p>"
   311        }
   312      },
   313      "SendEventRequest": {
   314        "base": null,
   315        "refs": {
   316        }
   317      },
   318      "SendEventResponse": {
   319        "base": null,
   320        "refs": {
   321        }
   322      },
   323      "SendMessageRequest": {
   324        "base": null,
   325        "refs": {
   326        }
   327      },
   328      "SendMessageResponse": {
   329        "base": null,
   330        "refs": {
   331        }
   332      },
   333      "ServiceQuotaExceededException": {
   334        "base": "<p>The number of attachments per contact exceeds the quota.</p>",
   335        "refs": {
   336        }
   337      },
   338      "SortKey": {
   339        "base": null,
   340        "refs": {
   341          "GetTranscriptRequest$SortOrder": "<p>The sort order for the records. Default: DESCENDING.</p>"
   342        }
   343      },
   344      "StartAttachmentUploadRequest": {
   345        "base": null,
   346        "refs": {
   347        }
   348      },
   349      "StartAttachmentUploadResponse": {
   350        "base": null,
   351        "refs": {
   352        }
   353      },
   354      "StartPosition": {
   355        "base": "<p>A filtering option for where to start. For example, if you sent 100 messages, start with message 50. </p>",
   356        "refs": {
   357          "GetTranscriptRequest$StartPosition": "<p>A filtering option for where to start.</p>"
   358        }
   359      },
   360      "ThrottlingException": {
   361        "base": "<p>The request was denied due to request throttling.</p>",
   362        "refs": {
   363        }
   364      },
   365      "Transcript": {
   366        "base": null,
   367        "refs": {
   368          "GetTranscriptResponse$Transcript": "<p>The list of messages in the session.</p>"
   369        }
   370      },
   371      "UploadMetadata": {
   372        "base": "<p>Fields to be used while uploading the attachment.</p>",
   373        "refs": {
   374          "StartAttachmentUploadResponse$UploadMetadata": "<p>Fields to be used while uploading the attachment.</p>"
   375        }
   376      },
   377      "UploadMetadataSignedHeaders": {
   378        "base": null,
   379        "refs": {
   380          "UploadMetadata$HeadersToInclude": "<p>The headers to be provided while uploading the file to the URL.</p>"
   381        }
   382      },
   383      "UploadMetadataSignedHeadersKey": {
   384        "base": null,
   385        "refs": {
   386          "UploadMetadataSignedHeaders$key": null
   387        }
   388      },
   389      "UploadMetadataSignedHeadersValue": {
   390        "base": null,
   391        "refs": {
   392          "UploadMetadataSignedHeaders$value": null
   393        }
   394      },
   395      "UploadMetadataUrl": {
   396        "base": null,
   397        "refs": {
   398          "UploadMetadata$Url": "<p>The pre-signed URL using which file would be downloaded from Amazon S3 by the API caller.</p>"
   399        }
   400      },
   401      "ValidationException": {
   402        "base": "<p>The input fails to satisfy the constraints specified by Amazon Connect.</p>",
   403        "refs": {
   404        }
   405      },
   406      "Websocket": {
   407        "base": "<p>The websocket for the participant's connection.</p>",
   408        "refs": {
   409          "CreateParticipantConnectionResponse$Websocket": "<p>Creates the participant's websocket connection.</p>"
   410        }
   411      }
   412    }
   413  }