aws-sdk-connectparticipant 1.0.0 → 1.5.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: '0408490c61eb842f40572525c9c274ac4c7fd354'
4
- data.tar.gz: 33f7fc05e0cf7508636ce0b0e872ccd02e525074
2
+ SHA256:
3
+ metadata.gz: 28c96b7fd9b6dc83173f9460901eaee32b2660ae7d16a529834ea24dd7e51014
4
+ data.tar.gz: dfe254b5de6d350900b3266bf02b778348fc2549d172c25dcbd1393f19d40404
5
5
  SHA512:
6
- metadata.gz: 3e4198016c47fc9bba2b3e350a0914ebaa17c990b4d37231755bae109c44cb22ddc098f1f794bf1d6e09824f8fff9982633c62d6251384c18919118f3eb7cdfe
7
- data.tar.gz: 76eb9ecd97e1ad2901495ff257b5b3d3f73633008b79858e50fc9ab7a7ebec8cf4e9ae83ec5fdc808f988fdafc4cc2763266d51a31f9af675d156b2e6b021b42
6
+ metadata.gz: 36c2199d19f4ecb877b6541cd46c0fb97ee10d2aaa8592e4aa8ff2b3196e779c553aac25b75667cf1db0b2138574d74e43d642c4d07b9feb2987500263c5bd88
7
+ data.tar.gz: 6348aecd67ca496136b64e6df7396f1788c7c01e033e004342ee19859f35e5e06049cc91119bd0cc38b0ea43040b49f964f5074c828962915354e148b939f779
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -24,17 +26,20 @@ require_relative 'aws-sdk-connectparticipant/customizations'
24
26
  # methods each accept a hash of request parameters and return a response
25
27
  # structure.
26
28
  #
29
+ # connect_participant = Aws::ConnectParticipant::Client.new
30
+ # resp = connect_participant.create_participant_connection(params)
31
+ #
27
32
  # See {Client} for more information.
28
33
  #
29
34
  # # Errors
30
35
  #
31
- # Errors returned from Amazon Connect Participant Service all
32
- # extend {Errors::ServiceError}.
36
+ # Errors returned from Amazon Connect Participant Service are defined in the
37
+ # {Errors} module and all extend {Errors::ServiceError}.
33
38
  #
34
39
  # begin
35
40
  # # do stuff
36
41
  # rescue Aws::ConnectParticipant::Errors::ServiceError
37
- # # rescues all service API errors
42
+ # # rescues all Amazon Connect Participant Service API errors
38
43
  # end
39
44
  #
40
45
  # See {Errors} for more information.
@@ -42,6 +47,6 @@ require_relative 'aws-sdk-connectparticipant/customizations'
42
47
  # @service
43
48
  module Aws::ConnectParticipant
44
49
 
45
- GEM_VERSION = '1.0.0'
50
+ GEM_VERSION = '1.5.0'
46
51
 
47
52
  end
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -24,12 +26,25 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
24
26
  require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
25
27
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
26
28
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
+ require 'aws-sdk-core/plugins/http_checksum.rb'
27
30
  require 'aws-sdk-core/plugins/signature_v4.rb'
28
31
  require 'aws-sdk-core/plugins/protocols/rest_json.rb'
29
32
 
30
33
  Aws::Plugins::GlobalConfiguration.add_identifier(:connectparticipant)
31
34
 
32
35
  module Aws::ConnectParticipant
36
+ # An API client for ConnectParticipant. To construct a client, you need to configure a `:region` and `:credentials`.
37
+ #
38
+ # client = Aws::ConnectParticipant::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.
33
48
  class Client < Seahorse::Client::Base
34
49
 
35
50
  include Aws::ClientStubs
@@ -57,6 +72,7 @@ module Aws::ConnectParticipant
57
72
  add_plugin(Aws::Plugins::ClientMetricsPlugin)
58
73
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
59
74
  add_plugin(Aws::Plugins::TransferEncoding)
75
+ add_plugin(Aws::Plugins::HttpChecksum)
60
76
  add_plugin(Aws::Plugins::SignatureV4)
61
77
  add_plugin(Aws::Plugins::Protocols::RestJson)
62
78
 
@@ -93,7 +109,7 @@ module Aws::ConnectParticipant
93
109
  # @option options [required, String] :region
94
110
  # The AWS region to connect to. The configured `:region` is
95
111
  # used to determine the service `:endpoint`. When not passed,
96
- # a default `:region` is search for in the following locations:
112
+ # a default `:region` is searched for in the following locations:
97
113
  #
98
114
  # * `Aws.config[:region]`
99
115
  # * `ENV['AWS_REGION']`
@@ -108,6 +124,12 @@ module Aws::ConnectParticipant
108
124
  # When set to `true`, a thread polling for endpoints will be running in
