aws-sdk-chimesdkvoice 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-chimesdkvoice/client.rb +2917 -0
- data/lib/aws-sdk-chimesdkvoice/client_api.rb +2264 -0
- data/lib/aws-sdk-chimesdkvoice/customizations.rb +0 -0
- data/lib/aws-sdk-chimesdkvoice/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-chimesdkvoice/endpoint_provider.rb +111 -0
- data/lib/aws-sdk-chimesdkvoice/endpoints.rb +1051 -0
- data/lib/aws-sdk-chimesdkvoice/errors.rb +148 -0
- data/lib/aws-sdk-chimesdkvoice/plugins/endpoints.rb +216 -0
- data/lib/aws-sdk-chimesdkvoice/resource.rb +26 -0
- data/lib/aws-sdk-chimesdkvoice/types.rb +3517 -0
- data/lib/aws-sdk-chimesdkvoice.rb +57 -0
- metadata +94 -0
@@ -0,0 +1,2917 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
require 'seahorse/client/plugins/content_length.rb'
|
11
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
12
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
13
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
14
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
15
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
16
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
17
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
18
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
19
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
20
|
+
require 'aws-sdk-core/plugins/endpoint_discovery.rb'
|
21
|
+
require 'aws-sdk-core/plugins/endpoint_pattern.rb'
|
22
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
23
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
24
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
25
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
26
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
27
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
|
+
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
31
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
32
|
+
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
33
|
+
require 'aws-sdk-core/plugins/sign.rb'
|
34
|
+
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
35
|
+
|
36
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:chimesdkvoice)
|
37
|
+
|
38
|
+
module Aws::ChimeSDKVoice
|
39
|
+
# An API client for ChimeSDKVoice. To construct a client, you need to configure a `:region` and `:credentials`.
|
40
|
+
#
|
41
|
+
# client = Aws::ChimeSDKVoice::Client.new(
|
42
|
+
# region: region_name,
|
43
|
+
# credentials: credentials,
|
44
|
+
# # ...
|
45
|
+
# )
|
46
|
+
#
|
47
|
+
# For details on configuring region and credentials see
|
48
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
49
|
+
#
|
50
|
+
# See {#initialize} for a full list of supported configuration options.
|
51
|
+
class Client < Seahorse::Client::Base
|
52
|
+
|
53
|
+
include Aws::ClientStubs
|
54
|
+
|
55
|
+
@identifier = :chimesdkvoice
|
56
|
+
|
57
|
+
set_api(ClientApi::API)
|
58
|
+
|
59
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
60
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
61
|
+
add_plugin(Aws::Plugins::Logging)
|
62
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
63
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
64
|
+
add_plugin(Aws::Plugins::UserAgent)
|
65
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
66
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
67
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
68
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
69
|
+
add_plugin(Aws::Plugins::EndpointDiscovery)
|
70
|
+
add_plugin(Aws::Plugins::EndpointPattern)
|
71
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
72
|
+
add_plugin(Aws::Plugins::StubResponses)
|
73
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
74
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
75
|
+
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
76
|
+
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
77
|
+
add_plugin(Aws::Plugins::TransferEncoding)
|
78
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
79
|
+
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
80
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
81
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
82
|
+
add_plugin(Aws::Plugins::Sign)
|
83
|
+
add_plugin(Aws::Plugins::Protocols::RestJson)
|
84
|
+
add_plugin(Aws::ChimeSDKVoice::Plugins::Endpoints)
|
85
|
+
|
86
|
+
# @overload initialize(options)
|
87
|
+
# @param [Hash] options
|
88
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
89
|
+
# Your AWS credentials. This can be an instance of any one of the
|
90
|
+
# following classes:
|
91
|
+
#
|
92
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
93
|
+
# credentials.
|
94
|
+
#
|
95
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
96
|
+
# shared file, such as `~/.aws/config`.
|
97
|
+
#
|
98
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
99
|
+
#
|
100
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
101
|
+
# assume a role after providing credentials via the web.
|
102
|
+
#
|
103
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
104
|
+
# access token generated from `aws login`.
|
105
|
+
#
|
106
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
107
|
+
# process that outputs to stdout.
|
108
|
+
#
|
109
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
110
|
+
# from an EC2 IMDS on an EC2 instance.
|
111
|
+
#
|
112
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
113
|
+
# instances running in ECS.
|
114
|
+
#
|
115
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
116
|
+
# from the Cognito Identity service.
|
117
|
+
#
|
118
|
+
# When `:credentials` are not configured directly, the following
|
119
|
+
# locations will be searched for credentials:
|
120
|
+
#
|
121
|
+
# * `Aws.config[:credentials]`
|
122
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
123
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
124
|
+
# * `~/.aws/credentials`
|
125
|
+
# * `~/.aws/config`
|
126
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
127
|
+
# are very aggressive. Construct and pass an instance of
|
128
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
129
|
+
# enable retries and extended timeouts. Instance profile credential
|
130
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
131
|
+
# to true.
|
132
|
+
#
|
133
|
+
# @option options [required, String] :region
|
134
|
+
# The AWS region to connect to. The configured `:region` is
|
135
|
+
# used to determine the service `:endpoint`. When not passed,
|
136
|
+
# a default `:region` is searched for in the following locations:
|
137
|
+
#
|
138
|
+
# * `Aws.config[:region]`
|
139
|
+
# * `ENV['AWS_REGION']`
|
140
|
+
# * `ENV['AMAZON_REGION']`
|
141
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
142
|
+
# * `~/.aws/credentials`
|
143
|
+
# * `~/.aws/config`
|
144
|
+
#
|
145
|
+
# @option options [String] :access_key_id
|
146
|
+
#
|
147
|
+
# @option options [Boolean] :active_endpoint_cache (false)
|
148
|
+
# When set to `true`, a thread polling for endpoints will be running in
|
149
|
+
# the background every 60 secs (default). Defaults to `false`.
|
150
|
+
#
|
151
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
152
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
153
|
+
# until there is sufficent client side capacity to retry the request.
|
154
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
155
|
+
# not retry instead of sleeping.
|
156
|
+
#
|
157
|
+
# @option options [Boolean] :client_side_monitoring (false)
|
158
|
+
# When `true`, client-side metrics will be collected for all API requests from
|
159
|
+
# this client.
|
160
|
+
#
|
161
|
+
# @option options [String] :client_side_monitoring_client_id ("")
|
162
|
+
# Allows you to provide an identifier for this client which will be attached to
|
163
|
+
# all generated client side metrics. Defaults to an empty string.
|
164
|
+
#
|
165
|
+
# @option options [String] :client_side_monitoring_host ("127.0.0.1")
|
166
|
+
# Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
|
167
|
+
# side monitoring agent is running on, where client metrics will be published via UDP.
|
168
|
+
#
|
169
|
+
# @option options [Integer] :client_side_monitoring_port (31000)
|
170
|
+
# Required for publishing client metrics. The port that the client side monitoring
|
171
|
+
# agent is running on, where client metrics will be published via UDP.
|
172
|
+
#
|
173
|
+
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
|
174
|
+
# Allows you to provide a custom client-side monitoring publisher class. By default,
|
175
|
+
# will use the Client Side Monitoring Agent Publisher.
|
176
|
+
#
|
177
|
+
# @option options [Boolean] :convert_params (true)
|
178
|
+
# When `true`, an attempt is made to coerce request parameters into
|
179
|
+
# the required types.
|
180
|
+
#
|
181
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
182
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
183
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
184
|
+
#
|
185
|
+
# @option options [String] :defaults_mode ("legacy")
|
186
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
187
|
+
# accepted modes and the configuration defaults that are included.
|
188
|
+
#
|
189
|
+
# @option options [Boolean] :disable_host_prefix_injection (false)
|
190
|
+
# Set to true to disable SDK automatically adding host prefix
|
191
|
+
# to default service endpoint when available.
|
192
|
+
#
|
193
|
+
# @option options [String] :endpoint
|
194
|
+
# The client endpoint is normally constructed from the `:region`
|
195
|
+
# option. You should only configure an `:endpoint` when connecting
|
196
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
197
|
+
#
|
198
|
+
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
199
|
+
# Used for the maximum size limit of the LRU cache storing endpoints data
|
200
|
+
# for endpoint discovery enabled operations. Defaults to 1000.
|
201
|
+
#
|
202
|
+
# @option options [Integer] :endpoint_cache_max_threads (10)
|
203
|
+
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
|
204
|
+
#
|
205
|
+
# @option options [Integer] :endpoint_cache_poll_interval (60)
|
206
|
+
# When :endpoint_discovery and :active_endpoint_cache is enabled,
|
207
|
+
# Use this option to config the time interval in seconds for making
|
208
|
+
# requests fetching endpoints information. Defaults to 60 sec.
|
209
|
+
#
|
210
|
+
# @option options [Boolean] :endpoint_discovery (false)
|
211
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
212
|
+
#
|
213
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
214
|
+
# The log formatter.
|
215
|
+
#
|
216
|
+
# @option options [Symbol] :log_level (:info)
|
217
|
+
# The log level to send messages to the `:logger` at.
|
218
|
+
#
|
219
|
+
# @option options [Logger] :logger
|
220
|
+
# The Logger instance to send log messages to. If this option
|
221
|
+
# is not set, logging will be disabled.
|
222
|
+
#
|
223
|
+
# @option options [Integer] :max_attempts (3)
|
224
|
+
# An integer representing the maximum number attempts that will be made for
|
225
|
+
# a single request, including the initial attempt. For example,
|
226
|
+
# setting this value to 5 will result in a request being retried up to
|
227
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
228
|
+
#
|
229
|
+
# @option options [String] :profile ("default")
|
230
|
+
# Used when loading credentials from the shared credentials file
|
231
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
232
|
+
#
|
233
|
+
# @option options [Proc] :retry_backoff
|
234
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
235
|
+
# This option is only used in the `legacy` retry mode.
|
236
|
+
#
|
237
|
+
# @option options [Float] :retry_base_delay (0.3)
|
238
|
+
# The base delay in seconds used by the default backoff function. This option
|
239
|
+
# is only used in the `legacy` retry mode.
|
240
|
+
#
|
241
|
+
# @option options [Symbol] :retry_jitter (:none)
|
242
|
+
# A delay randomiser function used by the default backoff function.
|
243
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
244
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
245
|
+
# in the `legacy` retry mode.
|
246
|
+
#
|
247
|
+
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
248
|
+
#
|
249
|
+
# @option options [Integer] :retry_limit (3)
|
250
|
+
# The maximum number of times to retry failed requests. Only
|
251
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
252
|
+
# are retried. Generally, these are throttling errors, data
|
253
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
254
|
+
# endpoint discovery, and errors from expired credentials.
|
255
|
+
# This option is only used in the `legacy` retry mode.
|
256
|
+
#
|
257
|
+
# @option options [Integer] :retry_max_delay (0)
|
258
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
259
|
+
# used by the default backoff function. This option is only used in the
|
260
|
+
# `legacy` retry mode.
|
261
|
+
#
|
262
|
+
# @option options [String] :retry_mode ("legacy")
|
263
|
+
# Specifies which retry algorithm to use. Values are:
|
264
|
+
#
|
265
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
266
|
+
# no retry mode is provided.
|
267
|
+
#
|
268
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
269
|
+
# This includes support for retry quotas, which limit the number of
|
270
|
+
# unsuccessful retries a client can make.
|
271
|
+
#
|
272
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
273
|
+
# functionality of `standard` mode along with automatic client side
|
274
|
+
# throttling. This is a provisional mode that may change behavior
|
275
|
+
# in the future.
|
276
|
+
#
|
277
|
+
#
|
278
|
+
# @option options [String] :secret_access_key
|
279
|
+
#
|
280
|
+
# @option options [String] :session_token
|
281
|
+
#
|
282
|
+
# @option options [Boolean] :stub_responses (false)
|
283
|
+
# Causes the client to return stubbed responses. By default
|
284
|
+
# fake responses are generated and returned. You can specify
|
285
|
+
# the response data to return or errors to raise by calling
|
286
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
287
|
+
#
|
288
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
289
|
+
# requests are made, and retries are disabled.
|
290
|
+
#
|
291
|
+
# @option options [Aws::TokenProvider] :token_provider
|
292
|
+
# A Bearer Token Provider. This can be an instance of any one of the
|
293
|
+
# following classes:
|
294
|
+
#
|
295
|
+
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
296
|
+
# tokens.
|
297
|
+
#
|
298
|
+
# * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
|
299
|
+
# access token generated from `aws login`.
|
300
|
+
#
|
301
|
+
# When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
|
302
|
+
# will be used to search for tokens configured for your profile in shared configuration files.
|
303
|
+
#
|
304
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
305
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
306
|
+
# will be used if available.
|
307
|
+
#
|
308
|
+
# @option options [Boolean] :use_fips_endpoint
|
309
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
310
|
+
# When a `fips` region is used, the region is normalized and this config
|
311
|
+
# is set to `true`.
|
312
|
+
#
|
313
|
+
# @option options [Boolean] :validate_params (true)
|
314
|
+
# When `true`, request parameters are validated before
|
315
|
+
# sending the request.
|
316
|
+
#
|
317
|
+
# @option options [Aws::ChimeSDKVoice::EndpointProvider] :endpoint_provider
|
318
|
+
# The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::ChimeSDKVoice::EndpointParameters`
|
319
|
+
#
|
320
|
+
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
321
|
+
# requests through. Formatted like 'http://proxy.com:123'.
|
322
|
+
#
|
323
|
+
# @option options [Float] :http_open_timeout (15) The number of
|
324
|
+
# seconds to wait when opening a HTTP session before raising a
|
325
|
+
# `Timeout::Error`.
|
326
|
+
#
|
327
|
+
# @option options [Float] :http_read_timeout (60) The default
|
328
|
+
# number of seconds to wait for response data. This value can
|
329
|
+
# safely be set per-request on the session.
|
330
|
+
#
|
331
|
+
# @option options [Float] :http_idle_timeout (5) The number of
|
332
|
+
# seconds a connection is allowed to sit idle before it is
|
333
|
+
# considered stale. Stale connections are closed and removed
|
334
|
+
# from the pool before making a request.
|
335
|
+
#
|
336
|
+
# @option options [Float] :http_continue_timeout (1) The number of
|
337
|
+
# seconds to wait for a 100-continue response before sending the
|
338
|
+
# request body. This option has no effect unless the request has
|
339
|
+
# "Expect" header set to "100-continue". Defaults to `nil` which
|
340
|
+
# disables this behaviour. This value can safely be set per
|
341
|
+
# request on the session.
|
342
|
+
#
|
343
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
344
|
+
# in seconds.
|
345
|
+
#
|
346
|
+
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
347
|
+
# HTTP debug output will be sent to the `:logger`.
|
348
|
+
#
|
349
|
+
# @option options [Boolean] :ssl_verify_peer (true) When `true`,
|
350
|
+
# SSL peer certificates are verified when establishing a
|
351
|
+
# connection.
|
352
|
+
#
|
353
|
+
# @option options [String] :ssl_ca_bundle Full path to the SSL
|
354
|
+
# certificate authority bundle file that should be used when
|
355
|
+
# verifying peer certificates. If you do not pass
|
356
|
+
# `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
|
357
|
+
# will be used if available.
|
358
|
+
#
|
359
|
+
# @option options [String] :ssl_ca_directory Full path of the
|
360
|
+
# directory that contains the unbundled SSL certificate
|
361
|
+
# authority files for verifying peer certificates. If you do
|
362
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
|
363
|
+
# system default will be used if available.
|
364
|
+
#
|
365
|
+
def initialize(*args)
|
366
|
+
super
|
367
|
+
end
|
368
|
+
|
369
|
+
# @!group API Operations
|
370
|
+
|
371
|
+
# @option params [required, String] :voice_connector_id
|
372
|
+
#
|
373
|
+
# @option params [required, Array<String>] :e164_phone_numbers
|
374
|
+
#
|
375
|
+
# @option params [Boolean] :force_associate
|
376
|
+
#
|
377
|
+
# @return [Types::AssociatePhoneNumbersWithVoiceConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
378
|
+
#
|
379
|
+
# * {Types::AssociatePhoneNumbersWithVoiceConnectorResponse#phone_number_errors #phone_number_errors} => Array<Types::PhoneNumberError>
|
380
|
+
#
|
381
|
+
# @example Request syntax with placeholder values
|
382
|
+
#
|
383
|
+
# resp = client.associate_phone_numbers_with_voice_connector({
|
384
|
+
# voice_connector_id: "NonEmptyString", # required
|
385
|
+
# e164_phone_numbers: ["E164PhoneNumber"], # required
|
386
|
+
# force_associate: false,
|
387
|
+
# })
|
388
|
+
#
|
389
|
+
# @example Response structure
|
390
|
+
#
|
391
|
+
# resp.phone_number_errors #=> Array
|
392
|
+
# resp.phone_number_errors[0].phone_number_id #=> String
|
393
|
+
# resp.phone_number_errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Throttling", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist", "Gone"
|
394
|
+
# resp.phone_number_errors[0].error_message #=> String
|
395
|
+
#
|
396
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/AssociatePhoneNumbersWithVoiceConnector AWS API Documentation
|
397
|
+
#
|
398
|
+
# @overload associate_phone_numbers_with_voice_connector(params = {})
|
399
|
+
# @param [Hash] params ({})
|
400
|
+
def associate_phone_numbers_with_voice_connector(params = {}, options = {})
|
401
|
+
req = build_request(:associate_phone_numbers_with_voice_connector, params)
|
402
|
+
req.send_request(options)
|
403
|
+
end
|
404
|
+
|
405
|
+
# @option params [required, String] :voice_connector_group_id
|
406
|
+
#
|
407
|
+
# @option params [required, Array<String>] :e164_phone_numbers
|
408
|
+
#
|
409
|
+
# @option params [Boolean] :force_associate
|
410
|
+
#
|
411
|
+
# @return [Types::AssociatePhoneNumbersWithVoiceConnectorGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
412
|
+
#
|
413
|
+
# * {Types::AssociatePhoneNumbersWithVoiceConnectorGroupResponse#phone_number_errors #phone_number_errors} => Array<Types::PhoneNumberError>
|
414
|
+
#
|
415
|
+
# @example Request syntax with placeholder values
|
416
|
+
#
|
417
|
+
# resp = client.associate_phone_numbers_with_voice_connector_group({
|
418
|
+
# voice_connector_group_id: "NonEmptyString", # required
|
419
|
+
# e164_phone_numbers: ["E164PhoneNumber"], # required
|
420
|
+
# force_associate: false,
|
421
|
+
# })
|
422
|
+
#
|
423
|
+
# @example Response structure
|
424
|
+
#
|
425
|
+
# resp.phone_number_errors #=> Array
|
426
|
+
# resp.phone_number_errors[0].phone_number_id #=> String
|
427
|
+
# resp.phone_number_errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Throttling", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist", "Gone"
|
428
|
+
# resp.phone_number_errors[0].error_message #=> String
|
429
|
+
#
|
430
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/AssociatePhoneNumbersWithVoiceConnectorGroup AWS API Documentation
|
431
|
+
#
|
432
|
+
# @overload associate_phone_numbers_with_voice_connector_group(params = {})
|
433
|
+
# @param [Hash] params ({})
|
434
|
+
def associate_phone_numbers_with_voice_connector_group(params = {}, options = {})
|
435
|
+
req = build_request(:associate_phone_numbers_with_voice_connector_group, params)
|
436
|
+
req.send_request(options)
|
437
|
+
end
|
438
|
+
|
439
|
+
# @option params [required, Array<String>] :phone_number_ids
|
440
|
+
#
|
441
|
+
# @return [Types::BatchDeletePhoneNumberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
442
|
+
#
|
443
|
+
# * {Types::BatchDeletePhoneNumberResponse#phone_number_errors #phone_number_errors} => Array<Types::PhoneNumberError>
|
444
|
+
#
|
445
|
+
# @example Request syntax with placeholder values
|
446
|
+
#
|
447
|
+
# resp = client.batch_delete_phone_number({
|
448
|
+
# phone_number_ids: ["String"], # required
|
449
|
+
# })
|
450
|
+
#
|
451
|
+
# @example Response structure
|
452
|
+
#
|
453
|
+
# resp.phone_number_errors #=> Array
|
454
|
+
# resp.phone_number_errors[0].phone_number_id #=> String
|
455
|
+
# resp.phone_number_errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Throttling", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist", "Gone"
|
456
|
+
# resp.phone_number_errors[0].error_message #=> String
|
457
|
+
#
|
458
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/BatchDeletePhoneNumber AWS API Documentation
|
459
|
+
#
|
460
|
+
# @overload batch_delete_phone_number(params = {})
|
461
|
+
# @param [Hash] params ({})
|
462
|
+
def batch_delete_phone_number(params = {}, options = {})
|
463
|
+
req = build_request(:batch_delete_phone_number, params)
|
464
|
+
req.send_request(options)
|
465
|
+
end
|
466
|
+
|
467
|
+
# @option params [required, Array<Types::UpdatePhoneNumberRequestItem>] :update_phone_number_request_items
|
468
|
+
#
|
469
|
+
# @return [Types::BatchUpdatePhoneNumberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
470
|
+
#
|
471
|
+
# * {Types::BatchUpdatePhoneNumberResponse#phone_number_errors #phone_number_errors} => Array<Types::PhoneNumberError>
|
472
|
+
#
|
473
|
+
# @example Request syntax with placeholder values
|
474
|
+
#
|
475
|
+
# resp = client.batch_update_phone_number({
|
476
|
+
# update_phone_number_request_items: [ # required
|
477
|
+
# {
|
478
|
+
# phone_number_id: "SensitiveNonEmptyString", # required
|
479
|
+
# product_type: "VoiceConnector", # accepts VoiceConnector, SipMediaApplicationDialIn
|
480
|
+
# calling_name: "CallingName",
|
481
|
+
# },
|
482
|
+
# ],
|
483
|
+
# })
|
484
|
+
#
|
485
|
+
# @example Response structure
|
486
|
+
#
|
487
|
+
# resp.phone_number_errors #=> Array
|
488
|
+
# resp.phone_number_errors[0].phone_number_id #=> String
|
489
|
+
# resp.phone_number_errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Throttling", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist", "Gone"
|
490
|
+
# resp.phone_number_errors[0].error_message #=> String
|
491
|
+
#
|
492
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/BatchUpdatePhoneNumber AWS API Documentation
|
493
|
+
#
|
494
|
+
# @overload batch_update_phone_number(params = {})
|
495
|
+
# @param [Hash] params ({})
|
496
|
+
def batch_update_phone_number(params = {}, options = {})
|
497
|
+
req = build_request(:batch_update_phone_number, params)
|
498
|
+
req.send_request(options)
|
499
|
+
end
|
500
|
+
|
501
|
+
# @option params [required, String] :product_type
|
502
|
+
#
|
503
|
+
# @option params [required, Array<String>] :e164_phone_numbers
|
504
|
+
#
|
505
|
+
# @return [Types::CreatePhoneNumberOrderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
506
|
+
#
|
507
|
+
# * {Types::CreatePhoneNumberOrderResponse#phone_number_order #phone_number_order} => Types::PhoneNumberOrder
|
508
|
+
#
|
509
|
+
# @example Request syntax with placeholder values
|
510
|
+
#
|
511
|
+
# resp = client.create_phone_number_order({
|
512
|
+
# product_type: "VoiceConnector", # required, accepts VoiceConnector, SipMediaApplicationDialIn
|
513
|
+
# e164_phone_numbers: ["E164PhoneNumber"], # required
|
514
|
+
# })
|
515
|
+
#
|
516
|
+
# @example Response structure
|
517
|
+
#
|
518
|
+
# resp.phone_number_order.phone_number_order_id #=> String
|
519
|
+
# resp.phone_number_order.product_type #=> String, one of "VoiceConnector", "SipMediaApplicationDialIn"
|
520
|
+
# resp.phone_number_order.status #=> String, one of "Processing", "Successful", "Failed", "Partial", "PendingDocuments", "Submitted", "FOC", "ChangeRequested", "Exception", "CancelRequested", "Cancelled"
|
521
|
+
# resp.phone_number_order.order_type #=> String, one of "New", "Porting"
|
522
|
+
# resp.phone_number_order.ordered_phone_numbers #=> Array
|
523
|
+
# resp.phone_number_order.ordered_phone_numbers[0].e164_phone_number #=> String
|
524
|
+
# resp.phone_number_order.ordered_phone_numbers[0].status #=> String, one of "Processing", "Acquired", "Failed"
|
525
|
+
# resp.phone_number_order.created_timestamp #=> Time
|
526
|
+
# resp.phone_number_order.updated_timestamp #=> Time
|
527
|
+
#
|
528
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreatePhoneNumberOrder AWS API Documentation
|
529
|
+
#
|
530
|
+
# @overload create_phone_number_order(params = {})
|
531
|
+
# @param [Hash] params ({})
|
532
|
+
def create_phone_number_order(params = {}, options = {})
|
533
|
+
req = build_request(:create_phone_number_order, params)
|
534
|
+
req.send_request(options)
|
535
|
+
end
|
536
|
+
|
537
|
+
# @option params [required, String] :voice_connector_id
|
538
|
+
#
|
539
|
+
# @option params [required, Array<String>] :participant_phone_numbers
|
540
|
+
#
|
541
|
+
# @option params [String] :name
|
542
|
+
#
|
543
|
+
# @option params [Integer] :expiry_minutes
|
544
|
+
#
|
545
|
+
# @option params [required, Array<String>] :capabilities
|
546
|
+
#
|
547
|
+
# @option params [String] :number_selection_behavior
|
548
|
+
#
|
549
|
+
# @option params [String] :geo_match_level
|
550
|
+
#
|
551
|
+
# @option params [Types::GeoMatchParams] :geo_match_params
|
552
|
+
#
|
553
|
+
# @return [Types::CreateProxySessionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
554
|
+
#
|
555
|
+
# * {Types::CreateProxySessionResponse#proxy_session #proxy_session} => Types::ProxySession
|
556
|
+
#
|
557
|
+
# @example Request syntax with placeholder values
|
558
|
+
#
|
559
|
+
# resp = client.create_proxy_session({
|
560
|
+
# voice_connector_id: "NonEmptyString128", # required
|
561
|
+
# participant_phone_numbers: ["E164PhoneNumber"], # required
|
562
|
+
# name: "ProxySessionNameString",
|
563
|
+
# expiry_minutes: 1,
|
564
|
+
# capabilities: ["Voice"], # required, accepts Voice, SMS
|
565
|
+
# number_selection_behavior: "PreferSticky", # accepts PreferSticky, AvoidSticky
|
566
|
+
# geo_match_level: "Country", # accepts Country, AreaCode
|
567
|
+
# geo_match_params: {
|
568
|
+
# country: "Country", # required
|
569
|
+
# area_code: "AreaCode", # required
|
570
|
+
# },
|
571
|
+
# })
|
572
|
+
#
|
573
|
+
# @example Response structure
|
574
|
+
#
|
575
|
+
# resp.proxy_session.voice_connector_id #=> String
|
576
|
+
# resp.proxy_session.proxy_session_id #=> String
|
577
|
+
# resp.proxy_session.name #=> String
|
578
|
+
# resp.proxy_session.status #=> String, one of "Open", "InProgress", "Closed"
|
579
|
+
# resp.proxy_session.expiry_minutes #=> Integer
|
580
|
+
# resp.proxy_session.capabilities #=> Array
|
581
|
+
# resp.proxy_session.capabilities[0] #=> String, one of "Voice", "SMS"
|
582
|
+
# resp.proxy_session.created_timestamp #=> Time
|
583
|
+
# resp.proxy_session.updated_timestamp #=> Time
|
584
|
+
# resp.proxy_session.ended_timestamp #=> Time
|
585
|
+
# resp.proxy_session.participants #=> Array
|
586
|
+
# resp.proxy_session.participants[0].phone_number #=> String
|
587
|
+
# resp.proxy_session.participants[0].proxy_phone_number #=> String
|
588
|
+
# resp.proxy_session.number_selection_behavior #=> String, one of "PreferSticky", "AvoidSticky"
|
589
|
+
# resp.proxy_session.geo_match_level #=> String, one of "Country", "AreaCode"
|
590
|
+
# resp.proxy_session.geo_match_params.country #=> String
|
591
|
+
# resp.proxy_session.geo_match_params.area_code #=> String
|
592
|
+
#
|
593
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateProxySession AWS API Documentation
|
594
|
+
#
|
595
|
+
# @overload create_proxy_session(params = {})
|
596
|
+
# @param [Hash] params ({})
|
597
|
+
def create_proxy_session(params = {}, options = {})
|
598
|
+
req = build_request(:create_proxy_session, params)
|
599
|
+
req.send_request(options)
|
600
|
+
end
|
601
|
+
|
602
|
+
# @option params [required, String] :aws_region
|
603
|
+
#
|
604
|
+
# @option params [required, String] :name
|
605
|
+
#
|
606
|
+
# @option params [required, Array<Types::SipMediaApplicationEndpoint>] :endpoints
|
607
|
+
#
|
608
|
+
# @return [Types::CreateSipMediaApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
609
|
+
#
|
610
|
+
# * {Types::CreateSipMediaApplicationResponse#sip_media_application #sip_media_application} => Types::SipMediaApplication
|
611
|
+
#
|
612
|
+
# @example Request syntax with placeholder values
|
613
|
+
#
|
614
|
+
# resp = client.create_sip_media_application({
|
615
|
+
# aws_region: "String", # required
|
616
|
+
# name: "SipMediaApplicationName", # required
|
617
|
+
# endpoints: [ # required
|
618
|
+
# {
|
619
|
+
# lambda_arn: "FunctionArn",
|
620
|
+
# },
|
621
|
+
# ],
|
622
|
+
# })
|
623
|
+
#
|
624
|
+
# @example Response structure
|
625
|
+
#
|
626
|
+
# resp.sip_media_application.sip_media_application_id #=> String
|
627
|
+
# resp.sip_media_application.aws_region #=> String
|
628
|
+
# resp.sip_media_application.name #=> String
|
629
|
+
# resp.sip_media_application.endpoints #=> Array
|
630
|
+
# resp.sip_media_application.endpoints[0].lambda_arn #=> String
|
631
|
+
# resp.sip_media_application.created_timestamp #=> Time
|
632
|
+
# resp.sip_media_application.updated_timestamp #=> Time
|
633
|
+
#
|
634
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateSipMediaApplication AWS API Documentation
|
635
|
+
#
|
636
|
+
# @overload create_sip_media_application(params = {})
|
637
|
+
# @param [Hash] params ({})
|
638
|
+
def create_sip_media_application(params = {}, options = {})
|
639
|
+
req = build_request(:create_sip_media_application, params)
|
640
|
+
req.send_request(options)
|
641
|
+
end
|
642
|
+
|
643
|
+
# @option params [required, String] :from_phone_number
|
644
|
+
#
|
645
|
+
# @option params [required, String] :to_phone_number
|
646
|
+
#
|
647
|
+
# @option params [required, String] :sip_media_application_id
|
648
|
+
#
|
649
|
+
# @option params [Hash<String,String>] :sip_headers
|
650
|
+
#
|
651
|
+
# @option params [Hash<String,String>] :arguments_map
|
652
|
+
#
|
653
|
+
# @return [Types::CreateSipMediaApplicationCallResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
654
|
+
#
|
655
|
+
# * {Types::CreateSipMediaApplicationCallResponse#sip_media_application_call #sip_media_application_call} => Types::SipMediaApplicationCall
|
656
|
+
#
|
657
|
+
# @example Request syntax with placeholder values
|
658
|
+
#
|
659
|
+
# resp = client.create_sip_media_application_call({
|
660
|
+
# from_phone_number: "E164PhoneNumber", # required
|
661
|
+
# to_phone_number: "E164PhoneNumber", # required
|
662
|
+
# sip_media_application_id: "NonEmptyString", # required
|
663
|
+
# sip_headers: {
|
664
|
+
# "SensitiveString" => "SensitiveString",
|
665
|
+
# },
|
666
|
+
# arguments_map: {
|
667
|
+
# "SensitiveString" => "SensitiveString",
|
668
|
+
# },
|
669
|
+
# })
|
670
|
+
#
|
671
|
+
# @example Response structure
|
672
|
+
#
|
673
|
+
# resp.sip_media_application_call.transaction_id #=> String
|
674
|
+
#
|
675
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateSipMediaApplicationCall AWS API Documentation
|
676
|
+
#
|
677
|
+
# @overload create_sip_media_application_call(params = {})
|
678
|
+
# @param [Hash] params ({})
|
679
|
+
def create_sip_media_application_call(params = {}, options = {})
|
680
|
+
req = build_request(:create_sip_media_application_call, params)
|
681
|
+
req.send_request(options)
|
682
|
+
end
|
683
|
+
|
684
|
+
# @option params [required, String] :name
|
685
|
+
#
|
686
|
+
# @option params [required, String] :trigger_type
|
687
|
+
#
|
688
|
+
# @option params [required, String] :trigger_value
|
689
|
+
#
|
690
|
+
# @option params [Boolean] :disabled
|
691
|
+
#
|
692
|
+
# @option params [Array<Types::SipRuleTargetApplication>] :target_applications
|
693
|
+
#
|
694
|
+
# @return [Types::CreateSipRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
695
|
+
#
|
696
|
+
# * {Types::CreateSipRuleResponse#sip_rule #sip_rule} => Types::SipRule
|
697
|
+
#
|
698
|
+
# @example Request syntax with placeholder values
|
699
|
+
#
|
700
|
+
# resp = client.create_sip_rule({
|
701
|
+
# name: "SipRuleName", # required
|
702
|
+
# trigger_type: "ToPhoneNumber", # required, accepts ToPhoneNumber, RequestUriHostname
|
703
|
+
# trigger_value: "NonEmptyString", # required
|
704
|
+
# disabled: false,
|
705
|
+
# target_applications: [
|
706
|
+
# {
|
707
|
+
# sip_media_application_id: "NonEmptyString",
|
708
|
+
# priority: 1,
|
709
|
+
# aws_region: "String",
|
710
|
+
# },
|
711
|
+
# ],
|
712
|
+
# })
|
713
|
+
#
|
714
|
+
# @example Response structure
|
715
|
+
#
|
716
|
+
# resp.sip_rule.sip_rule_id #=> String
|
717
|
+
# resp.sip_rule.name #=> String
|
718
|
+
# resp.sip_rule.disabled #=> Boolean
|
719
|
+
# resp.sip_rule.trigger_type #=> String, one of "ToPhoneNumber", "RequestUriHostname"
|
720
|
+
# resp.sip_rule.trigger_value #=> String
|
721
|
+
# resp.sip_rule.target_applications #=> Array
|
722
|
+
# resp.sip_rule.target_applications[0].sip_media_application_id #=> String
|
723
|
+
# resp.sip_rule.target_applications[0].priority #=> Integer
|
724
|
+
# resp.sip_rule.target_applications[0].aws_region #=> String
|
725
|
+
# resp.sip_rule.created_timestamp #=> Time
|
726
|
+
# resp.sip_rule.updated_timestamp #=> Time
|
727
|
+
#
|
728
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateSipRule AWS API Documentation
|
729
|
+
#
|
730
|
+
# @overload create_sip_rule(params = {})
|
731
|
+
# @param [Hash] params ({})
|
732
|
+
def create_sip_rule(params = {}, options = {})
|
733
|
+
req = build_request(:create_sip_rule, params)
|
734
|
+
req.send_request(options)
|
735
|
+
end
|
736
|
+
|
737
|
+
# @option params [required, String] :name
|
738
|
+
#
|
739
|
+
# @option params [String] :aws_region
|
740
|
+
#
|
741
|
+
# @option params [required, Boolean] :require_encryption
|
742
|
+
#
|
743
|
+
# @return [Types::CreateVoiceConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
744
|
+
#
|
745
|
+
# * {Types::CreateVoiceConnectorResponse#voice_connector #voice_connector} => Types::VoiceConnector
|
746
|
+
#
|
747
|
+
# @example Request syntax with placeholder values
|
748
|
+
#
|
749
|
+
# resp = client.create_voice_connector({
|
750
|
+
# name: "VoiceConnectorName", # required
|
751
|
+
# aws_region: "us-east-1", # accepts us-east-1, us-west-2, ca-central-1, eu-central-1, eu-west-1, eu-west-2, ap-northeast-2, ap-northeast-1, ap-southeast-1, ap-southeast-2
|
752
|
+
# require_encryption: false, # required
|
753
|
+
# })
|
754
|
+
#
|
755
|
+
# @example Response structure
|
756
|
+
#
|
757
|
+
# resp.voice_connector.voice_connector_id #=> String
|
758
|
+
# resp.voice_connector.aws_region #=> String, one of "us-east-1", "us-west-2", "ca-central-1", "eu-central-1", "eu-west-1", "eu-west-2", "ap-northeast-2", "ap-northeast-1", "ap-southeast-1", "ap-southeast-2"
|
759
|
+
# resp.voice_connector.name #=> String
|
760
|
+
# resp.voice_connector.outbound_host_name #=> String
|
761
|
+
# resp.voice_connector.require_encryption #=> Boolean
|
762
|
+
# resp.voice_connector.created_timestamp #=> Time
|
763
|
+
# resp.voice_connector.updated_timestamp #=> Time
|
764
|
+
# resp.voice_connector.voice_connector_arn #=> String
|
765
|
+
#
|
766
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateVoiceConnector AWS API Documentation
|
767
|
+
#
|
768
|
+
# @overload create_voice_connector(params = {})
|
769
|
+
# @param [Hash] params ({})
|
770
|
+
def create_voice_connector(params = {}, options = {})
|
771
|
+
req = build_request(:create_voice_connector, params)
|
772
|
+
req.send_request(options)
|
773
|
+
end
|
774
|
+
|
775
|
+
# @option params [required, String] :name
|
776
|
+
#
|
777
|
+
# @option params [Array<Types::VoiceConnectorItem>] :voice_connector_items
|
778
|
+
#
|
779
|
+
# @return [Types::CreateVoiceConnectorGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
780
|
+
#
|
781
|
+
# * {Types::CreateVoiceConnectorGroupResponse#voice_connector_group #voice_connector_group} => Types::VoiceConnectorGroup
|
782
|
+
#
|
783
|
+
# @example Request syntax with placeholder values
|
784
|
+
#
|
785
|
+
# resp = client.create_voice_connector_group({
|
786
|
+
# name: "VoiceConnectorGroupName", # required
|
787
|
+
# voice_connector_items: [
|
788
|
+
# {
|
789
|
+
# voice_connector_id: "NonEmptyString", # required
|
790
|
+
# priority: 1, # required
|
791
|
+
# },
|
792
|
+
# ],
|
793
|
+
# })
|
794
|
+
#
|
795
|
+
# @example Response structure
|
796
|
+
#
|
797
|
+
# resp.voice_connector_group.voice_connector_group_id #=> String
|
798
|
+
# resp.voice_connector_group.name #=> String
|
799
|
+
# resp.voice_connector_group.voice_connector_items #=> Array
|
800
|
+
# resp.voice_connector_group.voice_connector_items[0].voice_connector_id #=> String
|
801
|
+
# resp.voice_connector_group.voice_connector_items[0].priority #=> Integer
|
802
|
+
# resp.voice_connector_group.created_timestamp #=> Time
|
803
|
+
# resp.voice_connector_group.updated_timestamp #=> Time
|
804
|
+
# resp.voice_connector_group.voice_connector_group_arn #=> String
|
805
|
+
#
|
806
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateVoiceConnectorGroup AWS API Documentation
|
807
|
+
#
|
808
|
+
# @overload create_voice_connector_group(params = {})
|
809
|
+
# @param [Hash] params ({})
|
810
|
+
def create_voice_connector_group(params = {}, options = {})
|
811
|
+
req = build_request(:create_voice_connector_group, params)
|
812
|
+
req.send_request(options)
|
813
|
+
end
|
814
|
+
|
815
|
+
# @option params [required, String] :phone_number_id
|
816
|
+
#
|
817
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
818
|
+
#
|
819
|
+
# @example Request syntax with placeholder values
|
820
|
+
#
|
821
|
+
# resp = client.delete_phone_number({
|
822
|
+
# phone_number_id: "SensitiveNonEmptyString", # required
|
823
|
+
# })
|
824
|
+
#
|
825
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeletePhoneNumber AWS API Documentation
|
826
|
+
#
|
827
|
+
# @overload delete_phone_number(params = {})
|
828
|
+
# @param [Hash] params ({})
|
829
|
+
def delete_phone_number(params = {}, options = {})
|
830
|
+
req = build_request(:delete_phone_number, params)
|
831
|
+
req.send_request(options)
|
832
|
+
end
|
833
|
+
|
834
|
+
# @option params [required, String] :voice_connector_id
|
835
|
+
#
|
836
|
+
# @option params [required, String] :proxy_session_id
|
837
|
+
#
|
838
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
839
|
+
#
|
840
|
+
# @example Request syntax with placeholder values
|
841
|
+
#
|
842
|
+
# resp = client.delete_proxy_session({
|
843
|
+
# voice_connector_id: "NonEmptyString128", # required
|
844
|
+
# proxy_session_id: "NonEmptyString128", # required
|
845
|
+
# })
|
846
|
+
#
|
847
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteProxySession AWS API Documentation
|
848
|
+
#
|
849
|
+
# @overload delete_proxy_session(params = {})
|
850
|
+
# @param [Hash] params ({})
|
851
|
+
def delete_proxy_session(params = {}, options = {})
|
852
|
+
req = build_request(:delete_proxy_session, params)
|
853
|
+
req.send_request(options)
|
854
|
+
end
|
855
|
+
|
856
|
+
# @option params [required, String] :sip_media_application_id
|
857
|
+
#
|
858
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
859
|
+
#
|
860
|
+
# @example Request syntax with placeholder values
|
861
|
+
#
|
862
|
+
# resp = client.delete_sip_media_application({
|
863
|
+
# sip_media_application_id: "NonEmptyString", # required
|
864
|
+
# })
|
865
|
+
#
|
866
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteSipMediaApplication AWS API Documentation
|
867
|
+
#
|
868
|
+
# @overload delete_sip_media_application(params = {})
|
869
|
+
# @param [Hash] params ({})
|
870
|
+
def delete_sip_media_application(params = {}, options = {})
|
871
|
+
req = build_request(:delete_sip_media_application, params)
|
872
|
+
req.send_request(options)
|
873
|
+
end
|
874
|
+
|
875
|
+
# @option params [required, String] :sip_rule_id
|
876
|
+
#
|
877
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
878
|
+
#
|
879
|
+
# @example Request syntax with placeholder values
|
880
|
+
#
|
881
|
+
# resp = client.delete_sip_rule({
|
882
|
+
# sip_rule_id: "NonEmptyString", # required
|
883
|
+
# })
|
884
|
+
#
|
885
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteSipRule AWS API Documentation
|
886
|
+
#
|
887
|
+
# @overload delete_sip_rule(params = {})
|
888
|
+
# @param [Hash] params ({})
|
889
|
+
def delete_sip_rule(params = {}, options = {})
|
890
|
+
req = build_request(:delete_sip_rule, params)
|
891
|
+
req.send_request(options)
|
892
|
+
end
|
893
|
+
|
894
|
+
# @option params [required, String] :voice_connector_id
|
895
|
+
#
|
896
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
897
|
+
#
|
898
|
+
# @example Request syntax with placeholder values
|
899
|
+
#
|
900
|
+
# resp = client.delete_voice_connector({
|
901
|
+
# voice_connector_id: "NonEmptyString", # required
|
902
|
+
# })
|
903
|
+
#
|
904
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceConnector AWS API Documentation
|
905
|
+
#
|
906
|
+
# @overload delete_voice_connector(params = {})
|
907
|
+
# @param [Hash] params ({})
|
908
|
+
def delete_voice_connector(params = {}, options = {})
|
909
|
+
req = build_request(:delete_voice_connector, params)
|
910
|
+
req.send_request(options)
|
911
|
+
end
|
912
|
+
|
913
|
+
# @option params [required, String] :voice_connector_id
|
914
|
+
#
|
915
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
916
|
+
#
|
917
|
+
# @example Request syntax with placeholder values
|
918
|
+
#
|
919
|
+
# resp = client.delete_voice_connector_emergency_calling_configuration({
|
920
|
+
# voice_connector_id: "NonEmptyString", # required
|
921
|
+
# })
|
922
|
+
#
|
923
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorEmergencyCallingConfiguration AWS API Documentation
|
924
|
+
#
|
925
|
+
# @overload delete_voice_connector_emergency_calling_configuration(params = {})
|
926
|
+
# @param [Hash] params ({})
|
927
|
+
def delete_voice_connector_emergency_calling_configuration(params = {}, options = {})
|
928
|
+
req = build_request(:delete_voice_connector_emergency_calling_configuration, params)
|
929
|
+
req.send_request(options)
|
930
|
+
end
|
931
|
+
|
932
|
+
# @option params [required, String] :voice_connector_group_id
|
933
|
+
#
|
934
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
935
|
+
#
|
936
|
+
# @example Request syntax with placeholder values
|
937
|
+
#
|
938
|
+
# resp = client.delete_voice_connector_group({
|
939
|
+
# voice_connector_group_id: "NonEmptyString", # required
|
940
|
+
# })
|
941
|
+
#
|
942
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorGroup AWS API Documentation
|
943
|
+
#
|
944
|
+
# @overload delete_voice_connector_group(params = {})
|
945
|
+
# @param [Hash] params ({})
|
946
|
+
def delete_voice_connector_group(params = {}, options = {})
|
947
|
+
req = build_request(:delete_voice_connector_group, params)
|
948
|
+
req.send_request(options)
|
949
|
+
end
|
950
|
+
|
951
|
+
# @option params [required, String] :voice_connector_id
|
952
|
+
#
|
953
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
954
|
+
#
|
955
|
+
# @example Request syntax with placeholder values
|
956
|
+
#
|
957
|
+
# resp = client.delete_voice_connector_origination({
|
958
|
+
# voice_connector_id: "NonEmptyString", # required
|
959
|
+
# })
|
960
|
+
#
|
961
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorOrigination AWS API Documentation
|
962
|
+
#
|
963
|
+
# @overload delete_voice_connector_origination(params = {})
|
964
|
+
# @param [Hash] params ({})
|
965
|
+
def delete_voice_connector_origination(params = {}, options = {})
|
966
|
+
req = build_request(:delete_voice_connector_origination, params)
|
967
|
+
req.send_request(options)
|
968
|
+
end
|
969
|
+
|
970
|
+
# @option params [required, String] :voice_connector_id
|
971
|
+
#
|
972
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
973
|
+
#
|
974
|
+
# @example Request syntax with placeholder values
|
975
|
+
#
|
976
|
+
# resp = client.delete_voice_connector_proxy({
|
977
|
+
# voice_connector_id: "NonEmptyString128", # required
|
978
|
+
# })
|
979
|
+
#
|
980
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorProxy AWS API Documentation
|
981
|
+
#
|
982
|
+
# @overload delete_voice_connector_proxy(params = {})
|
983
|
+
# @param [Hash] params ({})
|
984
|
+
def delete_voice_connector_proxy(params = {}, options = {})
|
985
|
+
req = build_request(:delete_voice_connector_proxy, params)
|
986
|
+
req.send_request(options)
|
987
|
+
end
|
988
|
+
|
989
|
+
# @option params [required, String] :voice_connector_id
|
990
|
+
#
|
991
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
992
|
+
#
|
993
|
+
# @example Request syntax with placeholder values
|
994
|
+
#
|
995
|
+
# resp = client.delete_voice_connector_streaming_configuration({
|
996
|
+
# voice_connector_id: "NonEmptyString", # required
|
997
|
+
# })
|
998
|
+
#
|
999
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorStreamingConfiguration AWS API Documentation
|
1000
|
+
#
|
1001
|
+
# @overload delete_voice_connector_streaming_configuration(params = {})
|
1002
|
+
# @param [Hash] params ({})
|
1003
|
+
def delete_voice_connector_streaming_configuration(params = {}, options = {})
|
1004
|
+
req = build_request(:delete_voice_connector_streaming_configuration, params)
|
1005
|
+
req.send_request(options)
|
1006
|
+
end
|
1007
|
+
|
1008
|
+
# @option params [required, String] :voice_connector_id
|
1009
|
+
#
|
1010
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1011
|
+
#
|
1012
|
+
# @example Request syntax with placeholder values
|
1013
|
+
#
|
1014
|
+
# resp = client.delete_voice_connector_termination({
|
1015
|
+
# voice_connector_id: "NonEmptyString", # required
|
1016
|
+
# })
|
1017
|
+
#
|
1018
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorTermination AWS API Documentation
|
1019
|
+
#
|
1020
|
+
# @overload delete_voice_connector_termination(params = {})
|
1021
|
+
# @param [Hash] params ({})
|
1022
|
+
def delete_voice_connector_termination(params = {}, options = {})
|
1023
|
+
req = build_request(:delete_voice_connector_termination, params)
|
1024
|
+
req.send_request(options)
|
1025
|
+
end
|
1026
|
+
|
1027
|
+
# @option params [required, String] :voice_connector_id
|
1028
|
+
#
|
1029
|
+
# @option params [required, Array<String>] :usernames
|
1030
|
+
#
|
1031
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1032
|
+
#
|
1033
|
+
# @example Request syntax with placeholder values
|
1034
|
+
#
|
1035
|
+
# resp = client.delete_voice_connector_termination_credentials({
|
1036
|
+
# voice_connector_id: "NonEmptyString", # required
|
1037
|
+
# usernames: ["SensitiveString"], # required
|
1038
|
+
# })
|
1039
|
+
#
|
1040
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DeleteVoiceConnectorTerminationCredentials AWS API Documentation
|
1041
|
+
#
|
1042
|
+
# @overload delete_voice_connector_termination_credentials(params = {})
|
1043
|
+
# @param [Hash] params ({})
|
1044
|
+
def delete_voice_connector_termination_credentials(params = {}, options = {})
|
1045
|
+
req = build_request(:delete_voice_connector_termination_credentials, params)
|
1046
|
+
req.send_request(options)
|
1047
|
+
end
|
1048
|
+
|
1049
|
+
# @option params [required, String] :voice_connector_id
|
1050
|
+
#
|
1051
|
+
# @option params [required, Array<String>] :e164_phone_numbers
|
1052
|
+
#
|
1053
|
+
# @return [Types::DisassociatePhoneNumbersFromVoiceConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1054
|
+
#
|
1055
|
+
# * {Types::DisassociatePhoneNumbersFromVoiceConnectorResponse#phone_number_errors #phone_number_errors} => Array<Types::PhoneNumberError>
|
1056
|
+
#
|
1057
|
+
# @example Request syntax with placeholder values
|
1058
|
+
#
|
1059
|
+
# resp = client.disassociate_phone_numbers_from_voice_connector({
|
1060
|
+
# voice_connector_id: "NonEmptyString", # required
|
1061
|
+
# e164_phone_numbers: ["E164PhoneNumber"], # required
|
1062
|
+
# })
|
1063
|
+
#
|
1064
|
+
# @example Response structure
|
1065
|
+
#
|
1066
|
+
# resp.phone_number_errors #=> Array
|
1067
|
+
# resp.phone_number_errors[0].phone_number_id #=> String
|
1068
|
+
# resp.phone_number_errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Throttling", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist", "Gone"
|
1069
|
+
# resp.phone_number_errors[0].error_message #=> String
|
1070
|
+
#
|
1071
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DisassociatePhoneNumbersFromVoiceConnector AWS API Documentation
|
1072
|
+
#
|
1073
|
+
# @overload disassociate_phone_numbers_from_voice_connector(params = {})
|
1074
|
+
# @param [Hash] params ({})
|
1075
|
+
def disassociate_phone_numbers_from_voice_connector(params = {}, options = {})
|
1076
|
+
req = build_request(:disassociate_phone_numbers_from_voice_connector, params)
|
1077
|
+
req.send_request(options)
|
1078
|
+
end
|
1079
|
+
|
1080
|
+
# @option params [required, String] :voice_connector_group_id
|
1081
|
+
#
|
1082
|
+
# @option params [required, Array<String>] :e164_phone_numbers
|
1083
|
+
#
|
1084
|
+
# @return [Types::DisassociatePhoneNumbersFromVoiceConnectorGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1085
|
+
#
|
1086
|
+
# * {Types::DisassociatePhoneNumbersFromVoiceConnectorGroupResponse#phone_number_errors #phone_number_errors} => Array<Types::PhoneNumberError>
|
1087
|
+
#
|
1088
|
+
# @example Request syntax with placeholder values
|
1089
|
+
#
|
1090
|
+
# resp = client.disassociate_phone_numbers_from_voice_connector_group({
|
1091
|
+
# voice_connector_group_id: "NonEmptyString", # required
|
1092
|
+
# e164_phone_numbers: ["E164PhoneNumber"], # required
|
1093
|
+
# })
|
1094
|
+
#
|
1095
|
+
# @example Response structure
|
1096
|
+
#
|
1097
|
+
# resp.phone_number_errors #=> Array
|
1098
|
+
# resp.phone_number_errors[0].phone_number_id #=> String
|
1099
|
+
# resp.phone_number_errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Throttling", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist", "Gone"
|
1100
|
+
# resp.phone_number_errors[0].error_message #=> String
|
1101
|
+
#
|
1102
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/DisassociatePhoneNumbersFromVoiceConnectorGroup AWS API Documentation
|
1103
|
+
#
|
1104
|
+
# @overload disassociate_phone_numbers_from_voice_connector_group(params = {})
|
1105
|
+
# @param [Hash] params ({})
|
1106
|
+
def disassociate_phone_numbers_from_voice_connector_group(params = {}, options = {})
|
1107
|
+
req = build_request(:disassociate_phone_numbers_from_voice_connector_group, params)
|
1108
|
+
req.send_request(options)
|
1109
|
+
end
|
1110
|
+
|
1111
|
+
# @return [Types::GetGlobalSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1112
|
+
#
|
1113
|
+
# * {Types::GetGlobalSettingsResponse#voice_connector #voice_connector} => Types::VoiceConnectorSettings
|
1114
|
+
#
|
1115
|
+
# @example Response structure
|
1116
|
+
#
|
1117
|
+
# resp.voice_connector.cdr_bucket #=> String
|
1118
|
+
#
|
1119
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetGlobalSettings AWS API Documentation
|
1120
|
+
#
|
1121
|
+
# @overload get_global_settings(params = {})
|
1122
|
+
# @param [Hash] params ({})
|
1123
|
+
def get_global_settings(params = {}, options = {})
|
1124
|
+
req = build_request(:get_global_settings, params)
|
1125
|
+
req.send_request(options)
|
1126
|
+
end
|
1127
|
+
|
1128
|
+
# @option params [required, String] :phone_number_id
|
1129
|
+
#
|
1130
|
+
# @return [Types::GetPhoneNumberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1131
|
+
#
|
1132
|
+
# * {Types::GetPhoneNumberResponse#phone_number #phone_number} => Types::PhoneNumber
|
1133
|
+
#
|
1134
|
+
# @example Request syntax with placeholder values
|
1135
|
+
#
|
1136
|
+
# resp = client.get_phone_number({
|
1137
|
+
# phone_number_id: "SensitiveNonEmptyString", # required
|
1138
|
+
# })
|
1139
|
+
#
|
1140
|
+
# @example Response structure
|
1141
|
+
#
|
1142
|
+
# resp.phone_number.phone_number_id #=> String
|
1143
|
+
# resp.phone_number.e164_phone_number #=> String
|
1144
|
+
# resp.phone_number.country #=> String
|
1145
|
+
# resp.phone_number.type #=> String, one of "Local", "TollFree"
|
1146
|
+
# resp.phone_number.product_type #=> String, one of "VoiceConnector", "SipMediaApplicationDialIn"
|
1147
|
+
# resp.phone_number.status #=> String, one of "Cancelled", "PortinCancelRequested", "PortinInProgress", "AcquireInProgress", "AcquireFailed", "Unassigned", "Assigned", "ReleaseInProgress", "DeleteInProgress", "ReleaseFailed", "DeleteFailed"
|
1148
|
+
# resp.phone_number.capabilities.inbound_call #=> Boolean
|
1149
|
+
# resp.phone_number.capabilities.outbound_call #=> Boolean
|
1150
|
+
# resp.phone_number.capabilities.inbound_sms #=> Boolean
|
1151
|
+
# resp.phone_number.capabilities.outbound_sms #=> Boolean
|
1152
|
+
# resp.phone_number.capabilities.inbound_mms #=> Boolean
|
1153
|
+
# resp.phone_number.capabilities.outbound_mms #=> Boolean
|
1154
|
+
# resp.phone_number.associations #=> Array
|
1155
|
+
# resp.phone_number.associations[0].value #=> String
|
1156
|
+
# resp.phone_number.associations[0].name #=> String, one of "VoiceConnectorId", "VoiceConnectorGroupId", "SipRuleId"
|
1157
|
+
# resp.phone_number.associations[0].associated_timestamp #=> Time
|
1158
|
+
# resp.phone_number.calling_name #=> String
|
1159
|
+
# resp.phone_number.calling_name_status #=> String, one of "Unassigned", "UpdateInProgress", "UpdateSucceeded", "UpdateFailed"
|
1160
|
+
# resp.phone_number.created_timestamp #=> Time
|
1161
|
+
# resp.phone_number.updated_timestamp #=> Time
|
1162
|
+
# resp.phone_number.deletion_timestamp #=> Time
|
1163
|
+
# resp.phone_number.order_id #=> String
|
1164
|
+
#
|
1165
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetPhoneNumber AWS API Documentation
|
1166
|
+
#
|
1167
|
+
# @overload get_phone_number(params = {})
|
1168
|
+
# @param [Hash] params ({})
|
1169
|
+
def get_phone_number(params = {}, options = {})
|
1170
|
+
req = build_request(:get_phone_number, params)
|
1171
|
+
req.send_request(options)
|
1172
|
+
end
|
1173
|
+
|
1174
|
+
# @option params [required, String] :phone_number_order_id
|
1175
|
+
#
|
1176
|
+
# @return [Types::GetPhoneNumberOrderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1177
|
+
#
|
1178
|
+
# * {Types::GetPhoneNumberOrderResponse#phone_number_order #phone_number_order} => Types::PhoneNumberOrder
|
1179
|
+
#
|
1180
|
+
# @example Request syntax with placeholder values
|
1181
|
+
#
|
1182
|
+
# resp = client.get_phone_number_order({
|
1183
|
+
# phone_number_order_id: "GuidString", # required
|
1184
|
+
# })
|
1185
|
+
#
|
1186
|
+
# @example Response structure
|
1187
|
+
#
|
1188
|
+
# resp.phone_number_order.phone_number_order_id #=> String
|
1189
|
+
# resp.phone_number_order.product_type #=> String, one of "VoiceConnector", "SipMediaApplicationDialIn"
|
1190
|
+
# resp.phone_number_order.status #=> String, one of "Processing", "Successful", "Failed", "Partial", "PendingDocuments", "Submitted", "FOC", "ChangeRequested", "Exception", "CancelRequested", "Cancelled"
|
1191
|
+
# resp.phone_number_order.order_type #=> String, one of "New", "Porting"
|
1192
|
+
# resp.phone_number_order.ordered_phone_numbers #=> Array
|
1193
|
+
# resp.phone_number_order.ordered_phone_numbers[0].e164_phone_number #=> String
|
1194
|
+
# resp.phone_number_order.ordered_phone_numbers[0].status #=> String, one of "Processing", "Acquired", "Failed"
|
1195
|
+
# resp.phone_number_order.created_timestamp #=> Time
|
1196
|
+
# resp.phone_number_order.updated_timestamp #=> Time
|
1197
|
+
#
|
1198
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetPhoneNumberOrder AWS API Documentation
|
1199
|
+
#
|
1200
|
+
# @overload get_phone_number_order(params = {})
|
1201
|
+
# @param [Hash] params ({})
|
1202
|
+
def get_phone_number_order(params = {}, options = {})
|
1203
|
+
req = build_request(:get_phone_number_order, params)
|
1204
|
+
req.send_request(options)
|
1205
|
+
end
|
1206
|
+
|
1207
|
+
# @return [Types::GetPhoneNumberSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1208
|
+
#
|
1209
|
+
# * {Types::GetPhoneNumberSettingsResponse#calling_name #calling_name} => String
|
1210
|
+
# * {Types::GetPhoneNumberSettingsResponse#calling_name_updated_timestamp #calling_name_updated_timestamp} => Time
|
1211
|
+
#
|
1212
|
+
# @example Response structure
|
1213
|
+
#
|
1214
|
+
# resp.calling_name #=> String
|
1215
|
+
# resp.calling_name_updated_timestamp #=> Time
|
1216
|
+
#
|
1217
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetPhoneNumberSettings AWS API Documentation
|
1218
|
+
#
|
1219
|
+
# @overload get_phone_number_settings(params = {})
|
1220
|
+
# @param [Hash] params ({})
|
1221
|
+
def get_phone_number_settings(params = {}, options = {})
|
1222
|
+
req = build_request(:get_phone_number_settings, params)
|
1223
|
+
req.send_request(options)
|
1224
|
+
end
|
1225
|
+
|
1226
|
+
# @option params [required, String] :voice_connector_id
|
1227
|
+
#
|
1228
|
+
# @option params [required, String] :proxy_session_id
|
1229
|
+
#
|
1230
|
+
# @return [Types::GetProxySessionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1231
|
+
#
|
1232
|
+
# * {Types::GetProxySessionResponse#proxy_session #proxy_session} => Types::ProxySession
|
1233
|
+
#
|
1234
|
+
# @example Request syntax with placeholder values
|
1235
|
+
#
|
1236
|
+
# resp = client.get_proxy_session({
|
1237
|
+
# voice_connector_id: "NonEmptyString128", # required
|
1238
|
+
# proxy_session_id: "NonEmptyString128", # required
|
1239
|
+
# })
|
1240
|
+
#
|
1241
|
+
# @example Response structure
|
1242
|
+
#
|
1243
|
+
# resp.proxy_session.voice_connector_id #=> String
|
1244
|
+
# resp.proxy_session.proxy_session_id #=> String
|
1245
|
+
# resp.proxy_session.name #=> String
|
1246
|
+
# resp.proxy_session.status #=> String, one of "Open", "InProgress", "Closed"
|
1247
|
+
# resp.proxy_session.expiry_minutes #=> Integer
|
1248
|
+
# resp.proxy_session.capabilities #=> Array
|
1249
|
+
# resp.proxy_session.capabilities[0] #=> String, one of "Voice", "SMS"
|
1250
|
+
# resp.proxy_session.created_timestamp #=> Time
|
1251
|
+
# resp.proxy_session.updated_timestamp #=> Time
|
1252
|
+
# resp.proxy_session.ended_timestamp #=> Time
|
1253
|
+
# resp.proxy_session.participants #=> Array
|
1254
|
+
# resp.proxy_session.participants[0].phone_number #=> String
|
1255
|
+
# resp.proxy_session.participants[0].proxy_phone_number #=> String
|
1256
|
+
# resp.proxy_session.number_selection_behavior #=> String, one of "PreferSticky", "AvoidSticky"
|
1257
|
+
# resp.proxy_session.geo_match_level #=> String, one of "Country", "AreaCode"
|
1258
|
+
# resp.proxy_session.geo_match_params.country #=> String
|
1259
|
+
# resp.proxy_session.geo_match_params.area_code #=> String
|
1260
|
+
#
|
1261
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetProxySession AWS API Documentation
|
1262
|
+
#
|
1263
|
+
# @overload get_proxy_session(params = {})
|
1264
|
+
# @param [Hash] params ({})
|
1265
|
+
def get_proxy_session(params = {}, options = {})
|
1266
|
+
req = build_request(:get_proxy_session, params)
|
1267
|
+
req.send_request(options)
|
1268
|
+
end
|
1269
|
+
|
1270
|
+
# @option params [required, String] :sip_media_application_id
|
1271
|
+
#
|
1272
|
+
# @return [Types::GetSipMediaApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1273
|
+
#
|
1274
|
+
# * {Types::GetSipMediaApplicationResponse#sip_media_application #sip_media_application} => Types::SipMediaApplication
|
1275
|
+
#
|
1276
|
+
# @example Request syntax with placeholder values
|
1277
|
+
#
|
1278
|
+
# resp = client.get_sip_media_application({
|
1279
|
+
# sip_media_application_id: "NonEmptyString", # required
|
1280
|
+
# })
|
1281
|
+
#
|
1282
|
+
# @example Response structure
|
1283
|
+
#
|
1284
|
+
# resp.sip_media_application.sip_media_application_id #=> String
|
1285
|
+
# resp.sip_media_application.aws_region #=> String
|
1286
|
+
# resp.sip_media_application.name #=> String
|
1287
|
+
# resp.sip_media_application.endpoints #=> Array
|
1288
|
+
# resp.sip_media_application.endpoints[0].lambda_arn #=> String
|
1289
|
+
# resp.sip_media_application.created_timestamp #=> Time
|
1290
|
+
# resp.sip_media_application.updated_timestamp #=> Time
|
1291
|
+
#
|
1292
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetSipMediaApplication AWS API Documentation
|
1293
|
+
#
|
1294
|
+
# @overload get_sip_media_application(params = {})
|
1295
|
+
# @param [Hash] params ({})
|
1296
|
+
def get_sip_media_application(params = {}, options = {})
|
1297
|
+
req = build_request(:get_sip_media_application, params)
|
1298
|
+
req.send_request(options)
|
1299
|
+
end
|
1300
|
+
|
1301
|
+
# @option params [required, String] :sip_media_application_id
|
1302
|
+
#
|
1303
|
+
# @return [Types::GetSipMediaApplicationAlexaSkillConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1304
|
+
#
|
1305
|
+
# * {Types::GetSipMediaApplicationAlexaSkillConfigurationResponse#sip_media_application_alexa_skill_configuration #sip_media_application_alexa_skill_configuration} => Types::SipMediaApplicationAlexaSkillConfiguration
|
1306
|
+
#
|
1307
|
+
# @example Request syntax with placeholder values
|
1308
|
+
#
|
1309
|
+
# resp = client.get_sip_media_application_alexa_skill_configuration({
|
1310
|
+
# sip_media_application_id: "NonEmptyString", # required
|
1311
|
+
# })
|
1312
|
+
#
|
1313
|
+
# @example Response structure
|
1314
|
+
#
|
1315
|
+
# resp.sip_media_application_alexa_skill_configuration.alexa_skill_status #=> String, one of "ACTIVE", "INACTIVE"
|
1316
|
+
# resp.sip_media_application_alexa_skill_configuration.alexa_skill_ids #=> Array
|
1317
|
+
# resp.sip_media_application_alexa_skill_configuration.alexa_skill_ids[0] #=> String
|
1318
|
+
#
|
1319
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetSipMediaApplicationAlexaSkillConfiguration AWS API Documentation
|
1320
|
+
#
|
1321
|
+
# @overload get_sip_media_application_alexa_skill_configuration(params = {})
|
1322
|
+
# @param [Hash] params ({})
|
1323
|
+
def get_sip_media_application_alexa_skill_configuration(params = {}, options = {})
|
1324
|
+
req = build_request(:get_sip_media_application_alexa_skill_configuration, params)
|
1325
|
+
req.send_request(options)
|
1326
|
+
end
|
1327
|
+
|
1328
|
+
# @option params [required, String] :sip_media_application_id
|
1329
|
+
#
|
1330
|
+
# @return [Types::GetSipMediaApplicationLoggingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1331
|
+
#
|
1332
|
+
# * {Types::GetSipMediaApplicationLoggingConfigurationResponse#sip_media_application_logging_configuration #sip_media_application_logging_configuration} => Types::SipMediaApplicationLoggingConfiguration
|
1333
|
+
#
|
1334
|
+
# @example Request syntax with placeholder values
|
1335
|
+
#
|
1336
|
+
# resp = client.get_sip_media_application_logging_configuration({
|
1337
|
+
# sip_media_application_id: "NonEmptyString", # required
|
1338
|
+
# })
|
1339
|
+
#
|
1340
|
+
# @example Response structure
|
1341
|
+
#
|
1342
|
+
# resp.sip_media_application_logging_configuration.enable_sip_media_application_message_logs #=> Boolean
|
1343
|
+
#
|
1344
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetSipMediaApplicationLoggingConfiguration AWS API Documentation
|
1345
|
+
#
|
1346
|
+
# @overload get_sip_media_application_logging_configuration(params = {})
|
1347
|
+
# @param [Hash] params ({})
|
1348
|
+
def get_sip_media_application_logging_configuration(params = {}, options = {})
|
1349
|
+
req = build_request(:get_sip_media_application_logging_configuration, params)
|
1350
|
+
req.send_request(options)
|
1351
|
+
end
|
1352
|
+
|
1353
|
+
# @option params [required, String] :sip_rule_id
|
1354
|
+
#
|
1355
|
+
# @return [Types::GetSipRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1356
|
+
#
|
1357
|
+
# * {Types::GetSipRuleResponse#sip_rule #sip_rule} => Types::SipRule
|
1358
|
+
#
|
1359
|
+
# @example Request syntax with placeholder values
|
1360
|
+
#
|
1361
|
+
# resp = client.get_sip_rule({
|
1362
|
+
# sip_rule_id: "NonEmptyString", # required
|
1363
|
+
# })
|
1364
|
+
#
|
1365
|
+
# @example Response structure
|
1366
|
+
#
|
1367
|
+
# resp.sip_rule.sip_rule_id #=> String
|
1368
|
+
# resp.sip_rule.name #=> String
|
1369
|
+
# resp.sip_rule.disabled #=> Boolean
|
1370
|
+
# resp.sip_rule.trigger_type #=> String, one of "ToPhoneNumber", "RequestUriHostname"
|
1371
|
+
# resp.sip_rule.trigger_value #=> String
|
1372
|
+
# resp.sip_rule.target_applications #=> Array
|
1373
|
+
# resp.sip_rule.target_applications[0].sip_media_application_id #=> String
|
1374
|
+
# resp.sip_rule.target_applications[0].priority #=> Integer
|
1375
|
+
# resp.sip_rule.target_applications[0].aws_region #=> String
|
1376
|
+
# resp.sip_rule.created_timestamp #=> Time
|
1377
|
+
# resp.sip_rule.updated_timestamp #=> Time
|
1378
|
+
#
|
1379
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetSipRule AWS API Documentation
|
1380
|
+
#
|
1381
|
+
# @overload get_sip_rule(params = {})
|
1382
|
+
# @param [Hash] params ({})
|
1383
|
+
def get_sip_rule(params = {}, options = {})
|
1384
|
+
req = build_request(:get_sip_rule, params)
|
1385
|
+
req.send_request(options)
|
1386
|
+
end
|
1387
|
+
|
1388
|
+
# @option params [required, String] :voice_connector_id
|
1389
|
+
#
|
1390
|
+
# @return [Types::GetVoiceConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1391
|
+
#
|
1392
|
+
# * {Types::GetVoiceConnectorResponse#voice_connector #voice_connector} => Types::VoiceConnector
|
1393
|
+
#
|
1394
|
+
# @example Request syntax with placeholder values
|
1395
|
+
#
|
1396
|
+
# resp = client.get_voice_connector({
|
1397
|
+
# voice_connector_id: "NonEmptyString", # required
|
1398
|
+
# })
|
1399
|
+
#
|
1400
|
+
# @example Response structure
|
1401
|
+
#
|
1402
|
+
# resp.voice_connector.voice_connector_id #=> String
|
1403
|
+
# resp.voice_connector.aws_region #=> String, one of "us-east-1", "us-west-2", "ca-central-1", "eu-central-1", "eu-west-1", "eu-west-2", "ap-northeast-2", "ap-northeast-1", "ap-southeast-1", "ap-southeast-2"
|
1404
|
+
# resp.voice_connector.name #=> String
|
1405
|
+
# resp.voice_connector.outbound_host_name #=> String
|
1406
|
+
# resp.voice_connector.require_encryption #=> Boolean
|
1407
|
+
# resp.voice_connector.created_timestamp #=> Time
|
1408
|
+
# resp.voice_connector.updated_timestamp #=> Time
|
1409
|
+
# resp.voice_connector.voice_connector_arn #=> String
|
1410
|
+
#
|
1411
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnector AWS API Documentation
|
1412
|
+
#
|
1413
|
+
# @overload get_voice_connector(params = {})
|
1414
|
+
# @param [Hash] params ({})
|
1415
|
+
def get_voice_connector(params = {}, options = {})
|
1416
|
+
req = build_request(:get_voice_connector, params)
|
1417
|
+
req.send_request(options)
|
1418
|
+
end
|
1419
|
+
|
1420
|
+
# @option params [required, String] :voice_connector_id
|
1421
|
+
#
|
1422
|
+
# @return [Types::GetVoiceConnectorEmergencyCallingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1423
|
+
#
|
1424
|
+
# * {Types::GetVoiceConnectorEmergencyCallingConfigurationResponse#emergency_calling_configuration #emergency_calling_configuration} => Types::EmergencyCallingConfiguration
|
1425
|
+
#
|
1426
|
+
# @example Request syntax with placeholder values
|
1427
|
+
#
|
1428
|
+
# resp = client.get_voice_connector_emergency_calling_configuration({
|
1429
|
+
# voice_connector_id: "NonEmptyString", # required
|
1430
|
+
# })
|
1431
|
+
#
|
1432
|
+
# @example Response structure
|
1433
|
+
#
|
1434
|
+
# resp.emergency_calling_configuration.dnis #=> Array
|
1435
|
+
# resp.emergency_calling_configuration.dnis[0].emergency_phone_number #=> String
|
1436
|
+
# resp.emergency_calling_configuration.dnis[0].test_phone_number #=> String
|
1437
|
+
# resp.emergency_calling_configuration.dnis[0].calling_country #=> String
|
1438
|
+
#
|
1439
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorEmergencyCallingConfiguration AWS API Documentation
|
1440
|
+
#
|
1441
|
+
# @overload get_voice_connector_emergency_calling_configuration(params = {})
|
1442
|
+
# @param [Hash] params ({})
|
1443
|
+
def get_voice_connector_emergency_calling_configuration(params = {}, options = {})
|
1444
|
+
req = build_request(:get_voice_connector_emergency_calling_configuration, params)
|
1445
|
+
req.send_request(options)
|
1446
|
+
end
|
1447
|
+
|
1448
|
+
# @option params [required, String] :voice_connector_group_id
|
1449
|
+
#
|
1450
|
+
# @return [Types::GetVoiceConnectorGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1451
|
+
#
|
1452
|
+
# * {Types::GetVoiceConnectorGroupResponse#voice_connector_group #voice_connector_group} => Types::VoiceConnectorGroup
|
1453
|
+
#
|
1454
|
+
# @example Request syntax with placeholder values
|
1455
|
+
#
|
1456
|
+
# resp = client.get_voice_connector_group({
|
1457
|
+
# voice_connector_group_id: "NonEmptyString", # required
|
1458
|
+
# })
|
1459
|
+
#
|
1460
|
+
# @example Response structure
|
1461
|
+
#
|
1462
|
+
# resp.voice_connector_group.voice_connector_group_id #=> String
|
1463
|
+
# resp.voice_connector_group.name #=> String
|
1464
|
+
# resp.voice_connector_group.voice_connector_items #=> Array
|
1465
|
+
# resp.voice_connector_group.voice_connector_items[0].voice_connector_id #=> String
|
1466
|
+
# resp.voice_connector_group.voice_connector_items[0].priority #=> Integer
|
1467
|
+
# resp.voice_connector_group.created_timestamp #=> Time
|
1468
|
+
# resp.voice_connector_group.updated_timestamp #=> Time
|
1469
|
+
# resp.voice_connector_group.voice_connector_group_arn #=> String
|
1470
|
+
#
|
1471
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorGroup AWS API Documentation
|
1472
|
+
#
|
1473
|
+
# @overload get_voice_connector_group(params = {})
|
1474
|
+
# @param [Hash] params ({})
|
1475
|
+
def get_voice_connector_group(params = {}, options = {})
|
1476
|
+
req = build_request(:get_voice_connector_group, params)
|
1477
|
+
req.send_request(options)
|
1478
|
+
end
|
1479
|
+
|
1480
|
+
# @option params [required, String] :voice_connector_id
|
1481
|
+
#
|
1482
|
+
# @return [Types::GetVoiceConnectorLoggingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1483
|
+
#
|
1484
|
+
# * {Types::GetVoiceConnectorLoggingConfigurationResponse#logging_configuration #logging_configuration} => Types::LoggingConfiguration
|
1485
|
+
#
|
1486
|
+
# @example Request syntax with placeholder values
|
1487
|
+
#
|
1488
|
+
# resp = client.get_voice_connector_logging_configuration({
|
1489
|
+
# voice_connector_id: "NonEmptyString", # required
|
1490
|
+
# })
|
1491
|
+
#
|
1492
|
+
# @example Response structure
|
1493
|
+
#
|
1494
|
+
# resp.logging_configuration.enable_sip_logs #=> Boolean
|
1495
|
+
#
|
1496
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorLoggingConfiguration AWS API Documentation
|
1497
|
+
#
|
1498
|
+
# @overload get_voice_connector_logging_configuration(params = {})
|
1499
|
+
# @param [Hash] params ({})
|
1500
|
+
def get_voice_connector_logging_configuration(params = {}, options = {})
|
1501
|
+
req = build_request(:get_voice_connector_logging_configuration, params)
|
1502
|
+
req.send_request(options)
|
1503
|
+
end
|
1504
|
+
|
1505
|
+
# @option params [required, String] :voice_connector_id
|
1506
|
+
#
|
1507
|
+
# @return [Types::GetVoiceConnectorOriginationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1508
|
+
#
|
1509
|
+
# * {Types::GetVoiceConnectorOriginationResponse#origination #origination} => Types::Origination
|
1510
|
+
#
|
1511
|
+
# @example Request syntax with placeholder values
|
1512
|
+
#
|
1513
|
+
# resp = client.get_voice_connector_origination({
|
1514
|
+
# voice_connector_id: "NonEmptyString", # required
|
1515
|
+
# })
|
1516
|
+
#
|
1517
|
+
# @example Response structure
|
1518
|
+
#
|
1519
|
+
# resp.origination.routes #=> Array
|
1520
|
+
# resp.origination.routes[0].host #=> String
|
1521
|
+
# resp.origination.routes[0].port #=> Integer
|
1522
|
+
# resp.origination.routes[0].protocol #=> String, one of "TCP", "UDP"
|
1523
|
+
# resp.origination.routes[0].priority #=> Integer
|
1524
|
+
# resp.origination.routes[0].weight #=> Integer
|
1525
|
+
# resp.origination.disabled #=> Boolean
|
1526
|
+
#
|
1527
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorOrigination AWS API Documentation
|
1528
|
+
#
|
1529
|
+
# @overload get_voice_connector_origination(params = {})
|
1530
|
+
# @param [Hash] params ({})
|
1531
|
+
def get_voice_connector_origination(params = {}, options = {})
|
1532
|
+
req = build_request(:get_voice_connector_origination, params)
|
1533
|
+
req.send_request(options)
|
1534
|
+
end
|
1535
|
+
|
1536
|
+
# @option params [required, String] :voice_connector_id
|
1537
|
+
#
|
1538
|
+
# @return [Types::GetVoiceConnectorProxyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1539
|
+
#
|
1540
|
+
# * {Types::GetVoiceConnectorProxyResponse#proxy #proxy} => Types::Proxy
|
1541
|
+
#
|
1542
|
+
# @example Request syntax with placeholder values
|
1543
|
+
#
|
1544
|
+
# resp = client.get_voice_connector_proxy({
|
1545
|
+
# voice_connector_id: "NonEmptyString128", # required
|
1546
|
+
# })
|
1547
|
+
#
|
1548
|
+
# @example Response structure
|
1549
|
+
#
|
1550
|
+
# resp.proxy.default_session_expiry_minutes #=> Integer
|
1551
|
+
# resp.proxy.disabled #=> Boolean
|
1552
|
+
# resp.proxy.fall_back_phone_number #=> String
|
1553
|
+
# resp.proxy.phone_number_countries #=> Array
|
1554
|
+
# resp.proxy.phone_number_countries[0] #=> String
|
1555
|
+
#
|
1556
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorProxy AWS API Documentation
|
1557
|
+
#
|
1558
|
+
# @overload get_voice_connector_proxy(params = {})
|
1559
|
+
# @param [Hash] params ({})
|
1560
|
+
def get_voice_connector_proxy(params = {}, options = {})
|
1561
|
+
req = build_request(:get_voice_connector_proxy, params)
|
1562
|
+
req.send_request(options)
|
1563
|
+
end
|
1564
|
+
|
1565
|
+
# @option params [required, String] :voice_connector_id
|
1566
|
+
#
|
1567
|
+
# @return [Types::GetVoiceConnectorStreamingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1568
|
+
#
|
1569
|
+
# * {Types::GetVoiceConnectorStreamingConfigurationResponse#streaming_configuration #streaming_configuration} => Types::StreamingConfiguration
|
1570
|
+
#
|
1571
|
+
# @example Request syntax with placeholder values
|
1572
|
+
#
|
1573
|
+
# resp = client.get_voice_connector_streaming_configuration({
|
1574
|
+
# voice_connector_id: "NonEmptyString", # required
|
1575
|
+
# })
|
1576
|
+
#
|
1577
|
+
# @example Response structure
|
1578
|
+
#
|
1579
|
+
# resp.streaming_configuration.data_retention_in_hours #=> Integer
|
1580
|
+
# resp.streaming_configuration.disabled #=> Boolean
|
1581
|
+
# resp.streaming_configuration.streaming_notification_targets #=> Array
|
1582
|
+
# resp.streaming_configuration.streaming_notification_targets[0].notification_target #=> String, one of "EventBridge", "SNS", "SQS"
|
1583
|
+
#
|
1584
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorStreamingConfiguration AWS API Documentation
|
1585
|
+
#
|
1586
|
+
# @overload get_voice_connector_streaming_configuration(params = {})
|
1587
|
+
# @param [Hash] params ({})
|
1588
|
+
def get_voice_connector_streaming_configuration(params = {}, options = {})
|
1589
|
+
req = build_request(:get_voice_connector_streaming_configuration, params)
|
1590
|
+
req.send_request(options)
|
1591
|
+
end
|
1592
|
+
|
1593
|
+
# @option params [required, String] :voice_connector_id
|
1594
|
+
#
|
1595
|
+
# @return [Types::GetVoiceConnectorTerminationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1596
|
+
#
|
1597
|
+
# * {Types::GetVoiceConnectorTerminationResponse#termination #termination} => Types::Termination
|
1598
|
+
#
|
1599
|
+
# @example Request syntax with placeholder values
|
1600
|
+
#
|
1601
|
+
# resp = client.get_voice_connector_termination({
|
1602
|
+
# voice_connector_id: "NonEmptyString", # required
|
1603
|
+
# })
|
1604
|
+
#
|
1605
|
+
# @example Response structure
|
1606
|
+
#
|
1607
|
+
# resp.termination.cps_limit #=> Integer
|
1608
|
+
# resp.termination.default_phone_number #=> String
|
1609
|
+
# resp.termination.calling_regions #=> Array
|
1610
|
+
# resp.termination.calling_regions[0] #=> String
|
1611
|
+
# resp.termination.cidr_allowed_list #=> Array
|
1612
|
+
# resp.termination.cidr_allowed_list[0] #=> String
|
1613
|
+
# resp.termination.disabled #=> Boolean
|
1614
|
+
#
|
1615
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorTermination AWS API Documentation
|
1616
|
+
#
|
1617
|
+
# @overload get_voice_connector_termination(params = {})
|
1618
|
+
# @param [Hash] params ({})
|
1619
|
+
def get_voice_connector_termination(params = {}, options = {})
|
1620
|
+
req = build_request(:get_voice_connector_termination, params)
|
1621
|
+
req.send_request(options)
|
1622
|
+
end
|
1623
|
+
|
1624
|
+
# @option params [required, String] :voice_connector_id
|
1625
|
+
#
|
1626
|
+
# @return [Types::GetVoiceConnectorTerminationHealthResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1627
|
+
#
|
1628
|
+
# * {Types::GetVoiceConnectorTerminationHealthResponse#termination_health #termination_health} => Types::TerminationHealth
|
1629
|
+
#
|
1630
|
+
# @example Request syntax with placeholder values
|
1631
|
+
#
|
1632
|
+
# resp = client.get_voice_connector_termination_health({
|
1633
|
+
# voice_connector_id: "NonEmptyString", # required
|
1634
|
+
# })
|
1635
|
+
#
|
1636
|
+
# @example Response structure
|
1637
|
+
#
|
1638
|
+
# resp.termination_health.timestamp #=> Time
|
1639
|
+
# resp.termination_health.source #=> String
|
1640
|
+
#
|
1641
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/GetVoiceConnectorTerminationHealth AWS API Documentation
|
1642
|
+
#
|
1643
|
+
# @overload get_voice_connector_termination_health(params = {})
|
1644
|
+
# @param [Hash] params ({})
|
1645
|
+
def get_voice_connector_termination_health(params = {}, options = {})
|
1646
|
+
req = build_request(:get_voice_connector_termination_health, params)
|
1647
|
+
req.send_request(options)
|
1648
|
+
end
|
1649
|
+
|
1650
|
+
# @return [Types::ListAvailableVoiceConnectorRegionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1651
|
+
#
|
1652
|
+
# * {Types::ListAvailableVoiceConnectorRegionsResponse#voice_connector_regions #voice_connector_regions} => Array<String>
|
1653
|
+
#
|
1654
|
+
# @example Response structure
|
1655
|
+
#
|
1656
|
+
# resp.voice_connector_regions #=> Array
|
1657
|
+
# resp.voice_connector_regions[0] #=> String, one of "us-east-1", "us-west-2", "ca-central-1", "eu-central-1", "eu-west-1", "eu-west-2", "ap-northeast-2", "ap-northeast-1", "ap-southeast-1", "ap-southeast-2"
|
1658
|
+
#
|
1659
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListAvailableVoiceConnectorRegions AWS API Documentation
|
1660
|
+
#
|
1661
|
+
# @overload list_available_voice_connector_regions(params = {})
|
1662
|
+
# @param [Hash] params ({})
|
1663
|
+
def list_available_voice_connector_regions(params = {}, options = {})
|
1664
|
+
req = build_request(:list_available_voice_connector_regions, params)
|
1665
|
+
req.send_request(options)
|
1666
|
+
end
|
1667
|
+
|
1668
|
+
# @option params [String] :next_token
|
1669
|
+
#
|
1670
|
+
# @option params [Integer] :max_results
|
1671
|
+
#
|
1672
|
+
# @return [Types::ListPhoneNumberOrdersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1673
|
+
#
|
1674
|
+
# * {Types::ListPhoneNumberOrdersResponse#phone_number_orders #phone_number_orders} => Array<Types::PhoneNumberOrder>
|
1675
|
+
# * {Types::ListPhoneNumberOrdersResponse#next_token #next_token} => String
|
1676
|
+
#
|
1677
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1678
|
+
#
|
1679
|
+
# @example Request syntax with placeholder values
|
1680
|
+
#
|
1681
|
+
# resp = client.list_phone_number_orders({
|
1682
|
+
# next_token: "String",
|
1683
|
+
# max_results: 1,
|
1684
|
+
# })
|
1685
|
+
#
|
1686
|
+
# @example Response structure
|
1687
|
+
#
|
1688
|
+
# resp.phone_number_orders #=> Array
|
1689
|
+
# resp.phone_number_orders[0].phone_number_order_id #=> String
|
1690
|
+
# resp.phone_number_orders[0].product_type #=> String, one of "VoiceConnector", "SipMediaApplicationDialIn"
|
1691
|
+
# resp.phone_number_orders[0].status #=> String, one of "Processing", "Successful", "Failed", "Partial", "PendingDocuments", "Submitted", "FOC", "ChangeRequested", "Exception", "CancelRequested", "Cancelled"
|
1692
|
+
# resp.phone_number_orders[0].order_type #=> String, one of "New", "Porting"
|
1693
|
+
# resp.phone_number_orders[0].ordered_phone_numbers #=> Array
|
1694
|
+
# resp.phone_number_orders[0].ordered_phone_numbers[0].e164_phone_number #=> String
|
1695
|
+
# resp.phone_number_orders[0].ordered_phone_numbers[0].status #=> String, one of "Processing", "Acquired", "Failed"
|
1696
|
+
# resp.phone_number_orders[0].created_timestamp #=> Time
|
1697
|
+
# resp.phone_number_orders[0].updated_timestamp #=> Time
|
1698
|
+
# resp.next_token #=> String
|
1699
|
+
#
|
1700
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListPhoneNumberOrders AWS API Documentation
|
1701
|
+
#
|
1702
|
+
# @overload list_phone_number_orders(params = {})
|
1703
|
+
# @param [Hash] params ({})
|
1704
|
+
def list_phone_number_orders(params = {}, options = {})
|
1705
|
+
req = build_request(:list_phone_number_orders, params)
|
1706
|
+
req.send_request(options)
|
1707
|
+
end
|
1708
|
+
|
1709
|
+
# @option params [String] :status
|
1710
|
+
#
|
1711
|
+
# @option params [String] :product_type
|
1712
|
+
#
|
1713
|
+
# @option params [String] :filter_name
|
1714
|
+
#
|
1715
|
+
# @option params [String] :filter_value
|
1716
|
+
#
|
1717
|
+
# @option params [Integer] :max_results
|
1718
|
+
#
|
1719
|
+
# @option params [String] :next_token
|
1720
|
+
#
|
1721
|
+
# @return [Types::ListPhoneNumbersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1722
|
+
#
|
1723
|
+
# * {Types::ListPhoneNumbersResponse#phone_numbers #phone_numbers} => Array<Types::PhoneNumber>
|
1724
|
+
# * {Types::ListPhoneNumbersResponse#next_token #next_token} => String
|
1725
|
+
#
|
1726
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1727
|
+
#
|
1728
|
+
# @example Request syntax with placeholder values
|
1729
|
+
#
|
1730
|
+
# resp = client.list_phone_numbers({
|
1731
|
+
# status: "String",
|
1732
|
+
# product_type: "VoiceConnector", # accepts VoiceConnector, SipMediaApplicationDialIn
|
1733
|
+
# filter_name: "VoiceConnectorId", # accepts VoiceConnectorId, VoiceConnectorGroupId, SipRuleId
|
1734
|
+
# filter_value: "String",
|
1735
|
+
# max_results: 1,
|
1736
|
+
# next_token: "String",
|
1737
|
+
# })
|
1738
|
+
#
|
1739
|
+
# @example Response structure
|
1740
|
+
#
|
1741
|
+
# resp.phone_numbers #=> Array
|
1742
|
+
# resp.phone_numbers[0].phone_number_id #=> String
|
1743
|
+
# resp.phone_numbers[0].e164_phone_number #=> String
|
1744
|
+
# resp.phone_numbers[0].country #=> String
|
1745
|
+
# resp.phone_numbers[0].type #=> String, one of "Local", "TollFree"
|
1746
|
+
# resp.phone_numbers[0].product_type #=> String, one of "VoiceConnector", "SipMediaApplicationDialIn"
|
1747
|
+
# resp.phone_numbers[0].status #=> String, one of "Cancelled", "PortinCancelRequested", "PortinInProgress", "AcquireInProgress", "AcquireFailed", "Unassigned", "Assigned", "ReleaseInProgress", "DeleteInProgress", "ReleaseFailed", "DeleteFailed"
|
1748
|
+
# resp.phone_numbers[0].capabilities.inbound_call #=> Boolean
|
1749
|
+
# resp.phone_numbers[0].capabilities.outbound_call #=> Boolean
|
1750
|
+
# resp.phone_numbers[0].capabilities.inbound_sms #=> Boolean
|
1751
|
+
# resp.phone_numbers[0].capabilities.outbound_sms #=> Boolean
|
1752
|
+
# resp.phone_numbers[0].capabilities.inbound_mms #=> Boolean
|
1753
|
+
# resp.phone_numbers[0].capabilities.outbound_mms #=> Boolean
|
1754
|
+
# resp.phone_numbers[0].associations #=> Array
|
1755
|
+
# resp.phone_numbers[0].associations[0].value #=> String
|
1756
|
+
# resp.phone_numbers[0].associations[0].name #=> String, one of "VoiceConnectorId", "VoiceConnectorGroupId", "SipRuleId"
|
1757
|
+
# resp.phone_numbers[0].associations[0].associated_timestamp #=> Time
|
1758
|
+
# resp.phone_numbers[0].calling_name #=> String
|
1759
|
+
# resp.phone_numbers[0].calling_name_status #=> String, one of "Unassigned", "UpdateInProgress", "UpdateSucceeded", "UpdateFailed"
|
1760
|
+
# resp.phone_numbers[0].created_timestamp #=> Time
|
1761
|
+
# resp.phone_numbers[0].updated_timestamp #=> Time
|
1762
|
+
# resp.phone_numbers[0].deletion_timestamp #=> Time
|
1763
|
+
# resp.phone_numbers[0].order_id #=> String
|
1764
|
+
# resp.next_token #=> String
|
1765
|
+
#
|
1766
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListPhoneNumbers AWS API Documentation
|
1767
|
+
#
|
1768
|
+
# @overload list_phone_numbers(params = {})
|
1769
|
+
# @param [Hash] params ({})
|
1770
|
+
def list_phone_numbers(params = {}, options = {})
|
1771
|
+
req = build_request(:list_phone_numbers, params)
|
1772
|
+
req.send_request(options)
|
1773
|
+
end
|
1774
|
+
|
1775
|
+
# @option params [required, String] :voice_connector_id
|
1776
|
+
#
|
1777
|
+
# @option params [String] :status
|
1778
|
+
#
|
1779
|
+
# @option params [String] :next_token
|
1780
|
+
#
|
1781
|
+
# @option params [Integer] :max_results
|
1782
|
+
#
|
1783
|
+
# @return [Types::ListProxySessionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1784
|
+
#
|
1785
|
+
# * {Types::ListProxySessionsResponse#proxy_sessions #proxy_sessions} => Array<Types::ProxySession>
|
1786
|
+
# * {Types::ListProxySessionsResponse#next_token #next_token} => String
|
1787
|
+
#
|
1788
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1789
|
+
#
|
1790
|
+
# @example Request syntax with placeholder values
|
1791
|
+
#
|
1792
|
+
# resp = client.list_proxy_sessions({
|
1793
|
+
# voice_connector_id: "NonEmptyString128", # required
|
1794
|
+
# status: "Open", # accepts Open, InProgress, Closed
|
1795
|
+
# next_token: "NextTokenString",
|
1796
|
+
# max_results: 1,
|
1797
|
+
# })
|
1798
|
+
#
|
1799
|
+
# @example Response structure
|
1800
|
+
#
|
1801
|
+
# resp.proxy_sessions #=> Array
|
1802
|
+
# resp.proxy_sessions[0].voice_connector_id #=> String
|
1803
|
+
# resp.proxy_sessions[0].proxy_session_id #=> String
|
1804
|
+
# resp.proxy_sessions[0].name #=> String
|
1805
|
+
# resp.proxy_sessions[0].status #=> String, one of "Open", "InProgress", "Closed"
|
1806
|
+
# resp.proxy_sessions[0].expiry_minutes #=> Integer
|
1807
|
+
# resp.proxy_sessions[0].capabilities #=> Array
|
1808
|
+
# resp.proxy_sessions[0].capabilities[0] #=> String, one of "Voice", "SMS"
|
1809
|
+
# resp.proxy_sessions[0].created_timestamp #=> Time
|
1810
|
+
# resp.proxy_sessions[0].updated_timestamp #=> Time
|
1811
|
+
# resp.proxy_sessions[0].ended_timestamp #=> Time
|
1812
|
+
# resp.proxy_sessions[0].participants #=> Array
|
1813
|
+
# resp.proxy_sessions[0].participants[0].phone_number #=> String
|
1814
|
+
# resp.proxy_sessions[0].participants[0].proxy_phone_number #=> String
|
1815
|
+
# resp.proxy_sessions[0].number_selection_behavior #=> String, one of "PreferSticky", "AvoidSticky"
|
1816
|
+
# resp.proxy_sessions[0].geo_match_level #=> String, one of "Country", "AreaCode"
|
1817
|
+
# resp.proxy_sessions[0].geo_match_params.country #=> String
|
1818
|
+
# resp.proxy_sessions[0].geo_match_params.area_code #=> String
|
1819
|
+
# resp.next_token #=> String
|
1820
|
+
#
|
1821
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListProxySessions AWS API Documentation
|
1822
|
+
#
|
1823
|
+
# @overload list_proxy_sessions(params = {})
|
1824
|
+
# @param [Hash] params ({})
|
1825
|
+
def list_proxy_sessions(params = {}, options = {})
|
1826
|
+
req = build_request(:list_proxy_sessions, params)
|
1827
|
+
req.send_request(options)
|
1828
|
+
end
|
1829
|
+
|
1830
|
+
# @option params [Integer] :max_results
|
1831
|
+
#
|
1832
|
+
# @option params [String] :next_token
|
1833
|
+
#
|
1834
|
+
# @return [Types::ListSipMediaApplicationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1835
|
+
#
|
1836
|
+
# * {Types::ListSipMediaApplicationsResponse#sip_media_applications #sip_media_applications} => Array<Types::SipMediaApplication>
|
1837
|
+
# * {Types::ListSipMediaApplicationsResponse#next_token #next_token} => String
|
1838
|
+
#
|
1839
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1840
|
+
#
|
1841
|
+
# @example Request syntax with placeholder values
|
1842
|
+
#
|
1843
|
+
# resp = client.list_sip_media_applications({
|
1844
|
+
# max_results: 1,
|
1845
|
+
# next_token: "NextTokenString",
|
1846
|
+
# })
|
1847
|
+
#
|
1848
|
+
# @example Response structure
|
1849
|
+
#
|
1850
|
+
# resp.sip_media_applications #=> Array
|
1851
|
+
# resp.sip_media_applications[0].sip_media_application_id #=> String
|
1852
|
+
# resp.sip_media_applications[0].aws_region #=> String
|
1853
|
+
# resp.sip_media_applications[0].name #=> String
|
1854
|
+
# resp.sip_media_applications[0].endpoints #=> Array
|
1855
|
+
# resp.sip_media_applications[0].endpoints[0].lambda_arn #=> String
|
1856
|
+
# resp.sip_media_applications[0].created_timestamp #=> Time
|
1857
|
+
# resp.sip_media_applications[0].updated_timestamp #=> Time
|
1858
|
+
# resp.next_token #=> String
|
1859
|
+
#
|
1860
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListSipMediaApplications AWS API Documentation
|
1861
|
+
#
|
1862
|
+
# @overload list_sip_media_applications(params = {})
|
1863
|
+
# @param [Hash] params ({})
|
1864
|
+
def list_sip_media_applications(params = {}, options = {})
|
1865
|
+
req = build_request(:list_sip_media_applications, params)
|
1866
|
+
req.send_request(options)
|
1867
|
+
end
|
1868
|
+
|
1869
|
+
# @option params [String] :sip_media_application_id
|
1870
|
+
#
|
1871
|
+
# @option params [Integer] :max_results
|
1872
|
+
#
|
1873
|
+
# @option params [String] :next_token
|
1874
|
+
#
|
1875
|
+
# @return [Types::ListSipRulesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1876
|
+
#
|
1877
|
+
# * {Types::ListSipRulesResponse#sip_rules #sip_rules} => Array<Types::SipRule>
|
1878
|
+
# * {Types::ListSipRulesResponse#next_token #next_token} => String
|
1879
|
+
#
|
1880
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1881
|
+
#
|
1882
|
+
# @example Request syntax with placeholder values
|
1883
|
+
#
|
1884
|
+
# resp = client.list_sip_rules({
|
1885
|
+
# sip_media_application_id: "NonEmptyString",
|
1886
|
+
# max_results: 1,
|
1887
|
+
# next_token: "NextTokenString",
|
1888
|
+
# })
|
1889
|
+
#
|
1890
|
+
# @example Response structure
|
1891
|
+
#
|
1892
|
+
# resp.sip_rules #=> Array
|
1893
|
+
# resp.sip_rules[0].sip_rule_id #=> String
|
1894
|
+
# resp.sip_rules[0].name #=> String
|
1895
|
+
# resp.sip_rules[0].disabled #=> Boolean
|
1896
|
+
# resp.sip_rules[0].trigger_type #=> String, one of "ToPhoneNumber", "RequestUriHostname"
|
1897
|
+
# resp.sip_rules[0].trigger_value #=> String
|
1898
|
+
# resp.sip_rules[0].target_applications #=> Array
|
1899
|
+
# resp.sip_rules[0].target_applications[0].sip_media_application_id #=> String
|
1900
|
+
# resp.sip_rules[0].target_applications[0].priority #=> Integer
|
1901
|
+
# resp.sip_rules[0].target_applications[0].aws_region #=> String
|
1902
|
+
# resp.sip_rules[0].created_timestamp #=> Time
|
1903
|
+
# resp.sip_rules[0].updated_timestamp #=> Time
|
1904
|
+
# resp.next_token #=> String
|
1905
|
+
#
|
1906
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListSipRules AWS API Documentation
|
1907
|
+
#
|
1908
|
+
# @overload list_sip_rules(params = {})
|
1909
|
+
# @param [Hash] params ({})
|
1910
|
+
def list_sip_rules(params = {}, options = {})
|
1911
|
+
req = build_request(:list_sip_rules, params)
|
1912
|
+
req.send_request(options)
|
1913
|
+
end
|
1914
|
+
|
1915
|
+
# @option params [required, String] :product_type
|
1916
|
+
#
|
1917
|
+
# @return [Types::ListSupportedPhoneNumberCountriesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1918
|
+
#
|
1919
|
+
# * {Types::ListSupportedPhoneNumberCountriesResponse#phone_number_countries #phone_number_countries} => Array<Types::PhoneNumberCountry>
|
1920
|
+
#
|
1921
|
+
# @example Request syntax with placeholder values
|
1922
|
+
#
|
1923
|
+
# resp = client.list_supported_phone_number_countries({
|
1924
|
+
# product_type: "VoiceConnector", # required, accepts VoiceConnector, SipMediaApplicationDialIn
|
1925
|
+
# })
|
1926
|
+
#
|
1927
|
+
# @example Response structure
|
1928
|
+
#
|
1929
|
+
# resp.phone_number_countries #=> Array
|
1930
|
+
# resp.phone_number_countries[0].country_code #=> String
|
1931
|
+
# resp.phone_number_countries[0].supported_phone_number_types #=> Array
|
1932
|
+
# resp.phone_number_countries[0].supported_phone_number_types[0] #=> String, one of "Local", "TollFree"
|
1933
|
+
#
|
1934
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListSupportedPhoneNumberCountries AWS API Documentation
|
1935
|
+
#
|
1936
|
+
# @overload list_supported_phone_number_countries(params = {})
|
1937
|
+
# @param [Hash] params ({})
|
1938
|
+
def list_supported_phone_number_countries(params = {}, options = {})
|
1939
|
+
req = build_request(:list_supported_phone_number_countries, params)
|
1940
|
+
req.send_request(options)
|
1941
|
+
end
|
1942
|
+
|
1943
|
+
# @option params [String] :next_token
|
1944
|
+
#
|
1945
|
+
# @option params [Integer] :max_results
|
1946
|
+
#
|
1947
|
+
# @return [Types::ListVoiceConnectorGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1948
|
+
#
|
1949
|
+
# * {Types::ListVoiceConnectorGroupsResponse#voice_connector_groups #voice_connector_groups} => Array<Types::VoiceConnectorGroup>
|
1950
|
+
# * {Types::ListVoiceConnectorGroupsResponse#next_token #next_token} => String
|
1951
|
+
#
|
1952
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1953
|
+
#
|
1954
|
+
# @example Request syntax with placeholder values
|
1955
|
+
#
|
1956
|
+
# resp = client.list_voice_connector_groups({
|
1957
|
+
# next_token: "String",
|
1958
|
+
# max_results: 1,
|
1959
|
+
# })
|
1960
|
+
#
|
1961
|
+
# @example Response structure
|
1962
|
+
#
|
1963
|
+
# resp.voice_connector_groups #=> Array
|
1964
|
+
# resp.voice_connector_groups[0].voice_connector_group_id #=> String
|
1965
|
+
# resp.voice_connector_groups[0].name #=> String
|
1966
|
+
# resp.voice_connector_groups[0].voice_connector_items #=> Array
|
1967
|
+
# resp.voice_connector_groups[0].voice_connector_items[0].voice_connector_id #=> String
|
1968
|
+
# resp.voice_connector_groups[0].voice_connector_items[0].priority #=> Integer
|
1969
|
+
# resp.voice_connector_groups[0].created_timestamp #=> Time
|
1970
|
+
# resp.voice_connector_groups[0].updated_timestamp #=> Time
|
1971
|
+
# resp.voice_connector_groups[0].voice_connector_group_arn #=> String
|
1972
|
+
# resp.next_token #=> String
|
1973
|
+
#
|
1974
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListVoiceConnectorGroups AWS API Documentation
|
1975
|
+
#
|
1976
|
+
# @overload list_voice_connector_groups(params = {})
|
1977
|
+
# @param [Hash] params ({})
|
1978
|
+
def list_voice_connector_groups(params = {}, options = {})
|
1979
|
+
req = build_request(:list_voice_connector_groups, params)
|
1980
|
+
req.send_request(options)
|
1981
|
+
end
|
1982
|
+
|
1983
|
+
# @option params [required, String] :voice_connector_id
|
1984
|
+
#
|
1985
|
+
# @return [Types::ListVoiceConnectorTerminationCredentialsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1986
|
+
#
|
1987
|
+
# * {Types::ListVoiceConnectorTerminationCredentialsResponse#usernames #usernames} => Array<String>
|
1988
|
+
#
|
1989
|
+
# @example Request syntax with placeholder values
|
1990
|
+
#
|
1991
|
+
# resp = client.list_voice_connector_termination_credentials({
|
1992
|
+
# voice_connector_id: "NonEmptyString", # required
|
1993
|
+
# })
|
1994
|
+
#
|
1995
|
+
# @example Response structure
|
1996
|
+
#
|
1997
|
+
# resp.usernames #=> Array
|
1998
|
+
# resp.usernames[0] #=> String
|
1999
|
+
#
|
2000
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListVoiceConnectorTerminationCredentials AWS API Documentation
|
2001
|
+
#
|
2002
|
+
# @overload list_voice_connector_termination_credentials(params = {})
|
2003
|
+
# @param [Hash] params ({})
|
2004
|
+
def list_voice_connector_termination_credentials(params = {}, options = {})
|
2005
|
+
req = build_request(:list_voice_connector_termination_credentials, params)
|
2006
|
+
req.send_request(options)
|
2007
|
+
end
|
2008
|
+
|
2009
|
+
# @option params [String] :next_token
|
2010
|
+
#
|
2011
|
+
# @option params [Integer] :max_results
|
2012
|
+
#
|
2013
|
+
# @return [Types::ListVoiceConnectorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2014
|
+
#
|
2015
|
+
# * {Types::ListVoiceConnectorsResponse#voice_connectors #voice_connectors} => Array<Types::VoiceConnector>
|
2016
|
+
# * {Types::ListVoiceConnectorsResponse#next_token #next_token} => String
|
2017
|
+
#
|
2018
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2019
|
+
#
|
2020
|
+
# @example Request syntax with placeholder values
|
2021
|
+
#
|
2022
|
+
# resp = client.list_voice_connectors({
|
2023
|
+
# next_token: "String",
|
2024
|
+
# max_results: 1,
|
2025
|
+
# })
|
2026
|
+
#
|
2027
|
+
# @example Response structure
|
2028
|
+
#
|
2029
|
+
# resp.voice_connectors #=> Array
|
2030
|
+
# resp.voice_connectors[0].voice_connector_id #=> String
|
2031
|
+
# resp.voice_connectors[0].aws_region #=> String, one of "us-east-1", "us-west-2", "ca-central-1", "eu-central-1", "eu-west-1", "eu-west-2", "ap-northeast-2", "ap-northeast-1", "ap-southeast-1", "ap-southeast-2"
|
2032
|
+
# resp.voice_connectors[0].name #=> String
|
2033
|
+
# resp.voice_connectors[0].outbound_host_name #=> String
|
2034
|
+
# resp.voice_connectors[0].require_encryption #=> Boolean
|
2035
|
+
# resp.voice_connectors[0].created_timestamp #=> Time
|
2036
|
+
# resp.voice_connectors[0].updated_timestamp #=> Time
|
2037
|
+
# resp.voice_connectors[0].voice_connector_arn #=> String
|
2038
|
+
# resp.next_token #=> String
|
2039
|
+
#
|
2040
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ListVoiceConnectors AWS API Documentation
|
2041
|
+
#
|
2042
|
+
# @overload list_voice_connectors(params = {})
|
2043
|
+
# @param [Hash] params ({})
|
2044
|
+
def list_voice_connectors(params = {}, options = {})
|
2045
|
+
req = build_request(:list_voice_connectors, params)
|
2046
|
+
req.send_request(options)
|
2047
|
+
end
|
2048
|
+
|
2049
|
+
# @option params [required, String] :sip_media_application_id
|
2050
|
+
#
|
2051
|
+
# @option params [Types::SipMediaApplicationAlexaSkillConfiguration] :sip_media_application_alexa_skill_configuration
|
2052
|
+
#
|
2053
|
+
# @return [Types::PutSipMediaApplicationAlexaSkillConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2054
|
+
#
|
2055
|
+
# * {Types::PutSipMediaApplicationAlexaSkillConfigurationResponse#sip_media_application_alexa_skill_configuration #sip_media_application_alexa_skill_configuration} => Types::SipMediaApplicationAlexaSkillConfiguration
|
2056
|
+
#
|
2057
|
+
# @example Request syntax with placeholder values
|
2058
|
+
#
|
2059
|
+
# resp = client.put_sip_media_application_alexa_skill_configuration({
|
2060
|
+
# sip_media_application_id: "NonEmptyString", # required
|
2061
|
+
# sip_media_application_alexa_skill_configuration: {
|
2062
|
+
# alexa_skill_status: "ACTIVE", # required, accepts ACTIVE, INACTIVE
|
2063
|
+
# alexa_skill_ids: ["AlexaSkillId"], # required
|
2064
|
+
# },
|
2065
|
+
# })
|
2066
|
+
#
|
2067
|
+
# @example Response structure
|
2068
|
+
#
|
2069
|
+
# resp.sip_media_application_alexa_skill_configuration.alexa_skill_status #=> String, one of "ACTIVE", "INACTIVE"
|
2070
|
+
# resp.sip_media_application_alexa_skill_configuration.alexa_skill_ids #=> Array
|
2071
|
+
# resp.sip_media_application_alexa_skill_configuration.alexa_skill_ids[0] #=> String
|
2072
|
+
#
|
2073
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutSipMediaApplicationAlexaSkillConfiguration AWS API Documentation
|
2074
|
+
#
|
2075
|
+
# @overload put_sip_media_application_alexa_skill_configuration(params = {})
|
2076
|
+
# @param [Hash] params ({})
|
2077
|
+
def put_sip_media_application_alexa_skill_configuration(params = {}, options = {})
|
2078
|
+
req = build_request(:put_sip_media_application_alexa_skill_configuration, params)
|
2079
|
+
req.send_request(options)
|
2080
|
+
end
|
2081
|
+
|
2082
|
+
# @option params [required, String] :sip_media_application_id
|
2083
|
+
#
|
2084
|
+
# @option params [Types::SipMediaApplicationLoggingConfiguration] :sip_media_application_logging_configuration
|
2085
|
+
#
|
2086
|
+
# @return [Types::PutSipMediaApplicationLoggingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2087
|
+
#
|
2088
|
+
# * {Types::PutSipMediaApplicationLoggingConfigurationResponse#sip_media_application_logging_configuration #sip_media_application_logging_configuration} => Types::SipMediaApplicationLoggingConfiguration
|
2089
|
+
#
|
2090
|
+
# @example Request syntax with placeholder values
|
2091
|
+
#
|
2092
|
+
# resp = client.put_sip_media_application_logging_configuration({
|
2093
|
+
# sip_media_application_id: "NonEmptyString", # required
|
2094
|
+
# sip_media_application_logging_configuration: {
|
2095
|
+
# enable_sip_media_application_message_logs: false,
|
2096
|
+
# },
|
2097
|
+
# })
|
2098
|
+
#
|
2099
|
+
# @example Response structure
|
2100
|
+
#
|
2101
|
+
# resp.sip_media_application_logging_configuration.enable_sip_media_application_message_logs #=> Boolean
|
2102
|
+
#
|
2103
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutSipMediaApplicationLoggingConfiguration AWS API Documentation
|
2104
|
+
#
|
2105
|
+
# @overload put_sip_media_application_logging_configuration(params = {})
|
2106
|
+
# @param [Hash] params ({})
|
2107
|
+
def put_sip_media_application_logging_configuration(params = {}, options = {})
|
2108
|
+
req = build_request(:put_sip_media_application_logging_configuration, params)
|
2109
|
+
req.send_request(options)
|
2110
|
+
end
|
2111
|
+
|
2112
|
+
# @option params [required, String] :voice_connector_id
|
2113
|
+
#
|
2114
|
+
# @option params [required, Types::EmergencyCallingConfiguration] :emergency_calling_configuration
|
2115
|
+
#
|
2116
|
+
# @return [Types::PutVoiceConnectorEmergencyCallingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2117
|
+
#
|
2118
|
+
# * {Types::PutVoiceConnectorEmergencyCallingConfigurationResponse#emergency_calling_configuration #emergency_calling_configuration} => Types::EmergencyCallingConfiguration
|
2119
|
+
#
|
2120
|
+
# @example Request syntax with placeholder values
|
2121
|
+
#
|
2122
|
+
# resp = client.put_voice_connector_emergency_calling_configuration({
|
2123
|
+
# voice_connector_id: "NonEmptyString", # required
|
2124
|
+
# emergency_calling_configuration: { # required
|
2125
|
+
# dnis: [
|
2126
|
+
# {
|
2127
|
+
# emergency_phone_number: "E164PhoneNumber", # required
|
2128
|
+
# test_phone_number: "E164PhoneNumber",
|
2129
|
+
# calling_country: "Alpha2CountryCode", # required
|
2130
|
+
# },
|
2131
|
+
# ],
|
2132
|
+
# },
|
2133
|
+
# })
|
2134
|
+
#
|
2135
|
+
# @example Response structure
|
2136
|
+
#
|
2137
|
+
# resp.emergency_calling_configuration.dnis #=> Array
|
2138
|
+
# resp.emergency_calling_configuration.dnis[0].emergency_phone_number #=> String
|
2139
|
+
# resp.emergency_calling_configuration.dnis[0].test_phone_number #=> String
|
2140
|
+
# resp.emergency_calling_configuration.dnis[0].calling_country #=> String
|
2141
|
+
#
|
2142
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorEmergencyCallingConfiguration AWS API Documentation
|
2143
|
+
#
|
2144
|
+
# @overload put_voice_connector_emergency_calling_configuration(params = {})
|
2145
|
+
# @param [Hash] params ({})
|
2146
|
+
def put_voice_connector_emergency_calling_configuration(params = {}, options = {})
|
2147
|
+
req = build_request(:put_voice_connector_emergency_calling_configuration, params)
|
2148
|
+
req.send_request(options)
|
2149
|
+
end
|
2150
|
+
|
2151
|
+
# @option params [required, String] :voice_connector_id
|
2152
|
+
#
|
2153
|
+
# @option params [required, Types::LoggingConfiguration] :logging_configuration
|
2154
|
+
#
|
2155
|
+
# @return [Types::PutVoiceConnectorLoggingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2156
|
+
#
|
2157
|
+
# * {Types::PutVoiceConnectorLoggingConfigurationResponse#logging_configuration #logging_configuration} => Types::LoggingConfiguration
|
2158
|
+
#
|
2159
|
+
# @example Request syntax with placeholder values
|
2160
|
+
#
|
2161
|
+
# resp = client.put_voice_connector_logging_configuration({
|
2162
|
+
# voice_connector_id: "NonEmptyString", # required
|
2163
|
+
# logging_configuration: { # required
|
2164
|
+
# enable_sip_logs: false,
|
2165
|
+
# },
|
2166
|
+
# })
|
2167
|
+
#
|
2168
|
+
# @example Response structure
|
2169
|
+
#
|
2170
|
+
# resp.logging_configuration.enable_sip_logs #=> Boolean
|
2171
|
+
#
|
2172
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorLoggingConfiguration AWS API Documentation
|
2173
|
+
#
|
2174
|
+
# @overload put_voice_connector_logging_configuration(params = {})
|
2175
|
+
# @param [Hash] params ({})
|
2176
|
+
def put_voice_connector_logging_configuration(params = {}, options = {})
|
2177
|
+
req = build_request(:put_voice_connector_logging_configuration, params)
|
2178
|
+
req.send_request(options)
|
2179
|
+
end
|
2180
|
+
|
2181
|
+
# @option params [required, String] :voice_connector_id
|
2182
|
+
#
|
2183
|
+
# @option params [required, Types::Origination] :origination
|
2184
|
+
#
|
2185
|
+
# @return [Types::PutVoiceConnectorOriginationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2186
|
+
#
|
2187
|
+
# * {Types::PutVoiceConnectorOriginationResponse#origination #origination} => Types::Origination
|
2188
|
+
#
|
2189
|
+
# @example Request syntax with placeholder values
|
2190
|
+
#
|
2191
|
+
# resp = client.put_voice_connector_origination({
|
2192
|
+
# voice_connector_id: "NonEmptyString", # required
|
2193
|
+
# origination: { # required
|
2194
|
+
# routes: [
|
2195
|
+
# {
|
2196
|
+
# host: "String",
|
2197
|
+
# port: 1,
|
2198
|
+
# protocol: "TCP", # accepts TCP, UDP
|
2199
|
+
# priority: 1,
|
2200
|
+
# weight: 1,
|
2201
|
+
# },
|
2202
|
+
# ],
|
2203
|
+
# disabled: false,
|
2204
|
+
# },
|
2205
|
+
# })
|
2206
|
+
#
|
2207
|
+
# @example Response structure
|
2208
|
+
#
|
2209
|
+
# resp.origination.routes #=> Array
|
2210
|
+
# resp.origination.routes[0].host #=> String
|
2211
|
+
# resp.origination.routes[0].port #=> Integer
|
2212
|
+
# resp.origination.routes[0].protocol #=> String, one of "TCP", "UDP"
|
2213
|
+
# resp.origination.routes[0].priority #=> Integer
|
2214
|
+
# resp.origination.routes[0].weight #=> Integer
|
2215
|
+
# resp.origination.disabled #=> Boolean
|
2216
|
+
#
|
2217
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorOrigination AWS API Documentation
|
2218
|
+
#
|
2219
|
+
# @overload put_voice_connector_origination(params = {})
|
2220
|
+
# @param [Hash] params ({})
|
2221
|
+
def put_voice_connector_origination(params = {}, options = {})
|
2222
|
+
req = build_request(:put_voice_connector_origination, params)
|
2223
|
+
req.send_request(options)
|
2224
|
+
end
|
2225
|
+
|
2226
|
+
# @option params [required, String] :voice_connector_id
|
2227
|
+
#
|
2228
|
+
# @option params [required, Integer] :default_session_expiry_minutes
|
2229
|
+
#
|
2230
|
+
# @option params [required, Array<String>] :phone_number_pool_countries
|
2231
|
+
#
|
2232
|
+
# @option params [String] :fall_back_phone_number
|
2233
|
+
#
|
2234
|
+
# @option params [Boolean] :disabled
|
2235
|
+
#
|
2236
|
+
# @return [Types::PutVoiceConnectorProxyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2237
|
+
#
|
2238
|
+
# * {Types::PutVoiceConnectorProxyResponse#proxy #proxy} => Types::Proxy
|
2239
|
+
#
|
2240
|
+
# @example Request syntax with placeholder values
|
2241
|
+
#
|
2242
|
+
# resp = client.put_voice_connector_proxy({
|
2243
|
+
# voice_connector_id: "NonEmptyString128", # required
|
2244
|
+
# default_session_expiry_minutes: 1, # required
|
2245
|
+
# phone_number_pool_countries: ["Country"], # required
|
2246
|
+
# fall_back_phone_number: "E164PhoneNumber",
|
2247
|
+
# disabled: false,
|
2248
|
+
# })
|
2249
|
+
#
|
2250
|
+
# @example Response structure
|
2251
|
+
#
|
2252
|
+
# resp.proxy.default_session_expiry_minutes #=> Integer
|
2253
|
+
# resp.proxy.disabled #=> Boolean
|
2254
|
+
# resp.proxy.fall_back_phone_number #=> String
|
2255
|
+
# resp.proxy.phone_number_countries #=> Array
|
2256
|
+
# resp.proxy.phone_number_countries[0] #=> String
|
2257
|
+
#
|
2258
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorProxy AWS API Documentation
|
2259
|
+
#
|
2260
|
+
# @overload put_voice_connector_proxy(params = {})
|
2261
|
+
# @param [Hash] params ({})
|
2262
|
+
def put_voice_connector_proxy(params = {}, options = {})
|
2263
|
+
req = build_request(:put_voice_connector_proxy, params)
|
2264
|
+
req.send_request(options)
|
2265
|
+
end
|
2266
|
+
|
2267
|
+
# @option params [required, String] :voice_connector_id
|
2268
|
+
#
|
2269
|
+
# @option params [required, Types::StreamingConfiguration] :streaming_configuration
|
2270
|
+
#
|
2271
|
+
# @return [Types::PutVoiceConnectorStreamingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2272
|
+
#
|
2273
|
+
# * {Types::PutVoiceConnectorStreamingConfigurationResponse#streaming_configuration #streaming_configuration} => Types::StreamingConfiguration
|
2274
|
+
#
|
2275
|
+
# @example Request syntax with placeholder values
|
2276
|
+
#
|
2277
|
+
# resp = client.put_voice_connector_streaming_configuration({
|
2278
|
+
# voice_connector_id: "NonEmptyString", # required
|
2279
|
+
# streaming_configuration: { # required
|
2280
|
+
# data_retention_in_hours: 1, # required
|
2281
|
+
# disabled: false, # required
|
2282
|
+
# streaming_notification_targets: [
|
2283
|
+
# {
|
2284
|
+
# notification_target: "EventBridge", # accepts EventBridge, SNS, SQS
|
2285
|
+
# },
|
2286
|
+
# ],
|
2287
|
+
# },
|
2288
|
+
# })
|
2289
|
+
#
|
2290
|
+
# @example Response structure
|
2291
|
+
#
|
2292
|
+
# resp.streaming_configuration.data_retention_in_hours #=> Integer
|
2293
|
+
# resp.streaming_configuration.disabled #=> Boolean
|
2294
|
+
# resp.streaming_configuration.streaming_notification_targets #=> Array
|
2295
|
+
# resp.streaming_configuration.streaming_notification_targets[0].notification_target #=> String, one of "EventBridge", "SNS", "SQS"
|
2296
|
+
#
|
2297
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorStreamingConfiguration AWS API Documentation
|
2298
|
+
#
|
2299
|
+
# @overload put_voice_connector_streaming_configuration(params = {})
|
2300
|
+
# @param [Hash] params ({})
|
2301
|
+
def put_voice_connector_streaming_configuration(params = {}, options = {})
|
2302
|
+
req = build_request(:put_voice_connector_streaming_configuration, params)
|
2303
|
+
req.send_request(options)
|
2304
|
+
end
|
2305
|
+
|
2306
|
+
# @option params [required, String] :voice_connector_id
|
2307
|
+
#
|
2308
|
+
# @option params [required, Types::Termination] :termination
|
2309
|
+
#
|
2310
|
+
# @return [Types::PutVoiceConnectorTerminationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2311
|
+
#
|
2312
|
+
# * {Types::PutVoiceConnectorTerminationResponse#termination #termination} => Types::Termination
|
2313
|
+
#
|
2314
|
+
# @example Request syntax with placeholder values
|
2315
|
+
#
|
2316
|
+
# resp = client.put_voice_connector_termination({
|
2317
|
+
# voice_connector_id: "NonEmptyString", # required
|
2318
|
+
# termination: { # required
|
2319
|
+
# cps_limit: 1,
|
2320
|
+
# default_phone_number: "E164PhoneNumber",
|
2321
|
+
# calling_regions: ["CallingRegion"],
|
2322
|
+
# cidr_allowed_list: ["String"],
|
2323
|
+
# disabled: false,
|
2324
|
+
# },
|
2325
|
+
# })
|
2326
|
+
#
|
2327
|
+
# @example Response structure
|
2328
|
+
#
|
2329
|
+
# resp.termination.cps_limit #=> Integer
|
2330
|
+
# resp.termination.default_phone_number #=> String
|
2331
|
+
# resp.termination.calling_regions #=> Array
|
2332
|
+
# resp.termination.calling_regions[0] #=> String
|
2333
|
+
# resp.termination.cidr_allowed_list #=> Array
|
2334
|
+
# resp.termination.cidr_allowed_list[0] #=> String
|
2335
|
+
# resp.termination.disabled #=> Boolean
|
2336
|
+
#
|
2337
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorTermination AWS API Documentation
|
2338
|
+
#
|
2339
|
+
# @overload put_voice_connector_termination(params = {})
|
2340
|
+
# @param [Hash] params ({})
|
2341
|
+
def put_voice_connector_termination(params = {}, options = {})
|
2342
|
+
req = build_request(:put_voice_connector_termination, params)
|
2343
|
+
req.send_request(options)
|
2344
|
+
end
|
2345
|
+
|
2346
|
+
# @option params [required, String] :voice_connector_id
|
2347
|
+
#
|
2348
|
+
# @option params [Array<Types::Credential>] :credentials
|
2349
|
+
#
|
2350
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2351
|
+
#
|
2352
|
+
# @example Request syntax with placeholder values
|
2353
|
+
#
|
2354
|
+
# resp = client.put_voice_connector_termination_credentials({
|
2355
|
+
# voice_connector_id: "NonEmptyString", # required
|
2356
|
+
# credentials: [
|
2357
|
+
# {
|
2358
|
+
# username: "SensitiveString",
|
2359
|
+
# password: "SensitiveString",
|
2360
|
+
# },
|
2361
|
+
# ],
|
2362
|
+
# })
|
2363
|
+
#
|
2364
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/PutVoiceConnectorTerminationCredentials AWS API Documentation
|
2365
|
+
#
|
2366
|
+
# @overload put_voice_connector_termination_credentials(params = {})
|
2367
|
+
# @param [Hash] params ({})
|
2368
|
+
def put_voice_connector_termination_credentials(params = {}, options = {})
|
2369
|
+
req = build_request(:put_voice_connector_termination_credentials, params)
|
2370
|
+
req.send_request(options)
|
2371
|
+
end
|
2372
|
+
|
2373
|
+
# @option params [required, String] :phone_number_id
|
2374
|
+
#
|
2375
|
+
# @return [Types::RestorePhoneNumberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2376
|
+
#
|
2377
|
+
# * {Types::RestorePhoneNumberResponse#phone_number #phone_number} => Types::PhoneNumber
|
2378
|
+
#
|
2379
|
+
# @example Request syntax with placeholder values
|
2380
|
+
#
|
2381
|
+
# resp = client.restore_phone_number({
|
2382
|
+
# phone_number_id: "SensitiveNonEmptyString", # required
|
2383
|
+
# })
|
2384
|
+
#
|
2385
|
+
# @example Response structure
|
2386
|
+
#
|
2387
|
+
# resp.phone_number.phone_number_id #=> String
|
2388
|
+
# resp.phone_number.e164_phone_number #=> String
|
2389
|
+
# resp.phone_number.country #=> String
|
2390
|
+
# resp.phone_number.type #=> String, one of "Local", "TollFree"
|
2391
|
+
# resp.phone_number.product_type #=> String, one of "VoiceConnector", "SipMediaApplicationDialIn"
|
2392
|
+
# resp.phone_number.status #=> String, one of "Cancelled", "PortinCancelRequested", "PortinInProgress", "AcquireInProgress", "AcquireFailed", "Unassigned", "Assigned", "ReleaseInProgress", "DeleteInProgress", "ReleaseFailed", "DeleteFailed"
|
2393
|
+
# resp.phone_number.capabilities.inbound_call #=> Boolean
|
2394
|
+
# resp.phone_number.capabilities.outbound_call #=> Boolean
|
2395
|
+
# resp.phone_number.capabilities.inbound_sms #=> Boolean
|
2396
|
+
# resp.phone_number.capabilities.outbound_sms #=> Boolean
|
2397
|
+
# resp.phone_number.capabilities.inbound_mms #=> Boolean
|
2398
|
+
# resp.phone_number.capabilities.outbound_mms #=> Boolean
|
2399
|
+
# resp.phone_number.associations #=> Array
|
2400
|
+
# resp.phone_number.associations[0].value #=> String
|
2401
|
+
# resp.phone_number.associations[0].name #=> String, one of "VoiceConnectorId", "VoiceConnectorGroupId", "SipRuleId"
|
2402
|
+
# resp.phone_number.associations[0].associated_timestamp #=> Time
|
2403
|
+
# resp.phone_number.calling_name #=> String
|
2404
|
+
# resp.phone_number.calling_name_status #=> String, one of "Unassigned", "UpdateInProgress", "UpdateSucceeded", "UpdateFailed"
|
2405
|
+
# resp.phone_number.created_timestamp #=> Time
|
2406
|
+
# resp.phone_number.updated_timestamp #=> Time
|
2407
|
+
# resp.phone_number.deletion_timestamp #=> Time
|
2408
|
+
# resp.phone_number.order_id #=> String
|
2409
|
+
#
|
2410
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/RestorePhoneNumber AWS API Documentation
|
2411
|
+
#
|
2412
|
+
# @overload restore_phone_number(params = {})
|
2413
|
+
# @param [Hash] params ({})
|
2414
|
+
def restore_phone_number(params = {}, options = {})
|
2415
|
+
req = build_request(:restore_phone_number, params)
|
2416
|
+
req.send_request(options)
|
2417
|
+
end
|
2418
|
+
|
2419
|
+
# @option params [String] :area_code
|
2420
|
+
#
|
2421
|
+
# @option params [String] :city
|
2422
|
+
#
|
2423
|
+
# @option params [String] :country
|
2424
|
+
#
|
2425
|
+
# @option params [String] :state
|
2426
|
+
#
|
2427
|
+
# @option params [String] :toll_free_prefix
|
2428
|
+
#
|
2429
|
+
# @option params [String] :phone_number_type
|
2430
|
+
#
|
2431
|
+
# @option params [Integer] :max_results
|
2432
|
+
#
|
2433
|
+
# @option params [String] :next_token
|
2434
|
+
#
|
2435
|
+
# @return [Types::SearchAvailablePhoneNumbersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2436
|
+
#
|
2437
|
+
# * {Types::SearchAvailablePhoneNumbersResponse#e164_phone_numbers #e164_phone_numbers} => Array<String>
|
2438
|
+
# * {Types::SearchAvailablePhoneNumbersResponse#next_token #next_token} => String
|
2439
|
+
#
|
2440
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2441
|
+
#
|
2442
|
+
# @example Request syntax with placeholder values
|
2443
|
+
#
|
2444
|
+
# resp = client.search_available_phone_numbers({
|
2445
|
+
# area_code: "String",
|
2446
|
+
# city: "String",
|
2447
|
+
# country: "Alpha2CountryCode",
|
2448
|
+
# state: "String",
|
2449
|
+
# toll_free_prefix: "TollFreePrefix",
|
2450
|
+
# phone_number_type: "Local", # accepts Local, TollFree
|
2451
|
+
# max_results: 1,
|
2452
|
+
# next_token: "String",
|
2453
|
+
# })
|
2454
|
+
#
|
2455
|
+
# @example Response structure
|
2456
|
+
#
|
2457
|
+
# resp.e164_phone_numbers #=> Array
|
2458
|
+
# resp.e164_phone_numbers[0] #=> String
|
2459
|
+
# resp.next_token #=> String
|
2460
|
+
#
|
2461
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/SearchAvailablePhoneNumbers AWS API Documentation
|
2462
|
+
#
|
2463
|
+
# @overload search_available_phone_numbers(params = {})
|
2464
|
+
# @param [Hash] params ({})
|
2465
|
+
def search_available_phone_numbers(params = {}, options = {})
|
2466
|
+
req = build_request(:search_available_phone_numbers, params)
|
2467
|
+
req.send_request(options)
|
2468
|
+
end
|
2469
|
+
|
2470
|
+
# @option params [Types::VoiceConnectorSettings] :voice_connector
|
2471
|
+
#
|
2472
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2473
|
+
#
|
2474
|
+
# @example Request syntax with placeholder values
|
2475
|
+
#
|
2476
|
+
# resp = client.update_global_settings({
|
2477
|
+
# voice_connector: {
|
2478
|
+
# cdr_bucket: "String",
|
2479
|
+
# },
|
2480
|
+
# })
|
2481
|
+
#
|
2482
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateGlobalSettings AWS API Documentation
|
2483
|
+
#
|
2484
|
+
# @overload update_global_settings(params = {})
|
2485
|
+
# @param [Hash] params ({})
|
2486
|
+
def update_global_settings(params = {}, options = {})
|
2487
|
+
req = build_request(:update_global_settings, params)
|
2488
|
+
req.send_request(options)
|
2489
|
+
end
|
2490
|
+
|
2491
|
+
# @option params [required, String] :phone_number_id
|
2492
|
+
#
|
2493
|
+
# @option params [String] :product_type
|
2494
|
+
#
|
2495
|
+
# @option params [String] :calling_name
|
2496
|
+
#
|
2497
|
+
# @return [Types::UpdatePhoneNumberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2498
|
+
#
|
2499
|
+
# * {Types::UpdatePhoneNumberResponse#phone_number #phone_number} => Types::PhoneNumber
|
2500
|
+
#
|
2501
|
+
# @example Request syntax with placeholder values
|
2502
|
+
#
|
2503
|
+
# resp = client.update_phone_number({
|
2504
|
+
# phone_number_id: "SensitiveNonEmptyString", # required
|
2505
|
+
# product_type: "VoiceConnector", # accepts VoiceConnector, SipMediaApplicationDialIn
|
2506
|
+
# calling_name: "CallingName",
|
2507
|
+
# })
|
2508
|
+
#
|
2509
|
+
# @example Response structure
|
2510
|
+
#
|
2511
|
+
# resp.phone_number.phone_number_id #=> String
|
2512
|
+
# resp.phone_number.e164_phone_number #=> String
|
2513
|
+
# resp.phone_number.country #=> String
|
2514
|
+
# resp.phone_number.type #=> String, one of "Local", "TollFree"
|
2515
|
+
# resp.phone_number.product_type #=> String, one of "VoiceConnector", "SipMediaApplicationDialIn"
|
2516
|
+
# resp.phone_number.status #=> String, one of "Cancelled", "PortinCancelRequested", "PortinInProgress", "AcquireInProgress", "AcquireFailed", "Unassigned", "Assigned", "ReleaseInProgress", "DeleteInProgress", "ReleaseFailed", "DeleteFailed"
|
2517
|
+
# resp.phone_number.capabilities.inbound_call #=> Boolean
|
2518
|
+
# resp.phone_number.capabilities.outbound_call #=> Boolean
|
2519
|
+
# resp.phone_number.capabilities.inbound_sms #=> Boolean
|
2520
|
+
# resp.phone_number.capabilities.outbound_sms #=> Boolean
|
2521
|
+
# resp.phone_number.capabilities.inbound_mms #=> Boolean
|
2522
|
+
# resp.phone_number.capabilities.outbound_mms #=> Boolean
|
2523
|
+
# resp.phone_number.associations #=> Array
|
2524
|
+
# resp.phone_number.associations[0].value #=> String
|
2525
|
+
# resp.phone_number.associations[0].name #=> String, one of "VoiceConnectorId", "VoiceConnectorGroupId", "SipRuleId"
|
2526
|
+
# resp.phone_number.associations[0].associated_timestamp #=> Time
|
2527
|
+
# resp.phone_number.calling_name #=> String
|
2528
|
+
# resp.phone_number.calling_name_status #=> String, one of "Unassigned", "UpdateInProgress", "UpdateSucceeded", "UpdateFailed"
|
2529
|
+
# resp.phone_number.created_timestamp #=> Time
|
2530
|
+
# resp.phone_number.updated_timestamp #=> Time
|
2531
|
+
# resp.phone_number.deletion_timestamp #=> Time
|
2532
|
+
# resp.phone_number.order_id #=> String
|
2533
|
+
#
|
2534
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdatePhoneNumber AWS API Documentation
|
2535
|
+
#
|
2536
|
+
# @overload update_phone_number(params = {})
|
2537
|
+
# @param [Hash] params ({})
|
2538
|
+
def update_phone_number(params = {}, options = {})
|
2539
|
+
req = build_request(:update_phone_number, params)
|
2540
|
+
req.send_request(options)
|
2541
|
+
end
|
2542
|
+
|
2543
|
+
# @option params [required, String] :calling_name
|
2544
|
+
#
|
2545
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2546
|
+
#
|
2547
|
+
# @example Request syntax with placeholder values
|
2548
|
+
#
|
2549
|
+
# resp = client.update_phone_number_settings({
|
2550
|
+
# calling_name: "CallingName", # required
|
2551
|
+
# })
|
2552
|
+
#
|
2553
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdatePhoneNumberSettings AWS API Documentation
|
2554
|
+
#
|
2555
|
+
# @overload update_phone_number_settings(params = {})
|
2556
|
+
# @param [Hash] params ({})
|
2557
|
+
def update_phone_number_settings(params = {}, options = {})
|
2558
|
+
req = build_request(:update_phone_number_settings, params)
|
2559
|
+
req.send_request(options)
|
2560
|
+
end
|
2561
|
+
|
2562
|
+
# @option params [required, String] :voice_connector_id
|
2563
|
+
#
|
2564
|
+
# @option params [required, String] :proxy_session_id
|
2565
|
+
#
|
2566
|
+
# @option params [required, Array<String>] :capabilities
|
2567
|
+
#
|
2568
|
+
# @option params [Integer] :expiry_minutes
|
2569
|
+
#
|
2570
|
+
# @return [Types::UpdateProxySessionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2571
|
+
#
|
2572
|
+
# * {Types::UpdateProxySessionResponse#proxy_session #proxy_session} => Types::ProxySession
|
2573
|
+
#
|
2574
|
+
# @example Request syntax with placeholder values
|
2575
|
+
#
|
2576
|
+
# resp = client.update_proxy_session({
|
2577
|
+
# voice_connector_id: "NonEmptyString128", # required
|
2578
|
+
# proxy_session_id: "NonEmptyString128", # required
|
2579
|
+
# capabilities: ["Voice"], # required, accepts Voice, SMS
|
2580
|
+
# expiry_minutes: 1,
|
2581
|
+
# })
|
2582
|
+
#
|
2583
|
+
# @example Response structure
|
2584
|
+
#
|
2585
|
+
# resp.proxy_session.voice_connector_id #=> String
|
2586
|
+
# resp.proxy_session.proxy_session_id #=> String
|
2587
|
+
# resp.proxy_session.name #=> String
|
2588
|
+
# resp.proxy_session.status #=> String, one of "Open", "InProgress", "Closed"
|
2589
|
+
# resp.proxy_session.expiry_minutes #=> Integer
|
2590
|
+
# resp.proxy_session.capabilities #=> Array
|
2591
|
+
# resp.proxy_session.capabilities[0] #=> String, one of "Voice", "SMS"
|
2592
|
+
# resp.proxy_session.created_timestamp #=> Time
|
2593
|
+
# resp.proxy_session.updated_timestamp #=> Time
|
2594
|
+
# resp.proxy_session.ended_timestamp #=> Time
|
2595
|
+
# resp.proxy_session.participants #=> Array
|
2596
|
+
# resp.proxy_session.participants[0].phone_number #=> String
|
2597
|
+
# resp.proxy_session.participants[0].proxy_phone_number #=> String
|
2598
|
+
# resp.proxy_session.number_selection_behavior #=> String, one of "PreferSticky", "AvoidSticky"
|
2599
|
+
# resp.proxy_session.geo_match_level #=> String, one of "Country", "AreaCode"
|
2600
|
+
# resp.proxy_session.geo_match_params.country #=> String
|
2601
|
+
# resp.proxy_session.geo_match_params.area_code #=> String
|
2602
|
+
#
|
2603
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateProxySession AWS API Documentation
|
2604
|
+
#
|
2605
|
+
# @overload update_proxy_session(params = {})
|
2606
|
+
# @param [Hash] params ({})
|
2607
|
+
def update_proxy_session(params = {}, options = {})
|
2608
|
+
req = build_request(:update_proxy_session, params)
|
2609
|
+
req.send_request(options)
|
2610
|
+
end
|
2611
|
+
|
2612
|
+
# @option params [required, String] :sip_media_application_id
|
2613
|
+
#
|
2614
|
+
# @option params [String] :name
|
2615
|
+
#
|
2616
|
+
# @option params [Array<Types::SipMediaApplicationEndpoint>] :endpoints
|
2617
|
+
#
|
2618
|
+
# @return [Types::UpdateSipMediaApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2619
|
+
#
|
2620
|
+
# * {Types::UpdateSipMediaApplicationResponse#sip_media_application #sip_media_application} => Types::SipMediaApplication
|
2621
|
+
#
|
2622
|
+
# @example Request syntax with placeholder values
|
2623
|
+
#
|
2624
|
+
# resp = client.update_sip_media_application({
|
2625
|
+
# sip_media_application_id: "NonEmptyString", # required
|
2626
|
+
# name: "SipMediaApplicationName",
|
2627
|
+
# endpoints: [
|
2628
|
+
# {
|
2629
|
+
# lambda_arn: "FunctionArn",
|
2630
|
+
# },
|
2631
|
+
# ],
|
2632
|
+
# })
|
2633
|
+
#
|
2634
|
+
# @example Response structure
|
2635
|
+
#
|
2636
|
+
# resp.sip_media_application.sip_media_application_id #=> String
|
2637
|
+
# resp.sip_media_application.aws_region #=> String
|
2638
|
+
# resp.sip_media_application.name #=> String
|
2639
|
+
# resp.sip_media_application.endpoints #=> Array
|
2640
|
+
# resp.sip_media_application.endpoints[0].lambda_arn #=> String
|
2641
|
+
# resp.sip_media_application.created_timestamp #=> Time
|
2642
|
+
# resp.sip_media_application.updated_timestamp #=> Time
|
2643
|
+
#
|
2644
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateSipMediaApplication AWS API Documentation
|
2645
|
+
#
|
2646
|
+
# @overload update_sip_media_application(params = {})
|
2647
|
+
# @param [Hash] params ({})
|
2648
|
+
def update_sip_media_application(params = {}, options = {})
|
2649
|
+
req = build_request(:update_sip_media_application, params)
|
2650
|
+
req.send_request(options)
|
2651
|
+
end
|
2652
|
+
|
2653
|
+
# @option params [required, String] :sip_media_application_id
|
2654
|
+
#
|
2655
|
+
# @option params [required, String] :transaction_id
|
2656
|
+
#
|
2657
|
+
# @option params [required, Hash<String,String>] :arguments
|
2658
|
+
#
|
2659
|
+
# @return [Types::UpdateSipMediaApplicationCallResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2660
|
+
#
|
2661
|
+
# * {Types::UpdateSipMediaApplicationCallResponse#sip_media_application_call #sip_media_application_call} => Types::SipMediaApplicationCall
|
2662
|
+
#
|
2663
|
+
# @example Request syntax with placeholder values
|
2664
|
+
#
|
2665
|
+
# resp = client.update_sip_media_application_call({
|
2666
|
+
# sip_media_application_id: "NonEmptyString", # required
|
2667
|
+
# transaction_id: "NonEmptyString", # required
|
2668
|
+
# arguments: { # required
|
2669
|
+
# "SensitiveString" => "SensitiveString",
|
2670
|
+
# },
|
2671
|
+
# })
|
2672
|
+
#
|
2673
|
+
# @example Response structure
|
2674
|
+
#
|
2675
|
+
# resp.sip_media_application_call.transaction_id #=> String
|
2676
|
+
#
|
2677
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateSipMediaApplicationCall AWS API Documentation
|
2678
|
+
#
|
2679
|
+
# @overload update_sip_media_application_call(params = {})
|
2680
|
+
# @param [Hash] params ({})
|
2681
|
+
def update_sip_media_application_call(params = {}, options = {})
|
2682
|
+
req = build_request(:update_sip_media_application_call, params)
|
2683
|
+
req.send_request(options)
|
2684
|
+
end
|
2685
|
+
|
2686
|
+
# @option params [required, String] :sip_rule_id
|
2687
|
+
#
|
2688
|
+
# @option params [required, String] :name
|
2689
|
+
#
|
2690
|
+
# @option params [Boolean] :disabled
|
2691
|
+
#
|
2692
|
+
# @option params [Array<Types::SipRuleTargetApplication>] :target_applications
|
2693
|
+
#
|
2694
|
+
# @return [Types::UpdateSipRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2695
|
+
#
|
2696
|
+
# * {Types::UpdateSipRuleResponse#sip_rule #sip_rule} => Types::SipRule
|
2697
|
+
#
|
2698
|
+
# @example Request syntax with placeholder values
|
2699
|
+
#
|
2700
|
+
# resp = client.update_sip_rule({
|
2701
|
+
# sip_rule_id: "NonEmptyString", # required
|
2702
|
+
# name: "SipRuleName", # required
|
2703
|
+
# disabled: false,
|
2704
|
+
# target_applications: [
|
2705
|
+
# {
|
2706
|
+
# sip_media_application_id: "NonEmptyString",
|
2707
|
+
# priority: 1,
|
2708
|
+
# aws_region: "String",
|
2709
|
+
# },
|
2710
|
+
# ],
|
2711
|
+
# })
|
2712
|
+
#
|
2713
|
+
# @example Response structure
|
2714
|
+
#
|
2715
|
+
# resp.sip_rule.sip_rule_id #=> String
|
2716
|
+
# resp.sip_rule.name #=> String
|
2717
|
+
# resp.sip_rule.disabled #=> Boolean
|
2718
|
+
# resp.sip_rule.trigger_type #=> String, one of "ToPhoneNumber", "RequestUriHostname"
|
2719
|
+
# resp.sip_rule.trigger_value #=> String
|
2720
|
+
# resp.sip_rule.target_applications #=> Array
|
2721
|
+
# resp.sip_rule.target_applications[0].sip_media_application_id #=> String
|
2722
|
+
# resp.sip_rule.target_applications[0].priority #=> Integer
|
2723
|
+
# resp.sip_rule.target_applications[0].aws_region #=> String
|
2724
|
+
# resp.sip_rule.created_timestamp #=> Time
|
2725
|
+
# resp.sip_rule.updated_timestamp #=> Time
|
2726
|
+
#
|
2727
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateSipRule AWS API Documentation
|
2728
|
+
#
|
2729
|
+
# @overload update_sip_rule(params = {})
|
2730
|
+
# @param [Hash] params ({})
|
2731
|
+
def update_sip_rule(params = {}, options = {})
|
2732
|
+
req = build_request(:update_sip_rule, params)
|
2733
|
+
req.send_request(options)
|
2734
|
+
end
|
2735
|
+
|
2736
|
+
# @option params [required, String] :voice_connector_id
|
2737
|
+
#
|
2738
|
+
# @option params [required, String] :name
|
2739
|
+
#
|
2740
|
+
# @option params [required, Boolean] :require_encryption
|
2741
|
+
#
|
2742
|
+
# @return [Types::UpdateVoiceConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2743
|
+
#
|
2744
|
+
# * {Types::UpdateVoiceConnectorResponse#voice_connector #voice_connector} => Types::VoiceConnector
|
2745
|
+
#
|
2746
|
+
# @example Request syntax with placeholder values
|
2747
|
+
#
|
2748
|
+
# resp = client.update_voice_connector({
|
2749
|
+
# voice_connector_id: "NonEmptyString", # required
|
2750
|
+
# name: "VoiceConnectorName", # required
|
2751
|
+
# require_encryption: false, # required
|
2752
|
+
# })
|
2753
|
+
#
|
2754
|
+
# @example Response structure
|
2755
|
+
#
|
2756
|
+
# resp.voice_connector.voice_connector_id #=> String
|
2757
|
+
# resp.voice_connector.aws_region #=> String, one of "us-east-1", "us-west-2", "ca-central-1", "eu-central-1", "eu-west-1", "eu-west-2", "ap-northeast-2", "ap-northeast-1", "ap-southeast-1", "ap-southeast-2"
|
2758
|
+
# resp.voice_connector.name #=> String
|
2759
|
+
# resp.voice_connector.outbound_host_name #=> String
|
2760
|
+
# resp.voice_connector.require_encryption #=> Boolean
|
2761
|
+
# resp.voice_connector.created_timestamp #=> Time
|
2762
|
+
# resp.voice_connector.updated_timestamp #=> Time
|
2763
|
+
# resp.voice_connector.voice_connector_arn #=> String
|
2764
|
+
#
|
2765
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateVoiceConnector AWS API Documentation
|
2766
|
+
#
|
2767
|
+
# @overload update_voice_connector(params = {})
|
2768
|
+
# @param [Hash] params ({})
|
2769
|
+
def update_voice_connector(params = {}, options = {})
|
2770
|
+
req = build_request(:update_voice_connector, params)
|
2771
|
+
req.send_request(options)
|
2772
|
+
end
|
2773
|
+
|
2774
|
+
# @option params [required, String] :voice_connector_group_id
|
2775
|
+
#
|
2776
|
+
# @option params [required, String] :name
|
2777
|
+
#
|
2778
|
+
# @option params [required, Array<Types::VoiceConnectorItem>] :voice_connector_items
|
2779
|
+
#
|
2780
|
+
# @return [Types::UpdateVoiceConnectorGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2781
|
+
#
|
2782
|
+
# * {Types::UpdateVoiceConnectorGroupResponse#voice_connector_group #voice_connector_group} => Types::VoiceConnectorGroup
|
2783
|
+
#
|
2784
|
+
# @example Request syntax with placeholder values
|
2785
|
+
#
|
2786
|
+
# resp = client.update_voice_connector_group({
|
2787
|
+
# voice_connector_group_id: "NonEmptyString", # required
|
2788
|
+
# name: "VoiceConnectorGroupName", # required
|
2789
|
+
# voice_connector_items: [ # required
|
2790
|
+
# {
|
2791
|
+
# voice_connector_id: "NonEmptyString", # required
|
2792
|
+
# priority: 1, # required
|
2793
|
+
# },
|
2794
|
+
# ],
|
2795
|
+
# })
|
2796
|
+
#
|
2797
|
+
# @example Response structure
|
2798
|
+
#
|
2799
|
+
# resp.voice_connector_group.voice_connector_group_id #=> String
|
2800
|
+
# resp.voice_connector_group.name #=> String
|
2801
|
+
# resp.voice_connector_group.voice_connector_items #=> Array
|
2802
|
+
# resp.voice_connector_group.voice_connector_items[0].voice_connector_id #=> String
|
2803
|
+
# resp.voice_connector_group.voice_connector_items[0].priority #=> Integer
|
2804
|
+
# resp.voice_connector_group.created_timestamp #=> Time
|
2805
|
+
# resp.voice_connector_group.updated_timestamp #=> Time
|
2806
|
+
# resp.voice_connector_group.voice_connector_group_arn #=> String
|
2807
|
+
#
|
2808
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/UpdateVoiceConnectorGroup AWS API Documentation
|
2809
|
+
#
|
2810
|
+
# @overload update_voice_connector_group(params = {})
|
2811
|
+
# @param [Hash] params ({})
|
2812
|
+
def update_voice_connector_group(params = {}, options = {})
|
2813
|
+
req = build_request(:update_voice_connector_group, params)
|
2814
|
+
req.send_request(options)
|
2815
|
+
end
|
2816
|
+
|
2817
|
+
# @option params [required, String] :aws_account_id
|
2818
|
+
#
|
2819
|
+
# @option params [required, String] :street_number
|
2820
|
+
#
|
2821
|
+
# @option params [required, String] :street_info
|
2822
|
+
#
|
2823
|
+
# @option params [required, String] :city
|
2824
|
+
#
|
2825
|
+
# @option params [required, String] :state
|
2826
|
+
#
|
2827
|
+
# @option params [required, String] :country
|
2828
|
+
#
|
2829
|
+
# @option params [required, String] :postal_code
|
2830
|
+
#
|
2831
|
+
# @return [Types::ValidateE911AddressResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2832
|
+
#
|
2833
|
+
# * {Types::ValidateE911AddressResponse#validation_result #validation_result} => Integer
|
2834
|
+
# * {Types::ValidateE911AddressResponse#address_external_id #address_external_id} => String
|
2835
|
+
# * {Types::ValidateE911AddressResponse#address #address} => Types::Address
|
2836
|
+
# * {Types::ValidateE911AddressResponse#candidate_address_list #candidate_address_list} => Array<Types::CandidateAddress>
|
2837
|
+
#
|
2838
|
+
# @example Request syntax with placeholder values
|
2839
|
+
#
|
2840
|
+
# resp = client.validate_e911_address({
|
2841
|
+
# aws_account_id: "NonEmptyString", # required
|
2842
|
+
# street_number: "SensitiveNonEmptyString", # required
|
2843
|
+
# street_info: "SensitiveNonEmptyString", # required
|
2844
|
+
# city: "SensitiveNonEmptyString", # required
|
2845
|
+
# state: "SensitiveNonEmptyString", # required
|
2846
|
+
# country: "SensitiveNonEmptyString", # required
|
2847
|
+
# postal_code: "SensitiveNonEmptyString", # required
|
2848
|
+
# })
|
2849
|
+
#
|
2850
|
+
# @example Response structure
|
2851
|
+
#
|
2852
|
+
# resp.validation_result #=> Integer
|
2853
|
+
# resp.address_external_id #=> String
|
2854
|
+
# resp.address.street_name #=> String
|
2855
|
+
# resp.address.street_suffix #=> String
|
2856
|
+
# resp.address.post_directional #=> String
|
2857
|
+
# resp.address.pre_directional #=> String
|
2858
|
+
# resp.address.street_number #=> String
|
2859
|
+
# resp.address.city #=> String
|
2860
|
+
# resp.address.state #=> String
|
2861
|
+
# resp.address.postal_code #=> String
|
2862
|
+
# resp.address.postal_code_plus_4 #=> String
|
2863
|
+
# resp.address.country #=> String
|
2864
|
+
# resp.candidate_address_list #=> Array
|
2865
|
+
# resp.candidate_address_list[0].street_info #=> String
|
2866
|
+
# resp.candidate_address_list[0].street_number #=> String
|
2867
|
+
# resp.candidate_address_list[0].city #=> String
|
2868
|
+
# resp.candidate_address_list[0].state #=> String
|
2869
|
+
# resp.candidate_address_list[0].postal_code #=> String
|
2870
|
+
# resp.candidate_address_list[0].postal_code_plus_4 #=> String
|
2871
|
+
# resp.candidate_address_list[0].country #=> String
|
2872
|
+
#
|
2873
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/ValidateE911Address AWS API Documentation
|
2874
|
+
#
|
2875
|
+
# @overload validate_e911_address(params = {})
|
2876
|
+
# @param [Hash] params ({})
|
2877
|
+
def validate_e911_address(params = {}, options = {})
|
2878
|
+
req = build_request(:validate_e911_address, params)
|
2879
|
+
req.send_request(options)
|
2880
|
+
end
|
2881
|
+
|
2882
|
+
# @!endgroup
|
2883
|
+
|
2884
|
+
# @param params ({})
|
2885
|
+
# @api private
|
2886
|
+
def build_request(operation_name, params = {})
|
2887
|
+
handlers = @handlers.for(operation_name)
|
2888
|
+
context = Seahorse::Client::RequestContext.new(
|
2889
|
+
operation_name: operation_name,
|
2890
|
+
operation: config.api.operation(operation_name),
|
2891
|
+
client: self,
|
2892
|
+
params: params,
|
2893
|
+
config: config)
|
2894
|
+
context[:gem_name] = 'aws-sdk-chimesdkvoice'
|
2895
|
+
context[:gem_version] = '1.0.0'
|
2896
|
+
Seahorse::Client::Request.new(handlers, context)
|
2897
|
+
end
|
2898
|
+
|
2899
|
+
# @api private
|
2900
|
+
# @deprecated
|
2901
|
+
def waiter_names
|
2902
|
+
[]
|
2903
|
+
end
|
2904
|
+
|
2905
|
+
class << self
|
2906
|
+
|
2907
|
+
# @api private
|
2908
|
+
attr_reader :identifier
|
2909
|
+
|
2910
|
+
# @api private
|
2911
|
+
def errors_module
|
2912
|
+
Errors
|
2913
|
+
end
|
2914
|
+
|
2915
|
+
end
|
2916
|
+
end
|
2917
|
+
end
|