aws-sdk-connect 1.260.0 → 1.262.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +294 -4
- data/lib/aws-sdk-connect/client_api.rb +171 -0
- data/lib/aws-sdk-connect/types.rb +474 -0
- data/lib/aws-sdk-connect.rb +1 -1
- data/sig/client.rbs +88 -2
- data/sig/types.rbs +118 -3
- metadata +1 -1
|
@@ -745,6 +745,40 @@ module Aws::Connect
|
|
|
745
745
|
include Aws::Structure
|
|
746
746
|
end
|
|
747
747
|
|
|
748
|
+
# The configuration for conversational analytics.
|
|
749
|
+
#
|
|
750
|
+
# @!attribute [rw] language_configuration
|
|
751
|
+
# The language configuration for conversational analytics.
|
|
752
|
+
# @return [Types::LanguageConfiguration]
|
|
753
|
+
#
|
|
754
|
+
# @!attribute [rw] redaction_configuration
|
|
755
|
+
# The redaction configuration for conversational analytics.
|
|
756
|
+
# @return [Types::RedactionConfiguration]
|
|
757
|
+
#
|
|
758
|
+
# @!attribute [rw] sentiment_configuration
|
|
759
|
+
# The sentiment configuration for conversational analytics.
|
|
760
|
+
# @return [Types::SentimentConfiguration]
|
|
761
|
+
#
|
|
762
|
+
# @!attribute [rw] summary_configuration
|
|
763
|
+
# The summary configuration for conversational analytics.
|
|
764
|
+
# @return [Types::SummaryConfiguration]
|
|
765
|
+
#
|
|
766
|
+
# @!attribute [rw] rules_configuration
|
|
767
|
+
# The rules configuration for conversational analytics.
|
|
768
|
+
# @return [Types::RulesConfiguration]
|
|
769
|
+
#
|
|
770
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AnalyticsConfiguration AWS API Documentation
|
|
771
|
+
#
|
|
772
|
+
class AnalyticsConfiguration < Struct.new(
|
|
773
|
+
:language_configuration,
|
|
774
|
+
:redaction_configuration,
|
|
775
|
+
:sentiment_configuration,
|
|
776
|
+
:summary_configuration,
|
|
777
|
+
:rules_configuration)
|
|
778
|
+
SENSITIVE = []
|
|
779
|
+
include Aws::Structure
|
|
780
|
+
end
|
|
781
|
+
|
|
748
782
|
# This API is in preview release for Connect Customer and is subject to
|
|
749
783
|
# change.
|
|
750
784
|
#
|
|
@@ -5052,6 +5086,23 @@ module Aws::Connect
|
|
|
5052
5086
|
include Aws::Structure
|
|
5053
5087
|
end
|
|
5054
5088
|
|
|
5089
|
+
# Optional attributes used to populate the content of an outbound web
|
|
5090
|
+
# notification, such as recommender configuration for personalized
|
|
5091
|
+
# content.
|
|
5092
|
+
#
|
|
5093
|
+
# @!attribute [rw] recommender_config
|
|
5094
|
+
# Configuration for the recommender used to generate personalized
|
|
5095
|
+
# recommendations for the notification content.
|
|
5096
|
+
# @return [Types::RecommenderConfig]
|
|
5097
|
+
#
|
|
5098
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContentAttributes AWS API Documentation
|
|
5099
|
+
#
|
|
5100
|
+
class ContentAttributes < Struct.new(
|
|
5101
|
+
:recommender_config)
|
|
5102
|
+
SENSITIVE = []
|
|
5103
|
+
include Aws::Structure
|
|
5104
|
+
end
|
|
5105
|
+
|
|
5055
5106
|
# An object that can be used to specify Tag conditions inside the
|
|
5056
5107
|
# `SearchFilter`. This accepts an `OR` or `AND` (List of List) input
|
|
5057
5108
|
# where:
|
|
@@ -5230,6 +5281,100 @@ module Aws::Connect
|
|
|
5230
5281
|
include Aws::Structure
|
|
5231
5282
|
end
|
|
5232
5283
|
|
|
5284
|
+
# @!attribute [rw] client_token
|
|
5285
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
5286
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
|
5287
|
+
# SDK populates this field. For more information about idempotency,
|
|
5288
|
+
# see [Making retries safe with idempotent APIs][1].
|
|
5289
|
+
#
|
|
5290
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
5291
|
+
# not need to pass this option.
|
|
5292
|
+
#
|
|
5293
|
+
#
|
|
5294
|
+
#
|
|
5295
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
5296
|
+
# @return [String]
|
|
5297
|
+
#
|
|
5298
|
+
# @!attribute [rw] instance_id
|
|
5299
|
+
# The identifier of the Connect Customer instance. You can [find the
|
|
5300
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
5301
|
+
#
|
|
5302
|
+
#
|
|
5303
|
+
#
|
|
5304
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
5305
|
+
# @return [String]
|
|
5306
|
+
#
|
|
5307
|
+
# @!attribute [rw] file_use_case_type
|
|
5308
|
+
# The use case for the file.
|
|
5309
|
+
#
|
|
5310
|
+
# Only `VOICE_RECORDING` is supported.
|
|
5311
|
+
# @return [String]
|
|
5312
|
+
#
|
|
5313
|
+
# @!attribute [rw] file_source_uri
|
|
5314
|
+
# The S3 URI of the file to be attached. Only S3 source URIs are
|
|
5315
|
+
# supported.
|
|
5316
|
+
# @return [String]
|
|
5317
|
+
#
|
|
5318
|
+
# @!attribute [rw] associated_resource_arn
|
|
5319
|
+
# The ARN of the completed voice contact to attach the file to. Only
|
|
5320
|
+
# voice contacts with Telephony subtype are supported.
|
|
5321
|
+
#
|
|
5322
|
+
# <note markdown="1"> This value must be a valid ARN.
|
|
5323
|
+
#
|
|
5324
|
+
# </note>
|
|
5325
|
+
# @return [String]
|
|
5326
|
+
#
|
|
5327
|
+
# @!attribute [rw] tags
|
|
5328
|
+
# The tags used to organize, track, or control access for this
|
|
5329
|
+
# resource. For example, `{ "Tags": {"key1":"value1", "key2":"value2"}
|
|
5330
|
+
# }`.
|
|
5331
|
+
# @return [Hash<String,String>]
|
|
5332
|
+
#
|
|
5333
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateAttachedFileRequest AWS API Documentation
|
|
5334
|
+
#
|
|
5335
|
+
class CreateAttachedFileRequest < Struct.new(
|
|
5336
|
+
:client_token,
|
|
5337
|
+
:instance_id,
|
|
5338
|
+
:file_use_case_type,
|
|
5339
|
+
:file_source_uri,
|
|
5340
|
+
:associated_resource_arn,
|
|
5341
|
+
:tags)
|
|
5342
|
+
SENSITIVE = []
|
|
5343
|
+
include Aws::Structure
|
|
5344
|
+
end
|
|
5345
|
+
|
|
5346
|
+
# Response from CreateAttachedFile API.
|
|
5347
|
+
#
|
|
5348
|
+
# @!attribute [rw] file_arn
|
|
5349
|
+
# The unique identifier of the attached file resource (ARN).
|
|
5350
|
+
# @return [String]
|
|
5351
|
+
#
|
|
5352
|
+
# @!attribute [rw] file_id
|
|
5353
|
+
# The unique identifier of the attached file resource.
|
|
5354
|
+
# @return [String]
|
|
5355
|
+
#
|
|
5356
|
+
# @!attribute [rw] creation_time
|
|
5357
|
+
# The time of Creation of the file resource as an ISO timestamp. It's
|
|
5358
|
+
# specified in ISO 8601 format: `yyyy-MM-ddThh:mm:ss.SSSZ`. For
|
|
5359
|
+
# example, `2024-05-03T02:41:28.172Z`.
|
|
5360
|
+
# @return [String]
|
|
5361
|
+
#
|
|
5362
|
+
# @!attribute [rw] file_status
|
|
5363
|
+
# The current status of the attached file. Valid values: `PROCESSING`
|
|
5364
|
+
# \| `APPROVED` \| `REJECTED` \| `FAILED`.
|
|
5365
|
+
# @return [String]
|
|
5366
|
+
#
|
|
5367
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateAttachedFileResponse AWS API Documentation
|
|
5368
|
+
#
|
|
5369
|
+
class CreateAttachedFileResponse < Struct.new(
|
|
5370
|
+
:file_arn,
|
|
5371
|
+
:file_id,
|
|
5372
|
+
:creation_time,
|
|
5373
|
+
:file_status)
|
|
5374
|
+
SENSITIVE = []
|
|
5375
|
+
include Aws::Structure
|
|
5376
|
+
end
|
|
5377
|
+
|
|
5233
5378
|
# The `CreateCase` action definition.
|
|
5234
5379
|
#
|
|
5235
5380
|
# @!attribute [rw] fields
|
|
@@ -20593,6 +20738,20 @@ module Aws::Connect
|
|
|
20593
20738
|
include Aws::Structure
|
|
20594
20739
|
end
|
|
20595
20740
|
|
|
20741
|
+
# The language configuration for conversational analytics.
|
|
20742
|
+
#
|
|
20743
|
+
# @!attribute [rw] language_locale
|
|
20744
|
+
# The language locale setting for conversational analytics.
|
|
20745
|
+
# @return [String]
|
|
20746
|
+
#
|
|
20747
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/LanguageConfiguration AWS API Documentation
|
|
20748
|
+
#
|
|
20749
|
+
class LanguageConfiguration < Struct.new(
|
|
20750
|
+
:language_locale)
|
|
20751
|
+
SENSITIVE = []
|
|
20752
|
+
include Aws::Structure
|
|
20753
|
+
end
|
|
20754
|
+
|
|
20596
20755
|
# Configuration information of an Amazon Lex bot.
|
|
20597
20756
|
#
|
|
20598
20757
|
# @!attribute [rw] name
|
|
@@ -27647,6 +27806,33 @@ module Aws::Connect
|
|
|
27647
27806
|
class Unknown < RealtimeContactAnalysisSegment; end
|
|
27648
27807
|
end
|
|
27649
27808
|
|
|
27809
|
+
# Configuration for the recommender used to generate personalized
|
|
27810
|
+
# recommendations included in an outbound web notification.
|
|
27811
|
+
#
|
|
27812
|
+
# @!attribute [rw] domain_name
|
|
27813
|
+
# The name of the Amazon Personalize domain that hosts the
|
|
27814
|
+
# recommender.
|
|
27815
|
+
# @return [String]
|
|
27816
|
+
#
|
|
27817
|
+
# @!attribute [rw] recommender_name
|
|
27818
|
+
# The name of the recommender used to generate the recommendations.
|
|
27819
|
+
# @return [String]
|
|
27820
|
+
#
|
|
27821
|
+
# @!attribute [rw] context
|
|
27822
|
+
# A map of contextual key-value pairs supplied to the recommender to
|
|
27823
|
+
# influence the recommendations returned.
|
|
27824
|
+
# @return [Hash<String,String>]
|
|
27825
|
+
#
|
|
27826
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RecommenderConfig AWS API Documentation
|
|
27827
|
+
#
|
|
27828
|
+
class RecommenderConfig < Struct.new(
|
|
27829
|
+
:domain_name,
|
|
27830
|
+
:recommender_name,
|
|
27831
|
+
:context)
|
|
27832
|
+
SENSITIVE = []
|
|
27833
|
+
include Aws::Structure
|
|
27834
|
+
end
|
|
27835
|
+
|
|
27650
27836
|
# A record primary value.
|
|
27651
27837
|
#
|
|
27652
27838
|
# @!attribute [rw] record_id
|
|
@@ -27845,6 +28031,42 @@ module Aws::Connect
|
|
|
27845
28031
|
include Aws::Structure
|
|
27846
28032
|
end
|
|
27847
28033
|
|
|
28034
|
+
# The redaction configuration for conversational analytics.
|
|
28035
|
+
#
|
|
28036
|
+
# @!attribute [rw] behavior
|
|
28037
|
+
# Controls whether redaction is applied to the analytics output. Valid
|
|
28038
|
+
# values: `Enable` \| `Disable`.
|
|
28039
|
+
# @return [String]
|
|
28040
|
+
#
|
|
28041
|
+
# @!attribute [rw] policy
|
|
28042
|
+
# The redaction output policy that determines which versions of the
|
|
28043
|
+
# transcript are stored. Valid values: `None` \| `RedactedOnly` \|
|
|
28044
|
+
# `RedactedAndOriginal`.
|
|
28045
|
+
# @return [String]
|
|
28046
|
+
#
|
|
28047
|
+
# @!attribute [rw] entities
|
|
28048
|
+
# The list of PII entity types to redact from the transcript (for
|
|
28049
|
+
# example, `NAME`, `ADDRESS`, `CREDIT_DEBIT_NUMBER`).
|
|
28050
|
+
# @return [Array<String>]
|
|
28051
|
+
#
|
|
28052
|
+
# @!attribute [rw] mask_mode
|
|
28053
|
+
# The masking mode that determines how redacted content is replaced in
|
|
28054
|
+
# the output. Valid values: `PII` (replaces with the literal string
|
|
28055
|
+
# \[PII\]) \| `EntityType` (replaces with the entity type name, for
|
|
28056
|
+
# example \[NAME\]).
|
|
28057
|
+
# @return [String]
|
|
28058
|
+
#
|
|
28059
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RedactionConfiguration AWS API Documentation
|
|
28060
|
+
#
|
|
28061
|
+
class RedactionConfiguration < Struct.new(
|
|
28062
|
+
:behavior,
|
|
28063
|
+
:policy,
|
|
28064
|
+
:entities,
|
|
28065
|
+
:mask_mode)
|
|
28066
|
+
SENSITIVE = []
|
|
28067
|
+
include Aws::Structure
|
|
28068
|
+
end
|
|
28069
|
+
|
|
27848
28070
|
# Well-formed data on a contact, used by agents to complete a contact
|
|
27849
28071
|
# request. You can have up to 4,096 UTF-8 bytes across all references
|
|
27850
28072
|
# for a contact.
|
|
@@ -29001,6 +29223,22 @@ module Aws::Connect
|
|
|
29001
29223
|
include Aws::Structure
|
|
29002
29224
|
end
|
|
29003
29225
|
|
|
29226
|
+
# The rules configuration for conversational analytics. Controls whether
|
|
29227
|
+
# Contact Lens rules are evaluated against the analytics output.
|
|
29228
|
+
#
|
|
29229
|
+
# @!attribute [rw] behavior
|
|
29230
|
+
# Controls whether Contact Lens rules are evaluated for the contact.
|
|
29231
|
+
# Valid values: `Enable` \| `Disable`.
|
|
29232
|
+
# @return [String]
|
|
29233
|
+
#
|
|
29234
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RulesConfiguration AWS API Documentation
|
|
29235
|
+
#
|
|
29236
|
+
class RulesConfiguration < Struct.new(
|
|
29237
|
+
:behavior)
|
|
29238
|
+
SENSITIVE = []
|
|
29239
|
+
include Aws::Structure
|
|
29240
|
+
end
|
|
29241
|
+
|
|
29004
29242
|
# Information about the Amazon Simple Storage Service (Amazon S3)
|
|
29005
29243
|
# storage type.
|
|
29006
29244
|
#
|
|
@@ -31504,6 +31742,97 @@ module Aws::Connect
|
|
|
31504
31742
|
#
|
|
31505
31743
|
class SendOutboundEmailResponse < Aws::EmptyStructure; end
|
|
31506
31744
|
|
|
31745
|
+
# @!attribute [rw] instance_id
|
|
31746
|
+
# The identifier of the Connect Customer instance. You can [find the
|
|
31747
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
31748
|
+
#
|
|
31749
|
+
#
|
|
31750
|
+
#
|
|
31751
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
31752
|
+
# @return [String]
|
|
31753
|
+
#
|
|
31754
|
+
# @!attribute [rw] client_token
|
|
31755
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
31756
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
|
31757
|
+
# SDK populates this field. For more information about idempotency,
|
|
31758
|
+
# see [Making retries safe with idempotent APIs][1].
|
|
31759
|
+
#
|
|
31760
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
31761
|
+
# not need to pass this option.
|
|
31762
|
+
#
|
|
31763
|
+
#
|
|
31764
|
+
#
|
|
31765
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
31766
|
+
# @return [String]
|
|
31767
|
+
#
|
|
31768
|
+
# @!attribute [rw] browser_id
|
|
31769
|
+
# A unique identifier for the customer's web browser instance to
|
|
31770
|
+
# which the notification is being sent.
|
|
31771
|
+
# @return [String]
|
|
31772
|
+
#
|
|
31773
|
+
# @!attribute [rw] session_id
|
|
31774
|
+
# A unique identifier for the customer's web session to which the
|
|
31775
|
+
# notification is being sent.
|
|
31776
|
+
# @return [String]
|
|
31777
|
+
#
|
|
31778
|
+
# @!attribute [rw] expires_at
|
|
31779
|
+
# The timestamp, in Unix epoch time format, at which the web
|
|
31780
|
+
# notification expires. After this time, the notification is no longer
|
|
31781
|
+
# delivered to the customer's browser.
|
|
31782
|
+
# @return [Time]
|
|
31783
|
+
#
|
|
31784
|
+
# @!attribute [rw] source
|
|
31785
|
+
# The source of the web notification. A `SourceCampaign` object
|
|
31786
|
+
# identifies the campaign and outbound request that triggered this
|
|
31787
|
+
# notification.
|
|
31788
|
+
# @return [Types::WebNotificationSource]
|
|
31789
|
+
#
|
|
31790
|
+
# @!attribute [rw] destination
|
|
31791
|
+
# The destination for the web notification, specifying the
|
|
31792
|
+
# communication widget that delivers the notification and the customer
|
|
31793
|
+
# profile of the recipient.
|
|
31794
|
+
# @return [Types::WidgetDestination]
|
|
31795
|
+
#
|
|
31796
|
+
# @!attribute [rw] content
|
|
31797
|
+
# The content of the web notification, including the notification
|
|
31798
|
+
# type, the view to render, and any optional attributes used to
|
|
31799
|
+
# populate it.
|
|
31800
|
+
# @return [Types::WebNotificationContent]
|
|
31801
|
+
#
|
|
31802
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SendOutboundWebNotificationRequest AWS API Documentation
|
|
31803
|
+
#
|
|
31804
|
+
class SendOutboundWebNotificationRequest < Struct.new(
|
|
31805
|
+
:instance_id,
|
|
31806
|
+
:client_token,
|
|
31807
|
+
:browser_id,
|
|
31808
|
+
:session_id,
|
|
31809
|
+
:expires_at,
|
|
31810
|
+
:source,
|
|
31811
|
+
:destination,
|
|
31812
|
+
:content)
|
|
31813
|
+
SENSITIVE = []
|
|
31814
|
+
include Aws::Structure
|
|
31815
|
+
end
|
|
31816
|
+
|
|
31817
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SendOutboundWebNotificationResponse AWS API Documentation
|
|
31818
|
+
#
|
|
31819
|
+
class SendOutboundWebNotificationResponse < Aws::EmptyStructure; end
|
|
31820
|
+
|
|
31821
|
+
# The sentiment configuration for conversational analytics.
|
|
31822
|
+
#
|
|
31823
|
+
# @!attribute [rw] behavior
|
|
31824
|
+
# Controls whether sentiment analysis is applied to the analytics
|
|
31825
|
+
# output. Valid values: `Enable` \| `Disable`.
|
|
31826
|
+
# @return [String]
|
|
31827
|
+
#
|
|
31828
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SentimentConfiguration AWS API Documentation
|
|
31829
|
+
#
|
|
31830
|
+
class SentimentConfiguration < Struct.new(
|
|
31831
|
+
:behavior)
|
|
31832
|
+
SENSITIVE = []
|
|
31833
|
+
include Aws::Structure
|
|
31834
|
+
end
|
|
31835
|
+
|
|
31507
31836
|
# The service quota has been exceeded.
|
|
31508
31837
|
#
|
|
31509
31838
|
# @!attribute [rw] message
|
|
@@ -31955,6 +32284,68 @@ module Aws::Connect
|
|
|
31955
32284
|
include Aws::Structure
|
|
31956
32285
|
end
|
|
31957
32286
|
|
|
32287
|
+
# @!attribute [rw] instance_id
|
|
32288
|
+
# The identifier of the Connect Customer instance. You can [find the
|
|
32289
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
32290
|
+
#
|
|
32291
|
+
#
|
|
32292
|
+
#
|
|
32293
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
32294
|
+
# @return [String]
|
|
32295
|
+
#
|
|
32296
|
+
# @!attribute [rw] contact_id
|
|
32297
|
+
# The identifier of the contact in this instance of Connect Customer.
|
|
32298
|
+
# @return [String]
|
|
32299
|
+
#
|
|
32300
|
+
# @!attribute [rw] analytics_modes
|
|
32301
|
+
# The analytics modes to run for the contact. Valid values:
|
|
32302
|
+
# `PostContact`.
|
|
32303
|
+
# @return [Array<String>]
|
|
32304
|
+
#
|
|
32305
|
+
# @!attribute [rw] analytics_configuration
|
|
32306
|
+
# The configuration for the conversational analytics job.
|
|
32307
|
+
# @return [Types::AnalyticsConfiguration]
|
|
32308
|
+
#
|
|
32309
|
+
# @!attribute [rw] client_token
|
|
32310
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
32311
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
|
32312
|
+
# SDK populates this field. For more information about idempotency,
|
|
32313
|
+
# see [Making retries safe with idempotent APIs][1].
|
|
32314
|
+
#
|
|
32315
|
+
#
|
|
32316
|
+
#
|
|
32317
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
32318
|
+
# @return [String]
|
|
32319
|
+
#
|
|
32320
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartContactConversationalAnalyticsJobRequest AWS API Documentation
|
|
32321
|
+
#
|
|
32322
|
+
class StartContactConversationalAnalyticsJobRequest < Struct.new(
|
|
32323
|
+
:instance_id,
|
|
32324
|
+
:contact_id,
|
|
32325
|
+
:analytics_modes,
|
|
32326
|
+
:analytics_configuration,
|
|
32327
|
+
:client_token)
|
|
32328
|
+
SENSITIVE = []
|
|
32329
|
+
include Aws::Structure
|
|
32330
|
+
end
|
|
32331
|
+
|
|
32332
|
+
# @!attribute [rw] instance_id
|
|
32333
|
+
# The identifier of the Connect Customer instance.
|
|
32334
|
+
# @return [String]
|
|
32335
|
+
#
|
|
32336
|
+
# @!attribute [rw] contact_id
|
|
32337
|
+
# The identifier of the contact.
|
|
32338
|
+
# @return [String]
|
|
32339
|
+
#
|
|
32340
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartContactConversationalAnalyticsJobResponse AWS API Documentation
|
|
32341
|
+
#
|
|
32342
|
+
class StartContactConversationalAnalyticsJobResponse < Struct.new(
|
|
32343
|
+
:instance_id,
|
|
32344
|
+
:contact_id)
|
|
32345
|
+
SENSITIVE = []
|
|
32346
|
+
include Aws::Structure
|
|
32347
|
+
end
|
|
32348
|
+
|
|
31958
32349
|
# @!attribute [rw] instance_id
|
|
31959
32350
|
# The identifier of the Connect Customer instance. You can [find the
|
|
31960
32351
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
@@ -33477,6 +33868,22 @@ module Aws::Connect
|
|
|
33477
33868
|
include Aws::Structure
|
|
33478
33869
|
end
|
|
33479
33870
|
|
|
33871
|
+
# The summary configuration for conversational analytics.
|
|
33872
|
+
#
|
|
33873
|
+
# @!attribute [rw] summary_modes
|
|
33874
|
+
# The summary modes that determine what type of summarization is
|
|
33875
|
+
# generated. Valid values: `PostContact` \| `AutomatedInteraction` \|
|
|
33876
|
+
# `ContactChain`.
|
|
33877
|
+
# @return [Array<String>]
|
|
33878
|
+
#
|
|
33879
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SummaryConfiguration AWS API Documentation
|
|
33880
|
+
#
|
|
33881
|
+
class SummaryConfiguration < Struct.new(
|
|
33882
|
+
:summary_modes)
|
|
33883
|
+
SENSITIVE = []
|
|
33884
|
+
include Aws::Structure
|
|
33885
|
+
end
|
|
33886
|
+
|
|
33480
33887
|
# @!attribute [rw] instance_id
|
|
33481
33888
|
# The identifier of the Connect Customer instance. You can [find the
|
|
33482
33889
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
@@ -38941,6 +39348,73 @@ module Aws::Connect
|
|
|
38941
39348
|
include Aws::Structure
|
|
38942
39349
|
end
|
|
38943
39350
|
|
|
39351
|
+
# The content of an outbound web notification, including the
|
|
39352
|
+
# notification type, the view to render, and any optional attributes
|
|
39353
|
+
# used to populate the view.
|
|
39354
|
+
#
|
|
39355
|
+
# @!attribute [rw] type
|
|
39356
|
+
# The type of web notification to send.
|
|
39357
|
+
# @return [String]
|
|
39358
|
+
#
|
|
39359
|
+
# @!attribute [rw] view_arn
|
|
39360
|
+
# The Amazon Resource Name (ARN) of the view to render for the
|
|
39361
|
+
# notification.
|
|
39362
|
+
# @return [String]
|
|
39363
|
+
#
|
|
39364
|
+
# @!attribute [rw] attributes
|
|
39365
|
+
# Optional attributes used to populate the notification content, such
|
|
39366
|
+
# as recommender configuration for personalized content.
|
|
39367
|
+
# @return [Types::ContentAttributes]
|
|
39368
|
+
#
|
|
39369
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/WebNotificationContent AWS API Documentation
|
|
39370
|
+
#
|
|
39371
|
+
class WebNotificationContent < Struct.new(
|
|
39372
|
+
:type,
|
|
39373
|
+
:view_arn,
|
|
39374
|
+
:attributes)
|
|
39375
|
+
SENSITIVE = []
|
|
39376
|
+
include Aws::Structure
|
|
39377
|
+
end
|
|
39378
|
+
|
|
39379
|
+
# The source of an outbound web notification. Identifies the campaign
|
|
39380
|
+
# and outbound request that triggered the notification.
|
|
39381
|
+
#
|
|
39382
|
+
# @!attribute [rw] source_campaign
|
|
39383
|
+
# Information about the campaign that triggered the web notification,
|
|
39384
|
+
# including the campaign identifier and outbound request identifier.
|
|
39385
|
+
# @return [Types::SourceCampaign]
|
|
39386
|
+
#
|
|
39387
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/WebNotificationSource AWS API Documentation
|
|
39388
|
+
#
|
|
39389
|
+
class WebNotificationSource < Struct.new(
|
|
39390
|
+
:source_campaign)
|
|
39391
|
+
SENSITIVE = []
|
|
39392
|
+
include Aws::Structure
|
|
39393
|
+
end
|
|
39394
|
+
|
|
39395
|
+
# The destination for an outbound web notification, specifying the
|
|
39396
|
+
# communication widget that delivers the notification and the customer
|
|
39397
|
+
# profile of the recipient.
|
|
39398
|
+
#
|
|
39399
|
+
# @!attribute [rw] widget_id
|
|
39400
|
+
# The identifier of the communication widget that delivers the
|
|
39401
|
+
# notification to the customer's browser.
|
|
39402
|
+
# @return [String]
|
|
39403
|
+
#
|
|
39404
|
+
# @!attribute [rw] profile_id
|
|
39405
|
+
# The identifier of the customer profile associated with the browser
|
|
39406
|
+
# session that should receive the notification.
|
|
39407
|
+
# @return [String]
|
|
39408
|
+
#
|
|
39409
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/WidgetDestination AWS API Documentation
|
|
39410
|
+
#
|
|
39411
|
+
class WidgetDestination < Struct.new(
|
|
39412
|
+
:widget_id,
|
|
39413
|
+
:profile_id)
|
|
39414
|
+
SENSITIVE = []
|
|
39415
|
+
include Aws::Structure
|
|
39416
|
+
end
|
|
39417
|
+
|
|
38944
39418
|
# Information about Connect Customer Wisdom.
|
|
38945
39419
|
#
|
|
38946
39420
|
# @!attribute [rw] session_arn
|
data/lib/aws-sdk-connect.rb
CHANGED
data/sig/client.rbs
CHANGED
|
@@ -538,6 +538,24 @@ module Aws
|
|
|
538
538
|
) -> _CreateAgentStatusResponseSuccess
|
|
539
539
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateAgentStatusResponseSuccess
|
|
540
540
|
|
|
541
|
+
interface _CreateAttachedFileResponseSuccess
|
|
542
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateAttachedFileResponse]
|
|
543
|
+
def file_arn: () -> ::String
|
|
544
|
+
def file_id: () -> ::String
|
|
545
|
+
def creation_time: () -> ::String
|
|
546
|
+
def file_status: () -> ("APPROVED" | "REJECTED" | "PROCESSING" | "FAILED")
|
|
547
|
+
end
|
|
548
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Connect/Client.html#create_attached_file-instance_method
|
|
549
|
+
def create_attached_file: (
|
|
550
|
+
?client_token: ::String,
|
|
551
|
+
instance_id: ::String,
|
|
552
|
+
file_use_case_type: ("CONTACT_ANALYSIS" | "EMAIL_MESSAGE" | "EMAIL_MESSAGE_PLAIN_TEXT" | "EMAIL_MESSAGE_REDACTED" | "EMAIL_MESSAGE_PLAIN_TEXT_REDACTED" | "ATTACHMENT" | "VOICE_RECORDING"),
|
|
553
|
+
file_source_uri: ::String,
|
|
554
|
+
associated_resource_arn: ::String,
|
|
555
|
+
?tags: Hash[::String, ::String]
|
|
556
|
+
) -> _CreateAttachedFileResponseSuccess
|
|
557
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateAttachedFileResponseSuccess
|
|
558
|
+
|
|
541
559
|
interface _CreateContactResponseSuccess
|
|
542
560
|
include ::Seahorse::Client::_ResponseSuccess[Types::CreateContactResponse]
|
|
543
561
|
def contact_id: () -> ::String
|
|
@@ -2239,7 +2257,7 @@ module Aws
|
|
|
2239
2257
|
def file_name: () -> ::String
|
|
2240
2258
|
def file_size_in_bytes: () -> ::Integer
|
|
2241
2259
|
def associated_resource_arn: () -> ::String
|
|
2242
|
-
def file_use_case_type: () -> ("CONTACT_ANALYSIS" | "EMAIL_MESSAGE" | "EMAIL_MESSAGE_PLAIN_TEXT" | "EMAIL_MESSAGE_REDACTED" | "EMAIL_MESSAGE_PLAIN_TEXT_REDACTED" | "ATTACHMENT")
|
|
2260
|
+
def file_use_case_type: () -> ("CONTACT_ANALYSIS" | "EMAIL_MESSAGE" | "EMAIL_MESSAGE_PLAIN_TEXT" | "EMAIL_MESSAGE_REDACTED" | "EMAIL_MESSAGE_PLAIN_TEXT_REDACTED" | "ATTACHMENT" | "VOICE_RECORDING")
|
|
2243
2261
|
def created_by: () -> Types::CreatedByInfo
|
|
2244
2262
|
def download_url_metadata: () -> Types::DownloadUrlMetadata
|
|
2245
2263
|
def tags: () -> ::Hash[::String, ::String]
|
|
@@ -4288,6 +4306,40 @@ module Aws
|
|
|
4288
4306
|
) -> _SendOutboundEmailResponseSuccess
|
|
4289
4307
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SendOutboundEmailResponseSuccess
|
|
4290
4308
|
|
|
4309
|
+
interface _SendOutboundWebNotificationResponseSuccess
|
|
4310
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::SendOutboundWebNotificationResponse]
|
|
4311
|
+
end
|
|
4312
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Connect/Client.html#send_outbound_web_notification-instance_method
|
|
4313
|
+
def send_outbound_web_notification: (
|
|
4314
|
+
instance_id: ::String,
|
|
4315
|
+
?client_token: ::String,
|
|
4316
|
+
browser_id: ::String,
|
|
4317
|
+
session_id: ::String,
|
|
4318
|
+
expires_at: ::Time,
|
|
4319
|
+
source: {
|
|
4320
|
+
source_campaign: {
|
|
4321
|
+
campaign_id: ::String?,
|
|
4322
|
+
outbound_request_id: ::String?
|
|
4323
|
+
}
|
|
4324
|
+
},
|
|
4325
|
+
destination: {
|
|
4326
|
+
widget_id: ::String,
|
|
4327
|
+
profile_id: ::String
|
|
4328
|
+
},
|
|
4329
|
+
content: {
|
|
4330
|
+
type: ("WIDGET_VIEW" | "WIDGET_ACTION"),
|
|
4331
|
+
view_arn: ::String?,
|
|
4332
|
+
attributes: {
|
|
4333
|
+
recommender_config: {
|
|
4334
|
+
domain_name: ::String,
|
|
4335
|
+
recommender_name: ::String,
|
|
4336
|
+
context: Hash[::String, ::String]?
|
|
4337
|
+
}?
|
|
4338
|
+
}?
|
|
4339
|
+
}
|
|
4340
|
+
) -> _SendOutboundWebNotificationResponseSuccess
|
|
4341
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SendOutboundWebNotificationResponseSuccess
|
|
4342
|
+
|
|
4291
4343
|
interface _StartAttachedFileUploadResponseSuccess
|
|
4292
4344
|
include ::Seahorse::Client::_ResponseSuccess[Types::StartAttachedFileUploadResponse]
|
|
4293
4345
|
def file_arn: () -> ::String
|
|
@@ -4304,7 +4356,7 @@ module Aws
|
|
|
4304
4356
|
file_name: ::String,
|
|
4305
4357
|
file_size_in_bytes: ::Integer,
|
|
4306
4358
|
?url_expiry_in_seconds: ::Integer,
|
|
4307
|
-
file_use_case_type: ("CONTACT_ANALYSIS" | "EMAIL_MESSAGE" | "EMAIL_MESSAGE_PLAIN_TEXT" | "EMAIL_MESSAGE_REDACTED" | "EMAIL_MESSAGE_PLAIN_TEXT_REDACTED" | "ATTACHMENT"),
|
|
4359
|
+
file_use_case_type: ("CONTACT_ANALYSIS" | "EMAIL_MESSAGE" | "EMAIL_MESSAGE_PLAIN_TEXT" | "EMAIL_MESSAGE_REDACTED" | "EMAIL_MESSAGE_PLAIN_TEXT_REDACTED" | "ATTACHMENT" | "VOICE_RECORDING"),
|
|
4308
4360
|
associated_resource_arn: ::String,
|
|
4309
4361
|
?created_by: {
|
|
4310
4362
|
connect_user_arn: ::String?,
|
|
@@ -4350,6 +4402,40 @@ module Aws
|
|
|
4350
4402
|
) -> _StartChatContactResponseSuccess
|
|
4351
4403
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartChatContactResponseSuccess
|
|
4352
4404
|
|
|
4405
|
+
interface _StartContactConversationalAnalyticsJobResponseSuccess
|
|
4406
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::StartContactConversationalAnalyticsJobResponse]
|
|
4407
|
+
def instance_id: () -> ::String
|
|
4408
|
+
def contact_id: () -> ::String
|
|
4409
|
+
end
|
|
4410
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Connect/Client.html#start_contact_conversational_analytics_job-instance_method
|
|
4411
|
+
def start_contact_conversational_analytics_job: (
|
|
4412
|
+
instance_id: ::String,
|
|
4413
|
+
contact_id: ::String,
|
|
4414
|
+
analytics_modes: Array[("PostContact" | "RealTime" | "ContactLens" | "AutomatedInteraction")],
|
|
4415
|
+
analytics_configuration: {
|
|
4416
|
+
language_configuration: {
|
|
4417
|
+
language_locale: ::String?
|
|
4418
|
+
},
|
|
4419
|
+
redaction_configuration: {
|
|
4420
|
+
behavior: ("Enable" | "Disable"),
|
|
4421
|
+
policy: ("None" | "RedactedOnly" | "RedactedAndOriginal"),
|
|
4422
|
+
entities: Array[::String]?,
|
|
4423
|
+
mask_mode: ("PII" | "EntityType")?
|
|
4424
|
+
},
|
|
4425
|
+
sentiment_configuration: {
|
|
4426
|
+
behavior: ("Enable" | "Disable")
|
|
4427
|
+
},
|
|
4428
|
+
summary_configuration: {
|
|
4429
|
+
summary_modes: Array[("PostContact" | "AutomatedInteraction" | "ContactChain")]
|
|
4430
|
+
},
|
|
4431
|
+
rules_configuration: {
|
|
4432
|
+
behavior: ("Enable" | "Disable")?
|
|
4433
|
+
}
|
|
4434
|
+
},
|
|
4435
|
+
?client_token: ::String
|
|
4436
|
+
) -> _StartContactConversationalAnalyticsJobResponseSuccess
|
|
4437
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartContactConversationalAnalyticsJobResponseSuccess
|
|
4438
|
+
|
|
4353
4439
|
interface _StartContactEvaluationResponseSuccess
|
|
4354
4440
|
include ::Seahorse::Client::_ResponseSuccess[Types::StartContactEvaluationResponse]
|
|
4355
4441
|
def evaluation_id: () -> ::String
|