109
125
  # the background every 60 secs (default). Defaults to `false`.
110
126
  #
127
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
128
+ # Used only in `adaptive` retry mode. When true, the request will sleep
129
+ # until there is sufficent client side capacity to retry the request.
130
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
131
+ # not retry instead of sleeping.
132
+ #
111
133
  # @option options [Boolean] :client_side_monitoring (false)
112
134
  # When `true`, client-side metrics will be collected for all API requests from
113
135
  # this client.
@@ -132,6 +154,10 @@ module Aws::ConnectParticipant
132
154
  # When `true`, an attempt is made to coerce request parameters into
133
155
  # the required types.
134
156
  #
157
+ # @option options [Boolean] :correct_clock_skew (true)
158
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
159
+ # a clock skew correction and retry requests with skewed client clocks.
160
+ #
135
161
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
162
  # Set to true to disable SDK automatically adding host prefix
137
163
  # to default service endpoint when available.
@@ -139,7 +165,7 @@ module Aws::ConnectParticipant
139
165
  # @option options [String] :endpoint
140
166
  # The client endpoint is normally constructed from the `:region`
141
167
  # option. You should only configure an `:endpoint` when connecting
142
- # to test endpoints. This should be avalid HTTP(S) URI.
168
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
143
169
  #
144
170
  # @option options [Integer] :endpoint_cache_max_entries (1000)
145
171
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +180,7 @@ module Aws::ConnectParticipant
154
180
  # requests fetching endpoints information. Defaults to 60 sec.
155
181
  #
156
182
  # @option options [Boolean] :endpoint_discovery (false)
157
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
183
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
158
184
  #
159
185
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
186
  # The log formatter.
@@ -166,15 +192,29 @@ module Aws::ConnectParticipant
166
192
  # The Logger instance to send log messages to. If this option
167
193
  # is not set, logging will be disabled.
168
194
  #
195
+ # @option options [Integer] :max_attempts (3)
196
+ # An integer representing the maximum number attempts that will be made for
197
+ # a single request, including the initial attempt. For example,
198
+ # setting this value to 5 will result in a request being retried up to
199
+ # 4 times. Used in `standard` and `adaptive` retry modes.
200
+ #
169
201
  # @option options [String] :profile ("default")
170
202
  # Used when loading credentials from the shared credentials file
171
203
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
204
  #
205
+ # @option options [Proc] :retry_backoff
206
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
207
+ # This option is only used in the `legacy` retry mode.
208
+ #
173
209
  # @option options [Float] :retry_base_delay (0.3)
174
- # The base delay in seconds used by the default backoff function.
210
+ # The base delay in seconds used by the default backoff function. This option
211
+ # is only used in the `legacy` retry mode.
175
212
  #
176
213
  # @option options [Symbol] :retry_jitter (:none)
177
- # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
214
+ # A delay randomiser function used by the default backoff function.
215
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
216
+ # otherwise a Proc that takes and returns a number. This option is only used
217
+ # in the `legacy` retry mode.
178
218
  #
179
219
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
220
  #
@@ -182,11 +222,30 @@ module Aws::ConnectParticipant
182
222
  # The maximum number of times to retry failed requests. Only
183
223
  # ~ 500 level server errors and certain ~ 400 level client errors
184
224
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # errors from expired credentials.
225
+ # checksum errors, networking errors, timeout errors, auth errors,
226
+ # endpoint discovery, and errors from expired credentials.
227
+ # This option is only used in the `legacy` retry mode.
187
228
  #
188
229
  # @option options [Integer] :retry_max_delay (0)
189
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
230
+ # The maximum number of seconds to delay between retries (0 for no limit)
231
+ # used by the default backoff function. This option is only used in the
232
+ # `legacy` retry mode.
233
+ #
234
+ # @option options [String] :retry_mode ("legacy")
235
+ # Specifies which retry algorithm to use. Values are:
236
+ #
237
+ # * `legacy` - The pre-existing retry behavior. This is default value if
238
+ # no retry mode is provided.
239
+ #
240
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
241
+ # This includes support for retry quotas, which limit the number of
242
+ # unsuccessful retries a client can make.
243
+ #
244
+ # * `adaptive` - An experimental retry mode that includes all the
245
+ # functionality of `standard` mode along with automatic client side
246
+ # throttling. This is a provisional mode that may change behavior
247
+ # in the future.
248
+ #
190
249
  #
191
250
  # @option options [String] :secret_access_key
192
251
  #
@@ -209,16 +268,15 @@ module Aws::ConnectParticipant
209
268
  # requests through. Formatted like 'http://proxy.com:123'.
210
269
  #
211
270
  # @option options [Float] :http_open_timeout (15) The number of
