aws-sdk-pinpointsmsvoice 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/lib/aws-sdk-pinpointsmsvoice.rb +47 -0
- data/lib/aws-sdk-pinpointsmsvoice/client.rb +488 -0
- data/lib/aws-sdk-pinpointsmsvoice/client_api.rb +253 -0
- data/lib/aws-sdk-pinpointsmsvoice/customizations.rb +0 -0
- data/lib/aws-sdk-pinpointsmsvoice/errors.rb +14 -0
- data/lib/aws-sdk-pinpointsmsvoice/resource.rb +23 -0
- data/lib/aws-sdk-pinpointsmsvoice/types.rb +581 -0
- metadata +88 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: feff95916b5482e64ac69d17b2ed69f61e3bc210
|
4
|
+
data.tar.gz: 5608ce1cf18cf7c16fd9a151b55ffcdcec9dc938
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: de951db6b120cf08074b819859eaa9981abb163eaf35c100441a248cbc1561e5487afd35be4b033838ad7d6c84289c1ff165031e64701e9f661ae5209a5aa50d
|
7
|
+
data.tar.gz: 29993e8fe1966156eda3ce700a1c412efc02f758fdc37beba3761082fa8c6380a6699ddfd42ff2fa2ceade1279850d242f83679ce18ba7c33e41a34c933cd53c
|
@@ -0,0 +1,47 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
require 'aws-sdk-core'
|
9
|
+
require 'aws-sigv4'
|
10
|
+
|
11
|
+
require_relative 'aws-sdk-pinpointsmsvoice/types'
|
12
|
+
require_relative 'aws-sdk-pinpointsmsvoice/client_api'
|
13
|
+
require_relative 'aws-sdk-pinpointsmsvoice/client'
|
14
|
+
require_relative 'aws-sdk-pinpointsmsvoice/errors'
|
15
|
+
require_relative 'aws-sdk-pinpointsmsvoice/resource'
|
16
|
+
require_relative 'aws-sdk-pinpointsmsvoice/customizations'
|
17
|
+
|
18
|
+
# This module provides support for Amazon Pinpoint SMS and Voice Service. This module is available in the
|
19
|
+
# `aws-sdk-pinpointsmsvoice` gem.
|
20
|
+
#
|
21
|
+
# # Client
|
22
|
+
#
|
23
|
+
# The {Client} class provides one method for each API operation. Operation
|
24
|
+
# methods each accept a hash of request parameters and return a response
|
25
|
+
# structure.
|
26
|
+
#
|
27
|
+
# See {Client} for more information.
|
28
|
+
#
|
29
|
+
# # Errors
|
30
|
+
#
|
31
|
+
# Errors returned from Amazon Pinpoint SMS and Voice Service all
|
32
|
+
# extend {Errors::ServiceError}.
|
33
|
+
#
|
34
|
+
# begin
|
35
|
+
# # do stuff
|
36
|
+
# rescue Aws::PinpointSMSVoice::Errors::ServiceError
|
37
|
+
# # rescues all service API errors
|
38
|
+
# end
|
39
|
+
#
|
40
|
+
# See {Errors} for more information.
|
41
|
+
#
|
42
|
+
# @service
|
43
|
+
module Aws::PinpointSMSVoice
|
44
|
+
|
45
|
+
GEM_VERSION = '1.0.0'
|
46
|
+
|
47
|
+
end
|
@@ -0,0 +1,488 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
require 'seahorse/client/plugins/content_length.rb'
|
9
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
10
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
11
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
12
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
13
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
14
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
15
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
16
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
17
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
18
|
+
require 'aws-sdk-core/plugins/endpoint_discovery.rb'
|
19
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
20
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
21
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
22
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
23
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
24
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
25
|
+
require 'aws-sdk-core/plugins/signature_v4.rb'
|
26
|
+
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
27
|
+
|
28
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:pinpointsmsvoice)
|
29
|
+
|
30
|
+
module Aws::PinpointSMSVoice
|
31
|
+
class Client < Seahorse::Client::Base
|
32
|
+
|
33
|
+
include Aws::ClientStubs
|
34
|
+
|
35
|
+
@identifier = :pinpointsmsvoice
|
36
|
+
|
37
|
+
set_api(ClientApi::API)
|
38
|
+
|
39
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
40
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
41
|
+
add_plugin(Aws::Plugins::Logging)
|
42
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
43
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
44
|
+
add_plugin(Aws::Plugins::UserAgent)
|
45
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
46
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
47
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
48
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
49
|
+
add_plugin(Aws::Plugins::EndpointDiscovery)
|
50
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
51
|
+
add_plugin(Aws::Plugins::StubResponses)
|
52
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
53
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
54
|
+
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
55
|
+
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
56
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
57
|
+
add_plugin(Aws::Plugins::Protocols::RestJson)
|
58
|
+
|
59
|
+
# @overload initialize(options)
|
60
|
+
# @param [Hash] options
|
61
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
62
|
+
# Your AWS credentials. This can be an instance of any one of the
|
63
|
+
# following classes:
|
64
|
+
#
|
65
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
66
|
+
# credentials.
|
67
|
+
#
|
68
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
69
|
+
# from an EC2 IMDS on an EC2 instance.
|
70
|
+
#
|
71
|
+
# * `Aws::SharedCredentials` - Used for loading credentials from a
|
72
|
+
# shared file, such as `~/.aws/config`.
|
73
|
+
#
|
74
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
75
|
+
#
|
76
|
+
# When `:credentials` are not configured directly, the following
|
77
|
+
# locations will be searched for credentials:
|
78
|
+
#
|
79
|
+
# * `Aws.config[:credentials]`
|
80
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
81
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
82
|
+
# * `~/.aws/credentials`
|
83
|
+
# * `~/.aws/config`
|
84
|
+
# * EC2 IMDS instance profile - When used by default, the timeouts are
|
85
|
+
# very aggressive. Construct and pass an instance of
|
86
|
+
# `Aws::InstanceProfileCredentails` to enable retries and extended
|
87
|
+
# timeouts.
|
88
|
+
#
|
89
|
+
# @option options [required, String] :region
|
90
|
+
# The AWS region to connect to. The configured `:region` is
|
91
|
+
# used to determine the service `:endpoint`. When not passed,
|
92
|
+
# a default `:region` is search for in the following locations:
|
93
|
+
#
|
94
|
+
# * `Aws.config[:region]`
|
95
|
+
# * `ENV['AWS_REGION']`
|
96
|
+
# * `ENV['AMAZON_REGION']`
|
97
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
98
|
+
# * `~/.aws/credentials`
|
99
|
+
# * `~/.aws/config`
|
100
|
+
#
|
101
|
+
# @option options [String] :access_key_id
|
102
|
+
#
|
103
|
+
# @option options [Boolean] :active_endpoint_cache (false)
|
104
|
+
# When set to `true`, a thread polling for endpoints will be running in
|
105
|
+
# the background every 60 secs (default). Defaults to `false`.
|
106
|
+
#
|
107
|
+
# @option options [Boolean] :client_side_monitoring (false)
|
108
|
+
# When `true`, client-side metrics will be collected for all API requests from
|
109
|
+
# this client.
|
110
|
+
#
|
111
|
+
# @option options [String] :client_side_monitoring_client_id ("")
|
112
|
+
# Allows you to provide an identifier for this client which will be attached to
|
113
|
+
# all generated client side metrics. Defaults to an empty string.
|
114
|
+
#
|
115
|
+
# @option options [Integer] :client_side_monitoring_port (31000)
|
116
|
+
# Required for publishing client metrics. The port that the client side monitoring
|
117
|
+
# agent is running on, where client metrics will be published via UDP.
|
118
|
+
#
|
119
|
+
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
|
120
|
+
# Allows you to provide a custom client-side monitoring publisher class. By default,
|
121
|
+
# will use the Client Side Monitoring Agent Publisher.
|
122
|
+
#
|
123
|
+
# @option options [Boolean] :convert_params (true)
|
124
|
+
# When `true`, an attempt is made to coerce request parameters into
|
125
|
+
# the required types.
|
126
|
+
#
|
127
|
+
# @option options [String] :endpoint
|
128
|
+
# The client endpoint is normally constructed from the `:region`
|
129
|
+
# option. You should only configure an `:endpoint` when connecting
|
130
|
+
# to test endpoints. This should be avalid HTTP(S) URI.
|
131
|
+
#
|
132
|
+
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
133
|
+
# Used for the maximum size limit of the LRU cache storing endpoints data
|
134
|
+
# for endpoint discovery enabled operations. Defaults to 1000.
|
135
|
+
#
|
136
|
+
# @option options [Integer] :endpoint_cache_max_threads (10)
|
137
|
+
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
|
138
|
+
#
|
139
|
+
# @option options [Integer] :endpoint_cache_poll_interval (60)
|
140
|
+
# When :endpoint_discovery and :active_endpoint_cache is enabled,
|
141
|
+
# Use this option to config the time interval in seconds for making
|
142
|
+
# requests fetching endpoints information. Defaults to 60 sec.
|
143
|
+
#
|
144
|
+
# @option options [Boolean] :endpoint_discovery (false)
|
145
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
|
146
|
+
#
|
147
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
148
|
+
# The log formatter.
|
149
|
+
#
|
150
|
+
# @option options [Symbol] :log_level (:info)
|
151
|
+
# The log level to send messages to the `:logger` at.
|
152
|
+
#
|
153
|
+
# @option options [Logger] :logger
|
154
|
+
# The Logger instance to send log messages to. If this option
|
155
|
+
# is not set, logging will be disabled.
|
156
|
+
#
|
157
|
+
# @option options [String] :profile ("default")
|
158
|
+
# Used when loading credentials from the shared credentials file
|
159
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
160
|
+
#
|
161
|
+
# @option options [Float] :retry_base_delay (0.3)
|
162
|
+
# The base delay in seconds used by the default backoff function.
|
163
|
+
#
|
164
|
+
# @option options [Symbol] :retry_jitter (:none)
|
165
|
+
# A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
|
166
|
+
#
|
167
|
+
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
168
|
+
#
|
169
|
+
# @option options [Integer] :retry_limit (3)
|
170
|
+
# The maximum number of times to retry failed requests. Only
|
171
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
172
|
+
# are retried. Generally, these are throttling errors, data
|
173
|
+
# checksum errors, networking errors, timeout errors and auth
|
174
|
+
# errors from expired credentials.
|
175
|
+
#
|
176
|
+
# @option options [Integer] :retry_max_delay (0)
|
177
|
+
# The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
|
178
|
+
#
|
179
|
+
# @option options [String] :secret_access_key
|
180
|
+
#
|
181
|
+
# @option options [String] :session_token
|
182
|
+
#
|
183
|
+
# @option options [Boolean] :stub_responses (false)
|
184
|
+
# Causes the client to return stubbed responses. By default
|
185
|
+
# fake responses are generated and returned. You can specify
|
186
|
+
# the response data to return or errors to raise by calling
|
187
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
188
|
+
#
|
189
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
190
|
+
# requests are made, and retries are disabled.
|
191
|
+
#
|
192
|
+
# @option options [Boolean] :validate_params (true)
|
193
|
+
# When `true`, request parameters are validated before
|
194
|
+
# sending the request.
|
195
|
+
#
|
196
|
+
def initialize(*args)
|
197
|
+
super
|
198
|
+
end
|
199
|
+
|
200
|
+
# @!group API Operations
|
201
|
+
|
202
|
+
# Create a new configuration set. After you create the configuration
|
203
|
+
# set, you can add one or more event destinations to it.
|
204
|
+
#
|
205
|
+
# @option params [String] :configuration_set_name
|
206
|
+
# The name that you want to give the configuration set.
|
207
|
+
#
|
208
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
209
|
+
#
|
210
|
+
# @example Request syntax with placeholder values
|
211
|
+
#
|
212
|
+
# resp = client.create_configuration_set({
|
213
|
+
# configuration_set_name: "WordCharactersWithDelimiters",
|
214
|
+
# })
|
215
|
+
#
|
216
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/CreateConfigurationSet AWS API Documentation
|
217
|
+
#
|
218
|
+
# @overload create_configuration_set(params = {})
|
219
|
+
# @param [Hash] params ({})
|
220
|
+
def create_configuration_set(params = {}, options = {})
|
221
|
+
req = build_request(:create_configuration_set, params)
|
222
|
+
req.send_request(options)
|
223
|
+
end
|
224
|
+
|
225
|
+
# Create a new event destination in a configuration set.
|
226
|
+
#
|
227
|
+
# @option params [required, String] :configuration_set_name
|
228
|
+
#
|
229
|
+
# @option params [Types::EventDestinationDefinition] :event_destination
|
230
|
+
# An object that defines a single event destination.
|
231
|
+
#
|
232
|
+
# @option params [String] :event_destination_name
|
233
|
+
# A name that identifies the event destination.
|
234
|
+
#
|
235
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
236
|
+
#
|
237
|
+
# @example Request syntax with placeholder values
|
238
|
+
#
|
239
|
+
# resp = client.create_configuration_set_event_destination({
|
240
|
+
# configuration_set_name: "__string", # required
|
241
|
+
# event_destination: {
|
242
|
+
# cloud_watch_logs_destination: {
|
243
|
+
# iam_role_arn: "String",
|
244
|
+
# log_group_arn: "String",
|
245
|
+
# },
|
246
|
+
# enabled: false,
|
247
|
+
# kinesis_firehose_destination: {
|
248
|
+
# delivery_stream_arn: "String",
|
249
|
+
# iam_role_arn: "String",
|
250
|
+
# },
|
251
|
+
# matching_event_types: ["INITIATED_CALL"], # accepts INITIATED_CALL, RINGING, ANSWERED, COMPLETED_CALL, BUSY, FAILED, NO_ANSWER
|
252
|
+
# },
|
253
|
+
# event_destination_name: "NonEmptyString",
|
254
|
+
# })
|
255
|
+
#
|
256
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/CreateConfigurationSetEventDestination AWS API Documentation
|
257
|
+
#
|
258
|
+
# @overload create_configuration_set_event_destination(params = {})
|
259
|
+
# @param [Hash] params ({})
|
260
|
+
def create_configuration_set_event_destination(params = {}, options = {})
|
261
|
+
req = build_request(:create_configuration_set_event_destination, params)
|
262
|
+
req.send_request(options)
|
263
|
+
end
|
264
|
+
|
265
|
+
# Deletes an existing configuration set.
|
266
|
+
#
|
267
|
+
# @option params [required, String] :configuration_set_name
|
268
|
+
#
|
269
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
270
|
+
#
|
271
|
+
# @example Request syntax with placeholder values
|
272
|
+
#
|
273
|
+
# resp = client.delete_configuration_set({
|
274
|
+
# configuration_set_name: "__string", # required
|
275
|
+
# })
|
276
|
+
#
|
277
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/DeleteConfigurationSet AWS API Documentation
|
278
|
+
#
|
279
|
+
# @overload delete_configuration_set(params = {})
|
280
|
+
# @param [Hash] params ({})
|
281
|
+
def delete_configuration_set(params = {}, options = {})
|
282
|
+
req = build_request(:delete_configuration_set, params)
|
283
|
+
req.send_request(options)
|
284
|
+
end
|
285
|
+
|
286
|
+
# Deletes an event destination in a configuration set.
|
287
|
+
#
|
288
|
+
# @option params [required, String] :configuration_set_name
|
289
|
+
#
|
290
|
+
# @option params [required, String] :event_destination_name
|
291
|
+
#
|
292
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
293
|
+
#
|
294
|
+
# @example Request syntax with placeholder values
|
295
|
+
#
|
296
|
+
# resp = client.delete_configuration_set_event_destination({
|
297
|
+
# configuration_set_name: "__string", # required
|
298
|
+
# event_destination_name: "__string", # required
|
299
|
+
# })
|
300
|
+
#
|
301
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/DeleteConfigurationSetEventDestination AWS API Documentation
|
302
|
+
#
|
303
|
+
# @overload delete_configuration_set_event_destination(params = {})
|
304
|
+
# @param [Hash] params ({})
|
305
|
+
def delete_configuration_set_event_destination(params = {}, options = {})
|
306
|
+
req = build_request(:delete_configuration_set_event_destination, params)
|
307
|
+
req.send_request(options)
|
308
|
+
end
|
309
|
+
|
310
|
+
# Obtain information about an event destination, including the types of
|
311
|
+
# events it reports, the Amazon Resource Name (ARN) of the destination,
|
312
|
+
# and the name of the event destination.
|
313
|
+
#
|
314
|
+
# @option params [required, String] :configuration_set_name
|
315
|
+
#
|
316
|
+
# @return [Types::GetConfigurationSetEventDestinationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
317
|
+
#
|
318
|
+
# * {Types::GetConfigurationSetEventDestinationsResponse#event_destinations #event_destinations} => Array<Types::EventDestination>
|
319
|
+
#
|
320
|
+
# @example Request syntax with placeholder values
|
321
|
+
#
|
322
|
+
# resp = client.get_configuration_set_event_destinations({
|
323
|
+
# configuration_set_name: "__string", # required
|
324
|
+
# })
|
325
|
+
#
|
326
|
+
# @example Response structure
|
327
|
+
#
|
328
|
+
# resp.event_destinations #=> Array
|
329
|
+
# resp.event_destinations[0].cloud_watch_logs_destination.iam_role_arn #=> String
|
330
|
+
# resp.event_destinations[0].cloud_watch_logs_destination.log_group_arn #=> String
|
331
|
+
# resp.event_destinations[0].enabled #=> Boolean
|
332
|
+
# resp.event_destinations[0].kinesis_firehose_destination.delivery_stream_arn #=> String
|
333
|
+
# resp.event_destinations[0].kinesis_firehose_destination.iam_role_arn #=> String
|
334
|
+
# resp.event_destinations[0].matching_event_types #=> Array
|
335
|
+
# resp.event_destinations[0].matching_event_types[0] #=> String, one of "INITIATED_CALL", "RINGING", "ANSWERED", "COMPLETED_CALL", "BUSY", "FAILED", "NO_ANSWER"
|
336
|
+
# resp.event_destinations[0].name #=> String
|
337
|
+
#
|
338
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/GetConfigurationSetEventDestinations AWS API Documentation
|
339
|
+
#
|
340
|
+
# @overload get_configuration_set_event_destinations(params = {})
|
341
|
+
# @param [Hash] params ({})
|
342
|
+
def get_configuration_set_event_destinations(params = {}, options = {})
|
343
|
+
req = build_request(:get_configuration_set_event_destinations, params)
|
344
|
+
req.send_request(options)
|
345
|
+
end
|
346
|
+
|
347
|
+
# Create a new voice message and send it to a recipient's phone number.
|
348
|
+
#
|
349
|
+
# @option params [String] :caller_id
|
350
|
+
# The phone number that appears on recipients' devices when they
|
351
|
+
# receive the message.
|
352
|
+
#
|
353
|
+
# @option params [String] :configuration_set_name
|
354
|
+
# The name of the configuration set that you want to use to send the
|
355
|
+
# message.
|
356
|
+
#
|
357
|
+
# @option params [Types::VoiceMessageContent] :content
|
358
|
+
# An object that contains a voice message and information about the
|
359
|
+
# recipient that you want to send it to.
|
360
|
+
#
|
361
|
+
# @option params [String] :destination_phone_number
|
362
|
+
# The phone number that you want to send the voice message to.
|
363
|
+
#
|
364
|
+
# @option params [String] :origination_phone_number
|
365
|
+
# The phone number that Amazon Pinpoint should use to send the voice
|
366
|
+
# message. This isn't necessarily the phone number that appears on
|
367
|
+
# recipients' devices when they receive the message, because you can
|
368
|
+
# specify a CallerId parameter in the request.
|
369
|
+
#
|
370
|
+
# @return [Types::SendVoiceMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
371
|
+
#
|
372
|
+
# * {Types::SendVoiceMessageResponse#message_id #message_id} => String
|
373
|
+
#
|
374
|
+
# @example Request syntax with placeholder values
|
375
|
+
#
|
376
|
+
# resp = client.send_voice_message({
|
377
|
+
# caller_id: "String",
|
378
|
+
# configuration_set_name: "WordCharactersWithDelimiters",
|
379
|
+
# content: {
|
380
|
+
# call_instructions_message: {
|
381
|
+
# text: "NonEmptyString",
|
382
|
+
# },
|
383
|
+
# plain_text_message: {
|
384
|
+
# language_code: "String",
|
385
|
+
# text: "NonEmptyString",
|
386
|
+
# voice_id: "String",
|
387
|
+
# },
|
388
|
+
# ssml_message: {
|
389
|
+
# language_code: "String",
|
390
|
+
# text: "NonEmptyString",
|
391
|
+
# voice_id: "String",
|
392
|
+
# },
|
393
|
+
# },
|
394
|
+
# destination_phone_number: "NonEmptyString",
|
395
|
+
# origination_phone_number: "NonEmptyString",
|
396
|
+
# })
|
397
|
+
#
|
398
|
+
# @example Response structure
|
399
|
+
#
|
400
|
+
# resp.message_id #=> String
|
401
|
+
#
|
402
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/SendVoiceMessage AWS API Documentation
|
403
|
+
#
|
404
|
+
# @overload send_voice_message(params = {})
|
405
|
+
# @param [Hash] params ({})
|
406
|
+
def send_voice_message(params = {}, options = {})
|
407
|
+
req = build_request(:send_voice_message, params)
|
408
|
+
req.send_request(options)
|
409
|
+
end
|
410
|
+
|
411
|
+
# Update an event destination in a configuration set. An event
|
412
|
+
# destination is a location that you publish information about your
|
413
|
+
# voice calls to. For example, you can log an event to an Amazon
|
414
|
+
# CloudWatch destination when a call fails.
|
415
|
+
#
|
416
|
+
# @option params [required, String] :configuration_set_name
|
417
|
+
#
|
418
|
+
# @option params [Types::EventDestinationDefinition] :event_destination
|
419
|
+
# An object that defines a single event destination.
|
420
|
+
#
|
421
|
+
# @option params [required, String] :event_destination_name
|
422
|
+
#
|
423
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
424
|
+
#
|
425
|
+
# @example Request syntax with placeholder values
|
426
|
+
#
|
427
|
+
# resp = client.update_configuration_set_event_destination({
|
428
|
+
# configuration_set_name: "__string", # required
|
429
|
+
# event_destination: {
|
430
|
+
# cloud_watch_logs_destination: {
|
431
|
+
# iam_role_arn: "String",
|
432
|
+
# log_group_arn: "String",
|
433
|
+
# },
|
434
|
+
# enabled: false,
|
435
|
+
# kinesis_firehose_destination: {
|
436
|
+
# delivery_stream_arn: "String",
|
437
|
+
# iam_role_arn: "String",
|
438
|
+
# },
|
439
|
+
# matching_event_types: ["INITIATED_CALL"], # accepts INITIATED_CALL, RINGING, ANSWERED, COMPLETED_CALL, BUSY, FAILED, NO_ANSWER
|
440
|
+
# },
|
441
|
+
# event_destination_name: "__string", # required
|
442
|
+
# })
|
443
|
+
#
|
444
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/pinpoint-sms-voice-2018-09-05/UpdateConfigurationSetEventDestination AWS API Documentation
|
445
|
+
#
|
446
|
+
# @overload update_configuration_set_event_destination(params = {})
|
447
|
+
# @param [Hash] params ({})
|
448
|
+
def update_configuration_set_event_destination(params = {}, options = {})
|
449
|
+
req = build_request(:update_configuration_set_event_destination, params)
|
450
|
+
req.send_request(options)
|
451
|
+
end
|
452
|
+
|
453
|
+
# @!endgroup
|
454
|
+
|
455
|
+
# @param params ({})
|
456
|
+
# @api private
|
457
|
+
def build_request(operation_name, params = {})
|
458
|
+
handlers = @handlers.for(operation_name)
|
459
|
+
context = Seahorse::Client::RequestContext.new(
|
460
|
+
operation_name: operation_name,
|
461
|
+
operation: config.api.operation(operation_name),
|
462
|
+
client: self,
|
463
|
+
params: params,
|
464
|
+
config: config)
|
465
|
+
context[:gem_name] = 'aws-sdk-pinpointsmsvoice'
|
466
|
+
context[:gem_version] = '1.0.0'
|
467
|
+
Seahorse::Client::Request.new(handlers, context)
|
468
|
+
end
|
469
|
+
|
470
|
+
# @api private
|
471
|
+
# @deprecated
|
472
|
+
def waiter_names
|
473
|
+
[]
|
474
|
+
end
|
475
|
+
|
476
|
+
class << self
|
477
|
+
|
478
|
+
# @api private
|
479
|
+
attr_reader :identifier
|
480
|
+
|
481
|
+
# @api private
|
482
|
+
def errors_module
|
483
|
+
Errors
|
484
|
+
end
|
485
|
+
|
486
|
+
end
|
487
|
+
end
|
488
|
+
end
|