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

     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      "ListConfigurationSets" : {
   137        "name" : "ListConfigurationSets",
   138        "http" : {
   139          "method" : "GET",
   140          "requestUri" : "/v1/sms-voice/configuration-sets",
   141          "responseCode" : 200
   142        },
   143        "input" : {
   144          "shape" : "ListConfigurationSetsRequest"
   145        },
   146        "output" : {
   147          "shape" : "ListConfigurationSetsResponse"
   148        },
   149        "errors" : [ {
   150          "shape" : "TooManyRequestsException"
   151        }, {
   152          "shape" : "BadRequestException"
   153        }, {
   154          "shape" : "InternalServiceErrorException"
   155        } ]
   156      },
   157      "SendVoiceMessage" : {
   158        "name" : "SendVoiceMessage",
   159        "http" : {
   160          "method" : "POST",
   161          "requestUri" : "/v1/sms-voice/voice/message",
   162          "responseCode" : 200
   163        },
   164        "input" : {
   165          "shape" : "SendVoiceMessageRequest"
   166        },
   167        "output" : {
   168          "shape" : "SendVoiceMessageResponse"
   169        },
   170        "errors" : [ {
   171          "shape" : "TooManyRequestsException"
   172        }, {
   173          "shape" : "BadRequestException"
   174        }, {
   175          "shape" : "InternalServiceErrorException"
   176        } ]
   177      },
   178      "UpdateConfigurationSetEventDestination" : {
   179        "name" : "UpdateConfigurationSetEventDestination",
   180        "http" : {
   181          "method" : "PUT",
   182          "requestUri" : "/v1/sms-voice/configuration-sets/{ConfigurationSetName}/event-destinations/{EventDestinationName}",
   183          "responseCode" : 200
   184        },
   185        "input" : {
   186          "shape" : "UpdateConfigurationSetEventDestinationRequest"
   187        },
   188        "output" : {
   189          "shape" : "UpdateConfigurationSetEventDestinationResponse"
   190        },
   191        "errors" : [ {
   192          "shape" : "NotFoundException"
   193        }, {
   194          "shape" : "TooManyRequestsException"
   195        }, {
   196          "shape" : "BadRequestException"
   197        }, {
   198          "shape" : "InternalServiceErrorException"
   199        } ]
   200      }
   201    },
   202    "shapes" : {
   203      "AlreadyExistsException" : {
   204        "type" : "structure",
   205        "members" : {
   206          "Message" : {
   207            "shape" : "String"
   208          }
   209        },
   210        "exception" : true,
   211        "error" : {
   212          "httpStatusCode" : 409
   213        }
   214      },
   215      "BadRequestException" : {
   216        "type" : "structure",
   217        "members" : {
   218          "Message" : {
   219            "shape" : "String"
   220          }
   221        },
   222        "exception" : true,
   223        "error" : {
   224          "httpStatusCode" : 400
   225        }
   226      },
   227      "Boolean" : {
   228        "type" : "boolean"
   229      },
   230      "CallInstructionsMessageType" : {
   231        "type" : "structure",
   232        "members" : {
   233          "Text" : {
   234            "shape" : "NonEmptyString"
   235          }
   236        },
   237        "required" : [ ]
   238      },
   239      "CloudWatchLogsDestination" : {
   240        "type" : "structure",
   241        "members" : {
   242          "IamRoleArn" : {
   243            "shape" : "String"
   244          },
   245          "LogGroupArn" : {
   246            "shape" : "String"
   247          }
   248        },
   249        "required" : [ ]
   250      },
   251      "ConfigurationSets" : {
   252        "type" : "list",
   253        "member" : {
   254          "shape" : "WordCharactersWithDelimiters"
   255        }
   256      },
   257      "CreateConfigurationSetEventDestinationRequest" : {
   258        "type" : "structure",
   259        "members" : {
   260          "ConfigurationSetName" : {
   261            "shape" : "__string",
   262            "location" : "uri",
   263            "locationName" : "ConfigurationSetName"
   264          },
   265          "EventDestination" : {
   266            "shape" : "EventDestinationDefinition"
   267          },
   268          "EventDestinationName" : {
   269            "shape" : "NonEmptyString"
   270          }
   271        },
   272        "required" : [ "ConfigurationSetName" ]
   273      },
   274      "CreateConfigurationSetEventDestinationResponse" : {
   275        "type" : "structure",
   276        "members" : { }
   277      },
   278      "CreateConfigurationSetRequest" : {
   279        "type" : "structure",
   280        "members" : {
   281          "ConfigurationSetName" : {
   282            "shape" : "WordCharactersWithDelimiters"
   283          }
   284        }
   285      },
   286      "CreateConfigurationSetResponse" : {
   287        "type" : "structure",
   288        "members" : { }
   289      },
   290      "DeleteConfigurationSetEventDestinationRequest" : {
   291        "type" : "structure",
   292        "members" : {
   293          "ConfigurationSetName" : {
   294            "shape" : "__string",
   295            "location" : "uri",
   296            "locationName" : "ConfigurationSetName"
   297          },
   298          "EventDestinationName" : {
   299            "shape" : "__string",
   300            "location" : "uri",
   301            "locationName" : "EventDestinationName"
   302          }
   303        },
   304        "required" : [ "EventDestinationName", "ConfigurationSetName" ]
   305      },
   306      "DeleteConfigurationSetEventDestinationResponse" : {
   307        "type" : "structure",
   308        "members" : { }
   309      },
   310      "DeleteConfigurationSetRequest" : {
   311        "type" : "structure",
   312        "members" : {
   313          "ConfigurationSetName" : {
   314            "shape" : "__string",
   315            "location" : "uri",
   316            "locationName" : "ConfigurationSetName"
   317          }
   318        },
   319        "required" : [ "ConfigurationSetName" ]
   320      },
   321      "DeleteConfigurationSetResponse" : {
   322        "type" : "structure",
   323        "members" : { }
   324      },
   325      "EventDestination" : {
   326        "type" : "structure",
   327        "members" : {
   328          "CloudWatchLogsDestination" : {
   329            "shape" : "CloudWatchLogsDestination"
   330          },
   331          "Enabled" : {
   332            "shape" : "Boolean"
   333          },
   334          "KinesisFirehoseDestination" : {
   335            "shape" : "KinesisFirehoseDestination"
   336          },
   337          "MatchingEventTypes" : {
   338            "shape" : "EventTypes"
   339          },
   340          "Name" : {
   341            "shape" : "String"
   342          },
   343          "SnsDestination" : {
   344            "shape" : "SnsDestination"
   345          }
   346        }
   347      },
   348      "EventDestinationDefinition" : {
   349        "type" : "structure",
   350        "members" : {
   351          "CloudWatchLogsDestination" : {
   352            "shape" : "CloudWatchLogsDestination"
   353          },
   354          "Enabled" : {
   355            "shape" : "Boolean"
   356          },
   357          "KinesisFirehoseDestination" : {
   358            "shape" : "KinesisFirehoseDestination"
   359          },
   360          "MatchingEventTypes" : {
   361            "shape" : "EventTypes"
   362          },
   363          "SnsDestination" : {
   364            "shape" : "SnsDestination"
   365          }
   366        },
   367        "required" : [ ]
   368      },
   369      "EventDestinations" : {
   370        "type" : "list",
   371        "member" : {
   372          "shape" : "EventDestination"
   373        }
   374      },
   375      "EventType" : {
   376        "type" : "string",
   377        "enum" : [ "INITIATED_CALL", "RINGING", "ANSWERED", "COMPLETED_CALL", "BUSY", "FAILED", "NO_ANSWER" ]
   378      },
   379      "EventTypes" : {
   380        "type" : "list",
   381        "member" : {
   382          "shape" : "EventType"
   383        }
   384      },
   385      "GetConfigurationSetEventDestinationsRequest" : {
   386        "type" : "structure",
   387        "members" : {
   388          "ConfigurationSetName" : {
   389            "shape" : "__string",
   390            "location" : "uri",
   391            "locationName" : "ConfigurationSetName"
   392          }
   393        },
   394        "required" : [ "ConfigurationSetName" ]
   395      },
   396      "GetConfigurationSetEventDestinationsResponse" : {
   397        "type" : "structure",
   398        "members" : {
   399          "EventDestinations" : {
   400            "shape" : "EventDestinations"
   401          }
   402        }
   403      },
   404      "InternalServiceErrorException" : {
   405        "type" : "structure",
   406        "members" : {
   407          "Message" : {
   408            "shape" : "String"
   409          }
   410        },
   411        "exception" : true,
   412        "error" : {
   413          "httpStatusCode" : 500
   414        }
   415      },
   416      "KinesisFirehoseDestination" : {
   417        "type" : "structure",
   418        "members" : {
   419          "DeliveryStreamArn" : {
   420            "shape" : "String"
   421          },
   422          "IamRoleArn" : {
   423            "shape" : "String"
   424          }
   425        },
   426        "required" : [ ]
   427      },
   428      "LimitExceededException" : {
   429        "type" : "structure",
   430        "members" : {
   431          "Message" : {
   432            "shape" : "String"
   433          }
   434        },
   435        "exception" : true,
   436        "error" : {
   437          "httpStatusCode" : 412
   438        }
   439      },
   440      "ListConfigurationSetsRequest" : {
   441        "type" : "structure",
   442        "members" : {
   443          "NextToken" : {
   444            "shape" : "__string",
   445            "location" : "querystring",
   446            "locationName" : "NextToken"
   447          },
   448          "PageSize" : {
   449            "shape" : "__string",
   450            "location" : "querystring",
   451            "locationName" : "PageSize"
   452          }
   453        }
   454      },
   455      "ListConfigurationSetsResponse" : {
   456        "type" : "structure",
   457        "members" : {
   458          "ConfigurationSets" : {
   459            "shape" : "ConfigurationSets"
   460          },
   461          "NextToken" : {
   462            "shape" : "NextTokenString"
   463          }
   464        }
   465      },
   466      "NextTokenString" : {
   467        "type" : "string"
   468      },
   469      "NonEmptyString" : {
   470        "type" : "string"
   471      },
   472      "NotFoundException" : {
   473        "type" : "structure",
   474        "members" : {
   475          "Message" : {
   476            "shape" : "String"
   477          }
   478        },
   479        "exception" : true,
   480        "error" : {
   481          "httpStatusCode" : 404
   482        }
   483      },
   484      "PlainTextMessageType" : {
   485        "type" : "structure",
   486        "members" : {
   487          "LanguageCode" : {
   488            "shape" : "String"
   489          },
   490          "Text" : {
   491            "shape" : "NonEmptyString"
   492          },
   493          "VoiceId" : {
   494            "shape" : "String"
   495          }
   496        },
   497        "required" : [ ]
   498      },
   499      "SSMLMessageType" : {
   500        "type" : "structure",
   501        "members" : {
   502          "LanguageCode" : {
   503            "shape" : "String"
   504          },
   505          "Text" : {
   506            "shape" : "NonEmptyString"
   507          },
   508          "VoiceId" : {
   509            "shape" : "String"
   510          }
   511        },
   512        "required" : [ ]
   513      },
   514      "SendVoiceMessageRequest" : {
   515        "type" : "structure",
   516        "members" : {
   517          "CallerId" : {
   518            "shape" : "String"
   519          },
   520          "ConfigurationSetName" : {
   521            "shape" : "WordCharactersWithDelimiters"
   522          },
   523          "Content" : {
   524            "shape" : "VoiceMessageContent"
   525          },
   526          "DestinationPhoneNumber" : {
   527            "shape" : "NonEmptyString"
   528          },
   529          "OriginationPhoneNumber" : {
   530            "shape" : "NonEmptyString"
   531          }
   532        }
   533      },
   534      "SendVoiceMessageResponse" : {
   535        "type" : "structure",
   536        "members" : {
   537          "MessageId" : {
   538            "shape" : "String"
   539          }
   540        }
   541      },
   542      "SnsDestination" : {
   543        "type" : "structure",
   544        "members" : {
   545          "TopicArn" : {
   546            "shape" : "String"
   547          }
   548        },
   549        "required" : [ ]
   550      },
   551      "String" : {
   552        "type" : "string"
   553      },
   554      "TooManyRequestsException" : {
   555        "type" : "structure",
   556        "members" : {
   557          "Message" : {
   558            "shape" : "String"
   559          }
   560        },
   561        "exception" : true,
   562        "error" : {
   563          "httpStatusCode" : 429
   564        }
   565      },
   566      "UpdateConfigurationSetEventDestinationRequest" : {
   567        "type" : "structure",
   568        "members" : {
   569          "ConfigurationSetName" : {
   570            "shape" : "__string",
   571            "location" : "uri",
   572            "locationName" : "ConfigurationSetName"
   573          },
   574          "EventDestination" : {
   575            "shape" : "EventDestinationDefinition"
   576          },
   577          "EventDestinationName" : {
   578            "shape" : "__string",
   579            "location" : "uri",
   580            "locationName" : "EventDestinationName"
   581          }
   582        },
   583        "required" : [ "EventDestinationName", "ConfigurationSetName" ]
   584      },
   585      "UpdateConfigurationSetEventDestinationResponse" : {
   586        "type" : "structure",
   587        "members" : { }
   588      },
   589      "VoiceMessageContent" : {
   590        "type" : "structure",
   591        "members" : {
   592          "CallInstructionsMessage" : {
   593            "shape" : "CallInstructionsMessageType"
   594          },
   595          "PlainTextMessage" : {
   596            "shape" : "PlainTextMessageType"
   597          },
   598          "SSMLMessage" : {
   599            "shape" : "SSMLMessageType"
   600          }
   601        }
   602      },
   603      "WordCharactersWithDelimiters" : {
   604        "type" : "string"
   605      },
   606      "__boolean" : {
   607        "type" : "boolean"
   608      },
   609      "__double" : {
   610        "type" : "double"
   611      },
   612      "__integer" : {
   613        "type" : "integer"
   614      },
   615      "__long" : {
   616        "type" : "long"
   617      },
   618      "__string" : {
   619        "type" : "string"
   620      },
   621      "__timestampIso8601" : {
   622        "type" : "timestamp",
   623        "timestampFormat" : "iso8601"
   624      },
   625      "__timestampUnix" : {
   626        "type" : "timestamp",
   627        "timestampFormat" : "unixTimestamp"
   628      }
   629    }
   630  }