212
- # seconds to wait when opening a HTTP session before rasing a
271
+ # seconds to wait when opening a HTTP session before raising a
213
272
  # `Timeout::Error`.
214
273
  #
215
274
  # @option options [Integer] :http_read_timeout (60) The default
216
275
  # number of seconds to wait for response data. This value can
217
- # safely be set
218
- # per-request on the session yeidled by {#session_for}.
276
+ # safely be set per-request on the session.
219
277
  #
220
278
  # @option options [Float] :http_idle_timeout (5) The number of
221
- # seconds a connection is allowed to sit idble before it is
279
+ # seconds a connection is allowed to sit idle before it is
222
280
  # considered stale. Stale connections are closed and removed
223
281
  # from the pool before making a request.
224
282
  #
@@ -227,7 +285,7 @@ module Aws::ConnectParticipant
227
285
  # request body. This option has no effect unless the request has
228
286
  # "Expect" header set to "100-continue". Defaults to `nil` which
229
287
  # disables this behaviour. This value can safely be set per
230
- # request on the session yeidled by {#session_for}.
288
+ # request on the session.
231
289
  #
232
290
  # @option options [Boolean] :http_wire_trace (false) When `true`,
233
291
  # HTTP debug output will be sent to the `:logger`.
@@ -378,6 +436,8 @@ module Aws::ConnectParticipant
378
436
  # * {Types::GetTranscriptResponse#transcript #transcript} => Array&lt;Types::Item&gt;
379
437
  # * {Types::GetTranscriptResponse#next_token #next_token} => String
380
438
  #
439
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
440
+ #
381
441
  # @example Request syntax with placeholder values
382
442
  #
383
443
  # resp = client.get_transcript({
@@ -530,7 +590,7 @@ module Aws::ConnectParticipant
530
590
  params: params,
531
591
  config: config)
532
592
  context[:gem_name] = 'aws-sdk-connectparticipant'
533
- context[:gem_version] = '1.0.0'
593
+ context[:gem_version] = '1.5.0'
534
594
  Seahorse::Client::Request.new(handlers, context)
535
595
  end
536
596
 
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -6,6 +8,32 @@
6
8
  # WARNING ABOUT GENERATED CODE
7
9
 
8
10
  module Aws::ConnectParticipant
11
+
12
+ # When ConnectParticipant returns an error response, the Ruby SDK constructs and raises an error.
13
+ # These errors all extend Aws::ConnectParticipant::Errors::ServiceError < {Aws::Errors::ServiceError}
14
+ #
15
+ # You can rescue all ConnectParticipant errors using ServiceError:
16
+ #
17
+ # begin
18
+ # # do stuff
19
+ # rescue Aws::ConnectParticipant::Errors::ServiceError
20
+ # # rescues all ConnectParticipant 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
+ # * {InternalServerException}
32
+ # * {ThrottlingException}
33
+ # * {ValidationException}
34
+ #
35
+ # Additionally, error classes are dynamically generated for service errors based on the error code
36
+ # if they are not defined above.
9
37
  module Errors
10
38
 
11
39
  extend Aws::Errors::DynamicErrors
@@ -23,7 +51,6 @@ module Aws::ConnectParticipant
23
51
  def message
24
52
  @message || @data[:message]
25
53
  end
26
-
27
54
  end
28
55
 
29
56
  class InternalServerException < ServiceError
@@ -39,7 +66,6 @@ module Aws::ConnectParticipant
39
66
  def message
40
67
  @message || @data[:message]
41
68
  end
42
-
43
69
  end
44
70
 
45
71
  class ThrottlingException < ServiceError
@@ -55,7 +81,6 @@ module Aws::ConnectParticipant
55
81
  def message
56
82
  @message || @data[:message]
57
83
  end
58
-
59
84
  end
60
85
 
61
86
  class ValidationException < ServiceError
@@ -71,7 +96,6 @@ module Aws::ConnectParticipant
71
96
  def message
72
97
  @message || @data[:message]
73
98
  end
74
-
75
99
  end
76
100
 
77
101
  end
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -6,6 +8,7 @@
6
8
  # WARNING ABOUT GENERATED CODE
7
9
 
8
10
  module Aws::ConnectParticipant
11
+
9
12
  class Resource
10
13
 
11
14
  # @param options ({})
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -17,6 +19,7 @@ module Aws::ConnectParticipant
17
19
  #
18
20
  class AccessDeniedException < Struct.new(
19
21
  :message)
22
+ SENSITIVE = []
20
23
  include Aws::Structure
21
24
  end
22
25
 
@@ -38,6 +41,7 @@ module Aws::ConnectParticipant
38
41
  class ConnectionCredentials < Struct.new(
39
42
  :connection_token,
40
43
  :expiry)
44
+ SENSITIVE = []
41
45
  include Aws::Structure
