• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1{
2  "metadata" : {
3    "apiVersion" : "2018-09-05",
4    "endpointPrefix" : "sms-voice.pinpoint",
5    "signingName" : "sms-voice",
6    "serviceAbbreviation":"Pinpoint SMS Voice",
7    "serviceFullName" : "Amazon Pinpoint SMS and Voice Service",
8    "serviceId" : "Pinpoint SMS Voice",
9    "protocol" : "rest-json",
10    "jsonVersion" : "1.1",
11    "uid" : "pinpoint-sms-voice-2018-09-05",
12    "signatureVersion" : "v4"
13  },
14  "operations" : {
15    "CreateConfigurationSet" : {
16      "name" : "CreateConfigurationSet",
17      "http" : {
18        "method" : "POST",
19        "requestUri" : "/v1/sms-voice/configuration-sets",
20        "responseCode" : 200
21      },
22      "input" : {
23        "shape" : "CreateConfigurationSetRequest"
24      },
25      "output" : {
26        "shape" : "CreateConfigurationSetResponse"
27      },
28      "errors" : [ {
29        "shape" : "TooManyRequestsException"
30      }, {
31        "shape" : "BadRequestException"
32      }, {
33        "shape" : "LimitExceededException"
34      }, {
35        "shape" : "InternalServiceErrorException"
36      }, {
37        "shape" : "AlreadyExistsException"
38      } ]
39    },
40    "CreateConfigurationSetEventDestination" : {
41      "name" : "CreateConfigurationSetEventDestination",
42      "http" : {
43        "method" : "POST",
44        "requestUri" : "/v1/sms-voice/configuration-sets/{ConfigurationSetName}/event-destinations",
45        "responseCode" : 200
46      },
47      "input" : {
48        "shape" : "CreateConfigurationSetEventDestinationRequest"
49      },
50      "output" : {
51        "shape" : "CreateConfigurationSetEventDestinationResponse"
52      },
53      "errors" : [ {
54        "shape" : "BadRequestException"
55      }, {
56        "shape" : "LimitExceededException"
57      }, {
58        "shape" : "InternalServiceErrorException"
59      }, {
60        "shape" : "NotFoundException"
61      }, {
62        "shape" : "TooManyRequestsException"
63      }, {
64        "shape" : "AlreadyExistsException"
65      } ]
66    },
67    "DeleteConfigurationSet" : {
68      "name" : "DeleteConfigurationSet",
69      "http" : {
70        "method" : "DELETE",
71        "requestUri" : "/v1/sms-voice/configuration-sets/{ConfigurationSetName}",
72        "responseCode" : 200
73      },
74      "input" : {
75        "shape" : "DeleteConfigurationSetRequest"
76      },
77      "output" : {
78        "shape" : "DeleteConfigurationSetResponse"
79      },
80      "errors" : [ {
81        "shape" : "NotFoundException"
82      }, {
83        "shape" : "TooManyRequestsException"
84      }, {
85        "shape" : "BadRequestException"
86      }, {
87        "shape" : "InternalServiceErrorException"
88      } ]
89    },
90    "DeleteConfigurationSetEventDestination" : {
91      "name" : "DeleteConfigurationSetEventDestination",
92      "http" : {
93        "method" : "DELETE",
94        "requestUri" : "/v1/sms-voice/configuration-sets/{ConfigurationSetName}/event-destinations/{EventDestinationName}",
95        "responseCode" : 200
96      },
97      "input" : {
98        "shape" : "DeleteConfigurationSetEventDestinationRequest"
99      },
100      "output" : {
101        "shape" : "DeleteConfigurationSetEventDestinationResponse"
102      },
103      "errors" : [ {
104        "shape" : "NotFoundException"
105      }, {
106        "shape" : "TooManyRequestsException"
107      }, {
108        "shape" : "BadRequestException"
109      }, {
110        "shape" : "InternalServiceErrorException"
111      } ]
112    },
113    "GetConfigurationSetEventDestinations" : {
114      "name" : "GetConfigurationSetEventDestinations",
115      "http" : {
116        "method" : "GET",
117        "requestUri" : "/v1/sms-voice/configuration-sets/{ConfigurationSetName}/event-destinations",
118        "responseCode" : 200
119      },
120      "input" : {
121        "shape" : "GetConfigurationSetEventDestinationsRequest"
122      },
123      "output" : {
124        "shape" : "GetConfigurationSetEventDestinationsResponse"
125      },
126      "errors" : [ {
127        "shape" : "NotFoundException"
128      }, {
129        "shape" : "TooManyRequestsException"
130      }, {
131        "shape" : "BadRequestException"
132      }, {
133        "shape" : "InternalServiceErrorException"
134      } ]
135    },
136    "SendVoiceMessage" : {
137      "name" : "SendVoiceMessage",
138      "http" : {
139        "method" : "POST",
140        "requestUri" : "/v1/sms-voice/voice/message",
141        "responseCode" : 200
142      },
143      "input" : {
144        "shape" : "SendVoiceMessageRequest"
145      },
146      "output" : {
147        "shape" : "SendVoiceMessageResponse"
148      },
149      "errors" : [ {
150        "shape" : "TooManyRequestsException"
151      }, {
152        "shape" : "BadRequestException"
153      }, {
154        "shape" : "InternalServiceErrorException"
155      } ]
156    },
157    "UpdateConfigurationSetEventDestination" : {
158      "name" : "UpdateConfigurationSetEventDestination",
159      "http" : {
160        "method" : "PUT",
161        "requestUri" : "/v1/sms-voice/configuration-sets/{ConfigurationSetName}/event-destinations/{EventDestinationName}",
162        "responseCode" : 200
163      },
164      "input" : {
165        "shape" : "UpdateConfigurationSetEventDestinationRequest"
166      },
167      "output" : {
168        "shape" : "UpdateConfigurationSetEventDestinationResponse"
169      },
170      "errors" : [ {
171        "shape" : "NotFoundException"
172      }, {
173        "shape" : "TooManyRequestsException"
174      }, {
175        "shape" : "BadRequestException"
176      }, {
177        "shape" : "InternalServiceErrorException"
178      } ]
179    }
180  },
181  "shapes" : {
182    "AlreadyExistsException" : {
183      "type" : "structure",
184      "exception" : true,
185      "members" : {
186        "Message" : {
187          "shape" : "String"
188        }
189      },
190      "error" : {
191        "httpStatusCode" : 409
192      }
193    },
194    "BadRequestException" : {
195      "type" : "structure",
196      "exception" : true,
197      "members" : {
198        "Message" : {
199          "shape" : "String"
200        }
201      },
202      "error" : {
203        "httpStatusCode" : 400
204      }
205    },
206    "Boolean" : {
207      "type" : "boolean"
208    },
209    "CallInstructionsMessageType" : {
210      "type" : "structure",
211      "members" : {
212        "Text" : {
213          "shape" : "NonEmptyString"
214        }
215      },
216      "required" : [ ]
217    },
218    "CloudWatchLogsDestination" : {
219      "type" : "structure",
220      "members" : {
221        "IamRoleArn" : {
222          "shape" : "String"
223        },
224        "LogGroupArn" : {
225          "shape" : "String"
226        }
227      },
228      "required" : [ ]
229    },
230    "CreateConfigurationSetEventDestinationRequest" : {
231      "type" : "structure",
232      "members" : {
233        "ConfigurationSetName" : {
234          "shape" : "__string",
235          "location" : "uri",
236          "locationName" : "ConfigurationSetName"
237        },
238        "EventDestination" : {
239          "shape" : "EventDestinationDefinition"
240        },
241        "EventDestinationName" : {
242          "shape" : "NonEmptyString"
243        }
244      },
245      "required" : [ "ConfigurationSetName" ]
246    },
247    "CreateConfigurationSetEventDestinationResponse" : {
248      "type" : "structure",
249      "members" : { }
250    },
251    "CreateConfigurationSetRequest" : {
252      "type" : "structure",
253      "members" : {
254        "ConfigurationSetName" : {
255          "shape" : "WordCharactersWithDelimiters"
256        }
257      }
258    },
259    "CreateConfigurationSetResponse" : {
260      "type" : "structure",
261      "members" : { }
262    },
263    "DeleteConfigurationSetEventDestinationRequest" : {
264      "type" : "structure",
265      "members" : {
266        "ConfigurationSetName" : {
267          "shape" : "__string",
268          "location" : "uri",
269          "locationName" : "ConfigurationSetName"
270        },
271        "EventDestinationName" : {
272          "shape" : "__string",
273          "location" : "uri",
274          "locationName" : "EventDestinationName"
275        }
276      },
277      "required" : [ "EventDestinationName", "ConfigurationSetName" ]
278    },
279    "DeleteConfigurationSetEventDestinationResponse" : {
280      "type" : "structure",
281      "members" : { }
282    },
283    "DeleteConfigurationSetRequest" : {
284      "type" : "structure",
285      "members" : {
286        "ConfigurationSetName" : {
287          "shape" : "__string",
288          "location" : "uri",
289          "locationName" : "ConfigurationSetName"
290        }
291      },
292      "required" : [ "ConfigurationSetName" ]
293    },
294    "DeleteConfigurationSetResponse" : {
295      "type" : "structure",
296      "members" : { }
297    },
298    "EventDestination" : {
299      "type" : "structure",
300      "members" : {
301        "CloudWatchLogsDestination" : {
302          "shape" : "CloudWatchLogsDestination"
303        },
304        "Enabled" : {
305          "shape" : "Boolean"
306        },
307        "KinesisFirehoseDestination" : {
308          "shape" : "KinesisFirehoseDestination"
309        },
310        "MatchingEventTypes" : {
311          "shape" : "EventTypes"
312        },
313        "Name" : {
314          "shape" : "String"
315        }
316      }
317    },
318    "EventDestinationDefinition" : {
319      "type" : "structure",
320      "members" : {
321        "CloudWatchLogsDestination" : {
322          "shape" : "CloudWatchLogsDestination"
323        },
324        "Enabled" : {
325          "shape" : "Boolean"
326        },
327        "KinesisFirehoseDestination" : {
328          "shape" : "KinesisFirehoseDestination"
329        },
330        "MatchingEventTypes" : {
331          "shape" : "EventTypes"
332        }
333      },
334      "required" : [ ]
335    },
336    "EventDestinations" : {
337      "type" : "list",
338      "member" : {
339        "shape" : "EventDestination"
340      }
341    },
342    "EventType" : {
343      "type" : "string",
344      "enum" : [ "INITIATED_CALL", "RINGING", "ANSWERED", "COMPLETED_CALL", "BUSY", "FAILED", "NO_ANSWER" ]
345    },
346    "EventTypes" : {
347      "type" : "list",
348      "member" : {
349        "shape" : "EventType"
350      }
351    },
352    "GetConfigurationSetEventDestinationsRequest" : {
353      "type" : "structure",
354      "members" : {
355        "ConfigurationSetName" : {
356          "shape" : "__string",
357          "location" : "uri",
358          "locationName" : "ConfigurationSetName"
359        }
360      },
361      "required" : [ "ConfigurationSetName" ]
362    },
363    "GetConfigurationSetEventDestinationsResponse" : {
364      "type" : "structure",
365      "members" : {
366        "EventDestinations" : {
367          "shape" : "EventDestinations"
368        }
369      }
370    },
371    "InternalServiceErrorException" : {
372      "type" : "structure",
373      "members" : {
374        "Message" : {
375          "shape" : "String"
376        }
377      },
378      "exception" : true,
379      "error" : {
380        "httpStatusCode" : 500
381      }
382    },
383    "KinesisFirehoseDestination" : {
384      "type" : "structure",
385      "members" : {
386        "DeliveryStreamArn" : {
387          "shape" : "String"
388        },
389        "IamRoleArn" : {
390          "shape" : "String"
391        }
392      },
393      "required" : [ ]
394    },
395    "LimitExceededException" : {
396      "type" : "structure",
397      "exception" : true,
398      "members" : {
399        "Message" : {
400          "shape" : "String"
401        }
402      },
403      "error" : {
404        "httpStatusCode" : 412
405      }
406    },
407    "NonEmptyString" : {
408      "type" : "string"
409    },
410    "NotFoundException" : {
411      "type" : "structure",
412      "exception" : true,
413      "members" : {
414        "Message" : {
415          "shape" : "String"
416        }
417      },
418      "error" : {
419        "httpStatusCode" : 404
420      }
421    },
422    "PlainTextMessageType" : {
423      "type" : "structure",
424      "members" : {
425        "LanguageCode" : {
426          "shape" : "String"
427        },
428        "Text" : {
429          "shape" : "NonEmptyString"
430        },
431        "VoiceId" : {
432          "shape" : "String"
433        }
434      },
435      "required" : [ ]
436    },
437    "SSMLMessageType" : {
438      "type" : "structure",
439      "members" : {
440        "LanguageCode" : {
441          "shape" : "String"
442        },
443        "Text" : {
444          "shape" : "NonEmptyString"
445        },
446        "VoiceId" : {
447          "shape" : "String"
448        }
449      },
450      "required" : [ ]
451    },
452    "SendVoiceMessageRequest" : {
453      "type" : "structure",
454      "members" : {
455        "CallerId" : {
456          "shape" : "String"
457        },
458        "ConfigurationSetName" : {
459          "shape" : "WordCharactersWithDelimiters"
460        },
461        "Content" : {
462          "shape" : "VoiceMessageContent"
463        },
464        "DestinationPhoneNumber" : {
465          "shape" : "NonEmptyString"
466        },
467        "OriginationPhoneNumber" : {
468          "shape" : "NonEmptyString"
469        }
470      }
471    },
472    "SendVoiceMessageResponse" : {
473      "type" : "structure",
474      "members" : {
475        "MessageId" : {
476          "shape" : "String"
477        }
478      }
479    },
480    "String" : {
481      "type" : "string"
482    },
483    "TooManyRequestsException" : {
484      "type" : "structure",
485      "exception" : true,
486      "members" : {
487        "Message" : {
488          "shape" : "String"
489        }
490      },
491      "error" : {
492        "httpStatusCode" : 429
493      }
494    },
495    "UpdateConfigurationSetEventDestinationRequest" : {
496      "type" : "structure",
497      "members" : {
498        "ConfigurationSetName" : {
499          "shape" : "__string",
500          "location" : "uri",
501          "locationName" : "ConfigurationSetName"
502        },
503        "EventDestination" : {
504          "shape" : "EventDestinationDefinition"
505        },
506        "EventDestinationName" : {
507          "shape" : "__string",
508          "location" : "uri",
509          "locationName" : "EventDestinationName"
510        }
511      },
512      "required" : [ "EventDestinationName", "ConfigurationSetName" ]
513    },
514    "UpdateConfigurationSetEventDestinationResponse" : {
515      "type" : "structure",
516      "members" : { }
517    },
518    "VoiceMessageContent" : {
519      "type" : "structure",
520      "members" : {
521        "CallInstructionsMessage" : {
522          "shape" : "CallInstructionsMessageType"
523        },
524        "PlainTextMessage" : {
525          "shape" : "PlainTextMessageType"
526        },
527        "SSMLMessage" : {
528          "shape" : "SSMLMessageType"
529        }
530      }
531    },
532    "WordCharactersWithDelimiters" : {
533      "type" : "string"
534    },
535    "__boolean" : {
536      "type" : "boolean"
537    },
538    "__double" : {
539      "type" : "double"
540    },
541    "__integer" : {
542      "type" : "integer"
543    },
544    "__long" : {
545      "type" : "long"
546    },
547    "__string" : {
548      "type" : "string"
549    },
550    "__timestampIso8601" : {
551      "type" : "timestamp",
552      "timestampFormat" : "iso8601"
553    },
554    "__timestampUnix" : {
555      "type" : "timestamp",
556      "timestampFormat" : "unixTimestamp"
557    }
558  }
559}