aws-sdk-connectcontactlens 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/lib/aws-sdk-connectcontactlens.rb +53 -0
- data/lib/aws-sdk-connectcontactlens/client.rb +427 -0
- data/lib/aws-sdk-connectcontactlens/client_api.rb +157 -0
- data/lib/aws-sdk-connectcontactlens/customizations.rb +0 -0
- data/lib/aws-sdk-connectcontactlens/errors.rb +118 -0
- data/lib/aws-sdk-connectcontactlens/resource.rb +26 -0
- data/lib/aws-sdk-connectcontactlens/types.rb +307 -0
- metadata +88 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: bcc43c02f0a35d90be10f618d968bc65911948fb72fd6bfe69c871cfeb28b206
|
4
|
+
data.tar.gz: 98fa713270435c6e3bd8218bf09d2ffecad29b6074896bbfa30014f47c89b7cb
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: de9244705481d8c318d34cb63855ed85979671632b12c55c8806232ae592cdb86479ee1ca61e1e9a95c67fd62bcd9e9c950a9f5cd4b70aa5a8f97ff6046c2def
|
7
|
+
data.tar.gz: f2ab5de95dfac0524382853aa39e86761fb4fe1013a2e3475a27f4bfa8eb34fdacc2a88377b5c304ce8a36950e60c2efd255f1b4281b21582ac24774059ffc83
|
@@ -0,0 +1,53 @@
|
|
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/master/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
|
11
|
+
require 'aws-sdk-core'
|
12
|
+
require 'aws-sigv4'
|
13
|
+
|
14
|
+
require_relative 'aws-sdk-connectcontactlens/types'
|
15
|
+
require_relative 'aws-sdk-connectcontactlens/client_api'
|
16
|
+
require_relative 'aws-sdk-connectcontactlens/client'
|
17
|
+
require_relative 'aws-sdk-connectcontactlens/errors'
|
18
|
+
require_relative 'aws-sdk-connectcontactlens/resource'
|
19
|
+
require_relative 'aws-sdk-connectcontactlens/customizations'
|
20
|
+
|
21
|
+
# This module provides support for Amazon Connect Contact Lens. This module is available in the
|
22
|
+
# `aws-sdk-connectcontactlens` gem.
|
23
|
+
#
|
24
|
+
# # Client
|
25
|
+
#
|
26
|
+
# The {Client} class provides one method for each API operation. Operation
|
27
|
+
# methods each accept a hash of request parameters and return a response
|
28
|
+
# structure.
|
29
|
+
#
|
30
|
+
# connect_contact_lens = Aws::ConnectContactLens::Client.new
|
31
|
+
# resp = connect_contact_lens.list_realtime_contact_analysis_segments(params)
|
32
|
+
#
|
33
|
+
# See {Client} for more information.
|
34
|
+
#
|
35
|
+
# # Errors
|
36
|
+
#
|
37
|
+
# Errors returned from Amazon Connect Contact Lens are defined in the
|
38
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
39
|
+
#
|
40
|
+
# begin
|
41
|
+
# # do stuff
|
42
|
+
# rescue Aws::ConnectContactLens::Errors::ServiceError
|
43
|
+
# # rescues all Amazon Connect Contact Lens API errors
|
44
|
+
# end
|
45
|
+
#
|
46
|
+
# See {Errors} for more information.
|
47
|
+
#
|
48
|
+
# @!group service
|
49
|
+
module Aws::ConnectContactLens
|
50
|
+
|
51
|
+
GEM_VERSION = '1.0.0'
|
52
|
+
|
53
|
+
end
|
@@ -0,0 +1,427 @@
|
|
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/master/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/signature_v4.rb'
|
31
|
+
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
32
|
+
|
33
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:connectcontactlens)
|
34
|
+
|
35
|
+
module Aws::ConnectContactLens
|
36
|
+
# An API client for ConnectContactLens. To construct a client, you need to configure a `:region` and `:credentials`.
|
37
|
+
#
|
38
|
+
# client = Aws::ConnectContactLens::Client.new(
|
39
|
+
# region: region_name,
|
40
|
+
# credentials: credentials,
|
41
|
+
# # ...
|
42
|
+
# )
|
43
|
+
#
|
44
|
+
# For details on configuring region and credentials see
|
45
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
46
|
+
#
|
47
|
+
# See {#initialize} for a full list of supported configuration options.
|
48
|
+
class Client < Seahorse::Client::Base
|
49
|
+
|
50
|
+
include Aws::ClientStubs
|
51
|
+
|
52
|
+
@identifier = :connectcontactlens
|
53
|
+
|
54
|
+
set_api(ClientApi::API)
|
55
|
+
|
56
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
57
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
58
|
+
add_plugin(Aws::Plugins::Logging)
|
59
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
60
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
61
|
+
add_plugin(Aws::Plugins::UserAgent)
|
62
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
63
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
64
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
65
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
66
|
+
add_plugin(Aws::Plugins::EndpointDiscovery)
|
67
|
+
add_plugin(Aws::Plugins::EndpointPattern)
|
68
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
69
|
+
add_plugin(Aws::Plugins::StubResponses)
|
70
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
71
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
72
|
+
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
73
|
+
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
74
|
+
add_plugin(Aws::Plugins::TransferEncoding)
|
75
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
76
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
77
|
+
add_plugin(Aws::Plugins::Protocols::RestJson)
|
78
|
+
|
79
|
+
# @overload initialize(options)
|
80
|
+
# @param [Hash] options
|
81
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
82
|
+
# Your AWS credentials. This can be an instance of any one of the
|
83
|
+
# following classes:
|
84
|
+
#
|
85
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
86
|
+
# credentials.
|
87
|
+
#
|
88
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
89
|
+
# shared file, such as `~/.aws/config`.
|
90
|
+
#
|
91
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
92
|
+
#
|
93
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
94
|
+
# assume a role after providing credentials via the web.
|
95
|
+
#
|
96
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
97
|
+
# access token generated from `aws login`.
|
98
|
+
#
|
99
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
100
|
+
# process that outputs to stdout.
|
101
|
+
#
|
102
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
103
|
+
# from an EC2 IMDS on an EC2 instance.
|
104
|
+
#
|
105
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
106
|
+
# instances running in ECS.
|
107
|
+
#
|
108
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
109
|
+
# from the Cognito Identity service.
|
110
|
+
#
|
111
|
+
# When `:credentials` are not configured directly, the following
|
112
|
+
# locations will be searched for credentials:
|
113
|
+
#
|
114
|
+
# * `Aws.config[:credentials]`
|
115
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
116
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
117
|
+
# * `~/.aws/credentials`
|
118
|
+
# * `~/.aws/config`
|
119
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
|
+
# are very aggressive. Construct and pass an instance of
|
121
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
+
# enable retries and extended timeouts.
|
123
|
+
#
|
124
|
+
# @option options [required, String] :region
|
125
|
+
# The AWS region to connect to. The configured `:region` is
|
126
|
+
# used to determine the service `:endpoint`. When not passed,
|
127
|
+
# a default `:region` is searched for in the following locations:
|
128
|
+
#
|
129
|
+
# * `Aws.config[:region]`
|
130
|
+
# * `ENV['AWS_REGION']`
|
131
|
+
# * `ENV['AMAZON_REGION']`
|
132
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
133
|
+
# * `~/.aws/credentials`
|
134
|
+
# * `~/.aws/config`
|
135
|
+
#
|
136
|
+
# @option options [String] :access_key_id
|
137
|
+
#
|
138
|
+
# @option options [Boolean] :active_endpoint_cache (false)
|
139
|
+
# When set to `true`, a thread polling for endpoints will be running in
|
140
|
+
# the background every 60 secs (default). Defaults to `false`.
|
141
|
+
#
|
142
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
143
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
144
|
+
# until there is sufficent client side capacity to retry the request.
|
145
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
146
|
+
# not retry instead of sleeping.
|
147
|
+
#
|
148
|
+
# @option options [Boolean] :client_side_monitoring (false)
|
149
|
+
# When `true`, client-side metrics will be collected for all API requests from
|
150
|
+
# this client.
|
151
|
+
#
|
152
|
+
# @option options [String] :client_side_monitoring_client_id ("")
|
153
|
+
# Allows you to provide an identifier for this client which will be attached to
|
154
|
+
# all generated client side metrics. Defaults to an empty string.
|
155
|
+
#
|
156
|
+
# @option options [String] :client_side_monitoring_host ("127.0.0.1")
|
157
|
+
# Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
|
158
|
+
# side monitoring agent is running on, where client metrics will be published via UDP.
|
159
|
+
#
|
160
|
+
# @option options [Integer] :client_side_monitoring_port (31000)
|
161
|
+
# Required for publishing client metrics. The port that the client side monitoring
|
162
|
+
# agent is running on, where client metrics will be published via UDP.
|
163
|
+
#
|
164
|
+
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
|
165
|
+
# Allows you to provide a custom client-side monitoring publisher class. By default,
|
166
|
+
# will use the Client Side Monitoring Agent Publisher.
|
167
|
+
#
|
168
|
+
# @option options [Boolean] :convert_params (true)
|
169
|
+
# When `true`, an attempt is made to coerce request parameters into
|
170
|
+
# the required types.
|
171
|
+
#
|
172
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
173
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
174
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
175
|
+
#
|
176
|
+
# @option options [Boolean] :disable_host_prefix_injection (false)
|
177
|
+
# Set to true to disable SDK automatically adding host prefix
|
178
|
+
# to default service endpoint when available.
|
179
|
+
#
|
180
|
+
# @option options [String] :endpoint
|
181
|
+
# The client endpoint is normally constructed from the `:region`
|
182
|
+
# option. You should only configure an `:endpoint` when connecting
|
183
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
184
|
+
#
|
185
|
+
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
186
|
+
# Used for the maximum size limit of the LRU cache storing endpoints data
|
187
|
+
# for endpoint discovery enabled operations. Defaults to 1000.
|
188
|
+
#
|
189
|
+
# @option options [Integer] :endpoint_cache_max_threads (10)
|
190
|
+
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
|
191
|
+
#
|
192
|
+
# @option options [Integer] :endpoint_cache_poll_interval (60)
|
193
|
+
# When :endpoint_discovery and :active_endpoint_cache is enabled,
|
194
|
+
# Use this option to config the time interval in seconds for making
|
195
|
+
# requests fetching endpoints information. Defaults to 60 sec.
|
196
|
+
#
|
197
|
+
# @option options [Boolean] :endpoint_discovery (false)
|
198
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
199
|
+
#
|
200
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
201
|
+
# The log formatter.
|
202
|
+
#
|
203
|
+
# @option options [Symbol] :log_level (:info)
|
204
|
+
# The log level to send messages to the `:logger` at.
|
205
|
+
#
|
206
|
+
# @option options [Logger] :logger
|
207
|
+
# The Logger instance to send log messages to. If this option
|
208
|
+
# is not set, logging will be disabled.
|
209
|
+
#
|
210
|
+
# @option options [Integer] :max_attempts (3)
|
211
|
+
# An integer representing the maximum number attempts that will be made for
|
212
|
+
# a single request, including the initial attempt. For example,
|
213
|
+
# setting this value to 5 will result in a request being retried up to
|
214
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
215
|
+
#
|
216
|
+
# @option options [String] :profile ("default")
|
217
|
+
# Used when loading credentials from the shared credentials file
|
218
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
219
|
+
#
|
220
|
+
# @option options [Proc] :retry_backoff
|
221
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
222
|
+
# This option is only used in the `legacy` retry mode.
|
223
|
+
#
|
224
|
+
# @option options [Float] :retry_base_delay (0.3)
|
225
|
+
# The base delay in seconds used by the default backoff function. This option
|
226
|
+
# is only used in the `legacy` retry mode.
|
227
|
+
#
|
228
|
+
# @option options [Symbol] :retry_jitter (:none)
|
229
|
+
# A delay randomiser function used by the default backoff function.
|
230
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
231
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
232
|
+
# in the `legacy` retry mode.
|
233
|
+
#
|
234
|
+
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
235
|
+
#
|
236
|
+
# @option options [Integer] :retry_limit (3)
|
237
|
+
# The maximum number of times to retry failed requests. Only
|
238
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
239
|
+
# are retried. Generally, these are throttling errors, data
|
240
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
241
|
+
# endpoint discovery, and errors from expired credentials.
|
242
|
+
# This option is only used in the `legacy` retry mode.
|
243
|
+
#
|
244
|
+
# @option options [Integer] :retry_max_delay (0)
|
245
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
246
|
+
# used by the default backoff function. This option is only used in the
|
247
|
+
# `legacy` retry mode.
|
248
|
+
#
|
249
|
+
# @option options [String] :retry_mode ("legacy")
|
250
|
+
# Specifies which retry algorithm to use. Values are:
|
251
|
+
#
|
252
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
253
|
+
# no retry mode is provided.
|
254
|
+
#
|
255
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
256
|
+
# This includes support for retry quotas, which limit the number of
|
257
|
+
# unsuccessful retries a client can make.
|
258
|
+
#
|
259
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
260
|
+
# functionality of `standard` mode along with automatic client side
|
261
|
+
# throttling. This is a provisional mode that may change behavior
|
262
|
+
# in the future.
|
263
|
+
#
|
264
|
+
#
|
265
|
+
# @option options [String] :secret_access_key
|
266
|
+
#
|
267
|
+
# @option options [String] :session_token
|
268
|
+
#
|
269
|
+
# @option options [Boolean] :stub_responses (false)
|
270
|
+
# Causes the client to return stubbed responses. By default
|
271
|
+
# fake responses are generated and returned. You can specify
|
272
|
+
# the response data to return or errors to raise by calling
|
273
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
274
|
+
#
|
275
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
276
|
+
# requests are made, and retries are disabled.
|
277
|
+
#
|
278
|
+
# @option options [Boolean] :validate_params (true)
|
279
|
+
# When `true`, request parameters are validated before
|
280
|
+
# sending the request.
|
281
|
+
#
|
282
|
+
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
283
|
+
# requests through. Formatted like 'http://proxy.com:123'.
|
284
|
+
#
|
285
|
+
# @option options [Float] :http_open_timeout (15) The number of
|
286
|
+
# seconds to wait when opening a HTTP session before raising a
|
287
|
+
# `Timeout::Error`.
|
288
|
+
#
|
289
|
+
# @option options [Integer] :http_read_timeout (60) The default
|
290
|
+
# number of seconds to wait for response data. This value can
|
291
|
+
# safely be set per-request on the session.
|
292
|
+
#
|
293
|
+
# @option options [Float] :http_idle_timeout (5) The number of
|
294
|
+
# seconds a connection is allowed to sit idle before it is
|
295
|
+
# considered stale. Stale connections are closed and removed
|
296
|
+
# from the pool before making a request.
|
297
|
+
#
|
298
|
+
# @option options [Float] :http_continue_timeout (1) The number of
|
299
|
+
# seconds to wait for a 100-continue response before sending the
|
300
|
+
# request body. This option has no effect unless the request has
|
301
|
+
# "Expect" header set to "100-continue". Defaults to `nil` which
|
302
|
+
# disables this behaviour. This value can safely be set per
|
303
|
+
# request on the session.
|
304
|
+
#
|
305
|
+
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
306
|
+
# HTTP debug output will be sent to the `:logger`.
|
307
|
+
#
|
308
|
+
# @option options [Boolean] :ssl_verify_peer (true) When `true`,
|
309
|
+
# SSL peer certificates are verified when establishing a
|
310
|
+
# connection.
|
311
|
+
#
|
312
|
+
# @option options [String] :ssl_ca_bundle Full path to the SSL
|
313
|
+
# certificate authority bundle file that should be used when
|
314
|
+
# verifying peer certificates. If you do not pass
|
315
|
+
# `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
|
316
|
+
# will be used if available.
|
317
|
+
#
|
318
|
+
# @option options [String] :ssl_ca_directory Full path of the
|
319
|
+
# directory that contains the unbundled SSL certificate
|
320
|
+
# authority files for verifying peer certificates. If you do
|
321
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
|
322
|
+
# system default will be used if available.
|
323
|
+
#
|
324
|
+
def initialize(*args)
|
325
|
+
super
|
326
|
+
end
|
327
|
+
|
328
|
+
# @!group API Operations
|
329
|
+
|
330
|
+
# Provides a list of analysis segments for a real-time analysis session.
|
331
|
+
#
|
332
|
+
# @option params [required, String] :instance_id
|
333
|
+
# The identifier of the Amazon Connect instance.
|
334
|
+
#
|
335
|
+
# @option params [required, String] :contact_id
|
336
|
+
# The identifier of the contact.
|
337
|
+
#
|
338
|
+
# @option params [Integer] :max_results
|
339
|
+
# The maximimum number of results to return per page.
|
340
|
+
#
|
341
|
+
# @option params [String] :next_token
|
342
|
+
# The token for the next set of results. Use the value returned in the
|
343
|
+
# previous response in the next request to retrieve the next set of
|
344
|
+
# results.
|
345
|
+
#
|
346
|
+
# @return [Types::ListRealtimeContactAnalysisSegmentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
347
|
+
#
|
348
|
+
# * {Types::ListRealtimeContactAnalysisSegmentsResponse#segments #segments} => Array<Types::RealtimeContactAnalysisSegment>
|
349
|
+
# * {Types::ListRealtimeContactAnalysisSegmentsResponse#next_token #next_token} => String
|
350
|
+
#
|
351
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
352
|
+
#
|
353
|
+
# @example Request syntax with placeholder values
|
354
|
+
#
|
355
|
+
# resp = client.list_realtime_contact_analysis_segments({
|
356
|
+
# instance_id: "InstanceId", # required
|
357
|
+
# contact_id: "ContactId", # required
|
358
|
+
# max_results: 1,
|
359
|
+
# next_token: "NextToken",
|
360
|
+
# })
|
361
|
+
#
|
362
|
+
# @example Response structure
|
363
|
+
#
|
364
|
+
# resp.segments #=> Array
|
365
|
+
# resp.segments[0].transcript.id #=> String
|
366
|
+
# resp.segments[0].transcript.participant_id #=> String
|
367
|
+
# resp.segments[0].transcript.participant_role #=> String
|
368
|
+
# resp.segments[0].transcript.content #=> String
|
369
|
+
# resp.segments[0].transcript.begin_offset_millis #=> Integer
|
370
|
+
# resp.segments[0].transcript.end_offset_millis #=> Integer
|
371
|
+
# resp.segments[0].transcript.sentiment #=> String, one of "POSITIVE", "NEUTRAL", "NEGATIVE"
|
372
|
+
# resp.segments[0].transcript.issues_detected #=> Array
|
373
|
+
# resp.segments[0].transcript.issues_detected[0].character_offsets.begin_offset_char #=> Integer
|
374
|
+
# resp.segments[0].transcript.issues_detected[0].character_offsets.end_offset_char #=> Integer
|
375
|
+
# resp.segments[0].categories.matched_categories #=> Array
|
376
|
+
# resp.segments[0].categories.matched_categories[0] #=> String
|
377
|
+
# resp.segments[0].categories.matched_details #=> Hash
|
378
|
+
# resp.segments[0].categories.matched_details["CategoryName"].points_of_interest #=> Array
|
379
|
+
# resp.segments[0].categories.matched_details["CategoryName"].points_of_interest[0].begin_offset_millis #=> Integer
|
380
|
+
# resp.segments[0].categories.matched_details["CategoryName"].points_of_interest[0].end_offset_millis #=> Integer
|
381
|
+
# resp.next_token #=> String
|
382
|
+
#
|
383
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-contact-lens-2020-08-21/ListRealtimeContactAnalysisSegments AWS API Documentation
|
384
|
+
#
|
385
|
+
# @overload list_realtime_contact_analysis_segments(params = {})
|
386
|
+
# @param [Hash] params ({})
|
387
|
+
def list_realtime_contact_analysis_segments(params = {}, options = {})
|
388
|
+
req = build_request(:list_realtime_contact_analysis_segments, params)
|
389
|
+
req.send_request(options)
|
390
|
+
end
|
391
|
+
|
392
|
+
# @!endgroup
|
393
|
+
|
394
|
+
# @param params ({})
|
395
|
+
# @api private
|
396
|
+
def build_request(operation_name, params = {})
|
397
|
+
handlers = @handlers.for(operation_name)
|
398
|
+
context = Seahorse::Client::RequestContext.new(
|
399
|
+
operation_name: operation_name,
|
400
|
+
operation: config.api.operation(operation_name),
|
401
|
+
client: self,
|
402
|
+
params: params,
|
403
|
+
config: config)
|
404
|
+
context[:gem_name] = 'aws-sdk-connectcontactlens'
|
405
|
+
context[:gem_version] = '1.0.0'
|
406
|
+
Seahorse::Client::Request.new(handlers, context)
|
407
|
+
end
|
408
|
+
|
409
|
+
# @api private
|
410
|
+
# @deprecated
|
411
|
+
def waiter_names
|
412
|
+
[]
|
413
|
+
end
|
414
|
+
|
415
|
+
class << self
|
416
|
+
|
417
|
+
# @api private
|
418
|
+
attr_reader :identifier
|
419
|
+
|
420
|
+
# @api private
|
421
|
+
def errors_module
|
422
|
+
Errors
|
423
|
+
end
|
424
|
+
|
425
|
+
end
|
426
|
+
end
|
427
|
+
end
|
@@ -0,0 +1,157 @@
|
|
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/master/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::ConnectContactLens
|
11
|
+
# @api private
|
12
|
+
module ClientApi
|
13
|
+
|
14
|
+
include Seahorse::Model
|
15
|
+
|
16
|
+
AccessDeniedException = Shapes::StructureShape.new(name: 'AccessDeniedException')
|
17
|
+
Categories = Shapes::StructureShape.new(name: 'Categories')
|
18
|
+
CategoryDetails = Shapes::StructureShape.new(name: 'CategoryDetails')
|
19
|
+
CategoryName = Shapes::StringShape.new(name: 'CategoryName')
|
20
|
+
CharacterOffset = Shapes::IntegerShape.new(name: 'CharacterOffset')
|
21
|
+
CharacterOffsets = Shapes::StructureShape.new(name: 'CharacterOffsets')
|
22
|
+
ContactId = Shapes::StringShape.new(name: 'ContactId')
|
23
|
+
InstanceId = Shapes::StringShape.new(name: 'InstanceId')
|
24
|
+
InternalServiceException = Shapes::StructureShape.new(name: 'InternalServiceException')
|
25
|
+
InvalidRequestException = Shapes::StructureShape.new(name: 'InvalidRequestException')
|
26
|
+
IssueDetected = Shapes::StructureShape.new(name: 'IssueDetected')
|
27
|
+
IssuesDetected = Shapes::ListShape.new(name: 'IssuesDetected')
|
28
|
+
ListRealtimeContactAnalysisSegmentsRequest = Shapes::StructureShape.new(name: 'ListRealtimeContactAnalysisSegmentsRequest')
|
29
|
+
ListRealtimeContactAnalysisSegmentsResponse = Shapes::StructureShape.new(name: 'ListRealtimeContactAnalysisSegmentsResponse')
|
30
|
+
MatchedCategories = Shapes::ListShape.new(name: 'MatchedCategories')
|
31
|
+
MatchedDetails = Shapes::MapShape.new(name: 'MatchedDetails')
|
32
|
+
MaxResults = Shapes::IntegerShape.new(name: 'MaxResults')
|
33
|
+
Message = Shapes::StringShape.new(name: 'Message')
|
34
|
+
NextToken = Shapes::StringShape.new(name: 'NextToken')
|
35
|
+
OffsetMillis = Shapes::IntegerShape.new(name: 'OffsetMillis')
|
36
|
+
ParticipantId = Shapes::StringShape.new(name: 'ParticipantId')
|
37
|
+
ParticipantRole = Shapes::StringShape.new(name: 'ParticipantRole')
|
38
|
+
PointOfInterest = Shapes::StructureShape.new(name: 'PointOfInterest')
|
39
|
+
PointsOfInterest = Shapes::ListShape.new(name: 'PointsOfInterest')
|
40
|
+
RealtimeContactAnalysisSegment = Shapes::StructureShape.new(name: 'RealtimeContactAnalysisSegment')
|
41
|
+
RealtimeContactAnalysisSegments = Shapes::ListShape.new(name: 'RealtimeContactAnalysisSegments')
|
42
|
+
ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
|
43
|
+
SentimentValue = Shapes::StringShape.new(name: 'SentimentValue')
|
44
|
+
ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
|
45
|
+
Transcript = Shapes::StructureShape.new(name: 'Transcript')
|
46
|
+
TranscriptContent = Shapes::StringShape.new(name: 'TranscriptContent')
|
47
|
+
TranscriptId = Shapes::StringShape.new(name: 'TranscriptId')
|
48
|
+
|
49
|
+
AccessDeniedException.add_member(:message, Shapes::ShapeRef.new(shape: Message, required: true, location_name: "Message"))
|
50
|
+
AccessDeniedException.struct_class = Types::AccessDeniedException
|
51
|
+
|
52
|
+
Categories.add_member(:matched_categories, Shapes::ShapeRef.new(shape: MatchedCategories, required: true, location_name: "MatchedCategories"))
|
53
|
+
Categories.add_member(:matched_details, Shapes::ShapeRef.new(shape: MatchedDetails, required: true, location_name: "MatchedDetails"))
|
54
|
+
Categories.struct_class = Types::Categories
|
55
|
+
|
56
|
+
CategoryDetails.add_member(:points_of_interest, Shapes::ShapeRef.new(shape: PointsOfInterest, required: true, location_name: "PointsOfInterest"))
|
57
|
+
CategoryDetails.struct_class = Types::CategoryDetails
|
58
|
+
|
59
|
+
CharacterOffsets.add_member(:begin_offset_char, Shapes::ShapeRef.new(shape: CharacterOffset, required: true, location_name: "BeginOffsetChar"))
|
60
|
+
CharacterOffsets.add_member(:end_offset_char, Shapes::ShapeRef.new(shape: CharacterOffset, required: true, location_name: "EndOffsetChar"))
|
61
|
+
CharacterOffsets.struct_class = Types::CharacterOffsets
|
62
|
+
|
63
|
+
InternalServiceException.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message"))
|
64
|
+
InternalServiceException.struct_class = Types::InternalServiceException
|
65
|
+
|
66
|
+
InvalidRequestException.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message"))
|
67
|
+
InvalidRequestException.struct_class = Types::InvalidRequestException
|
68
|
+
|
69
|
+
IssueDetected.add_member(:character_offsets, Shapes::ShapeRef.new(shape: CharacterOffsets, required: true, location_name: "CharacterOffsets"))
|
70
|
+
IssueDetected.struct_class = Types::IssueDetected
|
71
|
+
|
72
|
+
IssuesDetected.member = Shapes::ShapeRef.new(shape: IssueDetected)
|
73
|
+
|
74
|
+
ListRealtimeContactAnalysisSegmentsRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location_name: "InstanceId"))
|
75
|
+
ListRealtimeContactAnalysisSegmentsRequest.add_member(:contact_id, Shapes::ShapeRef.new(shape: ContactId, required: true, location_name: "ContactId"))
|
76
|
+
ListRealtimeContactAnalysisSegmentsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
|
77
|
+
ListRealtimeContactAnalysisSegmentsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
78
|
+
ListRealtimeContactAnalysisSegmentsRequest.struct_class = Types::ListRealtimeContactAnalysisSegmentsRequest
|
79
|
+
|
80
|
+
ListRealtimeContactAnalysisSegmentsResponse.add_member(:segments, Shapes::ShapeRef.new(shape: RealtimeContactAnalysisSegments, required: true, location_name: "Segments"))
|
81
|
+
ListRealtimeContactAnalysisSegmentsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
82
|
+
ListRealtimeContactAnalysisSegmentsResponse.struct_class = Types::ListRealtimeContactAnalysisSegmentsResponse
|
83
|
+
|
84
|
+
MatchedCategories.member = Shapes::ShapeRef.new(shape: CategoryName)
|
85
|
+
|
86
|
+
MatchedDetails.key = Shapes::ShapeRef.new(shape: CategoryName)
|
87
|
+
MatchedDetails.value = Shapes::ShapeRef.new(shape: CategoryDetails)
|
88
|
+
|
89
|
+
PointOfInterest.add_member(:begin_offset_millis, Shapes::ShapeRef.new(shape: OffsetMillis, required: true, location_name: "BeginOffsetMillis"))
|
90
|
+
PointOfInterest.add_member(:end_offset_millis, Shapes::ShapeRef.new(shape: OffsetMillis, required: true, location_name: "EndOffsetMillis"))
|
91
|
+
PointOfInterest.struct_class = Types::PointOfInterest
|
92
|
+
|
93
|
+
PointsOfInterest.member = Shapes::ShapeRef.new(shape: PointOfInterest)
|
94
|
+
|
95
|
+
RealtimeContactAnalysisSegment.add_member(:transcript, Shapes::ShapeRef.new(shape: Transcript, location_name: "Transcript"))
|
96
|
+
RealtimeContactAnalysisSegment.add_member(:categories, Shapes::ShapeRef.new(shape: Categories, location_name: "Categories"))
|
97
|
+
RealtimeContactAnalysisSegment.struct_class = Types::RealtimeContactAnalysisSegment
|
98
|
+
|
99
|
+
RealtimeContactAnalysisSegments.member = Shapes::ShapeRef.new(shape: RealtimeContactAnalysisSegment)
|
100
|
+
|
101
|
+
ResourceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message"))
|
102
|
+
ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
|
103
|
+
|
104
|
+
ThrottlingException.add_member(:message, Shapes::ShapeRef.new(shape: Message, required: true, location_name: "Message"))
|
105
|
+
ThrottlingException.struct_class = Types::ThrottlingException
|
106
|
+
|
107
|
+
Transcript.add_member(:id, Shapes::ShapeRef.new(shape: TranscriptId, required: true, location_name: "Id"))
|
108
|
+
Transcript.add_member(:participant_id, Shapes::ShapeRef.new(shape: ParticipantId, required: true, location_name: "ParticipantId"))
|
109
|
+
Transcript.add_member(:participant_role, Shapes::ShapeRef.new(shape: ParticipantRole, required: true, location_name: "ParticipantRole"))
|
110
|
+
Transcript.add_member(:content, Shapes::ShapeRef.new(shape: TranscriptContent, required: true, location_name: "Content"))
|
111
|
+
Transcript.add_member(:begin_offset_millis, Shapes::ShapeRef.new(shape: OffsetMillis, required: true, location_name: "BeginOffsetMillis"))
|
112
|
+
Transcript.add_member(:end_offset_millis, Shapes::ShapeRef.new(shape: OffsetMillis, required: true, location_name: "EndOffsetMillis"))
|
113
|
+
Transcript.add_member(:sentiment, Shapes::ShapeRef.new(shape: SentimentValue, required: true, location_name: "Sentiment"))
|
114
|
+
Transcript.add_member(:issues_detected, Shapes::ShapeRef.new(shape: IssuesDetected, location_name: "IssuesDetected"))
|
115
|
+
Transcript.struct_class = Types::Transcript
|
116
|
+
|
117
|
+
|
118
|
+
# @api private
|
119
|
+
API = Seahorse::Model::Api.new.tap do |api|
|
120
|
+
|
121
|
+
api.version = "2020-08-21"
|
122
|
+
|
123
|
+
api.metadata = {
|
124
|
+
"apiVersion" => "2020-08-21",
|
125
|
+
"endpointPrefix" => "contact-lens",
|
126
|
+
"jsonVersion" => "1.1",
|
127
|
+
"protocol" => "rest-json",
|
128
|
+
"serviceAbbreviation" => "Amazon Connect Contact Lens",
|
129
|
+
"serviceFullName" => "Amazon Connect Contact Lens",
|
130
|
+
"serviceId" => "Connect Contact Lens",
|
131
|
+
"signatureVersion" => "v4",
|
132
|
+
"signingName" => "connect",
|
133
|
+
"uid" => "connect-contact-lens-2020-08-21",
|
134
|
+
}
|
135
|
+
|
136
|
+
api.add_operation(:list_realtime_contact_analysis_segments, Seahorse::Model::Operation.new.tap do |o|
|
137
|
+
o.name = "ListRealtimeContactAnalysisSegments"
|
138
|
+
o.http_method = "POST"
|
139
|
+
o.http_request_uri = "/realtime-contact-analysis/analysis-segments"
|
140
|
+
o.input = Shapes::ShapeRef.new(shape: ListRealtimeContactAnalysisSegmentsRequest)
|
141
|
+
o.output = Shapes::ShapeRef.new(shape: ListRealtimeContactAnalysisSegmentsResponse)
|
142
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
143
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
144
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
145
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
|
146
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
147
|
+
o[:pager] = Aws::Pager.new(
|
148
|
+
limit_key: "max_results",
|
149
|
+
tokens: {
|
150
|
+
"next_token" => "next_token"
|
151
|
+
}
|
152
|
+
)
|
153
|
+
end)
|
154
|
+
end
|
155
|
+
|
156
|
+
end
|
157
|
+
end
|
File without changes
|
@@ -0,0 +1,118 @@
|
|
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/master/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::ConnectContactLens
|
11
|
+
|
12
|
+
# When ConnectContactLens returns an error response, the Ruby SDK constructs and raises an error.
|
13
|
+
# These errors all extend Aws::ConnectContactLens::Errors::ServiceError < {Aws::Errors::ServiceError}
|
14
|
+
#
|
15
|
+
# You can rescue all ConnectContactLens errors using ServiceError:
|
16
|
+
#
|
17
|
+
# begin
|
18
|
+
# # do stuff
|
19
|
+
# rescue Aws::ConnectContactLens::Errors::ServiceError
|
20
|
+
# # rescues all ConnectContactLens API errors
|
21
|
+
# end
|
22
|
+
#
|
23
|
+
#
|
24
|
+
# ## Request Context
|
25
|
+
# ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
|
26
|
+
# information about the request that generated the error.
|
27
|
+
# See {Seahorse::Client::RequestContext} for more information.
|
28
|
+
#
|
29
|
+
# ## Error Classes
|
30
|
+
# * {AccessDeniedException}
|
31
|
+
# * {InternalServiceException}
|
32
|
+
# * {InvalidRequestException}
|
33
|
+
# * {ResourceNotFoundException}
|
34
|
+
# * {ThrottlingException}
|
35
|
+
#
|
36
|
+
# Additionally, error classes are dynamically generated for service errors based on the error code
|
37
|
+
# if they are not defined above.
|
38
|
+
module Errors
|
39
|
+
|
40
|
+
extend Aws::Errors::DynamicErrors
|
41
|
+
|
42
|
+
class AccessDeniedException < ServiceError
|
43
|
+
|
44
|
+
# @param [Seahorse::Client::RequestContext] context
|
45
|
+
# @param [String] message
|
46
|
+
# @param [Aws::ConnectContactLens::Types::AccessDeniedException] data
|
47
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
48
|
+
super(context, message, data)
|
49
|
+
end
|
50
|
+
|
51
|
+
# @return [String]
|
52
|
+
def message
|
53
|
+
@message || @data[:message]
|
54
|
+
end
|
55
|
+
end
|
56
|
+
|
57
|
+
class InternalServiceException < ServiceError
|
58
|
+
|
59
|
+
# @param [Seahorse::Client::RequestContext] context
|
60
|
+
# @param [String] message
|
61
|
+
# @param [Aws::ConnectContactLens::Types::InternalServiceException] data
|
62
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
63
|
+
super(context, message, data)
|
64
|
+
end
|
65
|
+
|
66
|
+
# @return [String]
|
67
|
+
def message
|
68
|
+
@message || @data[:message]
|
69
|
+
end
|
70
|
+
end
|
71
|
+
|
72
|
+
class InvalidRequestException < ServiceError
|
73
|
+
|
74
|
+
# @param [Seahorse::Client::RequestContext] context
|
75
|
+
# @param [String] message
|
76
|
+
# @param [Aws::ConnectContactLens::Types::InvalidRequestException] data
|
77
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
78
|
+
super(context, message, data)
|
79
|
+
end
|
80
|
+
|
81
|
+
# @return [String]
|
82
|
+
def message
|
83
|
+
@message || @data[:message]
|
84
|
+
end
|
85
|
+
end
|
86
|
+
|
87
|
+
class ResourceNotFoundException < ServiceError
|
88
|
+
|
89
|
+
# @param [Seahorse::Client::RequestContext] context
|
90
|
+
# @param [String] message
|
91
|
+
# @param [Aws::ConnectContactLens::Types::ResourceNotFoundException] data
|
92
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
93
|
+
super(context, message, data)
|
94
|
+
end
|
95
|
+
|
96
|
+
# @return [String]
|
97
|
+
def message
|
98
|
+
@message || @data[:message]
|
99
|
+
end
|
100
|
+
end
|
101
|
+
|
102
|
+
class ThrottlingException < ServiceError
|
103
|
+
|
104
|
+
# @param [Seahorse::Client::RequestContext] context
|
105
|
+
# @param [String] message
|
106
|
+
# @param [Aws::ConnectContactLens::Types::ThrottlingException] data
|
107
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
108
|
+
super(context, message, data)
|
109
|
+
end
|
110
|
+
|
111
|
+
# @return [String]
|
112
|
+
def message
|
113
|
+
@message || @data[:message]
|
114
|
+
end
|
115
|
+
end
|
116
|
+
|
117
|
+
end
|
118
|
+
end
|
@@ -0,0 +1,26 @@
|
|
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/master/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::ConnectContactLens
|
11
|
+
|
12
|
+
class Resource
|
13
|
+
|
14
|
+
# @param options ({})
|
15
|
+
# @option options [Client] :client
|
16
|
+
def initialize(options = {})
|
17
|
+
@client = options[:client] || Client.new(options)
|
18
|
+
end
|
19
|
+
|
20
|
+
# @return [Client]
|
21
|
+
def client
|
22
|
+
@client
|
23
|
+
end
|
24
|
+
|
25
|
+
end
|
26
|
+
end
|
@@ -0,0 +1,307 @@
|
|
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/master/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::ConnectContactLens
|
11
|
+
module Types
|
12
|
+
|
13
|
+
# You do not have sufficient access to perform this action.
|
14
|
+
#
|
15
|
+
# @!attribute [rw] message
|
16
|
+
# @return [String]
|
17
|
+
#
|
18
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-contact-lens-2020-08-21/AccessDeniedException AWS API Documentation
|
19
|
+
#
|
20
|
+
class AccessDeniedException < Struct.new(
|
21
|
+
:message)
|
22
|
+
SENSITIVE = []
|
23
|
+
include Aws::Structure
|
24
|
+
end
|
25
|
+
|
26
|
+
# Provides the category rules that are used to automatically categorize
|
27
|
+
# contacts based on uttered keywords and phrases.
|
28
|
+
#
|
29
|
+
# @!attribute [rw] matched_categories
|
30
|
+
# The category rules that have been matched in the analyzed segment.
|
31
|
+
# @return [Array<String>]
|
32
|
+
#
|
33
|
+
# @!attribute [rw] matched_details
|
34
|
+
# The category rule that was matched and when it occurred in the
|
35
|
+
# transcript.
|
36
|
+
# @return [Hash<String,Types::CategoryDetails>]
|
37
|
+
#
|
38
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-contact-lens-2020-08-21/Categories AWS API Documentation
|
39
|
+
#
|
40
|
+
class Categories < Struct.new(
|
41
|
+
:matched_categories,
|
42
|
+
:matched_details)
|
43
|
+
SENSITIVE = []
|
44
|
+
include Aws::Structure
|
45
|
+
end
|
46
|
+
|
47
|
+
# Provides information about the category rule that was matched.
|
48
|
+
#
|
49
|
+
# @!attribute [rw] points_of_interest
|
50
|
+
# The section of audio where the category rule was detected.
|
51
|
+
# @return [Array<Types::PointOfInterest>]
|
52
|
+
#
|
53
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-contact-lens-2020-08-21/CategoryDetails AWS API Documentation
|
54
|
+
#
|
55
|
+
class CategoryDetails < Struct.new(
|
56
|
+
:points_of_interest)
|
57
|
+
SENSITIVE = []
|
58
|
+
include Aws::Structure
|
59
|
+
end
|
60
|
+
|
61
|
+
# For characters that were detected as issues, where they occur in the
|
62
|
+
# transcript.
|
63
|
+
#
|
64
|
+
# @!attribute [rw] begin_offset_char
|
65
|
+
# The beginning of the issue.
|
66
|
+
# @return [Integer]
|
67
|
+
#
|
68
|
+
# @!attribute [rw] end_offset_char
|
69
|
+
# The end of the issue.
|
70
|
+
# @return [Integer]
|
71
|
+
#
|
72
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-contact-lens-2020-08-21/CharacterOffsets AWS API Documentation
|
73
|
+
#
|
74
|
+
class CharacterOffsets < Struct.new(
|
75
|
+
:begin_offset_char,
|
76
|
+
:end_offset_char)
|
77
|
+
SENSITIVE = []
|
78
|
+
include Aws::Structure
|
79
|
+
end
|
80
|
+
|
81
|
+
# Request processing failed due to an error or failure with the service.
|
82
|
+
#
|
83
|
+
# @!attribute [rw] message
|
84
|
+
# @return [String]
|
85
|
+
#
|
86
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-contact-lens-2020-08-21/InternalServiceException AWS API Documentation
|
87
|
+
#
|
88
|
+
class InternalServiceException < Struct.new(
|
89
|
+
:message)
|
90
|
+
SENSITIVE = []
|
91
|
+
include Aws::Structure
|
92
|
+
end
|
93
|
+
|
94
|
+
# The request is not valid.
|
95
|
+
#
|
96
|
+
# @!attribute [rw] message
|
97
|
+
# @return [String]
|
98
|
+
#
|
99
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-contact-lens-2020-08-21/InvalidRequestException AWS API Documentation
|
100
|
+
#
|
101
|
+
class InvalidRequestException < Struct.new(
|
102
|
+
:message)
|
103
|
+
SENSITIVE = []
|
104
|
+
include Aws::Structure
|
105
|
+
end
|
106
|
+
|
107
|
+
# Potential issues that are detected based on an artificial intelligence
|
108
|
+
# analysis of each turn in the conversation.
|
109
|
+
#
|
110
|
+
# @!attribute [rw] character_offsets
|
111
|
+
# The offset for when the issue was detected in the segment.
|
112
|
+
# @return [Types::CharacterOffsets]
|
113
|
+
#
|
114
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-contact-lens-2020-08-21/IssueDetected AWS API Documentation
|
115
|
+
#
|
116
|
+
class IssueDetected < Struct.new(
|
117
|
+
:character_offsets)
|
118
|
+
SENSITIVE = []
|
119
|
+
include Aws::Structure
|
120
|
+
end
|
121
|
+
|
122
|
+
# @note When making an API call, you may pass ListRealtimeContactAnalysisSegmentsRequest
|
123
|
+
# data as a hash:
|
124
|
+
#
|
125
|
+
# {
|
126
|
+
# instance_id: "InstanceId", # required
|
127
|
+
# contact_id: "ContactId", # required
|
128
|
+
# max_results: 1,
|
129
|
+
# next_token: "NextToken",
|
130
|
+
# }
|
131
|
+
#
|
132
|
+
# @!attribute [rw] instance_id
|
133
|
+
# The identifier of the Amazon Connect instance.
|
134
|
+
# @return [String]
|
135
|
+
#
|
136
|
+
# @!attribute [rw] contact_id
|
137
|
+
# The identifier of the contact.
|
138
|
+
# @return [String]
|
139
|
+
#
|
140
|
+
# @!attribute [rw] max_results
|
141
|
+
# The maximimum number of results to return per page.
|
142
|
+
# @return [Integer]
|
143
|
+
#
|
144
|
+
# @!attribute [rw] next_token
|
145
|
+
# The token for the next set of results. Use the value returned in the
|
146
|
+
# previous response in the next request to retrieve the next set of
|
147
|
+
# results.
|
148
|
+
# @return [String]
|
149
|
+
#
|
150
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-contact-lens-2020-08-21/ListRealtimeContactAnalysisSegmentsRequest AWS API Documentation
|
151
|
+
#
|
152
|
+
class ListRealtimeContactAnalysisSegmentsRequest < Struct.new(
|
153
|
+
:instance_id,
|
154
|
+
:contact_id,
|
155
|
+
:max_results,
|
156
|
+
:next_token)
|
157
|
+
SENSITIVE = []
|
158
|
+
include Aws::Structure
|
159
|
+
end
|
160
|
+
|
161
|
+
# @!attribute [rw] segments
|
162
|
+
# An analyzed transcript or category.
|
163
|
+
# @return [Array<Types::RealtimeContactAnalysisSegment>]
|
164
|
+
#
|
165
|
+
# @!attribute [rw] next_token
|
166
|
+
# If there are additional results, this is the token for the next set
|
167
|
+
# of results. If response includes `nextToken` there are two possible
|
168
|
+
# scenarios:
|
169
|
+
#
|
170
|
+
# * There are more segments so another call is required to get them.
|
171
|
+
#
|
172
|
+
# * There are no more segments at this time, but more may be available
|
173
|
+
# later (real-time analysis is in progress) so the client should
|
174
|
+
# call the operation again to get new segments.
|
175
|
+
#
|
176
|
+
# If response does not include `nextToken`, the analysis is completed
|
177
|
+
# (successfully or failed) and there are no more segments to retrieve.
|
178
|
+
# @return [String]
|
179
|
+
#
|
180
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-contact-lens-2020-08-21/ListRealtimeContactAnalysisSegmentsResponse AWS API Documentation
|
181
|
+
#
|
182
|
+
class ListRealtimeContactAnalysisSegmentsResponse < Struct.new(
|
183
|
+
:segments,
|
184
|
+
:next_token)
|
185
|
+
SENSITIVE = []
|
186
|
+
include Aws::Structure
|
187
|
+
end
|
188
|
+
|
189
|
+
# The section of the contact audio where that category rule was
|
190
|
+
# detected.
|
191
|
+
#
|
192
|
+
# @!attribute [rw] begin_offset_millis
|
193
|
+
# The beginning offset in milliseconds where the category rule was
|
194
|
+
# detected.
|
195
|
+
# @return [Integer]
|
196
|
+
#
|
197
|
+
# @!attribute [rw] end_offset_millis
|
198
|
+
# The ending offset in milliseconds where the category rule was
|
199
|
+
# detected.
|
200
|
+
# @return [Integer]
|
201
|
+
#
|
202
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-contact-lens-2020-08-21/PointOfInterest AWS API Documentation
|
203
|
+
#
|
204
|
+
class PointOfInterest < Struct.new(
|
205
|
+
:begin_offset_millis,
|
206
|
+
:end_offset_millis)
|
207
|
+
SENSITIVE = []
|
208
|
+
include Aws::Structure
|
209
|
+
end
|
210
|
+
|
211
|
+
# An analyzed segment for a real-time analysis session.
|
212
|
+
#
|
213
|
+
# @!attribute [rw] transcript
|
214
|
+
# The analyzed transcript.
|
215
|
+
# @return [Types::Transcript]
|
216
|
+
#
|
217
|
+
# @!attribute [rw] categories
|
218
|
+
# The matched category rules.
|
219
|
+
# @return [Types::Categories]
|
220
|
+
#
|
221
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-contact-lens-2020-08-21/RealtimeContactAnalysisSegment AWS API Documentation
|
222
|
+
#
|
223
|
+
class RealtimeContactAnalysisSegment < Struct.new(
|
224
|
+
:transcript,
|
225
|
+
:categories)
|
226
|
+
SENSITIVE = []
|
227
|
+
include Aws::Structure
|
228
|
+
end
|
229
|
+
|
230
|
+
# The specified resource was not found.
|
231
|
+
#
|
232
|
+
# @!attribute [rw] message
|
233
|
+
# @return [String]
|
234
|
+
#
|
235
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-contact-lens-2020-08-21/ResourceNotFoundException AWS API Documentation
|
236
|
+
#
|
237
|
+
class ResourceNotFoundException < Struct.new(
|
238
|
+
:message)
|
239
|
+
SENSITIVE = []
|
240
|
+
include Aws::Structure
|
241
|
+
end
|
242
|
+
|
243
|
+
# The throttling limit has been exceeded.
|
244
|
+
#
|
245
|
+
# @!attribute [rw] message
|
246
|
+
# @return [String]
|
247
|
+
#
|
248
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-contact-lens-2020-08-21/ThrottlingException AWS API Documentation
|
249
|
+
#
|
250
|
+
class ThrottlingException < Struct.new(
|
251
|
+
:message)
|
252
|
+
SENSITIVE = []
|
253
|
+
include Aws::Structure
|
254
|
+
end
|
255
|
+
|
256
|
+
# A list of messages in the session.
|
257
|
+
#
|
258
|
+
# @!attribute [rw] id
|
259
|
+
# The identifier of the transcript.
|
260
|
+
# @return [String]
|
261
|
+
#
|
262
|
+
# @!attribute [rw] participant_id
|
263
|
+
# The identifier of the participant.
|
264
|
+
# @return [String]
|
265
|
+
#
|
266
|
+
# @!attribute [rw] participant_role
|
267
|
+
# The role of participant. For example, is it a customer, agent, or
|
268
|
+
# system.
|
269
|
+
# @return [String]
|
270
|
+
#
|
271
|
+
# @!attribute [rw] content
|
272
|
+
# The content of the transcript.
|
273
|
+
# @return [String]
|
274
|
+
#
|
275
|
+
# @!attribute [rw] begin_offset_millis
|
276
|
+
# The beginning offset in the contact for this transcript.
|
277
|
+
# @return [Integer]
|
278
|
+
#
|
279
|
+
# @!attribute [rw] end_offset_millis
|
280
|
+
# The end offset in the contact for this transcript.
|
281
|
+
# @return [Integer]
|
282
|
+
#
|
283
|
+
# @!attribute [rw] sentiment
|
284
|
+
# The sentiment of the detected for this piece of transcript.
|
285
|
+
# @return [String]
|
286
|
+
#
|
287
|
+
# @!attribute [rw] issues_detected
|
288
|
+
# List of positions where issues were detected on the transcript.
|
289
|
+
# @return [Array<Types::IssueDetected>]
|
290
|
+
#
|
291
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-contact-lens-2020-08-21/Transcript AWS API Documentation
|
292
|
+
#
|
293
|
+
class Transcript < Struct.new(
|
294
|
+
:id,
|
295
|
+
:participant_id,
|
296
|
+
:participant_role,
|
297
|
+
:content,
|
298
|
+
:begin_offset_millis,
|
299
|
+
:end_offset_millis,
|
300
|
+
:sentiment,
|
301
|
+
:issues_detected)
|
302
|
+
SENSITIVE = []
|
303
|
+
include Aws::Structure
|
304
|
+
end
|
305
|
+
|
306
|
+
end
|
307
|
+
end
|
metadata
ADDED
@@ -0,0 +1,88 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: aws-sdk-connectcontactlens
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 1.0.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Amazon Web Services
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2020-12-01 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: aws-sdk-core
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '3'
|
20
|
+
- - ">="
|
21
|
+
- !ruby/object:Gem::Version
|
22
|
+
version: 3.109.0
|
23
|
+
type: :runtime
|
24
|
+
prerelease: false
|
25
|
+
version_requirements: !ruby/object:Gem::Requirement
|
26
|
+
requirements:
|
27
|
+
- - "~>"
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
version: '3'
|
30
|
+
- - ">="
|
31
|
+
- !ruby/object:Gem::Version
|
32
|
+
version: 3.109.0
|
33
|
+
- !ruby/object:Gem::Dependency
|
34
|
+
name: aws-sigv4
|
35
|
+
requirement: !ruby/object:Gem::Requirement
|
36
|
+
requirements:
|
37
|
+
- - "~>"
|
38
|
+
- !ruby/object:Gem::Version
|
39
|
+
version: '1.1'
|
40
|
+
type: :runtime
|
41
|
+
prerelease: false
|
42
|
+
version_requirements: !ruby/object:Gem::Requirement
|
43
|
+
requirements:
|
44
|
+
- - "~>"
|
45
|
+
- !ruby/object:Gem::Version
|
46
|
+
version: '1.1'
|
47
|
+
description: Official AWS Ruby gem for Amazon Connect Contact Lens. This gem is part
|
48
|
+
of the AWS SDK for Ruby.
|
49
|
+
email:
|
50
|
+
- trevrowe@amazon.com
|
51
|
+
executables: []
|
52
|
+
extensions: []
|
53
|
+
extra_rdoc_files: []
|
54
|
+
files:
|
55
|
+
- lib/aws-sdk-connectcontactlens.rb
|
56
|
+
- lib/aws-sdk-connectcontactlens/client.rb
|
57
|
+
- lib/aws-sdk-connectcontactlens/client_api.rb
|
58
|
+
- lib/aws-sdk-connectcontactlens/customizations.rb
|
59
|
+
- lib/aws-sdk-connectcontactlens/errors.rb
|
60
|
+
- lib/aws-sdk-connectcontactlens/resource.rb
|
61
|
+
- lib/aws-sdk-connectcontactlens/types.rb
|
62
|
+
homepage: https://github.com/aws/aws-sdk-ruby
|
63
|
+
licenses:
|
64
|
+
- Apache-2.0
|
65
|
+
metadata:
|
66
|
+
source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-connectcontactlens
|
67
|
+
changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-connectcontactlens/CHANGELOG.md
|
68
|
+
post_install_message:
|
69
|
+
rdoc_options: []
|
70
|
+
require_paths:
|
71
|
+
- lib
|
72
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
73
|
+
requirements:
|
74
|
+
- - ">="
|
75
|
+
- !ruby/object:Gem::Version
|
76
|
+
version: '0'
|
77
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
78
|
+
requirements:
|
79
|
+
- - ">="
|
80
|
+
- !ruby/object:Gem::Version
|
81
|
+
version: '0'
|
82
|
+
requirements: []
|
83
|
+
rubyforge_project:
|
84
|
+
rubygems_version: 2.7.6.2
|
85
|
+
signing_key:
|
86
|
+
specification_version: 4
|
87
|
+
summary: AWS SDK for Ruby - Amazon Connect Contact Lens
|
88
|
+
test_files: []
|