42
46
  end
43
47
 
@@ -67,6 +71,7 @@ module Aws::ConnectParticipant
67
71
  class CreateParticipantConnectionRequest < Struct.new(
68
72
  :type,
69
73
  :participant_token)
74
+ SENSITIVE = []
70
75
  include Aws::Structure
71
76
  end
72
77
 
@@ -84,6 +89,7 @@ module Aws::ConnectParticipant
84
89
  class CreateParticipantConnectionResponse < Struct.new(
85
90
  :websocket,
86
91
  :connection_credentials)
92
+ SENSITIVE = []
87
93
  include Aws::Structure
88
94
  end
89
95
 
@@ -113,6 +119,7 @@ module Aws::ConnectParticipant
113
119
  class DisconnectParticipantRequest < Struct.new(
114
120
  :client_token,
115
121
  :connection_token)
122
+ SENSITIVE = []
116
123
  include Aws::Structure
117
124
  end
118
125
 
@@ -180,6 +187,7 @@ module Aws::ConnectParticipant
180
187
  :sort_order,
181
188
  :start_position,
182
189
  :connection_token)
190
+ SENSITIVE = []
183
191
  include Aws::Structure
184
192
  end
185
193
 
@@ -202,6 +210,7 @@ module Aws::ConnectParticipant
202
210
  :initial_contact_id,
203
211
  :transcript,
204
212
  :next_token)
213
+ SENSITIVE = []
205
214
  include Aws::Structure
206
215
  end
207
216
 
@@ -215,6 +224,7 @@ module Aws::ConnectParticipant
215
224
  #
216
225
  class InternalServerException < Struct.new(
217
226
  :message)
227
+ SENSITIVE = []
218
228
  include Aws::Structure
219
229
  end
220
230
 
@@ -267,6 +277,7 @@ module Aws::ConnectParticipant
267
277
  :participant_id,
268
278
  :display_name,
269
279
  :participant_role)
280
+ SENSITIVE = []
270
281
  include Aws::Structure
271
282
  end
272
283
 
@@ -313,6 +324,7 @@ module Aws::ConnectParticipant
313
324
  :content,
314
325
  :client_token,
315
326
  :connection_token)
327
+ SENSITIVE = []
316
328
  include Aws::Structure
317
329
  end
318
330
 
@@ -332,6 +344,7 @@ module Aws::ConnectParticipant
332
344
  class SendEventResponse < Struct.new(
333
345
  :id,
334
346
  :absolute_time)
347
+ SENSITIVE = []
335
348
  include Aws::Structure
336
349
  end
337
350
 
@@ -372,6 +385,7 @@ module Aws::ConnectParticipant
372
385
  :content,
373
386
  :client_token,
374
387
  :connection_token)
388
+ SENSITIVE = []
375
389
  include Aws::Structure
376
390
  end
377
391
 
@@ -391,6 +405,7 @@ module Aws::ConnectParticipant
391
405
  class SendMessageResponse < Struct.new(
392
406
  :id,
393
407
  :absolute_time)
408
+ SENSITIVE = []
394
409
  include Aws::Structure
395
410
  end
396
411
 
@@ -428,6 +443,7 @@ module Aws::ConnectParticipant
428
443
  :id,
429
444
  :absolute_time,
430
445
  :most_recent)
446
+ SENSITIVE = []
431
447
  include Aws::Structure
432
448
  end
433
449
 
@@ -440,6 +456,7 @@ module Aws::ConnectParticipant
440
456
  #
441
457
  class ThrottlingException < Struct.new(
442
458
  :message)
459
+ SENSITIVE = []
443
460
  include Aws::Structure
444
461
  end
445
462
 
@@ -453,6 +470,7 @@ module Aws::ConnectParticipant
453
470
  #
454
471
  class ValidationException < Struct.new(
455
472
  :message)
473
+ SENSITIVE = []
456
474
  include Aws::Structure
457
475
  end
458
476
 
@@ -474,6 +492,7 @@ module Aws::ConnectParticipant
474
492
  class Websocket < Struct.new(
475
493
  :url,
476
494
  :connection_expiry)
495
+ SENSITIVE = []
477
496
  include Aws::Structure
478
497
  end
479
498
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-connectparticipant
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.5.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-11-21 00:00:00.000000000 Z
11
+ date: 2020-06-23 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.71.0
22
+ version: 3.99.0
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
29
29
  version: '3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 3.71.0
32
+ version: 3.99.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
81
81
  version: '0'
82
82
  requirements: []
83
83
  rubyforge_project:
84
- rubygems_version: 2.5.2.3
84
+ rubygems_version: 2.7.6.2
85
85
  signing_key:
86
86
  specification_version: 4
87
87
  summary: AWS SDK for Ruby - Amazon Connect Participant