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

     1  {
     2    "version":"2.0",
     3    "metadata":{
     4      "apiVersion":"2018-09-07",
     5      "endpointPrefix":"participant.connect",
     6      "jsonVersion":"1.1",
     7      "protocol":"rest-json",
     8      "serviceAbbreviation":"Amazon Connect Participant",
     9      "serviceFullName":"Amazon Connect Participant Service",
    10      "serviceId":"ConnectParticipant",
    11      "signatureVersion":"v4",
    12      "signingName":"execute-api",
    13      "uid":"connectparticipant-2018-09-07"
    14    },
    15    "operations":{
    16      "CompleteAttachmentUpload":{
    17        "name":"CompleteAttachmentUpload",
    18        "http":{
    19          "method":"POST",
    20          "requestUri":"/participant/complete-attachment-upload"
    21        },
    22        "input":{"shape":"CompleteAttachmentUploadRequest"},
    23        "output":{"shape":"CompleteAttachmentUploadResponse"},
    24        "errors":[
    25          {"shape":"AccessDeniedException"},
    26          {"shape":"InternalServerException"},
    27          {"shape":"ThrottlingException"},
    28          {"shape":"ValidationException"},
    29          {"shape":"ServiceQuotaExceededException"},
    30          {"shape":"ConflictException"}
    31        ]
    32      },
    33      "CreateParticipantConnection":{
    34        "name":"CreateParticipantConnection",
    35        "http":{
    36          "method":"POST",
    37          "requestUri":"/participant/connection"
    38        },
    39        "input":{"shape":"CreateParticipantConnectionRequest"},
    40        "output":{"shape":"CreateParticipantConnectionResponse"},
    41        "errors":[
    42          {"shape":"AccessDeniedException"},
    43          {"shape":"InternalServerException"},
    44          {"shape":"ThrottlingException"},
    45          {"shape":"ValidationException"}
    46        ]
    47      },
    48      "DisconnectParticipant":{
    49        "name":"DisconnectParticipant",
    50        "http":{
    51          "method":"POST",
    52          "requestUri":"/participant/disconnect"
    53        },
    54        "input":{"shape":"DisconnectParticipantRequest"},
    55        "output":{"shape":"DisconnectParticipantResponse"},
    56        "errors":[
    57          {"shape":"AccessDeniedException"},
    58          {"shape":"InternalServerException"},
    59          {"shape":"ThrottlingException"},
    60          {"shape":"ValidationException"}
    61        ]
    62      },
    63      "GetAttachment":{
    64        "name":"GetAttachment",
    65        "http":{
    66          "method":"POST",
    67          "requestUri":"/participant/attachment"
    68        },
    69        "input":{"shape":"GetAttachmentRequest"},
    70        "output":{"shape":"GetAttachmentResponse"},
    71        "errors":[
    72          {"shape":"AccessDeniedException"},
    73          {"shape":"InternalServerException"},
    74          {"shape":"ThrottlingException"},
    75          {"shape":"ValidationException"}
    76        ]
    77      },
    78      "GetTranscript":{
    79        "name":"GetTranscript",
    80        "http":{
    81          "method":"POST",
    82          "requestUri":"/participant/transcript"
    83        },
    84        "input":{"shape":"GetTranscriptRequest"},
    85        "output":{"shape":"GetTranscriptResponse"},
    86        "errors":[
    87          {"shape":"AccessDeniedException"},
    88          {"shape":"InternalServerException"},
    89          {"shape":"ThrottlingException"},
    90          {"shape":"ValidationException"}
    91        ]
    92      },
    93      "SendEvent":{
    94        "name":"SendEvent",
    95        "http":{
    96          "method":"POST",
    97          "requestUri":"/participant/event"
    98        },
    99        "input":{"shape":"SendEventRequest"},
   100        "output":{"shape":"SendEventResponse"},
   101        "errors":[
   102          {"shape":"AccessDeniedException"},
   103          {"shape":"InternalServerException"},
   104          {"shape":"ThrottlingException"},
   105          {"shape":"ValidationException"}
   106        ]
   107      },
   108      "SendMessage":{
   109        "name":"SendMessage",
   110        "http":{
   111          "method":"POST",
   112          "requestUri":"/participant/message"
   113        },
   114        "input":{"shape":"SendMessageRequest"},
   115        "output":{"shape":"SendMessageResponse"},
   116        "errors":[
   117          {"shape":"AccessDeniedException"},
   118          {"shape":"InternalServerException"},
   119          {"shape":"ThrottlingException"},
   120          {"shape":"ValidationException"}
   121        ]
   122      },
   123      "StartAttachmentUpload":{
   124        "name":"StartAttachmentUpload",
   125        "http":{
   126          "method":"POST",
   127          "requestUri":"/participant/start-attachment-upload"
   128        },
   129        "input":{"shape":"StartAttachmentUploadRequest"},
   130        "output":{"shape":"StartAttachmentUploadResponse"},
   131        "errors":[
   132          {"shape":"AccessDeniedException"},
   133          {"shape":"InternalServerException"},
   134          {"shape":"ThrottlingException"},
   135          {"shape":"ValidationException"},
   136          {"shape":"ServiceQuotaExceededException"}
   137        ]
   138      }
   139    },
   140    "shapes":{
   141      "AccessDeniedException":{
   142        "type":"structure",
   143        "required":["Message"],
   144        "members":{
   145          "Message":{"shape":"Message"}
   146        },
   147        "error":{"httpStatusCode":403},
   148        "exception":true
   149      },
   150      "ArtifactId":{
   151        "type":"string",
   152        "max":256,
   153        "min":1
   154      },
   155      "ArtifactStatus":{
   156        "type":"string",
   157        "enum":[
   158          "APPROVED",
   159          "REJECTED",
   160          "IN_PROGRESS"
   161        ]
   162      },
   163      "AttachmentIdList":{
   164        "type":"list",
   165        "member":{"shape":"ArtifactId"},
   166        "max":1,
   167        "min":1
   168      },
   169      "AttachmentItem":{
   170        "type":"structure",
   171        "members":{
   172          "ContentType":{"shape":"ContentType"},
   173          "AttachmentId":{"shape":"ArtifactId"},
   174          "AttachmentName":{"shape":"AttachmentName"},
   175          "Status":{"shape":"ArtifactStatus"}
   176        }
   177      },
   178      "AttachmentName":{
   179        "type":"string",
   180        "max":256,
   181        "min":1
   182      },
   183      "AttachmentSizeInBytes":{
   184        "type":"long",
   185        "min":1
   186      },
   187      "Attachments":{
   188        "type":"list",
   189        "member":{"shape":"AttachmentItem"}
   190      },
   191      "ChatContent":{
   192        "type":"string",
   193        "max":1024,
   194        "min":1
   195      },
   196      "ChatContentType":{
   197        "type":"string",
   198        "max":100,
   199        "min":1
   200      },
   201      "ChatItemId":{
   202        "type":"string",
   203        "max":256,
   204        "min":1
   205      },
   206      "ChatItemType":{
   207        "type":"string",
   208        "enum":[
   209          "TYPING",
   210          "PARTICIPANT_JOINED",
   211          "PARTICIPANT_LEFT",
   212          "CHAT_ENDED",
   213          "TRANSFER_SUCCEEDED",
   214          "TRANSFER_FAILED",
   215          "MESSAGE",
   216          "EVENT",
   217          "ATTACHMENT",
   218          "CONNECTION_ACK"
   219        ]
   220      },
   221      "ClientToken":{
   222        "type":"string",
   223        "max":500
   224      },
   225      "CompleteAttachmentUploadRequest":{
   226        "type":"structure",
   227        "required":[
   228          "AttachmentIds",
   229          "ClientToken",
   230          "ConnectionToken"
   231        ],
   232        "members":{
   233          "AttachmentIds":{"shape":"AttachmentIdList"},
   234          "ClientToken":{
   235            "shape":"NonEmptyClientToken",
   236            "idempotencyToken":true
   237          },
   238          "ConnectionToken":{
   239            "shape":"ParticipantToken",
   240            "location":"header",
   241            "locationName":"X-Amz-Bearer"
   242          }
   243        }
   244      },
   245      "CompleteAttachmentUploadResponse":{
   246        "type":"structure",
   247        "members":{
   248        }
   249      },
   250      "ConflictException":{
   251        "type":"structure",
   252        "required":["Message"],
   253        "members":{
   254          "Message":{"shape":"Reason"}
   255        },
   256        "error":{"httpStatusCode":409},
   257        "exception":true
   258      },
   259      "ConnectionCredentials":{
   260        "type":"structure",
   261        "members":{
   262          "ConnectionToken":{"shape":"ParticipantToken"},
   263          "Expiry":{"shape":"ISO8601Datetime"}
   264        }
   265      },
   266      "ConnectionType":{
   267        "type":"string",
   268        "enum":[
   269          "WEBSOCKET",
   270          "CONNECTION_CREDENTIALS"
   271        ]
   272      },
   273      "ConnectionTypeList":{
   274        "type":"list",
   275        "member":{"shape":"ConnectionType"},
   276        "min":1
   277      },
   278      "ContactId":{
   279        "type":"string",
   280        "max":256,
   281        "min":1
   282      },
   283      "ContentType":{
   284        "type":"string",
   285        "max":255,
   286        "min":1
   287      },
   288      "CreateParticipantConnectionRequest":{
   289        "type":"structure",
   290        "required":[
   291          "Type",
   292          "ParticipantToken"
   293        ],
   294        "members":{
   295          "Type":{"shape":"ConnectionTypeList"},
   296          "ParticipantToken":{
   297            "shape":"ParticipantToken",
   298            "location":"header",
   299            "locationName":"X-Amz-Bearer"
   300          }
   301        }
   302      },
   303      "CreateParticipantConnectionResponse":{
   304        "type":"structure",
   305        "members":{
   306          "Websocket":{"shape":"Websocket"},
   307          "ConnectionCredentials":{"shape":"ConnectionCredentials"}
   308        }
   309      },
   310      "DisconnectParticipantRequest":{
   311        "type":"structure",
   312        "required":["ConnectionToken"],
   313        "members":{
   314          "ClientToken":{
   315            "shape":"ClientToken",
   316            "idempotencyToken":true
   317          },
   318          "ConnectionToken":{
   319            "shape":"ParticipantToken",
   320            "location":"header",
   321            "locationName":"X-Amz-Bearer"
   322          }
   323        }
   324      },
   325      "DisconnectParticipantResponse":{
   326        "type":"structure",
   327        "members":{
   328        }
   329      },
   330      "DisplayName":{
   331        "type":"string",
   332        "max":256,
   333        "min":1
   334      },
   335      "GetAttachmentRequest":{
   336        "type":"structure",
   337        "required":[
   338          "AttachmentId",
   339          "ConnectionToken"
   340        ],
   341        "members":{
   342          "AttachmentId":{"shape":"ArtifactId"},
   343          "ConnectionToken":{
   344            "shape":"ParticipantToken",
   345            "location":"header",
   346            "locationName":"X-Amz-Bearer"
   347          }
   348        }
   349      },
   350      "GetAttachmentResponse":{
   351        "type":"structure",
   352        "members":{
   353          "Url":{"shape":"PreSignedAttachmentUrl"},
   354          "UrlExpiry":{"shape":"ISO8601Datetime"}
   355        }
   356      },
   357      "GetTranscriptRequest":{
   358        "type":"structure",
   359        "required":["ConnectionToken"],
   360        "members":{
   361          "ContactId":{"shape":"ContactId"},
   362          "MaxResults":{
   363            "shape":"MaxResults",
   364            "box":true
   365          },
   366          "NextToken":{"shape":"NextToken"},
   367          "ScanDirection":{"shape":"ScanDirection"},
   368          "SortOrder":{"shape":"SortKey"},
   369          "StartPosition":{"shape":"StartPosition"},
   370          "ConnectionToken":{
   371            "shape":"ParticipantToken",
   372            "location":"header",
   373            "locationName":"X-Amz-Bearer"
   374          }
   375        }
   376      },
   377      "GetTranscriptResponse":{
   378        "type":"structure",
   379        "members":{
   380          "InitialContactId":{"shape":"ContactId"},
   381          "Transcript":{"shape":"Transcript"},
   382          "NextToken":{"shape":"NextToken"}
   383        }
   384      },
   385      "ISO8601Datetime":{"type":"string"},
   386      "Instant":{
   387        "type":"string",
   388        "max":100,
   389        "min":1
   390      },
   391      "InternalServerException":{
   392        "type":"structure",
   393        "required":["Message"],
   394        "members":{
   395          "Message":{"shape":"Message"}
   396        },
   397        "error":{"httpStatusCode":500},
   398        "exception":true,
   399        "fault":true
   400      },
   401      "Item":{
   402        "type":"structure",
   403        "members":{
   404          "AbsoluteTime":{"shape":"Instant"},
   405          "Content":{"shape":"ChatContent"},
   406          "ContentType":{"shape":"ChatContentType"},
   407          "Id":{"shape":"ChatItemId"},
   408          "Type":{"shape":"ChatItemType"},
   409          "ParticipantId":{"shape":"ParticipantId"},
   410          "DisplayName":{"shape":"DisplayName"},
   411          "ParticipantRole":{"shape":"ParticipantRole"},
   412          "Attachments":{"shape":"Attachments"}
   413        }
   414      },
   415      "MaxResults":{
   416        "type":"integer",
   417        "max":100,
   418        "min":0
   419      },
   420      "Message":{"type":"string"},
   421      "MostRecent":{
   422        "type":"integer",
   423        "max":100,
   424        "min":0
   425      },
   426      "NextToken":{
   427        "type":"string",
   428        "max":1000,
   429        "min":1
   430      },
   431      "NonEmptyClientToken":{
   432        "type":"string",
   433        "max":500,
   434        "min":1
   435      },
   436      "ParticipantId":{
   437        "type":"string",
   438        "max":256,
   439        "min":1
   440      },
   441      "ParticipantRole":{
   442        "type":"string",
   443        "enum":[
   444          "AGENT",
   445          "CUSTOMER",
   446          "SYSTEM"
   447        ]
   448      },
   449      "ParticipantToken":{
   450        "type":"string",
   451        "max":1000,
   452        "min":1
   453      },
   454      "PreSignedAttachmentUrl":{
   455        "type":"string",
   456        "max":2000,
   457        "min":1
   458      },
   459      "PreSignedConnectionUrl":{
   460        "type":"string",
   461        "max":2000,
   462        "min":1
   463      },
   464      "Reason":{
   465        "type":"string",
   466        "max":2000,
   467        "min":1
   468      },
   469      "ScanDirection":{
   470        "type":"string",
   471        "enum":[
   472          "FORWARD",
   473          "BACKWARD"
   474        ]
   475      },
   476      "SendEventRequest":{
   477        "type":"structure",
   478        "required":[
   479          "ContentType",
   480          "ConnectionToken"
   481        ],
   482        "members":{
   483          "ContentType":{"shape":"ChatContentType"},
   484          "Content":{"shape":"ChatContent"},
   485          "ClientToken":{
   486            "shape":"ClientToken",
   487            "idempotencyToken":true
   488          },
   489          "ConnectionToken":{
   490            "shape":"ParticipantToken",
   491            "location":"header",
   492            "locationName":"X-Amz-Bearer"
   493          }
   494        }
   495      },
   496      "SendEventResponse":{
   497        "type":"structure",
   498        "members":{
   499          "Id":{"shape":"ChatItemId"},
   500          "AbsoluteTime":{"shape":"Instant"}
   501        }
   502      },
   503      "SendMessageRequest":{
   504        "type":"structure",
   505        "required":[
   506          "ContentType",
   507          "Content",
   508          "ConnectionToken"
   509        ],
   510        "members":{
   511          "ContentType":{"shape":"ChatContentType"},
   512          "Content":{"shape":"ChatContent"},
   513          "ClientToken":{
   514            "shape":"ClientToken",
   515            "idempotencyToken":true
   516          },
   517          "ConnectionToken":{
   518            "shape":"ParticipantToken",
   519            "location":"header",
   520            "locationName":"X-Amz-Bearer"
   521          }
   522        }
   523      },
   524      "SendMessageResponse":{
   525        "type":"structure",
   526        "members":{
   527          "Id":{"shape":"ChatItemId"},
   528          "AbsoluteTime":{"shape":"Instant"}
   529        }
   530      },
   531      "ServiceQuotaExceededException":{
   532        "type":"structure",
   533        "required":["Message"],
   534        "members":{
   535          "Message":{"shape":"Message"}
   536        },
   537        "error":{"httpStatusCode":402},
   538        "exception":true
   539      },
   540      "SortKey":{
   541        "type":"string",
   542        "enum":[
   543          "DESCENDING",
   544          "ASCENDING"
   545        ]
   546      },
   547      "StartAttachmentUploadRequest":{
   548        "type":"structure",
   549        "required":[
   550          "ContentType",
   551          "AttachmentSizeInBytes",
   552          "AttachmentName",
   553          "ClientToken",
   554          "ConnectionToken"
   555        ],
   556        "members":{
   557          "ContentType":{"shape":"ContentType"},
   558          "AttachmentSizeInBytes":{"shape":"AttachmentSizeInBytes"},
   559          "AttachmentName":{"shape":"AttachmentName"},
   560          "ClientToken":{
   561            "shape":"NonEmptyClientToken",
   562            "idempotencyToken":true
   563          },
   564          "ConnectionToken":{
   565            "shape":"ParticipantToken",
   566            "location":"header",
   567            "locationName":"X-Amz-Bearer"
   568          }
   569        }
   570      },
   571      "StartAttachmentUploadResponse":{
   572        "type":"structure",
   573        "members":{
   574          "AttachmentId":{"shape":"ArtifactId"},
   575          "UploadMetadata":{"shape":"UploadMetadata"}
   576        }
   577      },
   578      "StartPosition":{
   579        "type":"structure",
   580        "members":{
   581          "Id":{"shape":"ChatItemId"},
   582          "AbsoluteTime":{"shape":"Instant"},
   583          "MostRecent":{"shape":"MostRecent"}
   584        }
   585      },
   586      "ThrottlingException":{
   587        "type":"structure",
   588        "required":["Message"],
   589        "members":{
   590          "Message":{"shape":"Message"}
   591        },
   592        "error":{"httpStatusCode":429},
   593        "exception":true
   594      },
   595      "Transcript":{
   596        "type":"list",
   597        "member":{"shape":"Item"}
   598      },
   599      "UploadMetadata":{
   600        "type":"structure",
   601        "members":{
   602          "Url":{"shape":"UploadMetadataUrl"},
   603          "UrlExpiry":{"shape":"ISO8601Datetime"},
   604          "HeadersToInclude":{"shape":"UploadMetadataSignedHeaders"}
   605        }
   606      },
   607      "UploadMetadataSignedHeaders":{
   608        "type":"map",
   609        "key":{"shape":"UploadMetadataSignedHeadersKey"},
   610        "value":{"shape":"UploadMetadataSignedHeadersValue"}
   611      },
   612      "UploadMetadataSignedHeadersKey":{
   613        "type":"string",
   614        "max":128,
   615        "min":1
   616      },
   617      "UploadMetadataSignedHeadersValue":{
   618        "type":"string",
   619        "max":256,
   620        "min":1
   621      },
   622      "UploadMetadataUrl":{
   623        "type":"string",
   624        "max":2000,
   625        "min":1
   626      },
   627      "ValidationException":{
   628        "type":"structure",
   629        "required":["Message"],
   630        "members":{
   631          "Message":{"shape":"Reason"}
   632        },
   633        "error":{"httpStatusCode":400},
   634        "exception":true
   635      },
   636      "Websocket":{
   637        "type":"structure",
   638        "members":{
   639          "Url":{"shape":"PreSignedConnectionUrl"},
   640          "ConnectionExpiry":{"shape":"ISO8601Datetime"}
   641        }
   642      }
   643    }
   644  }