aws-sdk-connect 1.32.0 → 1.37.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-connect.rb +2 -2
- data/lib/aws-sdk-connect/client.rb +1556 -52
- data/lib/aws-sdk-connect/client_api.rb +1008 -0
- data/lib/aws-sdk-connect/errors.rb +58 -0
- data/lib/aws-sdk-connect/types.rb +2383 -218
- metadata +4 -4
@@ -37,7 +37,10 @@ module Aws::Connect
|
|
37
37
|
# * {InvalidRequestException}
|
38
38
|
# * {LimitExceededException}
|
39
39
|
# * {OutboundContactNotPermittedException}
|
40
|
+
# * {ResourceConflictException}
|
41
|
+
# * {ResourceInUseException}
|
40
42
|
# * {ResourceNotFoundException}
|
43
|
+
# * {ServiceQuotaExceededException}
|
41
44
|
# * {ThrottlingException}
|
42
45
|
# * {UserNotFoundException}
|
43
46
|
#
|
@@ -197,6 +200,46 @@ module Aws::Connect
|
|
197
200
|
end
|
198
201
|
end
|
199
202
|
|
203
|
+
class ResourceConflictException < ServiceError
|
204
|
+
|
205
|
+
# @param [Seahorse::Client::RequestContext] context
|
206
|
+
# @param [String] message
|
207
|
+
# @param [Aws::Connect::Types::ResourceConflictException] data
|
208
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
209
|
+
super(context, message, data)
|
210
|
+
end
|
211
|
+
|
212
|
+
# @return [String]
|
213
|
+
def message
|
214
|
+
@message || @data[:message]
|
215
|
+
end
|
216
|
+
end
|
217
|
+
|
218
|
+
class ResourceInUseException < ServiceError
|
219
|
+
|
220
|
+
# @param [Seahorse::Client::RequestContext] context
|
221
|
+
# @param [String] message
|
222
|
+
# @param [Aws::Connect::Types::ResourceInUseException] data
|
223
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
224
|
+
super(context, message, data)
|
225
|
+
end
|
226
|
+
|
227
|
+
# @return [String]
|
228
|
+
def message
|
229
|
+
@message || @data[:message]
|
230
|
+
end
|
231
|
+
|
232
|
+
# @return [String]
|
233
|
+
def resource_type
|
234
|
+
@data[:resource_type]
|
235
|
+
end
|
236
|
+
|
237
|
+
# @return [String]
|
238
|
+
def resource_id
|
239
|
+
@data[:resource_id]
|
240
|
+
end
|
241
|
+
end
|
242
|
+
|
200
243
|
class ResourceNotFoundException < ServiceError
|
201
244
|
|
202
245
|
# @param [Seahorse::Client::RequestContext] context
|
@@ -212,6 +255,21 @@ module Aws::Connect
|
|
212
255
|
end
|
213
256
|
end
|
214
257
|
|
258
|
+
class ServiceQuotaExceededException < ServiceError
|
259
|
+
|
260
|
+
# @param [Seahorse::Client::RequestContext] context
|
261
|
+
# @param [String] message
|
262
|
+
# @param [Aws::Connect::Types::ServiceQuotaExceededException] data
|
263
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
264
|
+
super(context, message, data)
|
265
|
+
end
|
266
|
+
|
267
|
+
# @return [String]
|
268
|
+
def message
|
269
|
+
@message || @data[:message]
|
270
|
+
end
|
271
|
+
end
|
272
|
+
|
215
273
|
class ThrottlingException < ServiceError
|
216
274
|
|
217
275
|
# @param [Seahorse::Client::RequestContext] context
|
@@ -10,6 +10,154 @@
|
|
10
10
|
module Aws::Connect
|
11
11
|
module Types
|
12
12
|
|
13
|
+
# @note When making an API call, you may pass AssociateApprovedOriginRequest
|
14
|
+
# data as a hash:
|
15
|
+
#
|
16
|
+
# {
|
17
|
+
# instance_id: "InstanceId", # required
|
18
|
+
# origin: "Origin", # required
|
19
|
+
# }
|
20
|
+
#
|
21
|
+
# @!attribute [rw] instance_id
|
22
|
+
# The identifier of the Amazon Connect instance.
|
23
|
+
# @return [String]
|
24
|
+
#
|
25
|
+
# @!attribute [rw] origin
|
26
|
+
# The domain to add to your allow list.
|
27
|
+
# @return [String]
|
28
|
+
#
|
29
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateApprovedOriginRequest AWS API Documentation
|
30
|
+
#
|
31
|
+
class AssociateApprovedOriginRequest < Struct.new(
|
32
|
+
:instance_id,
|
33
|
+
:origin)
|
34
|
+
SENSITIVE = []
|
35
|
+
include Aws::Structure
|
36
|
+
end
|
37
|
+
|
38
|
+
# @note When making an API call, you may pass AssociateInstanceStorageConfigRequest
|
39
|
+
# data as a hash:
|
40
|
+
#
|
41
|
+
# {
|
42
|
+
# instance_id: "InstanceId", # required
|
43
|
+
# resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS
|
44
|
+
# storage_config: { # required
|
45
|
+
# association_id: "AssociationId",
|
46
|
+
# storage_type: "S3", # required, accepts S3, KINESIS_VIDEO_STREAM, KINESIS_STREAM, KINESIS_FIREHOSE
|
47
|
+
# s3_config: {
|
48
|
+
# bucket_name: "BucketName", # required
|
49
|
+
# bucket_prefix: "Prefix", # required
|
50
|
+
# encryption_config: {
|
51
|
+
# encryption_type: "KMS", # required, accepts KMS
|
52
|
+
# key_id: "KeyId", # required
|
53
|
+
# },
|
54
|
+
# },
|
55
|
+
# kinesis_video_stream_config: {
|
56
|
+
# prefix: "Prefix", # required
|
57
|
+
# retention_period_hours: 1, # required
|
58
|
+
# encryption_config: { # required
|
59
|
+
# encryption_type: "KMS", # required, accepts KMS
|
60
|
+
# key_id: "KeyId", # required
|
61
|
+
# },
|
62
|
+
# },
|
63
|
+
# kinesis_stream_config: {
|
64
|
+
# stream_arn: "ARN", # required
|
65
|
+
# },
|
66
|
+
# kinesis_firehose_config: {
|
67
|
+
# firehose_arn: "ARN", # required
|
68
|
+
# },
|
69
|
+
# },
|
70
|
+
# }
|
71
|
+
#
|
72
|
+
# @!attribute [rw] instance_id
|
73
|
+
# The identifier of the Amazon Connect instance.
|
74
|
+
# @return [String]
|
75
|
+
#
|
76
|
+
# @!attribute [rw] resource_type
|
77
|
+
# A valid resource type.
|
78
|
+
# @return [String]
|
79
|
+
#
|
80
|
+
# @!attribute [rw] storage_config
|
81
|
+
# A valid storage type.
|
82
|
+
# @return [Types::InstanceStorageConfig]
|
83
|
+
#
|
84
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateInstanceStorageConfigRequest AWS API Documentation
|
85
|
+
#
|
86
|
+
class AssociateInstanceStorageConfigRequest < Struct.new(
|
87
|
+
:instance_id,
|
88
|
+
:resource_type,
|
89
|
+
:storage_config)
|
90
|
+
SENSITIVE = []
|
91
|
+
include Aws::Structure
|
92
|
+
end
|
93
|
+
|
94
|
+
# @!attribute [rw] association_id
|
95
|
+
# The existing association identifier that uniquely identifies the
|
96
|
+
# resource type and storage config for the given instance ID.
|
97
|
+
# @return [String]
|
98
|
+
#
|
99
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateInstanceStorageConfigResponse AWS API Documentation
|
100
|
+
#
|
101
|
+
class AssociateInstanceStorageConfigResponse < Struct.new(
|
102
|
+
:association_id)
|
103
|
+
SENSITIVE = []
|
104
|
+
include Aws::Structure
|
105
|
+
end
|
106
|
+
|
107
|
+
# @note When making an API call, you may pass AssociateLambdaFunctionRequest
|
108
|
+
# data as a hash:
|
109
|
+
#
|
110
|
+
# {
|
111
|
+
# instance_id: "InstanceId", # required
|
112
|
+
# function_arn: "FunctionArn", # required
|
113
|
+
# }
|
114
|
+
#
|
115
|
+
# @!attribute [rw] instance_id
|
116
|
+
# The identifier of the Amazon Connect instance.
|
117
|
+
# @return [String]
|
118
|
+
#
|
119
|
+
# @!attribute [rw] function_arn
|
120
|
+
# The Amazon Resource Name (ARN) for the Lambda function being
|
121
|
+
# associated. Maximum number of characters allowed is 140.
|
122
|
+
# @return [String]
|
123
|
+
#
|
124
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateLambdaFunctionRequest AWS API Documentation
|
125
|
+
#
|
126
|
+
class AssociateLambdaFunctionRequest < Struct.new(
|
127
|
+
:instance_id,
|
128
|
+
:function_arn)
|
129
|
+
SENSITIVE = []
|
130
|
+
include Aws::Structure
|
131
|
+
end
|
132
|
+
|
133
|
+
# @note When making an API call, you may pass AssociateLexBotRequest
|
134
|
+
# data as a hash:
|
135
|
+
#
|
136
|
+
# {
|
137
|
+
# instance_id: "InstanceId", # required
|
138
|
+
# lex_bot: { # required
|
139
|
+
# name: "BotName",
|
140
|
+
# lex_region: "LexRegion",
|
141
|
+
# },
|
142
|
+
# }
|
143
|
+
#
|
144
|
+
# @!attribute [rw] instance_id
|
145
|
+
# The identifier of the Amazon Connect instance.
|
146
|
+
# @return [String]
|
147
|
+
#
|
148
|
+
# @!attribute [rw] lex_bot
|
149
|
+
# The Amazon Lex box to associate with the instance.
|
150
|
+
# @return [Types::LexBot]
|
151
|
+
#
|
152
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateLexBotRequest AWS API Documentation
|
153
|
+
#
|
154
|
+
class AssociateLexBotRequest < Struct.new(
|
155
|
+
:instance_id,
|
156
|
+
:lex_bot)
|
157
|
+
SENSITIVE = []
|
158
|
+
include Aws::Structure
|
159
|
+
end
|
160
|
+
|
13
161
|
# @note When making an API call, you may pass AssociateRoutingProfileQueuesRequest
|
14
162
|
# data as a hash:
|
15
163
|
#
|
@@ -20,7 +168,7 @@ module Aws::Connect
|
|
20
168
|
# {
|
21
169
|
# queue_reference: { # required
|
22
170
|
# queue_id: "QueueId", # required
|
23
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
171
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
24
172
|
# },
|
25
173
|
# priority: 1, # required
|
26
174
|
# delay: 1, # required
|
@@ -50,6 +198,63 @@ module Aws::Connect
|
|
50
198
|
include Aws::Structure
|
51
199
|
end
|
52
200
|
|
201
|
+
# @note When making an API call, you may pass AssociateSecurityKeyRequest
|
202
|
+
# data as a hash:
|
203
|
+
#
|
204
|
+
# {
|
205
|
+
# instance_id: "InstanceId", # required
|
206
|
+
# key: "PEM", # required
|
207
|
+
# }
|
208
|
+
#
|
209
|
+
# @!attribute [rw] instance_id
|
210
|
+
# The identifier of the Amazon Connect instance.
|
211
|
+
# @return [String]
|
212
|
+
#
|
213
|
+
# @!attribute [rw] key
|
214
|
+
# A valid security key in PEM format.
|
215
|
+
# @return [String]
|
216
|
+
#
|
217
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateSecurityKeyRequest AWS API Documentation
|
218
|
+
#
|
219
|
+
class AssociateSecurityKeyRequest < Struct.new(
|
220
|
+
:instance_id,
|
221
|
+
:key)
|
222
|
+
SENSITIVE = []
|
223
|
+
include Aws::Structure
|
224
|
+
end
|
225
|
+
|
226
|
+
# @!attribute [rw] association_id
|
227
|
+
# The existing association identifier that uniquely identifies the
|
228
|
+
# resource type and storage config for the given instance ID.
|
229
|
+
# @return [String]
|
230
|
+
#
|
231
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateSecurityKeyResponse AWS API Documentation
|
232
|
+
#
|
233
|
+
class AssociateSecurityKeyResponse < Struct.new(
|
234
|
+
:association_id)
|
235
|
+
SENSITIVE = []
|
236
|
+
include Aws::Structure
|
237
|
+
end
|
238
|
+
|
239
|
+
# A toggle for an individual feature at the instance level.
|
240
|
+
#
|
241
|
+
# @!attribute [rw] attribute_type
|
242
|
+
# The type of attribute.
|
243
|
+
# @return [String]
|
244
|
+
#
|
245
|
+
# @!attribute [rw] value
|
246
|
+
# The value of the attribute.
|
247
|
+
# @return [String]
|
248
|
+
#
|
249
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Attribute AWS API Documentation
|
250
|
+
#
|
251
|
+
class Attribute < Struct.new(
|
252
|
+
:attribute_type,
|
253
|
+
:value)
|
254
|
+
SENSITIVE = []
|
255
|
+
include Aws::Structure
|
256
|
+
end
|
257
|
+
|
53
258
|
# A chat message.
|
54
259
|
#
|
55
260
|
# @note When making an API call, you may pass ChatMessage
|
@@ -142,6 +347,13 @@ module Aws::Connect
|
|
142
347
|
|
143
348
|
# Contains summary information about a contact flow.
|
144
349
|
#
|
350
|
+
# You can also create and update contact flows using the [Amazon Connect
|
351
|
+
# Flow language][1].
|
352
|
+
#
|
353
|
+
#
|
354
|
+
#
|
355
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html
|
356
|
+
#
|
145
357
|
# @!attribute [rw] id
|
146
358
|
# The identifier of the contact flow.
|
147
359
|
# @return [String]
|
@@ -257,6 +469,138 @@ module Aws::Connect
|
|
257
469
|
include Aws::Structure
|
258
470
|
end
|
259
471
|
|
472
|
+
# @note When making an API call, you may pass CreateInstanceRequest
|
473
|
+
# data as a hash:
|
474
|
+
#
|
475
|
+
# {
|
476
|
+
# client_token: "ClientToken",
|
477
|
+
# identity_management_type: "SAML", # required, accepts SAML, CONNECT_MANAGED, EXISTING_DIRECTORY
|
478
|
+
# instance_alias: "DirectoryAlias",
|
479
|
+
# directory_id: "DirectoryId",
|
480
|
+
# inbound_calls_enabled: false, # required
|
481
|
+
# outbound_calls_enabled: false, # required
|
482
|
+
# }
|
483
|
+
#
|
484
|
+
# @!attribute [rw] client_token
|
485
|
+
# The idempotency token.
|
486
|
+
# @return [String]
|
487
|
+
#
|
488
|
+
# @!attribute [rw] identity_management_type
|
489
|
+
# The type of identity management for your Amazon Connect users.
|
490
|
+
# @return [String]
|
491
|
+
#
|
492
|
+
# @!attribute [rw] instance_alias
|
493
|
+
# The name for your instance.
|
494
|
+
# @return [String]
|
495
|
+
#
|
496
|
+
# @!attribute [rw] directory_id
|
497
|
+
# The identifier for the directory.
|
498
|
+
# @return [String]
|
499
|
+
#
|
500
|
+
# @!attribute [rw] inbound_calls_enabled
|
501
|
+
# Whether your contact center handles incoming contacts.
|
502
|
+
# @return [Boolean]
|
503
|
+
#
|
504
|
+
# @!attribute [rw] outbound_calls_enabled
|
505
|
+
# Whether your contact center allows outbound calls.
|
506
|
+
# @return [Boolean]
|
507
|
+
#
|
508
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateInstanceRequest AWS API Documentation
|
509
|
+
#
|
510
|
+
class CreateInstanceRequest < Struct.new(
|
511
|
+
:client_token,
|
512
|
+
:identity_management_type,
|
513
|
+
:instance_alias,
|
514
|
+
:directory_id,
|
515
|
+
:inbound_calls_enabled,
|
516
|
+
:outbound_calls_enabled)
|
517
|
+
SENSITIVE = [:instance_alias]
|
518
|
+
include Aws::Structure
|
519
|
+
end
|
520
|
+
|
521
|
+
# @!attribute [rw] id
|
522
|
+
# The identifier for the instance.
|
523
|
+
# @return [String]
|
524
|
+
#
|
525
|
+
# @!attribute [rw] arn
|
526
|
+
# The Amazon Resource Name (ARN) of the instance.
|
527
|
+
# @return [String]
|
528
|
+
#
|
529
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateInstanceResponse AWS API Documentation
|
530
|
+
#
|
531
|
+
class CreateInstanceResponse < Struct.new(
|
532
|
+
:id,
|
533
|
+
:arn)
|
534
|
+
SENSITIVE = []
|
535
|
+
include Aws::Structure
|
536
|
+
end
|
537
|
+
|
538
|
+
# @note When making an API call, you may pass CreateIntegrationAssociationRequest
|
539
|
+
# data as a hash:
|
540
|
+
#
|
541
|
+
# {
|
542
|
+
# instance_id: "InstanceId", # required
|
543
|
+
# integration_type: "EVENT", # required, accepts EVENT
|
544
|
+
# integration_arn: "ARN", # required
|
545
|
+
# source_application_url: "URI", # required
|
546
|
+
# source_application_name: "SourceApplicationName", # required
|
547
|
+
# source_type: "SALESFORCE", # required, accepts SALESFORCE, ZENDESK
|
548
|
+
# }
|
549
|
+
#
|
550
|
+
# @!attribute [rw] instance_id
|
551
|
+
# The identifier of the Amazon Connect instance.
|
552
|
+
# @return [String]
|
553
|
+
#
|
554
|
+
# @!attribute [rw] integration_type
|
555
|
+
# The type of information to be ingested.
|
556
|
+
# @return [String]
|
557
|
+
#
|
558
|
+
# @!attribute [rw] integration_arn
|
559
|
+
# The Amazon Resource Name (ARN) of the integration.
|
560
|
+
# @return [String]
|
561
|
+
#
|
562
|
+
# @!attribute [rw] source_application_url
|
563
|
+
# The URL for the external application.
|
564
|
+
# @return [String]
|
565
|
+
#
|
566
|
+
# @!attribute [rw] source_application_name
|
567
|
+
# The name of the external application.
|
568
|
+
# @return [String]
|
569
|
+
#
|
570
|
+
# @!attribute [rw] source_type
|
571
|
+
# The type of the data source.
|
572
|
+
# @return [String]
|
573
|
+
#
|
574
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateIntegrationAssociationRequest AWS API Documentation
|
575
|
+
#
|
576
|
+
class CreateIntegrationAssociationRequest < Struct.new(
|
577
|
+
:instance_id,
|
578
|
+
:integration_type,
|
579
|
+
:integration_arn,
|
580
|
+
:source_application_url,
|
581
|
+
:source_application_name,
|
582
|
+
:source_type)
|
583
|
+
SENSITIVE = []
|
584
|
+
include Aws::Structure
|
585
|
+
end
|
586
|
+
|
587
|
+
# @!attribute [rw] integration_association_id
|
588
|
+
# The identifier for the association.
|
589
|
+
# @return [String]
|
590
|
+
#
|
591
|
+
# @!attribute [rw] integration_association_arn
|
592
|
+
# The Amazon Resource Name (ARN) for the association.
|
593
|
+
# @return [String]
|
594
|
+
#
|
595
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateIntegrationAssociationResponse AWS API Documentation
|
596
|
+
#
|
597
|
+
class CreateIntegrationAssociationResponse < Struct.new(
|
598
|
+
:integration_association_id,
|
599
|
+
:integration_association_arn)
|
600
|
+
SENSITIVE = []
|
601
|
+
include Aws::Structure
|
602
|
+
end
|
603
|
+
|
260
604
|
# @note When making an API call, you may pass CreateRoutingProfileRequest
|
261
605
|
# data as a hash:
|
262
606
|
#
|
@@ -269,7 +613,7 @@ module Aws::Connect
|
|
269
613
|
# {
|
270
614
|
# queue_reference: { # required
|
271
615
|
# queue_id: "QueueId", # required
|
272
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
616
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
273
617
|
# },
|
274
618
|
# priority: 1, # required
|
275
619
|
# delay: 1, # required
|
@@ -277,7 +621,7 @@ module Aws::Connect
|
|
277
621
|
# ],
|
278
622
|
# media_concurrencies: [ # required
|
279
623
|
# {
|
280
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
624
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
281
625
|
# concurrency: 1, # required
|
282
626
|
# },
|
283
627
|
# ],
|
@@ -349,72 +693,172 @@ module Aws::Connect
|
|
349
693
|
include Aws::Structure
|
350
694
|
end
|
351
695
|
|
352
|
-
# @note When making an API call, you may pass
|
696
|
+
# @note When making an API call, you may pass CreateUseCaseRequest
|
353
697
|
# data as a hash:
|
354
698
|
#
|
355
699
|
# {
|
356
|
-
# username: "AgentUsername", # required
|
357
|
-
# password: "Password",
|
358
|
-
# identity_info: {
|
359
|
-
# first_name: "AgentFirstName",
|
360
|
-
# last_name: "AgentLastName",
|
361
|
-
# email: "Email",
|
362
|
-
# },
|
363
|
-
# phone_config: { # required
|
364
|
-
# phone_type: "SOFT_PHONE", # required, accepts SOFT_PHONE, DESK_PHONE
|
365
|
-
# auto_accept: false,
|
366
|
-
# after_contact_work_time_limit: 1,
|
367
|
-
# desk_phone_number: "PhoneNumber",
|
368
|
-
# },
|
369
|
-
# directory_user_id: "DirectoryUserId",
|
370
|
-
# security_profile_ids: ["SecurityProfileId"], # required
|
371
|
-
# routing_profile_id: "RoutingProfileId", # required
|
372
|
-
# hierarchy_group_id: "HierarchyGroupId",
|
373
700
|
# instance_id: "InstanceId", # required
|
374
|
-
#
|
375
|
-
#
|
376
|
-
# },
|
701
|
+
# integration_association_id: "IntegrationAssociationId", # required
|
702
|
+
# use_case_type: "RULES_EVALUATION", # required, accepts RULES_EVALUATION
|
377
703
|
# }
|
378
704
|
#
|
379
|
-
# @!attribute [rw]
|
380
|
-
# The
|
381
|
-
# identity management, the user name can include up to 20 characters.
|
382
|
-
# If you are using SAML for identity management, the user name can
|
383
|
-
# include up to 64 characters from \[a-zA-Z0-9\_-.\\@\]+.
|
705
|
+
# @!attribute [rw] instance_id
|
706
|
+
# The identifier of the Amazon Connect instance.
|
384
707
|
# @return [String]
|
385
708
|
#
|
386
|
-
# @!attribute [rw]
|
387
|
-
# The
|
388
|
-
# using Amazon Connect for identity management. Otherwise, it is an
|
389
|
-
# error to include a password.
|
709
|
+
# @!attribute [rw] integration_association_id
|
710
|
+
# The identifier for the AppIntegration association.
|
390
711
|
# @return [String]
|
391
712
|
#
|
392
|
-
# @!attribute [rw]
|
393
|
-
# The
|
394
|
-
#
|
395
|
-
#
|
396
|
-
# @!attribute [rw] phone_config
|
397
|
-
# The phone settings for the user.
|
398
|
-
# @return [Types::UserPhoneConfig]
|
399
|
-
#
|
400
|
-
# @!attribute [rw] directory_user_id
|
401
|
-
# The identifier of the user account in the directory used for
|
402
|
-
# identity management. If Amazon Connect cannot access the directory,
|
403
|
-
# you can specify this identifier to authenticate users. If you
|
404
|
-
# include the identifier, we assume that Amazon Connect cannot access
|
405
|
-
# the directory. Otherwise, the identity information is used to
|
406
|
-
# authenticate users from your directory.
|
407
|
-
#
|
408
|
-
# This parameter is required if you are using an existing directory
|
409
|
-
# for identity management in Amazon Connect when Amazon Connect cannot
|
410
|
-
# access your directory to authenticate users. If you are using SAML
|
411
|
-
# for identity management and include this parameter, an error is
|
412
|
-
# returned.
|
713
|
+
# @!attribute [rw] use_case_type
|
714
|
+
# The type of use case to associate to the AppIntegration association.
|
715
|
+
# Each AppIntegration association can have only one of each use case
|
716
|
+
# type.
|
413
717
|
# @return [String]
|
414
718
|
#
|
415
|
-
#
|
416
|
-
#
|
417
|
-
|
719
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUseCaseRequest AWS API Documentation
|
720
|
+
#
|
721
|
+
class CreateUseCaseRequest < Struct.new(
|
722
|
+
:instance_id,
|
723
|
+
:integration_association_id,
|
724
|
+
:use_case_type)
|
725
|
+
SENSITIVE = []
|
726
|
+
include Aws::Structure
|
727
|
+
end
|
728
|
+
|
729
|
+
# @!attribute [rw] use_case_id
|
730
|
+
# The identifier of the use case.
|
731
|
+
# @return [String]
|
732
|
+
#
|
733
|
+
# @!attribute [rw] use_case_arn
|
734
|
+
# The Amazon Resource Name (ARN) for the use case.
|
735
|
+
# @return [String]
|
736
|
+
#
|
737
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUseCaseResponse AWS API Documentation
|
738
|
+
#
|
739
|
+
class CreateUseCaseResponse < Struct.new(
|
740
|
+
:use_case_id,
|
741
|
+
:use_case_arn)
|
742
|
+
SENSITIVE = []
|
743
|
+
include Aws::Structure
|
744
|
+
end
|
745
|
+
|
746
|
+
# @note When making an API call, you may pass CreateUserHierarchyGroupRequest
|
747
|
+
# data as a hash:
|
748
|
+
#
|
749
|
+
# {
|
750
|
+
# name: "HierarchyGroupName", # required
|
751
|
+
# parent_group_id: "HierarchyGroupId",
|
752
|
+
# instance_id: "InstanceId", # required
|
753
|
+
# }
|
754
|
+
#
|
755
|
+
# @!attribute [rw] name
|
756
|
+
# The name of the user hierarchy group. Must not be more than 100
|
757
|
+
# characters.
|
758
|
+
# @return [String]
|
759
|
+
#
|
760
|
+
# @!attribute [rw] parent_group_id
|
761
|
+
# The identifier for the parent hierarchy group. The user hierarchy is
|
762
|
+
# created at level one if the parent group ID is null.
|
763
|
+
# @return [String]
|
764
|
+
#
|
765
|
+
# @!attribute [rw] instance_id
|
766
|
+
# The identifier of the Amazon Connect instance.
|
767
|
+
# @return [String]
|
768
|
+
#
|
769
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUserHierarchyGroupRequest AWS API Documentation
|
770
|
+
#
|
771
|
+
class CreateUserHierarchyGroupRequest < Struct.new(
|
772
|
+
:name,
|
773
|
+
:parent_group_id,
|
774
|
+
:instance_id)
|
775
|
+
SENSITIVE = []
|
776
|
+
include Aws::Structure
|
777
|
+
end
|
778
|
+
|
779
|
+
# @!attribute [rw] hierarchy_group_id
|
780
|
+
# The identifier of the hierarchy group.
|
781
|
+
# @return [String]
|
782
|
+
#
|
783
|
+
# @!attribute [rw] hierarchy_group_arn
|
784
|
+
# The Amazon Resource Name (ARN) of the hierarchy group.
|
785
|
+
# @return [String]
|
786
|
+
#
|
787
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUserHierarchyGroupResponse AWS API Documentation
|
788
|
+
#
|
789
|
+
class CreateUserHierarchyGroupResponse < Struct.new(
|
790
|
+
:hierarchy_group_id,
|
791
|
+
:hierarchy_group_arn)
|
792
|
+
SENSITIVE = []
|
793
|
+
include Aws::Structure
|
794
|
+
end
|
795
|
+
|
796
|
+
# @note When making an API call, you may pass CreateUserRequest
|
797
|
+
# data as a hash:
|
798
|
+
#
|
799
|
+
# {
|
800
|
+
# username: "AgentUsername", # required
|
801
|
+
# password: "Password",
|
802
|
+
# identity_info: {
|
803
|
+
# first_name: "AgentFirstName",
|
804
|
+
# last_name: "AgentLastName",
|
805
|
+
# email: "Email",
|
806
|
+
# },
|
807
|
+
# phone_config: { # required
|
808
|
+
# phone_type: "SOFT_PHONE", # required, accepts SOFT_PHONE, DESK_PHONE
|
809
|
+
# auto_accept: false,
|
810
|
+
# after_contact_work_time_limit: 1,
|
811
|
+
# desk_phone_number: "PhoneNumber",
|
812
|
+
# },
|
813
|
+
# directory_user_id: "DirectoryUserId",
|
814
|
+
# security_profile_ids: ["SecurityProfileId"], # required
|
815
|
+
# routing_profile_id: "RoutingProfileId", # required
|
816
|
+
# hierarchy_group_id: "HierarchyGroupId",
|
817
|
+
# instance_id: "InstanceId", # required
|
818
|
+
# tags: {
|
819
|
+
# "TagKey" => "TagValue",
|
820
|
+
# },
|
821
|
+
# }
|
822
|
+
#
|
823
|
+
# @!attribute [rw] username
|
824
|
+
# The user name for the account. For instances not using SAML for
|
825
|
+
# identity management, the user name can include up to 20 characters.
|
826
|
+
# If you are using SAML for identity management, the user name can
|
827
|
+
# include up to 64 characters from \[a-zA-Z0-9\_-.\\@\]+.
|
828
|
+
# @return [String]
|
829
|
+
#
|
830
|
+
# @!attribute [rw] password
|
831
|
+
# The password for the user account. A password is required if you are
|
832
|
+
# using Amazon Connect for identity management. Otherwise, it is an
|
833
|
+
# error to include a password.
|
834
|
+
# @return [String]
|
835
|
+
#
|
836
|
+
# @!attribute [rw] identity_info
|
837
|
+
# The information about the identity of the user.
|
838
|
+
# @return [Types::UserIdentityInfo]
|
839
|
+
#
|
840
|
+
# @!attribute [rw] phone_config
|
841
|
+
# The phone settings for the user.
|
842
|
+
# @return [Types::UserPhoneConfig]
|
843
|
+
#
|
844
|
+
# @!attribute [rw] directory_user_id
|
845
|
+
# The identifier of the user account in the directory used for
|
846
|
+
# identity management. If Amazon Connect cannot access the directory,
|
847
|
+
# you can specify this identifier to authenticate users. If you
|
848
|
+
# include the identifier, we assume that Amazon Connect cannot access
|
849
|
+
# the directory. Otherwise, the identity information is used to
|
850
|
+
# authenticate users from your directory.
|
851
|
+
#
|
852
|
+
# This parameter is required if you are using an existing directory
|
853
|
+
# for identity management in Amazon Connect when Amazon Connect cannot
|
854
|
+
# access your directory to authenticate users. If you are using SAML
|
855
|
+
# for identity management and include this parameter, an error is
|
856
|
+
# returned.
|
857
|
+
# @return [String]
|
858
|
+
#
|
859
|
+
# @!attribute [rw] security_profile_ids
|
860
|
+
# The identifier of the security profile for the user.
|
861
|
+
# @return [Array<String>]
|
418
862
|
#
|
419
863
|
# @!attribute [rw] routing_profile_id
|
420
864
|
# The identifier of the routing profile for the user.
|
@@ -569,6 +1013,106 @@ module Aws::Connect
|
|
569
1013
|
include Aws::Structure
|
570
1014
|
end
|
571
1015
|
|
1016
|
+
# @note When making an API call, you may pass DeleteInstanceRequest
|
1017
|
+
# data as a hash:
|
1018
|
+
#
|
1019
|
+
# {
|
1020
|
+
# instance_id: "InstanceId", # required
|
1021
|
+
# }
|
1022
|
+
#
|
1023
|
+
# @!attribute [rw] instance_id
|
1024
|
+
# The identifier of the Amazon Connect instance.
|
1025
|
+
# @return [String]
|
1026
|
+
#
|
1027
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteInstanceRequest AWS API Documentation
|
1028
|
+
#
|
1029
|
+
class DeleteInstanceRequest < Struct.new(
|
1030
|
+
:instance_id)
|
1031
|
+
SENSITIVE = []
|
1032
|
+
include Aws::Structure
|
1033
|
+
end
|
1034
|
+
|
1035
|
+
# @note When making an API call, you may pass DeleteIntegrationAssociationRequest
|
1036
|
+
# data as a hash:
|
1037
|
+
#
|
1038
|
+
# {
|
1039
|
+
# instance_id: "InstanceId", # required
|
1040
|
+
# integration_association_id: "IntegrationAssociationId", # required
|
1041
|
+
# }
|
1042
|
+
#
|
1043
|
+
# @!attribute [rw] instance_id
|
1044
|
+
# The identifier of the Amazon Connect instance.
|
1045
|
+
# @return [String]
|
1046
|
+
#
|
1047
|
+
# @!attribute [rw] integration_association_id
|
1048
|
+
# The identifier for the AppIntegration association.
|
1049
|
+
# @return [String]
|
1050
|
+
#
|
1051
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteIntegrationAssociationRequest AWS API Documentation
|
1052
|
+
#
|
1053
|
+
class DeleteIntegrationAssociationRequest < Struct.new(
|
1054
|
+
:instance_id,
|
1055
|
+
:integration_association_id)
|
1056
|
+
SENSITIVE = []
|
1057
|
+
include Aws::Structure
|
1058
|
+
end
|
1059
|
+
|
1060
|
+
# @note When making an API call, you may pass DeleteUseCaseRequest
|
1061
|
+
# data as a hash:
|
1062
|
+
#
|
1063
|
+
# {
|
1064
|
+
# instance_id: "InstanceId", # required
|
1065
|
+
# integration_association_id: "IntegrationAssociationId", # required
|
1066
|
+
# use_case_id: "UseCaseId", # required
|
1067
|
+
# }
|
1068
|
+
#
|
1069
|
+
# @!attribute [rw] instance_id
|
1070
|
+
# The identifier of the Amazon Connect instance.
|
1071
|
+
# @return [String]
|
1072
|
+
#
|
1073
|
+
# @!attribute [rw] integration_association_id
|
1074
|
+
# The identifier for the AppIntegration association.
|
1075
|
+
# @return [String]
|
1076
|
+
#
|
1077
|
+
# @!attribute [rw] use_case_id
|
1078
|
+
# The identifier for the use case.
|
1079
|
+
# @return [String]
|
1080
|
+
#
|
1081
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteUseCaseRequest AWS API Documentation
|
1082
|
+
#
|
1083
|
+
class DeleteUseCaseRequest < Struct.new(
|
1084
|
+
:instance_id,
|
1085
|
+
:integration_association_id,
|
1086
|
+
:use_case_id)
|
1087
|
+
SENSITIVE = []
|
1088
|
+
include Aws::Structure
|
1089
|
+
end
|
1090
|
+
|
1091
|
+
# @note When making an API call, you may pass DeleteUserHierarchyGroupRequest
|
1092
|
+
# data as a hash:
|
1093
|
+
#
|
1094
|
+
# {
|
1095
|
+
# hierarchy_group_id: "HierarchyGroupId", # required
|
1096
|
+
# instance_id: "InstanceId", # required
|
1097
|
+
# }
|
1098
|
+
#
|
1099
|
+
# @!attribute [rw] hierarchy_group_id
|
1100
|
+
# The identifier of the hierarchy group.
|
1101
|
+
# @return [String]
|
1102
|
+
#
|
1103
|
+
# @!attribute [rw] instance_id
|
1104
|
+
# The identifier of the Amazon Connect instance.
|
1105
|
+
# @return [String]
|
1106
|
+
#
|
1107
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteUserHierarchyGroupRequest AWS API Documentation
|
1108
|
+
#
|
1109
|
+
class DeleteUserHierarchyGroupRequest < Struct.new(
|
1110
|
+
:hierarchy_group_id,
|
1111
|
+
:instance_id)
|
1112
|
+
SENSITIVE = []
|
1113
|
+
include Aws::Structure
|
1114
|
+
end
|
1115
|
+
|
572
1116
|
# @note When making an API call, you may pass DeleteUserRequest
|
573
1117
|
# data as a hash:
|
574
1118
|
#
|
@@ -631,132 +1175,244 @@ module Aws::Connect
|
|
631
1175
|
include Aws::Structure
|
632
1176
|
end
|
633
1177
|
|
634
|
-
# @note When making an API call, you may pass
|
1178
|
+
# @note When making an API call, you may pass DescribeInstanceAttributeRequest
|
635
1179
|
# data as a hash:
|
636
1180
|
#
|
637
1181
|
# {
|
638
1182
|
# instance_id: "InstanceId", # required
|
639
|
-
#
|
1183
|
+
# attribute_type: "INBOUND_CALLS", # required, accepts INBOUND_CALLS, OUTBOUND_CALLS, CONTACTFLOW_LOGS, CONTACT_LENS, AUTO_RESOLVE_BEST_VOICES, USE_CUSTOM_TTS_VOICES, EARLY_MEDIA
|
640
1184
|
# }
|
641
1185
|
#
|
642
1186
|
# @!attribute [rw] instance_id
|
643
1187
|
# The identifier of the Amazon Connect instance.
|
644
1188
|
# @return [String]
|
645
1189
|
#
|
646
|
-
# @!attribute [rw]
|
647
|
-
# The
|
1190
|
+
# @!attribute [rw] attribute_type
|
1191
|
+
# The type of attribute.
|
648
1192
|
# @return [String]
|
649
1193
|
#
|
650
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
1194
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeInstanceAttributeRequest AWS API Documentation
|
651
1195
|
#
|
652
|
-
class
|
1196
|
+
class DescribeInstanceAttributeRequest < Struct.new(
|
653
1197
|
:instance_id,
|
654
|
-
:
|
1198
|
+
:attribute_type)
|
655
1199
|
SENSITIVE = []
|
656
1200
|
include Aws::Structure
|
657
1201
|
end
|
658
1202
|
|
659
|
-
# @!attribute [rw]
|
660
|
-
# The
|
661
|
-
# @return [Types::
|
1203
|
+
# @!attribute [rw] attribute
|
1204
|
+
# The type of attribute.
|
1205
|
+
# @return [Types::Attribute]
|
662
1206
|
#
|
663
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
1207
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeInstanceAttributeResponse AWS API Documentation
|
664
1208
|
#
|
665
|
-
class
|
666
|
-
:
|
1209
|
+
class DescribeInstanceAttributeResponse < Struct.new(
|
1210
|
+
:attribute)
|
667
1211
|
SENSITIVE = []
|
668
1212
|
include Aws::Structure
|
669
1213
|
end
|
670
1214
|
|
671
|
-
# @note When making an API call, you may pass
|
1215
|
+
# @note When making an API call, you may pass DescribeInstanceRequest
|
672
1216
|
# data as a hash:
|
673
1217
|
#
|
674
1218
|
# {
|
675
|
-
# hierarchy_group_id: "HierarchyGroupId", # required
|
676
1219
|
# instance_id: "InstanceId", # required
|
677
1220
|
# }
|
678
1221
|
#
|
679
|
-
# @!attribute [rw] hierarchy_group_id
|
680
|
-
# The identifier of the hierarchy group.
|
681
|
-
# @return [String]
|
682
|
-
#
|
683
1222
|
# @!attribute [rw] instance_id
|
684
1223
|
# The identifier of the Amazon Connect instance.
|
685
1224
|
# @return [String]
|
686
1225
|
#
|
687
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
1226
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeInstanceRequest AWS API Documentation
|
688
1227
|
#
|
689
|
-
class
|
690
|
-
:hierarchy_group_id,
|
1228
|
+
class DescribeInstanceRequest < Struct.new(
|
691
1229
|
:instance_id)
|
692
1230
|
SENSITIVE = []
|
693
1231
|
include Aws::Structure
|
694
1232
|
end
|
695
1233
|
|
696
|
-
# @!attribute [rw]
|
697
|
-
#
|
698
|
-
# @return [Types::
|
1234
|
+
# @!attribute [rw] instance
|
1235
|
+
# The name of the instance.
|
1236
|
+
# @return [Types::Instance]
|
699
1237
|
#
|
700
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
1238
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeInstanceResponse AWS API Documentation
|
701
1239
|
#
|
702
|
-
class
|
703
|
-
:
|
1240
|
+
class DescribeInstanceResponse < Struct.new(
|
1241
|
+
:instance)
|
704
1242
|
SENSITIVE = []
|
705
1243
|
include Aws::Structure
|
706
1244
|
end
|
707
1245
|
|
708
|
-
# @note When making an API call, you may pass
|
1246
|
+
# @note When making an API call, you may pass DescribeInstanceStorageConfigRequest
|
709
1247
|
# data as a hash:
|
710
1248
|
#
|
711
1249
|
# {
|
712
1250
|
# instance_id: "InstanceId", # required
|
1251
|
+
# association_id: "AssociationId", # required
|
1252
|
+
# resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS
|
713
1253
|
# }
|
714
1254
|
#
|
715
1255
|
# @!attribute [rw] instance_id
|
716
1256
|
# The identifier of the Amazon Connect instance.
|
717
1257
|
# @return [String]
|
718
1258
|
#
|
719
|
-
#
|
1259
|
+
# @!attribute [rw] association_id
|
1260
|
+
# The existing association identifier that uniquely identifies the
|
1261
|
+
# resource type and storage config for the given instance ID.
|
1262
|
+
# @return [String]
|
720
1263
|
#
|
721
|
-
|
722
|
-
|
1264
|
+
# @!attribute [rw] resource_type
|
1265
|
+
# A valid resource type.
|
1266
|
+
# @return [String]
|
1267
|
+
#
|
1268
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeInstanceStorageConfigRequest AWS API Documentation
|
1269
|
+
#
|
1270
|
+
class DescribeInstanceStorageConfigRequest < Struct.new(
|
1271
|
+
:instance_id,
|
1272
|
+
:association_id,
|
1273
|
+
:resource_type)
|
723
1274
|
SENSITIVE = []
|
724
1275
|
include Aws::Structure
|
725
1276
|
end
|
726
1277
|
|
727
|
-
# @!attribute [rw]
|
728
|
-
#
|
729
|
-
# @return [Types::
|
1278
|
+
# @!attribute [rw] storage_config
|
1279
|
+
# A valid storage type.
|
1280
|
+
# @return [Types::InstanceStorageConfig]
|
730
1281
|
#
|
731
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
1282
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeInstanceStorageConfigResponse AWS API Documentation
|
732
1283
|
#
|
733
|
-
class
|
734
|
-
:
|
1284
|
+
class DescribeInstanceStorageConfigResponse < Struct.new(
|
1285
|
+
:storage_config)
|
735
1286
|
SENSITIVE = []
|
736
1287
|
include Aws::Structure
|
737
1288
|
end
|
738
1289
|
|
739
|
-
# @note When making an API call, you may pass
|
1290
|
+
# @note When making an API call, you may pass DescribeRoutingProfileRequest
|
740
1291
|
# data as a hash:
|
741
1292
|
#
|
742
1293
|
# {
|
743
|
-
# user_id: "UserId", # required
|
744
1294
|
# instance_id: "InstanceId", # required
|
1295
|
+
# routing_profile_id: "RoutingProfileId", # required
|
745
1296
|
# }
|
746
1297
|
#
|
747
|
-
# @!attribute [rw] user_id
|
748
|
-
# The identifier of the user account.
|
749
|
-
# @return [String]
|
750
|
-
#
|
751
1298
|
# @!attribute [rw] instance_id
|
752
1299
|
# The identifier of the Amazon Connect instance.
|
753
1300
|
# @return [String]
|
754
1301
|
#
|
755
|
-
#
|
1302
|
+
# @!attribute [rw] routing_profile_id
|
1303
|
+
# The identifier of the routing profile.
|
1304
|
+
# @return [String]
|
756
1305
|
#
|
757
|
-
|
758
|
-
|
759
|
-
|
1306
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeRoutingProfileRequest AWS API Documentation
|
1307
|
+
#
|
1308
|
+
class DescribeRoutingProfileRequest < Struct.new(
|
1309
|
+
:instance_id,
|
1310
|
+
:routing_profile_id)
|
1311
|
+
SENSITIVE = []
|
1312
|
+
include Aws::Structure
|
1313
|
+
end
|
1314
|
+
|
1315
|
+
# @!attribute [rw] routing_profile
|
1316
|
+
# The routing profile.
|
1317
|
+
# @return [Types::RoutingProfile]
|
1318
|
+
#
|
1319
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeRoutingProfileResponse AWS API Documentation
|
1320
|
+
#
|
1321
|
+
class DescribeRoutingProfileResponse < Struct.new(
|
1322
|
+
:routing_profile)
|
1323
|
+
SENSITIVE = []
|
1324
|
+
include Aws::Structure
|
1325
|
+
end
|
1326
|
+
|
1327
|
+
# @note When making an API call, you may pass DescribeUserHierarchyGroupRequest
|
1328
|
+
# data as a hash:
|
1329
|
+
#
|
1330
|
+
# {
|
1331
|
+
# hierarchy_group_id: "HierarchyGroupId", # required
|
1332
|
+
# instance_id: "InstanceId", # required
|
1333
|
+
# }
|
1334
|
+
#
|
1335
|
+
# @!attribute [rw] hierarchy_group_id
|
1336
|
+
# The identifier of the hierarchy group.
|
1337
|
+
# @return [String]
|
1338
|
+
#
|
1339
|
+
# @!attribute [rw] instance_id
|
1340
|
+
# The identifier of the Amazon Connect instance.
|
1341
|
+
# @return [String]
|
1342
|
+
#
|
1343
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyGroupRequest AWS API Documentation
|
1344
|
+
#
|
1345
|
+
class DescribeUserHierarchyGroupRequest < Struct.new(
|
1346
|
+
:hierarchy_group_id,
|
1347
|
+
:instance_id)
|
1348
|
+
SENSITIVE = []
|
1349
|
+
include Aws::Structure
|
1350
|
+
end
|
1351
|
+
|
1352
|
+
# @!attribute [rw] hierarchy_group
|
1353
|
+
# Information about the hierarchy group.
|
1354
|
+
# @return [Types::HierarchyGroup]
|
1355
|
+
#
|
1356
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyGroupResponse AWS API Documentation
|
1357
|
+
#
|
1358
|
+
class DescribeUserHierarchyGroupResponse < Struct.new(
|
1359
|
+
:hierarchy_group)
|
1360
|
+
SENSITIVE = []
|
1361
|
+
include Aws::Structure
|
1362
|
+
end
|
1363
|
+
|
1364
|
+
# @note When making an API call, you may pass DescribeUserHierarchyStructureRequest
|
1365
|
+
# data as a hash:
|
1366
|
+
#
|
1367
|
+
# {
|
1368
|
+
# instance_id: "InstanceId", # required
|
1369
|
+
# }
|
1370
|
+
#
|
1371
|
+
# @!attribute [rw] instance_id
|
1372
|
+
# The identifier of the Amazon Connect instance.
|
1373
|
+
# @return [String]
|
1374
|
+
#
|
1375
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyStructureRequest AWS API Documentation
|
1376
|
+
#
|
1377
|
+
class DescribeUserHierarchyStructureRequest < Struct.new(
|
1378
|
+
:instance_id)
|
1379
|
+
SENSITIVE = []
|
1380
|
+
include Aws::Structure
|
1381
|
+
end
|
1382
|
+
|
1383
|
+
# @!attribute [rw] hierarchy_structure
|
1384
|
+
# Information about the hierarchy structure.
|
1385
|
+
# @return [Types::HierarchyStructure]
|
1386
|
+
#
|
1387
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserHierarchyStructureResponse AWS API Documentation
|
1388
|
+
#
|
1389
|
+
class DescribeUserHierarchyStructureResponse < Struct.new(
|
1390
|
+
:hierarchy_structure)
|
1391
|
+
SENSITIVE = []
|
1392
|
+
include Aws::Structure
|
1393
|
+
end
|
1394
|
+
|
1395
|
+
# @note When making an API call, you may pass DescribeUserRequest
|
1396
|
+
# data as a hash:
|
1397
|
+
#
|
1398
|
+
# {
|
1399
|
+
# user_id: "UserId", # required
|
1400
|
+
# instance_id: "InstanceId", # required
|
1401
|
+
# }
|
1402
|
+
#
|
1403
|
+
# @!attribute [rw] user_id
|
1404
|
+
# The identifier of the user account.
|
1405
|
+
# @return [String]
|
1406
|
+
#
|
1407
|
+
# @!attribute [rw] instance_id
|
1408
|
+
# The identifier of the Amazon Connect instance.
|
1409
|
+
# @return [String]
|
1410
|
+
#
|
1411
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeUserRequest AWS API Documentation
|
1412
|
+
#
|
1413
|
+
class DescribeUserRequest < Struct.new(
|
1414
|
+
:user_id,
|
1415
|
+
:instance_id)
|
760
1416
|
SENSITIVE = []
|
761
1417
|
include Aws::Structure
|
762
1418
|
end
|
@@ -806,6 +1462,120 @@ module Aws::Connect
|
|
806
1462
|
include Aws::Structure
|
807
1463
|
end
|
808
1464
|
|
1465
|
+
# @note When making an API call, you may pass DisassociateApprovedOriginRequest
|
1466
|
+
# data as a hash:
|
1467
|
+
#
|
1468
|
+
# {
|
1469
|
+
# instance_id: "InstanceId", # required
|
1470
|
+
# origin: "Origin", # required
|
1471
|
+
# }
|
1472
|
+
#
|
1473
|
+
# @!attribute [rw] instance_id
|
1474
|
+
# The identifier of the Amazon Connect instance.
|
1475
|
+
# @return [String]
|
1476
|
+
#
|
1477
|
+
# @!attribute [rw] origin
|
1478
|
+
# The domain URL of the integrated application.
|
1479
|
+
# @return [String]
|
1480
|
+
#
|
1481
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateApprovedOriginRequest AWS API Documentation
|
1482
|
+
#
|
1483
|
+
class DisassociateApprovedOriginRequest < Struct.new(
|
1484
|
+
:instance_id,
|
1485
|
+
:origin)
|
1486
|
+
SENSITIVE = []
|
1487
|
+
include Aws::Structure
|
1488
|
+
end
|
1489
|
+
|
1490
|
+
# @note When making an API call, you may pass DisassociateInstanceStorageConfigRequest
|
1491
|
+
# data as a hash:
|
1492
|
+
#
|
1493
|
+
# {
|
1494
|
+
# instance_id: "InstanceId", # required
|
1495
|
+
# association_id: "AssociationId", # required
|
1496
|
+
# resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS
|
1497
|
+
# }
|
1498
|
+
#
|
1499
|
+
# @!attribute [rw] instance_id
|
1500
|
+
# The identifier of the Amazon Connect instance.
|
1501
|
+
# @return [String]
|
1502
|
+
#
|
1503
|
+
# @!attribute [rw] association_id
|
1504
|
+
# The existing association identifier that uniquely identifies the
|
1505
|
+
# resource type and storage config for the given instance ID.
|
1506
|
+
# @return [String]
|
1507
|
+
#
|
1508
|
+
# @!attribute [rw] resource_type
|
1509
|
+
# A valid resource type.
|
1510
|
+
# @return [String]
|
1511
|
+
#
|
1512
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateInstanceStorageConfigRequest AWS API Documentation
|
1513
|
+
#
|
1514
|
+
class DisassociateInstanceStorageConfigRequest < Struct.new(
|
1515
|
+
:instance_id,
|
1516
|
+
:association_id,
|
1517
|
+
:resource_type)
|
1518
|
+
SENSITIVE = []
|
1519
|
+
include Aws::Structure
|
1520
|
+
end
|
1521
|
+
|
1522
|
+
# @note When making an API call, you may pass DisassociateLambdaFunctionRequest
|
1523
|
+
# data as a hash:
|
1524
|
+
#
|
1525
|
+
# {
|
1526
|
+
# instance_id: "InstanceId", # required
|
1527
|
+
# function_arn: "FunctionArn", # required
|
1528
|
+
# }
|
1529
|
+
#
|
1530
|
+
# @!attribute [rw] instance_id
|
1531
|
+
# The identifier of the Amazon Connect instance..
|
1532
|
+
# @return [String]
|
1533
|
+
#
|
1534
|
+
# @!attribute [rw] function_arn
|
1535
|
+
# The Amazon Resource Name (ARN) of the Lambda function being
|
1536
|
+
# disassociated.
|
1537
|
+
# @return [String]
|
1538
|
+
#
|
1539
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateLambdaFunctionRequest AWS API Documentation
|
1540
|
+
#
|
1541
|
+
class DisassociateLambdaFunctionRequest < Struct.new(
|
1542
|
+
:instance_id,
|
1543
|
+
:function_arn)
|
1544
|
+
SENSITIVE = []
|
1545
|
+
include Aws::Structure
|
1546
|
+
end
|
1547
|
+
|
1548
|
+
# @note When making an API call, you may pass DisassociateLexBotRequest
|
1549
|
+
# data as a hash:
|
1550
|
+
#
|
1551
|
+
# {
|
1552
|
+
# instance_id: "InstanceId", # required
|
1553
|
+
# bot_name: "BotName", # required
|
1554
|
+
# lex_region: "LexRegion", # required
|
1555
|
+
# }
|
1556
|
+
#
|
1557
|
+
# @!attribute [rw] instance_id
|
1558
|
+
# The identifier of the Amazon Connect instance.
|
1559
|
+
# @return [String]
|
1560
|
+
#
|
1561
|
+
# @!attribute [rw] bot_name
|
1562
|
+
# The name of the Amazon Lex bot. Maximum character limit of 50.
|
1563
|
+
# @return [String]
|
1564
|
+
#
|
1565
|
+
# @!attribute [rw] lex_region
|
1566
|
+
# The Region in which the Amazon Lex bot has been created.
|
1567
|
+
# @return [String]
|
1568
|
+
#
|
1569
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateLexBotRequest AWS API Documentation
|
1570
|
+
#
|
1571
|
+
class DisassociateLexBotRequest < Struct.new(
|
1572
|
+
:instance_id,
|
1573
|
+
:bot_name,
|
1574
|
+
:lex_region)
|
1575
|
+
SENSITIVE = []
|
1576
|
+
include Aws::Structure
|
1577
|
+
end
|
1578
|
+
|
809
1579
|
# @note When making an API call, you may pass DisassociateRoutingProfileQueuesRequest
|
810
1580
|
# data as a hash:
|
811
1581
|
#
|
@@ -815,7 +1585,7 @@ module Aws::Connect
|
|
815
1585
|
# queue_references: [ # required
|
816
1586
|
# {
|
817
1587
|
# queue_id: "QueueId", # required
|
818
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
1588
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
819
1589
|
# },
|
820
1590
|
# ],
|
821
1591
|
# }
|
@@ -842,6 +1612,32 @@ module Aws::Connect
|
|
842
1612
|
include Aws::Structure
|
843
1613
|
end
|
844
1614
|
|
1615
|
+
# @note When making an API call, you may pass DisassociateSecurityKeyRequest
|
1616
|
+
# data as a hash:
|
1617
|
+
#
|
1618
|
+
# {
|
1619
|
+
# instance_id: "InstanceId", # required
|
1620
|
+
# association_id: "AssociationId", # required
|
1621
|
+
# }
|
1622
|
+
#
|
1623
|
+
# @!attribute [rw] instance_id
|
1624
|
+
# The identifier of the Amazon Connect instance.
|
1625
|
+
# @return [String]
|
1626
|
+
#
|
1627
|
+
# @!attribute [rw] association_id
|
1628
|
+
# The existing association identifier that uniquely identifies the
|
1629
|
+
# resource type and storage config for the given instance ID.
|
1630
|
+
# @return [String]
|
1631
|
+
#
|
1632
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateSecurityKeyRequest AWS API Documentation
|
1633
|
+
#
|
1634
|
+
class DisassociateSecurityKeyRequest < Struct.new(
|
1635
|
+
:instance_id,
|
1636
|
+
:association_id)
|
1637
|
+
SENSITIVE = []
|
1638
|
+
include Aws::Structure
|
1639
|
+
end
|
1640
|
+
|
845
1641
|
# A resource with the specified name already exists.
|
846
1642
|
#
|
847
1643
|
# @!attribute [rw] message
|
@@ -855,6 +1651,33 @@ module Aws::Connect
|
|
855
1651
|
include Aws::Structure
|
856
1652
|
end
|
857
1653
|
|
1654
|
+
# The encryption configuration.
|
1655
|
+
#
|
1656
|
+
# @note When making an API call, you may pass EncryptionConfig
|
1657
|
+
# data as a hash:
|
1658
|
+
#
|
1659
|
+
# {
|
1660
|
+
# encryption_type: "KMS", # required, accepts KMS
|
1661
|
+
# key_id: "KeyId", # required
|
1662
|
+
# }
|
1663
|
+
#
|
1664
|
+
# @!attribute [rw] encryption_type
|
1665
|
+
# The type of encryption.
|
1666
|
+
# @return [String]
|
1667
|
+
#
|
1668
|
+
# @!attribute [rw] key_id
|
1669
|
+
# The identifier of the encryption key.
|
1670
|
+
# @return [String]
|
1671
|
+
#
|
1672
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EncryptionConfig AWS API Documentation
|
1673
|
+
#
|
1674
|
+
class EncryptionConfig < Struct.new(
|
1675
|
+
:encryption_type,
|
1676
|
+
:key_id)
|
1677
|
+
SENSITIVE = []
|
1678
|
+
include Aws::Structure
|
1679
|
+
end
|
1680
|
+
|
858
1681
|
# Contains the filter to apply when retrieving metrics.
|
859
1682
|
#
|
860
1683
|
# @note When making an API call, you may pass Filters
|
@@ -862,7 +1685,7 @@ module Aws::Connect
|
|
862
1685
|
#
|
863
1686
|
# {
|
864
1687
|
# queues: ["QueueId"],
|
865
|
-
# channels: ["VOICE"], # accepts VOICE, CHAT
|
1688
|
+
# channels: ["VOICE"], # accepts VOICE, CHAT, TASK
|
866
1689
|
# }
|
867
1690
|
#
|
868
1691
|
# @!attribute [rw] queues
|
@@ -927,7 +1750,7 @@ module Aws::Connect
|
|
927
1750
|
# instance_id: "InstanceId", # required
|
928
1751
|
# filters: { # required
|
929
1752
|
# queues: ["QueueId"],
|
930
|
-
# channels: ["VOICE"], # accepts VOICE, CHAT
|
1753
|
+
# channels: ["VOICE"], # accepts VOICE, CHAT, TASK
|
931
1754
|
# },
|
932
1755
|
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
|
933
1756
|
# current_metrics: [ # required
|
@@ -948,16 +1771,16 @@ module Aws::Connect
|
|
948
1771
|
# The queues, up to 100, or channels, to use to filter the metrics
|
949
1772
|
# returned. Metric data is retrieved only for the resources associated
|
950
1773
|
# with the queues or channels included in the filter. You can include
|
951
|
-
# both queue IDs and queue ARNs in the same request.
|
952
|
-
#
|
1774
|
+
# both queue IDs and queue ARNs in the same request. VOICE, CHAT, and
|
1775
|
+
# TASK channels are supported.
|
953
1776
|
# @return [Types::Filters]
|
954
1777
|
#
|
955
1778
|
# @!attribute [rw] groupings
|
956
1779
|
# The grouping applied to the metrics returned. For example, when
|
957
1780
|
# grouped by `QUEUE`, the metrics returned apply to each queue rather
|
958
1781
|
# than aggregated for all queues. If you group by `CHANNEL`, you
|
959
|
-
# should include a Channels filter.
|
960
|
-
#
|
1782
|
+
# should include a Channels filter. VOICE, CHAT, and TASK channels are
|
1783
|
+
# supported.
|
961
1784
|
#
|
962
1785
|
# If no `Grouping` is included in the request, a summary of metrics is
|
963
1786
|
# returned.
|
@@ -1168,7 +1991,7 @@ module Aws::Connect
|
|
1168
1991
|
# end_time: Time.now, # required
|
1169
1992
|
# filters: { # required
|
1170
1993
|
# queues: ["QueueId"],
|
1171
|
-
# channels: ["VOICE"], # accepts VOICE, CHAT
|
1994
|
+
# channels: ["VOICE"], # accepts VOICE, CHAT, TASK
|
1172
1995
|
# },
|
1173
1996
|
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL
|
1174
1997
|
# historical_metrics: [ # required
|
@@ -1215,8 +2038,8 @@ module Aws::Connect
|
|
1215
2038
|
# The queues, up to 100, or channels, to use to filter the metrics
|
1216
2039
|
# returned. Metric data is retrieved only for the resources associated
|
1217
2040
|
# with the queues or channels included in the filter. You can include
|
1218
|
-
# both queue IDs and queue ARNs in the same request.
|
1219
|
-
#
|
2041
|
+
# both queue IDs and queue ARNs in the same request. VOICE, CHAT, and
|
2042
|
+
# TASK channels are supported.
|
1220
2043
|
# @return [Types::Filters]
|
1221
2044
|
#
|
1222
2045
|
# @!attribute [rw] groupings
|
@@ -1527,6 +2350,28 @@ module Aws::Connect
|
|
1527
2350
|
include Aws::Structure
|
1528
2351
|
end
|
1529
2352
|
|
2353
|
+
# Contains information about the hierarchy level to update.
|
2354
|
+
#
|
2355
|
+
# @note When making an API call, you may pass HierarchyLevelUpdate
|
2356
|
+
# data as a hash:
|
2357
|
+
#
|
2358
|
+
# {
|
2359
|
+
# name: "HierarchyLevelName", # required
|
2360
|
+
# }
|
2361
|
+
#
|
2362
|
+
# @!attribute [rw] name
|
2363
|
+
# The name of the user hierarchy level. Must not be more than 50
|
2364
|
+
# characters.
|
2365
|
+
# @return [String]
|
2366
|
+
#
|
2367
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HierarchyLevelUpdate AWS API Documentation
|
2368
|
+
#
|
2369
|
+
class HierarchyLevelUpdate < Struct.new(
|
2370
|
+
:name)
|
2371
|
+
SENSITIVE = []
|
2372
|
+
include Aws::Structure
|
2373
|
+
end
|
2374
|
+
|
1530
2375
|
# Contains information about the levels of a hierarchy group.
|
1531
2376
|
#
|
1532
2377
|
# @!attribute [rw] level_one
|
@@ -1595,34 +2440,89 @@ module Aws::Connect
|
|
1595
2440
|
include Aws::Structure
|
1596
2441
|
end
|
1597
2442
|
|
1598
|
-
# Contains information about
|
1599
|
-
# each metric, see [Historical Metrics Definitions][1] in the *Amazon
|
1600
|
-
# Connect Administrator Guide*.
|
1601
|
-
#
|
1602
|
-
#
|
1603
|
-
#
|
1604
|
-
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html
|
2443
|
+
# Contains information about the level hierarchy to update.
|
1605
2444
|
#
|
1606
|
-
# @note When making an API call, you may pass
|
2445
|
+
# @note When making an API call, you may pass HierarchyStructureUpdate
|
1607
2446
|
# data as a hash:
|
1608
2447
|
#
|
1609
2448
|
# {
|
1610
|
-
#
|
1611
|
-
#
|
1612
|
-
#
|
1613
|
-
#
|
2449
|
+
# level_one: {
|
2450
|
+
# name: "HierarchyLevelName", # required
|
2451
|
+
# },
|
2452
|
+
# level_two: {
|
2453
|
+
# name: "HierarchyLevelName", # required
|
2454
|
+
# },
|
2455
|
+
# level_three: {
|
2456
|
+
# name: "HierarchyLevelName", # required
|
2457
|
+
# },
|
2458
|
+
# level_four: {
|
2459
|
+
# name: "HierarchyLevelName", # required
|
2460
|
+
# },
|
2461
|
+
# level_five: {
|
2462
|
+
# name: "HierarchyLevelName", # required
|
1614
2463
|
# },
|
1615
|
-
# statistic: "SUM", # accepts SUM, MAX, AVG
|
1616
|
-
# unit: "SECONDS", # accepts SECONDS, COUNT, PERCENT
|
1617
2464
|
# }
|
1618
2465
|
#
|
1619
|
-
# @!attribute [rw]
|
1620
|
-
# The
|
1621
|
-
# @return [
|
2466
|
+
# @!attribute [rw] level_one
|
2467
|
+
# The update for level one.
|
2468
|
+
# @return [Types::HierarchyLevelUpdate]
|
1622
2469
|
#
|
1623
|
-
# @!attribute [rw]
|
1624
|
-
# The
|
1625
|
-
# @return [Types::
|
2470
|
+
# @!attribute [rw] level_two
|
2471
|
+
# The update for level two.
|
2472
|
+
# @return [Types::HierarchyLevelUpdate]
|
2473
|
+
#
|
2474
|
+
# @!attribute [rw] level_three
|
2475
|
+
# The update for level three.
|
2476
|
+
# @return [Types::HierarchyLevelUpdate]
|
2477
|
+
#
|
2478
|
+
# @!attribute [rw] level_four
|
2479
|
+
# The update for level four.
|
2480
|
+
# @return [Types::HierarchyLevelUpdate]
|
2481
|
+
#
|
2482
|
+
# @!attribute [rw] level_five
|
2483
|
+
# The update for level five.
|
2484
|
+
# @return [Types::HierarchyLevelUpdate]
|
2485
|
+
#
|
2486
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HierarchyStructureUpdate AWS API Documentation
|
2487
|
+
#
|
2488
|
+
class HierarchyStructureUpdate < Struct.new(
|
2489
|
+
:level_one,
|
2490
|
+
:level_two,
|
2491
|
+
:level_three,
|
2492
|
+
:level_four,
|
2493
|
+
:level_five)
|
2494
|
+
SENSITIVE = []
|
2495
|
+
include Aws::Structure
|
2496
|
+
end
|
2497
|
+
|
2498
|
+
# Contains information about a historical metric. For a description of
|
2499
|
+
# each metric, see [Historical Metrics Definitions][1] in the *Amazon
|
2500
|
+
# Connect Administrator Guide*.
|
2501
|
+
#
|
2502
|
+
#
|
2503
|
+
#
|
2504
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html
|
2505
|
+
#
|
2506
|
+
# @note When making an API call, you may pass HistoricalMetric
|
2507
|
+
# data as a hash:
|
2508
|
+
#
|
2509
|
+
# {
|
2510
|
+
# name: "CONTACTS_QUEUED", # accepts CONTACTS_QUEUED, CONTACTS_HANDLED, CONTACTS_ABANDONED, CONTACTS_CONSULTED, CONTACTS_AGENT_HUNG_UP_FIRST, CONTACTS_HANDLED_INCOMING, CONTACTS_HANDLED_OUTBOUND, CONTACTS_HOLD_ABANDONS, CONTACTS_TRANSFERRED_IN, CONTACTS_TRANSFERRED_OUT, CONTACTS_TRANSFERRED_IN_FROM_QUEUE, CONTACTS_TRANSFERRED_OUT_FROM_QUEUE, CONTACTS_MISSED, CALLBACK_CONTACTS_HANDLED, API_CONTACTS_HANDLED, OCCUPANCY, HANDLE_TIME, AFTER_CONTACT_WORK_TIME, QUEUED_TIME, ABANDON_TIME, QUEUE_ANSWER_TIME, HOLD_TIME, INTERACTION_TIME, INTERACTION_AND_HOLD_TIME, SERVICE_LEVEL
|
2511
|
+
# threshold: {
|
2512
|
+
# comparison: "LT", # accepts LT
|
2513
|
+
# threshold_value: 1.0,
|
2514
|
+
# },
|
2515
|
+
# statistic: "SUM", # accepts SUM, MAX, AVG
|
2516
|
+
# unit: "SECONDS", # accepts SECONDS, COUNT, PERCENT
|
2517
|
+
# }
|
2518
|
+
#
|
2519
|
+
# @!attribute [rw] name
|
2520
|
+
# The name of the metric.
|
2521
|
+
# @return [String]
|
2522
|
+
#
|
2523
|
+
# @!attribute [rw] threshold
|
2524
|
+
# The threshold for the metric, used with service level metrics.
|
2525
|
+
# @return [Types::Threshold]
|
1626
2526
|
#
|
1627
2527
|
# @!attribute [rw] statistic
|
1628
2528
|
# The statistic for the metric.
|
@@ -1706,82 +2606,800 @@ module Aws::Connect
|
|
1706
2606
|
include Aws::Structure
|
1707
2607
|
end
|
1708
2608
|
|
1709
|
-
#
|
2609
|
+
# The Amazon Connect instance.
|
2610
|
+
#
|
2611
|
+
# @!attribute [rw] id
|
2612
|
+
# The identifier of the Amazon Connect instance.
|
2613
|
+
# @return [String]
|
2614
|
+
#
|
2615
|
+
# @!attribute [rw] arn
|
2616
|
+
# The Amazon Resource Name (ARN) of the instance.
|
2617
|
+
# @return [String]
|
2618
|
+
#
|
2619
|
+
# @!attribute [rw] identity_management_type
|
2620
|
+
# The identity management type.
|
2621
|
+
# @return [String]
|
2622
|
+
#
|
2623
|
+
# @!attribute [rw] instance_alias
|
2624
|
+
# The alias of instance.
|
2625
|
+
# @return [String]
|
2626
|
+
#
|
2627
|
+
# @!attribute [rw] created_time
|
2628
|
+
# When the instance was created.
|
2629
|
+
# @return [Time]
|
2630
|
+
#
|
2631
|
+
# @!attribute [rw] service_role
|
2632
|
+
# The service role of the instance.
|
2633
|
+
# @return [String]
|
2634
|
+
#
|
2635
|
+
# @!attribute [rw] instance_status
|
2636
|
+
# The state of the instance.
|
2637
|
+
# @return [String]
|
2638
|
+
#
|
2639
|
+
# @!attribute [rw] status_reason
|
2640
|
+
# Relevant details why the instance was not successfully created.
|
2641
|
+
# @return [Types::InstanceStatusReason]
|
2642
|
+
#
|
2643
|
+
# @!attribute [rw] inbound_calls_enabled
|
2644
|
+
# Whether inbound calls are enabled.
|
2645
|
+
# @return [Boolean]
|
2646
|
+
#
|
2647
|
+
# @!attribute [rw] outbound_calls_enabled
|
2648
|
+
# Whether outbound calls are enabled.
|
2649
|
+
# @return [Boolean]
|
2650
|
+
#
|
2651
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Instance AWS API Documentation
|
2652
|
+
#
|
2653
|
+
class Instance < Struct.new(
|
2654
|
+
:id,
|
2655
|
+
:arn,
|
2656
|
+
:identity_management_type,
|
2657
|
+
:instance_alias,
|
2658
|
+
:created_time,
|
2659
|
+
:service_role,
|
2660
|
+
:instance_status,
|
2661
|
+
:status_reason,
|
2662
|
+
:inbound_calls_enabled,
|
2663
|
+
:outbound_calls_enabled)
|
2664
|
+
SENSITIVE = [:instance_alias]
|
2665
|
+
include Aws::Structure
|
2666
|
+
end
|
2667
|
+
|
2668
|
+
# Relevant details why the instance was not successfully created.
|
2669
|
+
#
|
2670
|
+
# @!attribute [rw] message
|
2671
|
+
# The message.
|
2672
|
+
# @return [String]
|
2673
|
+
#
|
2674
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/InstanceStatusReason AWS API Documentation
|
2675
|
+
#
|
2676
|
+
class InstanceStatusReason < Struct.new(
|
2677
|
+
:message)
|
2678
|
+
SENSITIVE = []
|
2679
|
+
include Aws::Structure
|
2680
|
+
end
|
2681
|
+
|
2682
|
+
# The storage configuration for the instance.
|
2683
|
+
#
|
2684
|
+
# @note When making an API call, you may pass InstanceStorageConfig
|
2685
|
+
# data as a hash:
|
2686
|
+
#
|
2687
|
+
# {
|
2688
|
+
# association_id: "AssociationId",
|
2689
|
+
# storage_type: "S3", # required, accepts S3, KINESIS_VIDEO_STREAM, KINESIS_STREAM, KINESIS_FIREHOSE
|
2690
|
+
# s3_config: {
|
2691
|
+
# bucket_name: "BucketName", # required
|
2692
|
+
# bucket_prefix: "Prefix", # required
|
2693
|
+
# encryption_config: {
|
2694
|
+
# encryption_type: "KMS", # required, accepts KMS
|
2695
|
+
# key_id: "KeyId", # required
|
2696
|
+
# },
|
2697
|
+
# },
|
2698
|
+
# kinesis_video_stream_config: {
|
2699
|
+
# prefix: "Prefix", # required
|
2700
|
+
# retention_period_hours: 1, # required
|
2701
|
+
# encryption_config: { # required
|
2702
|
+
# encryption_type: "KMS", # required, accepts KMS
|
2703
|
+
# key_id: "KeyId", # required
|
2704
|
+
# },
|
2705
|
+
# },
|
2706
|
+
# kinesis_stream_config: {
|
2707
|
+
# stream_arn: "ARN", # required
|
2708
|
+
# },
|
2709
|
+
# kinesis_firehose_config: {
|
2710
|
+
# firehose_arn: "ARN", # required
|
2711
|
+
# },
|
2712
|
+
# }
|
2713
|
+
#
|
2714
|
+
# @!attribute [rw] association_id
|
2715
|
+
# The existing association identifier that uniquely identifies the
|
2716
|
+
# resource type and storage config for the given instance ID.
|
2717
|
+
# @return [String]
|
2718
|
+
#
|
2719
|
+
# @!attribute [rw] storage_type
|
2720
|
+
# A valid storage type.
|
2721
|
+
# @return [String]
|
2722
|
+
#
|
2723
|
+
# @!attribute [rw] s3_config
|
2724
|
+
# The S3 configuration.
|
2725
|
+
# @return [Types::S3Config]
|
2726
|
+
#
|
2727
|
+
# @!attribute [rw] kinesis_video_stream_config
|
2728
|
+
# The configuration of the Kinesis video stream.
|
2729
|
+
# @return [Types::KinesisVideoStreamConfig]
|
2730
|
+
#
|
2731
|
+
# @!attribute [rw] kinesis_stream_config
|
2732
|
+
# The configuration of the Kinesis data stream.
|
2733
|
+
# @return [Types::KinesisStreamConfig]
|
2734
|
+
#
|
2735
|
+
# @!attribute [rw] kinesis_firehose_config
|
2736
|
+
# The configuration of the Kinesis Firehose delivery stream.
|
2737
|
+
# @return [Types::KinesisFirehoseConfig]
|
2738
|
+
#
|
2739
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/InstanceStorageConfig AWS API Documentation
|
2740
|
+
#
|
2741
|
+
class InstanceStorageConfig < Struct.new(
|
2742
|
+
:association_id,
|
2743
|
+
:storage_type,
|
2744
|
+
:s3_config,
|
2745
|
+
:kinesis_video_stream_config,
|
2746
|
+
:kinesis_stream_config,
|
2747
|
+
:kinesis_firehose_config)
|
2748
|
+
SENSITIVE = []
|
2749
|
+
include Aws::Structure
|
2750
|
+
end
|
2751
|
+
|
2752
|
+
# Information about the instance.
|
2753
|
+
#
|
2754
|
+
# @!attribute [rw] id
|
2755
|
+
# The identifier of the instance.
|
2756
|
+
# @return [String]
|
2757
|
+
#
|
2758
|
+
# @!attribute [rw] arn
|
2759
|
+
# The Amazon Resource Name (ARN) of the instance.
|
2760
|
+
# @return [String]
|
2761
|
+
#
|
2762
|
+
# @!attribute [rw] identity_management_type
|
2763
|
+
# The identity management type of the instance.
|
2764
|
+
# @return [String]
|
2765
|
+
#
|
2766
|
+
# @!attribute [rw] instance_alias
|
2767
|
+
# The alias of the instance.
|
2768
|
+
# @return [String]
|
2769
|
+
#
|
2770
|
+
# @!attribute [rw] created_time
|
2771
|
+
# When the instance was created.
|
2772
|
+
# @return [Time]
|
2773
|
+
#
|
2774
|
+
# @!attribute [rw] service_role
|
2775
|
+
# The service role of the instance.
|
2776
|
+
# @return [String]
|
2777
|
+
#
|
2778
|
+
# @!attribute [rw] instance_status
|
2779
|
+
# The state of the instance.
|
2780
|
+
# @return [String]
|
2781
|
+
#
|
2782
|
+
# @!attribute [rw] inbound_calls_enabled
|
2783
|
+
# Whether inbound calls are enabled.
|
2784
|
+
# @return [Boolean]
|
2785
|
+
#
|
2786
|
+
# @!attribute [rw] outbound_calls_enabled
|
2787
|
+
# Whether outbound calls are enabled.
|
2788
|
+
# @return [Boolean]
|
2789
|
+
#
|
2790
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/InstanceSummary AWS API Documentation
|
2791
|
+
#
|
2792
|
+
class InstanceSummary < Struct.new(
|
2793
|
+
:id,
|
2794
|
+
:arn,
|
2795
|
+
:identity_management_type,
|
2796
|
+
:instance_alias,
|
2797
|
+
:created_time,
|
2798
|
+
:service_role,
|
2799
|
+
:instance_status,
|
2800
|
+
:inbound_calls_enabled,
|
2801
|
+
:outbound_calls_enabled)
|
2802
|
+
SENSITIVE = [:instance_alias]
|
2803
|
+
include Aws::Structure
|
2804
|
+
end
|
2805
|
+
|
2806
|
+
# Contains summary information about the associated AppIntegrations.
|
2807
|
+
#
|
2808
|
+
# @!attribute [rw] integration_association_id
|
2809
|
+
# The identifier for the AppIntegration association.
|
2810
|
+
# @return [String]
|
2811
|
+
#
|
2812
|
+
# @!attribute [rw] integration_association_arn
|
2813
|
+
# The Amazon Resource Name (ARN) for the AppIntegration association.
|
2814
|
+
# @return [String]
|
2815
|
+
#
|
2816
|
+
# @!attribute [rw] instance_id
|
2817
|
+
# The identifier of the Amazon Connect instance.
|
2818
|
+
# @return [String]
|
2819
|
+
#
|
2820
|
+
# @!attribute [rw] integration_type
|
2821
|
+
# The integration type.
|
2822
|
+
# @return [String]
|
2823
|
+
#
|
2824
|
+
# @!attribute [rw] integration_arn
|
2825
|
+
# The Amazon Resource Name (ARN) for the AppIntegration.
|
2826
|
+
# @return [String]
|
2827
|
+
#
|
2828
|
+
# @!attribute [rw] source_application_url
|
2829
|
+
# The URL for the external application.
|
2830
|
+
# @return [String]
|
2831
|
+
#
|
2832
|
+
# @!attribute [rw] source_application_name
|
2833
|
+
# The user-provided, friendly name for the external application.
|
2834
|
+
# @return [String]
|
2835
|
+
#
|
2836
|
+
# @!attribute [rw] source_type
|
2837
|
+
# The name of the source.
|
2838
|
+
# @return [String]
|
2839
|
+
#
|
2840
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/IntegrationAssociationSummary AWS API Documentation
|
2841
|
+
#
|
2842
|
+
class IntegrationAssociationSummary < Struct.new(
|
2843
|
+
:integration_association_id,
|
2844
|
+
:integration_association_arn,
|
2845
|
+
:instance_id,
|
2846
|
+
:integration_type,
|
2847
|
+
:integration_arn,
|
2848
|
+
:source_application_url,
|
2849
|
+
:source_application_name,
|
2850
|
+
:source_type)
|
2851
|
+
SENSITIVE = []
|
2852
|
+
include Aws::Structure
|
2853
|
+
end
|
2854
|
+
|
2855
|
+
# Request processing failed due to an error or failure with the service.
|
2856
|
+
#
|
2857
|
+
# @!attribute [rw] message
|
2858
|
+
# The message.
|
2859
|
+
# @return [String]
|
2860
|
+
#
|
2861
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/InternalServiceException AWS API Documentation
|
2862
|
+
#
|
2863
|
+
class InternalServiceException < Struct.new(
|
2864
|
+
:message)
|
2865
|
+
SENSITIVE = []
|
2866
|
+
include Aws::Structure
|
2867
|
+
end
|
2868
|
+
|
2869
|
+
# The contact flow is not valid.
|
2870
|
+
#
|
2871
|
+
# @!attribute [rw] problems
|
2872
|
+
# The problems with the contact flow. Please fix before trying again.
|
2873
|
+
# @return [Array<Types::ProblemDetail>]
|
2874
|
+
#
|
2875
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/InvalidContactFlowException AWS API Documentation
|
2876
|
+
#
|
2877
|
+
class InvalidContactFlowException < Struct.new(
|
2878
|
+
:problems)
|
2879
|
+
SENSITIVE = []
|
2880
|
+
include Aws::Structure
|
2881
|
+
end
|
2882
|
+
|
2883
|
+
# One or more of the specified parameters are not valid.
|
2884
|
+
#
|
2885
|
+
# @!attribute [rw] message
|
2886
|
+
# The message.
|
2887
|
+
# @return [String]
|
2888
|
+
#
|
2889
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/InvalidParameterException AWS API Documentation
|
2890
|
+
#
|
2891
|
+
class InvalidParameterException < Struct.new(
|
2892
|
+
:message)
|
2893
|
+
SENSITIVE = []
|
2894
|
+
include Aws::Structure
|
2895
|
+
end
|
2896
|
+
|
2897
|
+
# The request is not valid.
|
2898
|
+
#
|
2899
|
+
# @!attribute [rw] message
|
2900
|
+
# The message.
|
2901
|
+
# @return [String]
|
2902
|
+
#
|
2903
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/InvalidRequestException AWS API Documentation
|
2904
|
+
#
|
2905
|
+
class InvalidRequestException < Struct.new(
|
2906
|
+
:message)
|
2907
|
+
SENSITIVE = []
|
2908
|
+
include Aws::Structure
|
2909
|
+
end
|
2910
|
+
|
2911
|
+
# Configuration information of a Kinesis Firehose delivery stream.
|
2912
|
+
#
|
2913
|
+
# @note When making an API call, you may pass KinesisFirehoseConfig
|
2914
|
+
# data as a hash:
|
2915
|
+
#
|
2916
|
+
# {
|
2917
|
+
# firehose_arn: "ARN", # required
|
2918
|
+
# }
|
2919
|
+
#
|
2920
|
+
# @!attribute [rw] firehose_arn
|
2921
|
+
# The Amazon Resource Name (ARN) of the delivery stream.
|
2922
|
+
# @return [String]
|
2923
|
+
#
|
2924
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/KinesisFirehoseConfig AWS API Documentation
|
2925
|
+
#
|
2926
|
+
class KinesisFirehoseConfig < Struct.new(
|
2927
|
+
:firehose_arn)
|
2928
|
+
SENSITIVE = []
|
2929
|
+
include Aws::Structure
|
2930
|
+
end
|
2931
|
+
|
2932
|
+
# Configuration information of a Kinesis data stream.
|
2933
|
+
#
|
2934
|
+
# @note When making an API call, you may pass KinesisStreamConfig
|
2935
|
+
# data as a hash:
|
2936
|
+
#
|
2937
|
+
# {
|
2938
|
+
# stream_arn: "ARN", # required
|
2939
|
+
# }
|
2940
|
+
#
|
2941
|
+
# @!attribute [rw] stream_arn
|
2942
|
+
# The Amazon Resource Name (ARN) of the data stream.
|
2943
|
+
# @return [String]
|
2944
|
+
#
|
2945
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/KinesisStreamConfig AWS API Documentation
|
2946
|
+
#
|
2947
|
+
class KinesisStreamConfig < Struct.new(
|
2948
|
+
:stream_arn)
|
2949
|
+
SENSITIVE = []
|
2950
|
+
include Aws::Structure
|
2951
|
+
end
|
2952
|
+
|
2953
|
+
# Configuration information of a Kinesis video stream.
|
2954
|
+
#
|
2955
|
+
# @note When making an API call, you may pass KinesisVideoStreamConfig
|
2956
|
+
# data as a hash:
|
2957
|
+
#
|
2958
|
+
# {
|
2959
|
+
# prefix: "Prefix", # required
|
2960
|
+
# retention_period_hours: 1, # required
|
2961
|
+
# encryption_config: { # required
|
2962
|
+
# encryption_type: "KMS", # required, accepts KMS
|
2963
|
+
# key_id: "KeyId", # required
|
2964
|
+
# },
|
2965
|
+
# }
|
2966
|
+
#
|
2967
|
+
# @!attribute [rw] prefix
|
2968
|
+
# The prefix of the video stream.
|
2969
|
+
# @return [String]
|
2970
|
+
#
|
2971
|
+
# @!attribute [rw] retention_period_hours
|
2972
|
+
# The number of hours data is retained in the stream. Kinesis Video
|
2973
|
+
# Streams retains the data in a data store that is associated with the
|
2974
|
+
# stream.
|
2975
|
+
#
|
2976
|
+
# The default value is 0, indicating that the stream does not persist
|
2977
|
+
# data.
|
2978
|
+
# @return [Integer]
|
2979
|
+
#
|
2980
|
+
# @!attribute [rw] encryption_config
|
2981
|
+
# The encryption configuration.
|
2982
|
+
# @return [Types::EncryptionConfig]
|
2983
|
+
#
|
2984
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/KinesisVideoStreamConfig AWS API Documentation
|
2985
|
+
#
|
2986
|
+
class KinesisVideoStreamConfig < Struct.new(
|
2987
|
+
:prefix,
|
2988
|
+
:retention_period_hours,
|
2989
|
+
:encryption_config)
|
2990
|
+
SENSITIVE = []
|
2991
|
+
include Aws::Structure
|
2992
|
+
end
|
2993
|
+
|
2994
|
+
# Configuration information of an Amazon Lex bot.
|
2995
|
+
#
|
2996
|
+
# @note When making an API call, you may pass LexBot
|
2997
|
+
# data as a hash:
|
2998
|
+
#
|
2999
|
+
# {
|
3000
|
+
# name: "BotName",
|
3001
|
+
# lex_region: "LexRegion",
|
3002
|
+
# }
|
3003
|
+
#
|
3004
|
+
# @!attribute [rw] name
|
3005
|
+
# The name of the Amazon Lex bot.
|
3006
|
+
# @return [String]
|
3007
|
+
#
|
3008
|
+
# @!attribute [rw] lex_region
|
3009
|
+
# The Region the Amazon Lex bot was created in.
|
3010
|
+
# @return [String]
|
3011
|
+
#
|
3012
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/LexBot AWS API Documentation
|
3013
|
+
#
|
3014
|
+
class LexBot < Struct.new(
|
3015
|
+
:name,
|
3016
|
+
:lex_region)
|
3017
|
+
SENSITIVE = []
|
3018
|
+
include Aws::Structure
|
3019
|
+
end
|
3020
|
+
|
3021
|
+
# The allowed limit for the resource has been exceeded.
|
3022
|
+
#
|
3023
|
+
# @!attribute [rw] message
|
3024
|
+
# The message.
|
3025
|
+
# @return [String]
|
3026
|
+
#
|
3027
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/LimitExceededException AWS API Documentation
|
3028
|
+
#
|
3029
|
+
class LimitExceededException < Struct.new(
|
3030
|
+
:message)
|
3031
|
+
SENSITIVE = []
|
3032
|
+
include Aws::Structure
|
3033
|
+
end
|
3034
|
+
|
3035
|
+
# @note When making an API call, you may pass ListApprovedOriginsRequest
|
3036
|
+
# data as a hash:
|
3037
|
+
#
|
3038
|
+
# {
|
3039
|
+
# instance_id: "InstanceId", # required
|
3040
|
+
# next_token: "NextToken",
|
3041
|
+
# max_results: 1,
|
3042
|
+
# }
|
3043
|
+
#
|
3044
|
+
# @!attribute [rw] instance_id
|
3045
|
+
# The identifier of the Amazon Connect instance.
|
3046
|
+
# @return [String]
|
3047
|
+
#
|
3048
|
+
# @!attribute [rw] next_token
|
3049
|
+
# The token for the next set of results. Use the value returned in the
|
3050
|
+
# previous response in the next request to retrieve the next set of
|
3051
|
+
# results.
|
3052
|
+
# @return [String]
|
3053
|
+
#
|
3054
|
+
# @!attribute [rw] max_results
|
3055
|
+
# The maximimum number of results to return per page.
|
3056
|
+
# @return [Integer]
|
3057
|
+
#
|
3058
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListApprovedOriginsRequest AWS API Documentation
|
3059
|
+
#
|
3060
|
+
class ListApprovedOriginsRequest < Struct.new(
|
3061
|
+
:instance_id,
|
3062
|
+
:next_token,
|
3063
|
+
:max_results)
|
3064
|
+
SENSITIVE = []
|
3065
|
+
include Aws::Structure
|
3066
|
+
end
|
3067
|
+
|
3068
|
+
# @!attribute [rw] origins
|
3069
|
+
# The approved origins.
|
3070
|
+
# @return [Array<String>]
|
3071
|
+
#
|
3072
|
+
# @!attribute [rw] next_token
|
3073
|
+
# If there are additional results, this is the token for the next set
|
3074
|
+
# of results.
|
3075
|
+
# @return [String]
|
3076
|
+
#
|
3077
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListApprovedOriginsResponse AWS API Documentation
|
3078
|
+
#
|
3079
|
+
class ListApprovedOriginsResponse < Struct.new(
|
3080
|
+
:origins,
|
3081
|
+
:next_token)
|
3082
|
+
SENSITIVE = []
|
3083
|
+
include Aws::Structure
|
3084
|
+
end
|
3085
|
+
|
3086
|
+
# @note When making an API call, you may pass ListContactFlowsRequest
|
3087
|
+
# data as a hash:
|
3088
|
+
#
|
3089
|
+
# {
|
3090
|
+
# instance_id: "InstanceId", # required
|
3091
|
+
# contact_flow_types: ["CONTACT_FLOW"], # accepts CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER
|
3092
|
+
# next_token: "NextToken",
|
3093
|
+
# max_results: 1,
|
3094
|
+
# }
|
3095
|
+
#
|
3096
|
+
# @!attribute [rw] instance_id
|
3097
|
+
# The identifier of the Amazon Connect instance.
|
3098
|
+
# @return [String]
|
3099
|
+
#
|
3100
|
+
# @!attribute [rw] contact_flow_types
|
3101
|
+
# The type of contact flow.
|
3102
|
+
# @return [Array<String>]
|
3103
|
+
#
|
3104
|
+
# @!attribute [rw] next_token
|
3105
|
+
# The token for the next set of results. Use the value returned in the
|
3106
|
+
# previous response in the next request to retrieve the next set of
|
3107
|
+
# results.
|
3108
|
+
# @return [String]
|
3109
|
+
#
|
3110
|
+
# @!attribute [rw] max_results
|
3111
|
+
# The maximimum number of results to return per page.
|
3112
|
+
# @return [Integer]
|
3113
|
+
#
|
3114
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactFlowsRequest AWS API Documentation
|
3115
|
+
#
|
3116
|
+
class ListContactFlowsRequest < Struct.new(
|
3117
|
+
:instance_id,
|
3118
|
+
:contact_flow_types,
|
3119
|
+
:next_token,
|
3120
|
+
:max_results)
|
3121
|
+
SENSITIVE = []
|
3122
|
+
include Aws::Structure
|
3123
|
+
end
|
3124
|
+
|
3125
|
+
# @!attribute [rw] contact_flow_summary_list
|
3126
|
+
# Information about the contact flows.
|
3127
|
+
# @return [Array<Types::ContactFlowSummary>]
|
3128
|
+
#
|
3129
|
+
# @!attribute [rw] next_token
|
3130
|
+
# If there are additional results, this is the token for the next set
|
3131
|
+
# of results.
|
3132
|
+
# @return [String]
|
3133
|
+
#
|
3134
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactFlowsResponse AWS API Documentation
|
3135
|
+
#
|
3136
|
+
class ListContactFlowsResponse < Struct.new(
|
3137
|
+
:contact_flow_summary_list,
|
3138
|
+
:next_token)
|
3139
|
+
SENSITIVE = []
|
3140
|
+
include Aws::Structure
|
3141
|
+
end
|
3142
|
+
|
3143
|
+
# @note When making an API call, you may pass ListHoursOfOperationsRequest
|
3144
|
+
# data as a hash:
|
3145
|
+
#
|
3146
|
+
# {
|
3147
|
+
# instance_id: "InstanceId", # required
|
3148
|
+
# next_token: "NextToken",
|
3149
|
+
# max_results: 1,
|
3150
|
+
# }
|
3151
|
+
#
|
3152
|
+
# @!attribute [rw] instance_id
|
3153
|
+
# The identifier of the Amazon Connect instance.
|
3154
|
+
# @return [String]
|
3155
|
+
#
|
3156
|
+
# @!attribute [rw] next_token
|
3157
|
+
# The token for the next set of results. Use the value returned in the
|
3158
|
+
# previous response in the next request to retrieve the next set of
|
3159
|
+
# results.
|
3160
|
+
# @return [String]
|
3161
|
+
#
|
3162
|
+
# @!attribute [rw] max_results
|
3163
|
+
# The maximimum number of results to return per page.
|
3164
|
+
# @return [Integer]
|
3165
|
+
#
|
3166
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListHoursOfOperationsRequest AWS API Documentation
|
3167
|
+
#
|
3168
|
+
class ListHoursOfOperationsRequest < Struct.new(
|
3169
|
+
:instance_id,
|
3170
|
+
:next_token,
|
3171
|
+
:max_results)
|
3172
|
+
SENSITIVE = []
|
3173
|
+
include Aws::Structure
|
3174
|
+
end
|
3175
|
+
|
3176
|
+
# @!attribute [rw] hours_of_operation_summary_list
|
3177
|
+
# Information about the hours of operation.
|
3178
|
+
# @return [Array<Types::HoursOfOperationSummary>]
|
3179
|
+
#
|
3180
|
+
# @!attribute [rw] next_token
|
3181
|
+
# If there are additional results, this is the token for the next set
|
3182
|
+
# of results.
|
3183
|
+
# @return [String]
|
3184
|
+
#
|
3185
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListHoursOfOperationsResponse AWS API Documentation
|
3186
|
+
#
|
3187
|
+
class ListHoursOfOperationsResponse < Struct.new(
|
3188
|
+
:hours_of_operation_summary_list,
|
3189
|
+
:next_token)
|
3190
|
+
SENSITIVE = []
|
3191
|
+
include Aws::Structure
|
3192
|
+
end
|
3193
|
+
|
3194
|
+
# @note When making an API call, you may pass ListInstanceAttributesRequest
|
3195
|
+
# data as a hash:
|
3196
|
+
#
|
3197
|
+
# {
|
3198
|
+
# instance_id: "InstanceId", # required
|
3199
|
+
# next_token: "NextToken",
|
3200
|
+
# max_results: 1,
|
3201
|
+
# }
|
3202
|
+
#
|
3203
|
+
# @!attribute [rw] instance_id
|
3204
|
+
# The identifier of the Amazon Connect instance.
|
3205
|
+
# @return [String]
|
3206
|
+
#
|
3207
|
+
# @!attribute [rw] next_token
|
3208
|
+
# The token for the next set of results. Use the value returned in the
|
3209
|
+
# previous response in the next request to retrieve the next set of
|
3210
|
+
# results.
|
3211
|
+
# @return [String]
|
3212
|
+
#
|
3213
|
+
# @!attribute [rw] max_results
|
3214
|
+
# The maximimum number of results to return per page.
|
3215
|
+
# @return [Integer]
|
3216
|
+
#
|
3217
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListInstanceAttributesRequest AWS API Documentation
|
3218
|
+
#
|
3219
|
+
class ListInstanceAttributesRequest < Struct.new(
|
3220
|
+
:instance_id,
|
3221
|
+
:next_token,
|
3222
|
+
:max_results)
|
3223
|
+
SENSITIVE = []
|
3224
|
+
include Aws::Structure
|
3225
|
+
end
|
3226
|
+
|
3227
|
+
# @!attribute [rw] attributes
|
3228
|
+
# The attribute types.
|
3229
|
+
# @return [Array<Types::Attribute>]
|
3230
|
+
#
|
3231
|
+
# @!attribute [rw] next_token
|
3232
|
+
# If there are additional results, this is the token for the next set
|
3233
|
+
# of results.
|
3234
|
+
# @return [String]
|
3235
|
+
#
|
3236
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListInstanceAttributesResponse AWS API Documentation
|
3237
|
+
#
|
3238
|
+
class ListInstanceAttributesResponse < Struct.new(
|
3239
|
+
:attributes,
|
3240
|
+
:next_token)
|
3241
|
+
SENSITIVE = []
|
3242
|
+
include Aws::Structure
|
3243
|
+
end
|
3244
|
+
|
3245
|
+
# @note When making an API call, you may pass ListInstanceStorageConfigsRequest
|
3246
|
+
# data as a hash:
|
3247
|
+
#
|
3248
|
+
# {
|
3249
|
+
# instance_id: "InstanceId", # required
|
3250
|
+
# resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS
|
3251
|
+
# next_token: "NextToken",
|
3252
|
+
# max_results: 1,
|
3253
|
+
# }
|
3254
|
+
#
|
3255
|
+
# @!attribute [rw] instance_id
|
3256
|
+
# The identifier of the Amazon Connect instance.
|
3257
|
+
# @return [String]
|
3258
|
+
#
|
3259
|
+
# @!attribute [rw] resource_type
|
3260
|
+
# A valid resource type.
|
3261
|
+
# @return [String]
|
3262
|
+
#
|
3263
|
+
# @!attribute [rw] next_token
|
3264
|
+
# The token for the next set of results. Use the value returned in the
|
3265
|
+
# previous response in the next request to retrieve the next set of
|
3266
|
+
# results.
|
3267
|
+
# @return [String]
|
3268
|
+
#
|
3269
|
+
# @!attribute [rw] max_results
|
3270
|
+
# The maximimum number of results to return per page.
|
3271
|
+
# @return [Integer]
|
3272
|
+
#
|
3273
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListInstanceStorageConfigsRequest AWS API Documentation
|
3274
|
+
#
|
3275
|
+
class ListInstanceStorageConfigsRequest < Struct.new(
|
3276
|
+
:instance_id,
|
3277
|
+
:resource_type,
|
3278
|
+
:next_token,
|
3279
|
+
:max_results)
|
3280
|
+
SENSITIVE = []
|
3281
|
+
include Aws::Structure
|
3282
|
+
end
|
3283
|
+
|
3284
|
+
# @!attribute [rw] storage_configs
|
3285
|
+
# A valid storage type.
|
3286
|
+
# @return [Array<Types::InstanceStorageConfig>]
|
1710
3287
|
#
|
1711
|
-
# @!attribute [rw]
|
1712
|
-
#
|
3288
|
+
# @!attribute [rw] next_token
|
3289
|
+
# If there are additional results, this is the token for the next set
|
3290
|
+
# of results.
|
1713
3291
|
# @return [String]
|
1714
3292
|
#
|
1715
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
3293
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListInstanceStorageConfigsResponse AWS API Documentation
|
1716
3294
|
#
|
1717
|
-
class
|
1718
|
-
:
|
3295
|
+
class ListInstanceStorageConfigsResponse < Struct.new(
|
3296
|
+
:storage_configs,
|
3297
|
+
:next_token)
|
1719
3298
|
SENSITIVE = []
|
1720
3299
|
include Aws::Structure
|
1721
3300
|
end
|
1722
3301
|
|
1723
|
-
#
|
3302
|
+
# @note When making an API call, you may pass ListInstancesRequest
|
3303
|
+
# data as a hash:
|
1724
3304
|
#
|
1725
|
-
#
|
1726
|
-
#
|
1727
|
-
#
|
3305
|
+
# {
|
3306
|
+
# next_token: "NextToken",
|
3307
|
+
# max_results: 1,
|
3308
|
+
# }
|
1728
3309
|
#
|
1729
|
-
#
|
3310
|
+
# @!attribute [rw] next_token
|
3311
|
+
# The token for the next set of results. Use the value returned in the
|
3312
|
+
# previous response in the next request to retrieve the next set of
|
3313
|
+
# results.
|
3314
|
+
# @return [String]
|
1730
3315
|
#
|
1731
|
-
|
1732
|
-
|
3316
|
+
# @!attribute [rw] max_results
|
3317
|
+
# The maximimum number of results to return per page.
|
3318
|
+
# @return [Integer]
|
3319
|
+
#
|
3320
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListInstancesRequest AWS API Documentation
|
3321
|
+
#
|
3322
|
+
class ListInstancesRequest < Struct.new(
|
3323
|
+
:next_token,
|
3324
|
+
:max_results)
|
1733
3325
|
SENSITIVE = []
|
1734
3326
|
include Aws::Structure
|
1735
3327
|
end
|
1736
3328
|
|
1737
|
-
#
|
3329
|
+
# @!attribute [rw] instance_summary_list
|
3330
|
+
# Information about the instances.
|
3331
|
+
# @return [Array<Types::InstanceSummary>]
|
1738
3332
|
#
|
1739
|
-
# @!attribute [rw]
|
1740
|
-
#
|
3333
|
+
# @!attribute [rw] next_token
|
3334
|
+
# If there are additional results, this is the token for the next set
|
3335
|
+
# of results.
|
1741
3336
|
# @return [String]
|
1742
3337
|
#
|
1743
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
3338
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListInstancesResponse AWS API Documentation
|
1744
3339
|
#
|
1745
|
-
class
|
1746
|
-
:
|
3340
|
+
class ListInstancesResponse < Struct.new(
|
3341
|
+
:instance_summary_list,
|
3342
|
+
:next_token)
|
1747
3343
|
SENSITIVE = []
|
1748
3344
|
include Aws::Structure
|
1749
3345
|
end
|
1750
3346
|
|
1751
|
-
#
|
3347
|
+
# @note When making an API call, you may pass ListIntegrationAssociationsRequest
|
3348
|
+
# data as a hash:
|
1752
3349
|
#
|
1753
|
-
#
|
1754
|
-
#
|
3350
|
+
# {
|
3351
|
+
# instance_id: "InstanceId", # required
|
3352
|
+
# next_token: "NextToken",
|
3353
|
+
# max_results: 1,
|
3354
|
+
# }
|
3355
|
+
#
|
3356
|
+
# @!attribute [rw] instance_id
|
3357
|
+
# The identifier of the Amazon Connect instance.
|
1755
3358
|
# @return [String]
|
1756
3359
|
#
|
1757
|
-
#
|
3360
|
+
# @!attribute [rw] next_token
|
3361
|
+
# The token for the next set of results. Use the value returned in the
|
3362
|
+
# previous response in the next request to retrieve the next set of
|
3363
|
+
# results.
|
3364
|
+
# @return [String]
|
1758
3365
|
#
|
1759
|
-
|
1760
|
-
|
3366
|
+
# @!attribute [rw] max_results
|
3367
|
+
# The maximimum number of results to return per page.
|
3368
|
+
# @return [Integer]
|
3369
|
+
#
|
3370
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListIntegrationAssociationsRequest AWS API Documentation
|
3371
|
+
#
|
3372
|
+
class ListIntegrationAssociationsRequest < Struct.new(
|
3373
|
+
:instance_id,
|
3374
|
+
:next_token,
|
3375
|
+
:max_results)
|
1761
3376
|
SENSITIVE = []
|
1762
3377
|
include Aws::Structure
|
1763
3378
|
end
|
1764
3379
|
|
1765
|
-
#
|
3380
|
+
# @!attribute [rw] integration_association_summary_list
|
3381
|
+
# The AppIntegration associations.
|
3382
|
+
# @return [Array<Types::IntegrationAssociationSummary>]
|
1766
3383
|
#
|
1767
|
-
# @!attribute [rw]
|
1768
|
-
#
|
3384
|
+
# @!attribute [rw] next_token
|
3385
|
+
# If there are additional results, this is the token for the next set
|
3386
|
+
# of results.
|
1769
3387
|
# @return [String]
|
1770
3388
|
#
|
1771
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
3389
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListIntegrationAssociationsResponse AWS API Documentation
|
1772
3390
|
#
|
1773
|
-
class
|
1774
|
-
:
|
3391
|
+
class ListIntegrationAssociationsResponse < Struct.new(
|
3392
|
+
:integration_association_summary_list,
|
3393
|
+
:next_token)
|
1775
3394
|
SENSITIVE = []
|
1776
3395
|
include Aws::Structure
|
1777
3396
|
end
|
1778
3397
|
|
1779
|
-
# @note When making an API call, you may pass
|
3398
|
+
# @note When making an API call, you may pass ListLambdaFunctionsRequest
|
1780
3399
|
# data as a hash:
|
1781
3400
|
#
|
1782
3401
|
# {
|
1783
3402
|
# instance_id: "InstanceId", # required
|
1784
|
-
# contact_flow_types: ["CONTACT_FLOW"], # accepts CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER
|
1785
3403
|
# next_token: "NextToken",
|
1786
3404
|
# max_results: 1,
|
1787
3405
|
# }
|
@@ -1790,10 +3408,6 @@ module Aws::Connect
|
|
1790
3408
|
# The identifier of the Amazon Connect instance.
|
1791
3409
|
# @return [String]
|
1792
3410
|
#
|
1793
|
-
# @!attribute [rw] contact_flow_types
|
1794
|
-
# The type of contact flow.
|
1795
|
-
# @return [Array<String>]
|
1796
|
-
#
|
1797
3411
|
# @!attribute [rw] next_token
|
1798
3412
|
# The token for the next set of results. Use the value returned in the
|
1799
3413
|
# previous response in the next request to retrieve the next set of
|
@@ -1804,36 +3418,35 @@ module Aws::Connect
|
|
1804
3418
|
# The maximimum number of results to return per page.
|
1805
3419
|
# @return [Integer]
|
1806
3420
|
#
|
1807
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
3421
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListLambdaFunctionsRequest AWS API Documentation
|
1808
3422
|
#
|
1809
|
-
class
|
3423
|
+
class ListLambdaFunctionsRequest < Struct.new(
|
1810
3424
|
:instance_id,
|
1811
|
-
:contact_flow_types,
|
1812
3425
|
:next_token,
|
1813
3426
|
:max_results)
|
1814
3427
|
SENSITIVE = []
|
1815
3428
|
include Aws::Structure
|
1816
3429
|
end
|
1817
3430
|
|
1818
|
-
# @!attribute [rw]
|
1819
|
-
#
|
1820
|
-
# @return [Array<
|
3431
|
+
# @!attribute [rw] lambda_functions
|
3432
|
+
# The Lambdafunction ARNs associated with the specified instance.
|
3433
|
+
# @return [Array<String>]
|
1821
3434
|
#
|
1822
3435
|
# @!attribute [rw] next_token
|
1823
3436
|
# If there are additional results, this is the token for the next set
|
1824
3437
|
# of results.
|
1825
3438
|
# @return [String]
|
1826
3439
|
#
|
1827
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
3440
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListLambdaFunctionsResponse AWS API Documentation
|
1828
3441
|
#
|
1829
|
-
class
|
1830
|
-
:
|
3442
|
+
class ListLambdaFunctionsResponse < Struct.new(
|
3443
|
+
:lambda_functions,
|
1831
3444
|
:next_token)
|
1832
3445
|
SENSITIVE = []
|
1833
3446
|
include Aws::Structure
|
1834
3447
|
end
|
1835
3448
|
|
1836
|
-
# @note When making an API call, you may pass
|
3449
|
+
# @note When making an API call, you may pass ListLexBotsRequest
|
1837
3450
|
# data as a hash:
|
1838
3451
|
#
|
1839
3452
|
# {
|
@@ -1856,9 +3469,9 @@ module Aws::Connect
|
|
1856
3469
|
# The maximimum number of results to return per page.
|
1857
3470
|
# @return [Integer]
|
1858
3471
|
#
|
1859
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
3472
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListLexBotsRequest AWS API Documentation
|
1860
3473
|
#
|
1861
|
-
class
|
3474
|
+
class ListLexBotsRequest < Struct.new(
|
1862
3475
|
:instance_id,
|
1863
3476
|
:next_token,
|
1864
3477
|
:max_results)
|
@@ -1866,19 +3479,20 @@ module Aws::Connect
|
|
1866
3479
|
include Aws::Structure
|
1867
3480
|
end
|
1868
3481
|
|
1869
|
-
# @!attribute [rw]
|
1870
|
-
#
|
1871
|
-
#
|
3482
|
+
# @!attribute [rw] lex_bots
|
3483
|
+
# The the names and regions of the Amazon Lex bots associated with the
|
3484
|
+
# specified instance.
|
3485
|
+
# @return [Array<Types::LexBot>]
|
1872
3486
|
#
|
1873
3487
|
# @!attribute [rw] next_token
|
1874
3488
|
# If there are additional results, this is the token for the next set
|
1875
3489
|
# of results.
|
1876
3490
|
# @return [String]
|
1877
3491
|
#
|
1878
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
3492
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListLexBotsResponse AWS API Documentation
|
1879
3493
|
#
|
1880
|
-
class
|
1881
|
-
:
|
3494
|
+
class ListLexBotsResponse < Struct.new(
|
3495
|
+
:lex_bots,
|
1882
3496
|
:next_token)
|
1883
3497
|
SENSITIVE = []
|
1884
3498
|
include Aws::Structure
|
@@ -2163,6 +3777,57 @@ module Aws::Connect
|
|
2163
3777
|
include Aws::Structure
|
2164
3778
|
end
|
2165
3779
|
|
3780
|
+
# @note When making an API call, you may pass ListSecurityKeysRequest
|
3781
|
+
# data as a hash:
|
3782
|
+
#
|
3783
|
+
# {
|
3784
|
+
# instance_id: "InstanceId", # required
|
3785
|
+
# next_token: "NextToken",
|
3786
|
+
# max_results: 1,
|
3787
|
+
# }
|
3788
|
+
#
|
3789
|
+
# @!attribute [rw] instance_id
|
3790
|
+
# The identifier of the Amazon Connect instance.
|
3791
|
+
# @return [String]
|
3792
|
+
#
|
3793
|
+
# @!attribute [rw] next_token
|
3794
|
+
# The token for the next set of results. Use the value returned in the
|
3795
|
+
# previous response in the next request to retrieve the next set of
|
3796
|
+
# results.
|
3797
|
+
# @return [String]
|
3798
|
+
#
|
3799
|
+
# @!attribute [rw] max_results
|
3800
|
+
# The maximimum number of results to return per page.
|
3801
|
+
# @return [Integer]
|
3802
|
+
#
|
3803
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListSecurityKeysRequest AWS API Documentation
|
3804
|
+
#
|
3805
|
+
class ListSecurityKeysRequest < Struct.new(
|
3806
|
+
:instance_id,
|
3807
|
+
:next_token,
|
3808
|
+
:max_results)
|
3809
|
+
SENSITIVE = []
|
3810
|
+
include Aws::Structure
|
3811
|
+
end
|
3812
|
+
|
3813
|
+
# @!attribute [rw] security_keys
|
3814
|
+
# The security keys.
|
3815
|
+
# @return [Array<Types::SecurityKey>]
|
3816
|
+
#
|
3817
|
+
# @!attribute [rw] next_token
|
3818
|
+
# If there are additional results, this is the token for the next set
|
3819
|
+
# of results.
|
3820
|
+
# @return [String]
|
3821
|
+
#
|
3822
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListSecurityKeysResponse AWS API Documentation
|
3823
|
+
#
|
3824
|
+
class ListSecurityKeysResponse < Struct.new(
|
3825
|
+
:security_keys,
|
3826
|
+
:next_token)
|
3827
|
+
SENSITIVE = []
|
3828
|
+
include Aws::Structure
|
3829
|
+
end
|
3830
|
+
|
2166
3831
|
# @note When making an API call, you may pass ListSecurityProfilesRequest
|
2167
3832
|
# data as a hash:
|
2168
3833
|
#
|
@@ -2245,6 +3910,66 @@ module Aws::Connect
|
|
2245
3910
|
include Aws::Structure
|
2246
3911
|
end
|
2247
3912
|
|
3913
|
+
# Provides summary information about the use cases for the specified
|
3914
|
+
# Amazon Connect AppIntegration association.
|
3915
|
+
#
|
3916
|
+
# @note When making an API call, you may pass ListUseCasesRequest
|
3917
|
+
# data as a hash:
|
3918
|
+
#
|
3919
|
+
# {
|
3920
|
+
# instance_id: "InstanceId", # required
|
3921
|
+
# integration_association_id: "IntegrationAssociationId", # required
|
3922
|
+
# next_token: "NextToken",
|
3923
|
+
# max_results: 1,
|
3924
|
+
# }
|
3925
|
+
#
|
3926
|
+
# @!attribute [rw] instance_id
|
3927
|
+
# The identifier of the Amazon Connect instance.
|
3928
|
+
# @return [String]
|
3929
|
+
#
|
3930
|
+
# @!attribute [rw] integration_association_id
|
3931
|
+
# The identifier for the integration association.
|
3932
|
+
# @return [String]
|
3933
|
+
#
|
3934
|
+
# @!attribute [rw] next_token
|
3935
|
+
# The token for the next set of results. Use the value returned in the
|
3936
|
+
# previous response in the next request to retrieve the next set of
|
3937
|
+
# results.
|
3938
|
+
# @return [String]
|
3939
|
+
#
|
3940
|
+
# @!attribute [rw] max_results
|
3941
|
+
# The maximimum number of results to return per page.
|
3942
|
+
# @return [Integer]
|
3943
|
+
#
|
3944
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUseCasesRequest AWS API Documentation
|
3945
|
+
#
|
3946
|
+
class ListUseCasesRequest < Struct.new(
|
3947
|
+
:instance_id,
|
3948
|
+
:integration_association_id,
|
3949
|
+
:next_token,
|
3950
|
+
:max_results)
|
3951
|
+
SENSITIVE = []
|
3952
|
+
include Aws::Structure
|
3953
|
+
end
|
3954
|
+
|
3955
|
+
# @!attribute [rw] use_case_summary_list
|
3956
|
+
# The use cases.
|
3957
|
+
# @return [Array<Types::UseCase>]
|
3958
|
+
#
|
3959
|
+
# @!attribute [rw] next_token
|
3960
|
+
# If there are additional results, this is the token for the next set
|
3961
|
+
# of results.
|
3962
|
+
# @return [String]
|
3963
|
+
#
|
3964
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUseCasesResponse AWS API Documentation
|
3965
|
+
#
|
3966
|
+
class ListUseCasesResponse < Struct.new(
|
3967
|
+
:use_case_summary_list,
|
3968
|
+
:next_token)
|
3969
|
+
SENSITIVE = []
|
3970
|
+
include Aws::Structure
|
3971
|
+
end
|
3972
|
+
|
2248
3973
|
# @note When making an API call, you may pass ListUserHierarchyGroupsRequest
|
2249
3974
|
# data as a hash:
|
2250
3975
|
#
|
@@ -2354,7 +4079,7 @@ module Aws::Connect
|
|
2354
4079
|
# data as a hash:
|
2355
4080
|
#
|
2356
4081
|
# {
|
2357
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
4082
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
2358
4083
|
# concurrency: 1, # required
|
2359
4084
|
# }
|
2360
4085
|
#
|
@@ -2496,40 +4221,105 @@ module Aws::Connect
|
|
2496
4221
|
# The Amazon Resource Name (ARN) of the queue.
|
2497
4222
|
# @return [String]
|
2498
4223
|
#
|
2499
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/QueueReference AWS API Documentation
|
4224
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/QueueReference AWS API Documentation
|
4225
|
+
#
|
4226
|
+
class QueueReference < Struct.new(
|
4227
|
+
:id,
|
4228
|
+
:arn)
|
4229
|
+
SENSITIVE = []
|
4230
|
+
include Aws::Structure
|
4231
|
+
end
|
4232
|
+
|
4233
|
+
# Contains summary information about a queue.
|
4234
|
+
#
|
4235
|
+
# @!attribute [rw] id
|
4236
|
+
# The identifier of the queue.
|
4237
|
+
# @return [String]
|
4238
|
+
#
|
4239
|
+
# @!attribute [rw] arn
|
4240
|
+
# The Amazon Resource Name (ARN) of the queue.
|
4241
|
+
# @return [String]
|
4242
|
+
#
|
4243
|
+
# @!attribute [rw] name
|
4244
|
+
# The name of the queue.
|
4245
|
+
# @return [String]
|
4246
|
+
#
|
4247
|
+
# @!attribute [rw] queue_type
|
4248
|
+
# The type of queue.
|
4249
|
+
# @return [String]
|
4250
|
+
#
|
4251
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/QueueSummary AWS API Documentation
|
4252
|
+
#
|
4253
|
+
class QueueSummary < Struct.new(
|
4254
|
+
:id,
|
4255
|
+
:arn,
|
4256
|
+
:name,
|
4257
|
+
:queue_type)
|
4258
|
+
SENSITIVE = []
|
4259
|
+
include Aws::Structure
|
4260
|
+
end
|
4261
|
+
|
4262
|
+
# A link that an agent selects to complete a given task. You can have up
|
4263
|
+
# to 4,096 UTF-8 bytes across all references for a contact.
|
4264
|
+
#
|
4265
|
+
# @note When making an API call, you may pass Reference
|
4266
|
+
# data as a hash:
|
4267
|
+
#
|
4268
|
+
# {
|
4269
|
+
# value: "ReferenceValue", # required
|
4270
|
+
# type: "URL", # required, accepts URL
|
4271
|
+
# }
|
4272
|
+
#
|
4273
|
+
# @!attribute [rw] value
|
4274
|
+
# A formatted URL that will be shown to an agent in the Contact
|
4275
|
+
# Control Panel (CCP)
|
4276
|
+
# @return [String]
|
4277
|
+
#
|
4278
|
+
# @!attribute [rw] type
|
4279
|
+
# A valid URL.
|
4280
|
+
# @return [String]
|
4281
|
+
#
|
4282
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Reference AWS API Documentation
|
4283
|
+
#
|
4284
|
+
class Reference < Struct.new(
|
4285
|
+
:value,
|
4286
|
+
:type)
|
4287
|
+
SENSITIVE = []
|
4288
|
+
include Aws::Structure
|
4289
|
+
end
|
4290
|
+
|
4291
|
+
# A resource already has that name.
|
4292
|
+
#
|
4293
|
+
# @!attribute [rw] message
|
4294
|
+
# @return [String]
|
4295
|
+
#
|
4296
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ResourceConflictException AWS API Documentation
|
2500
4297
|
#
|
2501
|
-
class
|
2502
|
-
:
|
2503
|
-
:arn)
|
4298
|
+
class ResourceConflictException < Struct.new(
|
4299
|
+
:message)
|
2504
4300
|
SENSITIVE = []
|
2505
4301
|
include Aws::Structure
|
2506
4302
|
end
|
2507
4303
|
|
2508
|
-
#
|
4304
|
+
# That resource is already in use. Please try another.
|
2509
4305
|
#
|
2510
|
-
# @!attribute [rw]
|
2511
|
-
# The identifier of the queue.
|
2512
|
-
# @return [String]
|
2513
|
-
#
|
2514
|
-
# @!attribute [rw] arn
|
2515
|
-
# The Amazon Resource Name (ARN) of the queue.
|
4306
|
+
# @!attribute [rw] message
|
2516
4307
|
# @return [String]
|
2517
4308
|
#
|
2518
|
-
# @!attribute [rw]
|
2519
|
-
# The
|
4309
|
+
# @!attribute [rw] resource_type
|
4310
|
+
# The type of resource.
|
2520
4311
|
# @return [String]
|
2521
4312
|
#
|
2522
|
-
# @!attribute [rw]
|
2523
|
-
# The
|
4313
|
+
# @!attribute [rw] resource_id
|
4314
|
+
# The identifier for the resource.
|
2524
4315
|
# @return [String]
|
2525
4316
|
#
|
2526
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
4317
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ResourceInUseException AWS API Documentation
|
2527
4318
|
#
|
2528
|
-
class
|
2529
|
-
:
|
2530
|
-
:
|
2531
|
-
:
|
2532
|
-
:queue_type)
|
4319
|
+
class ResourceInUseException < Struct.new(
|
4320
|
+
:message,
|
4321
|
+
:resource_type,
|
4322
|
+
:resource_id)
|
2533
4323
|
SENSITIVE = []
|
2534
4324
|
include Aws::Structure
|
2535
4325
|
end
|
@@ -2644,7 +4434,7 @@ module Aws::Connect
|
|
2644
4434
|
# {
|
2645
4435
|
# queue_reference: { # required
|
2646
4436
|
# queue_id: "QueueId", # required
|
2647
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
4437
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
2648
4438
|
# },
|
2649
4439
|
# priority: 1, # required
|
2650
4440
|
# delay: 1, # required
|
@@ -2741,7 +4531,7 @@ module Aws::Connect
|
|
2741
4531
|
#
|
2742
4532
|
# {
|
2743
4533
|
# queue_id: "QueueId", # required
|
2744
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
4534
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
2745
4535
|
# }
|
2746
4536
|
#
|
2747
4537
|
# @!attribute [rw] queue_id
|
@@ -2786,6 +4576,67 @@ module Aws::Connect
|
|
2786
4576
|
include Aws::Structure
|
2787
4577
|
end
|
2788
4578
|
|
4579
|
+
# Information about the S3 storage type.
|
4580
|
+
#
|
4581
|
+
# @note When making an API call, you may pass S3Config
|
4582
|
+
# data as a hash:
|
4583
|
+
#
|
4584
|
+
# {
|
4585
|
+
# bucket_name: "BucketName", # required
|
4586
|
+
# bucket_prefix: "Prefix", # required
|
4587
|
+
# encryption_config: {
|
4588
|
+
# encryption_type: "KMS", # required, accepts KMS
|
4589
|
+
# key_id: "KeyId", # required
|
4590
|
+
# },
|
4591
|
+
# }
|
4592
|
+
#
|
4593
|
+
# @!attribute [rw] bucket_name
|
4594
|
+
# The S3 bucket name.
|
4595
|
+
# @return [String]
|
4596
|
+
#
|
4597
|
+
# @!attribute [rw] bucket_prefix
|
4598
|
+
# The S3 bucket prefix.
|
4599
|
+
# @return [String]
|
4600
|
+
#
|
4601
|
+
# @!attribute [rw] encryption_config
|
4602
|
+
# The S3 encryption configuration.
|
4603
|
+
# @return [Types::EncryptionConfig]
|
4604
|
+
#
|
4605
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/S3Config AWS API Documentation
|
4606
|
+
#
|
4607
|
+
class S3Config < Struct.new(
|
4608
|
+
:bucket_name,
|
4609
|
+
:bucket_prefix,
|
4610
|
+
:encryption_config)
|
4611
|
+
SENSITIVE = []
|
4612
|
+
include Aws::Structure
|
4613
|
+
end
|
4614
|
+
|
4615
|
+
# Configuration information of the security key.
|
4616
|
+
#
|
4617
|
+
# @!attribute [rw] association_id
|
4618
|
+
# The existing association identifier that uniquely identifies the
|
4619
|
+
# resource type and storage config for the given instance ID.
|
4620
|
+
# @return [String]
|
4621
|
+
#
|
4622
|
+
# @!attribute [rw] key
|
4623
|
+
# The key of the security key.
|
4624
|
+
# @return [String]
|
4625
|
+
#
|
4626
|
+
# @!attribute [rw] creation_time
|
4627
|
+
# When the security key was created.
|
4628
|
+
# @return [Time]
|
4629
|
+
#
|
4630
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SecurityKey AWS API Documentation
|
4631
|
+
#
|
4632
|
+
class SecurityKey < Struct.new(
|
4633
|
+
:association_id,
|
4634
|
+
:key,
|
4635
|
+
:creation_time)
|
4636
|
+
SENSITIVE = []
|
4637
|
+
include Aws::Structure
|
4638
|
+
end
|
4639
|
+
|
2789
4640
|
# Contains information about a security profile.
|
2790
4641
|
#
|
2791
4642
|
# @!attribute [rw] id
|
@@ -2810,6 +4661,19 @@ module Aws::Connect
|
|
2810
4661
|
include Aws::Structure
|
2811
4662
|
end
|
2812
4663
|
|
4664
|
+
# The service quota has been exceeded.
|
4665
|
+
#
|
4666
|
+
# @!attribute [rw] message
|
4667
|
+
# @return [String]
|
4668
|
+
#
|
4669
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ServiceQuotaExceededException AWS API Documentation
|
4670
|
+
#
|
4671
|
+
class ServiceQuotaExceededException < Struct.new(
|
4672
|
+
:message)
|
4673
|
+
SENSITIVE = []
|
4674
|
+
include Aws::Structure
|
4675
|
+
end
|
4676
|
+
|
2813
4677
|
# @note When making an API call, you may pass StartChatContactRequest
|
2814
4678
|
# data as a hash:
|
2815
4679
|
#
|
@@ -3050,6 +4914,106 @@ module Aws::Connect
|
|
3050
4914
|
include Aws::Structure
|
3051
4915
|
end
|
3052
4916
|
|
4917
|
+
# @note When making an API call, you may pass StartTaskContactRequest
|
4918
|
+
# data as a hash:
|
4919
|
+
#
|
4920
|
+
# {
|
4921
|
+
# instance_id: "InstanceId", # required
|
4922
|
+
# previous_contact_id: "ContactId",
|
4923
|
+
# contact_flow_id: "ContactFlowId", # required
|
4924
|
+
# attributes: {
|
4925
|
+
# "AttributeName" => "AttributeValue",
|
4926
|
+
# },
|
4927
|
+
# name: "Name", # required
|
4928
|
+
# references: {
|
4929
|
+
# "ReferenceKey" => {
|
4930
|
+
# value: "ReferenceValue", # required
|
4931
|
+
# type: "URL", # required, accepts URL
|
4932
|
+
# },
|
4933
|
+
# },
|
4934
|
+
# description: "Description",
|
4935
|
+
# client_token: "ClientToken",
|
4936
|
+
# }
|
4937
|
+
#
|
4938
|
+
# @!attribute [rw] instance_id
|
4939
|
+
# The identifier of the Amazon Connect instance.
|
4940
|
+
# @return [String]
|
4941
|
+
#
|
4942
|
+
# @!attribute [rw] previous_contact_id
|
4943
|
+
# The identifier of the previous chat, voice, or task contact.
|
4944
|
+
# @return [String]
|
4945
|
+
#
|
4946
|
+
# @!attribute [rw] contact_flow_id
|
4947
|
+
# The identifier of the contact flow for initiating the tasks. To see
|
4948
|
+
# the ContactFlowId in the Amazon Connect console user interface, on
|
4949
|
+
# the navigation menu go to **Routing**, **Contact Flows**. Choose the
|
4950
|
+
# contact flow. On the contact flow page, under the name of the
|
4951
|
+
# contact flow, choose **Show additional flow information**. The
|
4952
|
+
# ContactFlowId is the last part of the ARN, shown here in bold:
|
4953
|
+
#
|
4954
|
+
# arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
|
4955
|
+
# @return [String]
|
4956
|
+
#
|
4957
|
+
# @!attribute [rw] attributes
|
4958
|
+
# A custom key-value pair using an attribute map. The attributes are
|
4959
|
+
# standard Amazon Connect attributes, and can be accessed in contact
|
4960
|
+
# flows just like any other contact attributes.
|
4961
|
+
#
|
4962
|
+
# There can be up to 32,768 UTF-8 bytes across all key-value pairs per
|
4963
|
+
# contact. Attribute keys can include only alphanumeric, dash, and
|
4964
|
+
# underscore characters.
|
4965
|
+
# @return [Hash<String,String>]
|
4966
|
+
#
|
4967
|
+
# @!attribute [rw] name
|
4968
|
+
# The name of a task that is shown to an agent in the Contact Control
|
4969
|
+
# Panel (CCP).
|
4970
|
+
# @return [String]
|
4971
|
+
#
|
4972
|
+
# @!attribute [rw] references
|
4973
|
+
# A formatted URL that is shown to an agent in the Contact Control
|
4974
|
+
# Panel (CCP).
|
4975
|
+
# @return [Hash<String,Types::Reference>]
|
4976
|
+
#
|
4977
|
+
# @!attribute [rw] description
|
4978
|
+
# A description of the task that is shown to an agent in the Contact
|
4979
|
+
# Control Panel (CCP).
|
4980
|
+
# @return [String]
|
4981
|
+
#
|
4982
|
+
# @!attribute [rw] client_token
|
4983
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
4984
|
+
# idempotency of the request.
|
4985
|
+
#
|
4986
|
+
# **A suitable default value is auto-generated.** You should normally
|
4987
|
+
# not need to pass this option.
|
4988
|
+
# @return [String]
|
4989
|
+
#
|
4990
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartTaskContactRequest AWS API Documentation
|
4991
|
+
#
|
4992
|
+
class StartTaskContactRequest < Struct.new(
|
4993
|
+
:instance_id,
|
4994
|
+
:previous_contact_id,
|
4995
|
+
:contact_flow_id,
|
4996
|
+
:attributes,
|
4997
|
+
:name,
|
4998
|
+
:references,
|
4999
|
+
:description,
|
5000
|
+
:client_token)
|
5001
|
+
SENSITIVE = []
|
5002
|
+
include Aws::Structure
|
5003
|
+
end
|
5004
|
+
|
5005
|
+
# @!attribute [rw] contact_id
|
5006
|
+
# The identifier of this contact within the Amazon Connect instance.
|
5007
|
+
# @return [String]
|
5008
|
+
#
|
5009
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartTaskContactResponse AWS API Documentation
|
5010
|
+
#
|
5011
|
+
class StartTaskContactResponse < Struct.new(
|
5012
|
+
:contact_id)
|
5013
|
+
SENSITIVE = []
|
5014
|
+
include Aws::Structure
|
5015
|
+
end
|
5016
|
+
|
3053
5017
|
# @note When making an API call, you may pass StopContactRecordingRequest
|
3054
5018
|
# data as a hash:
|
3055
5019
|
#
|
@@ -3306,7 +5270,13 @@ module Aws::Connect
|
|
3306
5270
|
# @return [String]
|
3307
5271
|
#
|
3308
5272
|
# @!attribute [rw] content
|
3309
|
-
# The
|
5273
|
+
# The JSON string that represents contact flow’s content. For an
|
5274
|
+
# example, see [Example contact flow in Amazon Connect Flow
|
5275
|
+
# language][1] in the *Amazon Connect Administrator Guide*.
|
5276
|
+
#
|
5277
|
+
#
|
5278
|
+
#
|
5279
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/flow-language-example.html
|
3310
5280
|
# @return [String]
|
3311
5281
|
#
|
3312
5282
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowContentRequest AWS API Documentation
|
@@ -3356,6 +5326,100 @@ module Aws::Connect
|
|
3356
5326
|
include Aws::Structure
|
3357
5327
|
end
|
3358
5328
|
|
5329
|
+
# @note When making an API call, you may pass UpdateInstanceAttributeRequest
|
5330
|
+
# data as a hash:
|
5331
|
+
#
|
5332
|
+
# {
|
5333
|
+
# instance_id: "InstanceId", # required
|
5334
|
+
# attribute_type: "INBOUND_CALLS", # required, accepts INBOUND_CALLS, OUTBOUND_CALLS, CONTACTFLOW_LOGS, CONTACT_LENS, AUTO_RESOLVE_BEST_VOICES, USE_CUSTOM_TTS_VOICES, EARLY_MEDIA
|
5335
|
+
# value: "InstanceAttributeValue", # required
|
5336
|
+
# }
|
5337
|
+
#
|
5338
|
+
# @!attribute [rw] instance_id
|
5339
|
+
# The identifier of the Amazon Connect instance.
|
5340
|
+
# @return [String]
|
5341
|
+
#
|
5342
|
+
# @!attribute [rw] attribute_type
|
5343
|
+
# The type of attribute.
|
5344
|
+
# @return [String]
|
5345
|
+
#
|
5346
|
+
# @!attribute [rw] value
|
5347
|
+
# The value for the attribute. Maximum character limit is 100.
|
5348
|
+
# @return [String]
|
5349
|
+
#
|
5350
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateInstanceAttributeRequest AWS API Documentation
|
5351
|
+
#
|
5352
|
+
class UpdateInstanceAttributeRequest < Struct.new(
|
5353
|
+
:instance_id,
|
5354
|
+
:attribute_type,
|
5355
|
+
:value)
|
5356
|
+
SENSITIVE = []
|
5357
|
+
include Aws::Structure
|
5358
|
+
end
|
5359
|
+
|
5360
|
+
# @note When making an API call, you may pass UpdateInstanceStorageConfigRequest
|
5361
|
+
# data as a hash:
|
5362
|
+
#
|
5363
|
+
# {
|
5364
|
+
# instance_id: "InstanceId", # required
|
5365
|
+
# association_id: "AssociationId", # required
|
5366
|
+
# resource_type: "CHAT_TRANSCRIPTS", # required, accepts CHAT_TRANSCRIPTS, CALL_RECORDINGS, SCHEDULED_REPORTS, MEDIA_STREAMS, CONTACT_TRACE_RECORDS, AGENT_EVENTS
|
5367
|
+
# storage_config: { # required
|
5368
|
+
# association_id: "AssociationId",
|
5369
|
+
# storage_type: "S3", # required, accepts S3, KINESIS_VIDEO_STREAM, KINESIS_STREAM, KINESIS_FIREHOSE
|
5370
|
+
# s3_config: {
|
5371
|
+
# bucket_name: "BucketName", # required
|
5372
|
+
# bucket_prefix: "Prefix", # required
|
5373
|
+
# encryption_config: {
|
5374
|
+
# encryption_type: "KMS", # required, accepts KMS
|
5375
|
+
# key_id: "KeyId", # required
|
5376
|
+
# },
|
5377
|
+
# },
|
5378
|
+
# kinesis_video_stream_config: {
|
5379
|
+
# prefix: "Prefix", # required
|
5380
|
+
# retention_period_hours: 1, # required
|
5381
|
+
# encryption_config: { # required
|
5382
|
+
# encryption_type: "KMS", # required, accepts KMS
|
5383
|
+
# key_id: "KeyId", # required
|
5384
|
+
# },
|
5385
|
+
# },
|
5386
|
+
# kinesis_stream_config: {
|
5387
|
+
# stream_arn: "ARN", # required
|
5388
|
+
# },
|
5389
|
+
# kinesis_firehose_config: {
|
5390
|
+
# firehose_arn: "ARN", # required
|
5391
|
+
# },
|
5392
|
+
# },
|
5393
|
+
# }
|
5394
|
+
#
|
5395
|
+
# @!attribute [rw] instance_id
|
5396
|
+
# The identifier of the Amazon Connect instance.
|
5397
|
+
# @return [String]
|
5398
|
+
#
|
5399
|
+
# @!attribute [rw] association_id
|
5400
|
+
# The existing association identifier that uniquely identifies the
|
5401
|
+
# resource type and storage config for the given instance ID.
|
5402
|
+
# @return [String]
|
5403
|
+
#
|
5404
|
+
# @!attribute [rw] resource_type
|
5405
|
+
# A valid resource type.
|
5406
|
+
# @return [String]
|
5407
|
+
#
|
5408
|
+
# @!attribute [rw] storage_config
|
5409
|
+
# The storage configuration for the instance.
|
5410
|
+
# @return [Types::InstanceStorageConfig]
|
5411
|
+
#
|
5412
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateInstanceStorageConfigRequest AWS API Documentation
|
5413
|
+
#
|
5414
|
+
class UpdateInstanceStorageConfigRequest < Struct.new(
|
5415
|
+
:instance_id,
|
5416
|
+
:association_id,
|
5417
|
+
:resource_type,
|
5418
|
+
:storage_config)
|
5419
|
+
SENSITIVE = []
|
5420
|
+
include Aws::Structure
|
5421
|
+
end
|
5422
|
+
|
3359
5423
|
# @note When making an API call, you may pass UpdateRoutingProfileConcurrencyRequest
|
3360
5424
|
# data as a hash:
|
3361
5425
|
#
|
@@ -3364,7 +5428,7 @@ module Aws::Connect
|
|
3364
5428
|
# routing_profile_id: "RoutingProfileId", # required
|
3365
5429
|
# media_concurrencies: [ # required
|
3366
5430
|
# {
|
3367
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
5431
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
3368
5432
|
# concurrency: 1, # required
|
3369
5433
|
# },
|
3370
5434
|
# ],
|
@@ -3472,7 +5536,7 @@ module Aws::Connect
|
|
3472
5536
|
# {
|
3473
5537
|
# queue_reference: { # required
|
3474
5538
|
# queue_id: "QueueId", # required
|
3475
|
-
# channel: "VOICE", # required, accepts VOICE, CHAT
|
5539
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK
|
3476
5540
|
# },
|
3477
5541
|
# priority: 1, # required
|
3478
5542
|
# delay: 1, # required
|
@@ -3489,7 +5553,9 @@ module Aws::Connect
|
|
3489
5553
|
# @return [String]
|
3490
5554
|
#
|
3491
5555
|
# @!attribute [rw] queue_configs
|
3492
|
-
# The queues to be updated for this routing profile.
|
5556
|
+
# The queues to be updated for this routing profile. Queues must first
|
5557
|
+
# be associated to the routing profile. You can do this using
|
5558
|
+
# AssociateRoutingProfileQueues.
|
3493
5559
|
# @return [Array<Types::RoutingProfileQueueConfig>]
|
3494
5560
|
#
|
3495
5561
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRoutingProfileQueuesRequest AWS API Documentation
|
@@ -3502,6 +5568,38 @@ module Aws::Connect
|
|
3502
5568
|
include Aws::Structure
|
3503
5569
|
end
|
3504
5570
|
|
5571
|
+
# @note When making an API call, you may pass UpdateUserHierarchyGroupNameRequest
|
5572
|
+
# data as a hash:
|
5573
|
+
#
|
5574
|
+
# {
|
5575
|
+
# name: "HierarchyGroupName", # required
|
5576
|
+
# hierarchy_group_id: "HierarchyGroupId", # required
|
5577
|
+
# instance_id: "InstanceId", # required
|
5578
|
+
# }
|
5579
|
+
#
|
5580
|
+
# @!attribute [rw] name
|
5581
|
+
# The name of the hierarchy group. Must not be more than 100
|
5582
|
+
# characters.
|
5583
|
+
# @return [String]
|
5584
|
+
#
|
5585
|
+
# @!attribute [rw] hierarchy_group_id
|
5586
|
+
# The identifier of the hierarchy group.
|
5587
|
+
# @return [String]
|
5588
|
+
#
|
5589
|
+
# @!attribute [rw] instance_id
|
5590
|
+
# The identifier of the Amazon Connect instance.
|
5591
|
+
# @return [String]
|
5592
|
+
#
|
5593
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserHierarchyGroupNameRequest AWS API Documentation
|
5594
|
+
#
|
5595
|
+
class UpdateUserHierarchyGroupNameRequest < Struct.new(
|
5596
|
+
:name,
|
5597
|
+
:hierarchy_group_id,
|
5598
|
+
:instance_id)
|
5599
|
+
SENSITIVE = []
|
5600
|
+
include Aws::Structure
|
5601
|
+
end
|
5602
|
+
|
3505
5603
|
# @note When making an API call, you may pass UpdateUserHierarchyRequest
|
3506
5604
|
# data as a hash:
|
3507
5605
|
#
|
@@ -3533,6 +5631,47 @@ module Aws::Connect
|
|
3533
5631
|
include Aws::Structure
|
3534
5632
|
end
|
3535
5633
|
|
5634
|
+
# @note When making an API call, you may pass UpdateUserHierarchyStructureRequest
|
5635
|
+
# data as a hash:
|
5636
|
+
#
|
5637
|
+
# {
|
5638
|
+
# hierarchy_structure: { # required
|
5639
|
+
# level_one: {
|
5640
|
+
# name: "HierarchyLevelName", # required
|
5641
|
+
# },
|
5642
|
+
# level_two: {
|
5643
|
+
# name: "HierarchyLevelName", # required
|
5644
|
+
# },
|
5645
|
+
# level_three: {
|
5646
|
+
# name: "HierarchyLevelName", # required
|
5647
|
+
# },
|
5648
|
+
# level_four: {
|
5649
|
+
# name: "HierarchyLevelName", # required
|
5650
|
+
# },
|
5651
|
+
# level_five: {
|
5652
|
+
# name: "HierarchyLevelName", # required
|
5653
|
+
# },
|
5654
|
+
# },
|
5655
|
+
# instance_id: "InstanceId", # required
|
5656
|
+
# }
|
5657
|
+
#
|
5658
|
+
# @!attribute [rw] hierarchy_structure
|
5659
|
+
# The hierarchy levels to update.
|
5660
|
+
# @return [Types::HierarchyStructureUpdate]
|
5661
|
+
#
|
5662
|
+
# @!attribute [rw] instance_id
|
5663
|
+
# The identifier of the Amazon Connect instance.
|
5664
|
+
# @return [String]
|
5665
|
+
#
|
5666
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateUserHierarchyStructureRequest AWS API Documentation
|
5667
|
+
#
|
5668
|
+
class UpdateUserHierarchyStructureRequest < Struct.new(
|
5669
|
+
:hierarchy_structure,
|
5670
|
+
:instance_id)
|
5671
|
+
SENSITIVE = []
|
5672
|
+
include Aws::Structure
|
5673
|
+
end
|
5674
|
+
|
3536
5675
|
# @note When making an API call, you may pass UpdateUserIdentityInfoRequest
|
3537
5676
|
# data as a hash:
|
3538
5677
|
#
|
@@ -3666,6 +5805,32 @@ module Aws::Connect
|
|
3666
5805
|
include Aws::Structure
|
3667
5806
|
end
|
3668
5807
|
|
5808
|
+
# Contains the use case.
|
5809
|
+
#
|
5810
|
+
# @!attribute [rw] use_case_id
|
5811
|
+
# The identifier for the use case.
|
5812
|
+
# @return [String]
|
5813
|
+
#
|
5814
|
+
# @!attribute [rw] use_case_arn
|
5815
|
+
# The Amazon Resource Name (ARN) for the use case.
|
5816
|
+
# @return [String]
|
5817
|
+
#
|
5818
|
+
# @!attribute [rw] use_case_type
|
5819
|
+
# The type of use case to associate to the AppIntegration association.
|
5820
|
+
# Each AppIntegration association can have only one of each use case
|
5821
|
+
# type.
|
5822
|
+
# @return [String]
|
5823
|
+
#
|
5824
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UseCase AWS API Documentation
|
5825
|
+
#
|
5826
|
+
class UseCase < Struct.new(
|
5827
|
+
:use_case_id,
|
5828
|
+
:use_case_arn,
|
5829
|
+
:use_case_type)
|
5830
|
+
SENSITIVE = []
|
5831
|
+
include Aws::Structure
|
5832
|
+
end
|
5833
|
+
|
3669
5834
|
# Contains information about a user account for a Amazon Connect
|
3670
5835
|
# instance.
|
3671
5836
|
#
|