aws-sdk-connect 1.178.0 → 1.179.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +185 -32
- data/lib/aws-sdk-connect/client_api.rb +34 -0
- data/lib/aws-sdk-connect/endpoints.rb +11 -0
- data/lib/aws-sdk-connect/plugins/endpoints.rb +2 -0
- data/lib/aws-sdk-connect/types.rb +148 -13
- data/lib/aws-sdk-connect.rb +1 -1
- data/sig/client.rbs +36 -2
- data/sig/types.rbs +22 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 3bc68422d6cba63a041912c0bb9ed4e59e03768aa10709ada6ef96b0496a29f7
|
4
|
+
data.tar.gz: 9d8bc377d9f64c20f6eaa7c4262ebb70796fd81cd4fe435566404669f7d37ff5
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: cb5fee7fa89604f272d7a2729510f5c8f0f6c71579bd3d9ac36b3682415d3389dc7181d36e544e5538adb36cad3a5cbe608556c0a79cdb30ad01ecf5b0848412
|
7
|
+
data.tar.gz: 5e7c7c22374821d3330a4388e0a49ecf729b4f88789a4de5288d30876621b64b2864c842277df1b5bc0fdb5041bb85fbdc97189ef36682518638122aef4b484d
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.179.0 (2024-09-30)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Amazon Connect introduces StartOutboundChatContact API allowing customers to initiate outbound chat contacts
|
8
|
+
|
4
9
|
1.178.0 (2024-09-24)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.179.0
|
@@ -496,9 +496,6 @@ module Aws::Connect
|
|
496
496
|
req.send_request(options)
|
497
497
|
end
|
498
498
|
|
499
|
-
# This API is in preview release for Amazon Connect and is subject to
|
500
|
-
# change.
|
501
|
-
#
|
502
499
|
# Associates the specified dataset for a Amazon Connect instance with
|
503
500
|
# the target account. You can associate only one dataset in a single
|
504
501
|
# call.
|
@@ -1129,9 +1126,6 @@ module Aws::Connect
|
|
1129
1126
|
req.send_request(options)
|
1130
1127
|
end
|
1131
1128
|
|
1132
|
-
# This API is in preview release for Amazon Connect and is subject to
|
1133
|
-
# change.
|
1134
|
-
#
|
1135
1129
|
# Associates a list of analytics datasets for a given Amazon Connect
|
1136
1130
|
# instance to a target account. You can associate multiple datasets in a
|
1137
1131
|
# single call.
|
@@ -1186,9 +1180,6 @@ module Aws::Connect
|
|
1186
1180
|
req.send_request(options)
|
1187
1181
|
end
|
1188
1182
|
|
1189
|
-
# This API is in preview release for Amazon Connect and is subject to
|
1190
|
-
# change.
|
1191
|
-
#
|
1192
1183
|
# Removes a list of analytics datasets associated with a given Amazon
|
1193
1184
|
# Connect instance. You can disassociate multiple datasets in a single
|
1194
1185
|
# call.
|
@@ -1402,11 +1393,11 @@ module Aws::Connect
|
|
1402
1393
|
# contact_data_request_list: [ # required
|
1403
1394
|
# {
|
1404
1395
|
# system_endpoint: {
|
1405
|
-
# type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW
|
1396
|
+
# type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW, CONNECT_PHONENUMBER_ARN
|
1406
1397
|
# address: "EndpointAddress",
|
1407
1398
|
# },
|
1408
1399
|
# customer_endpoint: {
|
1409
|
-
# type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW
|
1400
|
+
# type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW, CONNECT_PHONENUMBER_ARN
|
1410
1401
|
# address: "EndpointAddress",
|
1411
1402
|
# },
|
1412
1403
|
# request_identifier: "RequestIdentifier",
|
@@ -4629,10 +4620,10 @@ module Aws::Connect
|
|
4629
4620
|
#
|
4630
4621
|
# Describes the specified contact.
|
4631
4622
|
#
|
4632
|
-
# Contact information remains available in Amazon Connect for 24 months
|
4633
|
-
# and then it is deleted.
|
4634
|
-
#
|
4635
|
-
#
|
4623
|
+
# Contact information remains available in Amazon Connect for 24 months
|
4624
|
+
# from the InitiationTimestamp, and then it is deleted. Only contact
|
4625
|
+
# information that is available in Amazon Connect is returned by this
|
4626
|
+
# API
|
4636
4627
|
#
|
4637
4628
|
# @option params [required, String] :instance_id
|
4638
4629
|
# The identifier of the Amazon Connect instance. You can [find the
|
@@ -6026,9 +6017,6 @@ module Aws::Connect
|
|
6026
6017
|
req.send_request(options)
|
6027
6018
|
end
|
6028
6019
|
|
6029
|
-
# This API is in preview release for Amazon Connect and is subject to
|
6030
|
-
# change.
|
6031
|
-
#
|
6032
6020
|
# Removes the dataset ID associated with a given Amazon Connect
|
6033
6021
|
# instance.
|
6034
6022
|
#
|
@@ -8242,8 +8230,8 @@ module Aws::Connect
|
|
8242
8230
|
# Connect
|
8243
8231
|
#
|
8244
8232
|
# Threshold: For `ThresholdValue`, enter any whole number from 1 to
|
8245
|
-
# 604800 (inclusive), in seconds. For `Comparison`, you
|
8246
|
-
# `
|
8233
|
+
# 604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
|
8234
|
+
# (for "Less than") or `LTE` (for "Less than equal").
|
8247
8235
|
#
|
8248
8236
|
# UI name: [Contacts removed from queue in X seconds][51]
|
8249
8237
|
#
|
@@ -8255,8 +8243,8 @@ module Aws::Connect
|
|
8255
8243
|
# contact/segmentAttributes/connect:Subtype, Q in Connect
|
8256
8244
|
#
|
8257
8245
|
# Threshold: For `ThresholdValue` enter any whole number from 1 to
|
8258
|
-
# 604800 (inclusive), in seconds. For `Comparison`, you
|
8259
|
-
# `
|
8246
|
+
# 604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
|
8247
|
+
# (for "Less than") or `LTE` (for "Less than equal").
|
8260
8248
|
#
|
8261
8249
|
# UI name: [Contacts resolved in X][52]
|
8262
8250
|
#
|
@@ -8537,8 +8525,8 @@ module Aws::Connect
|
|
8537
8525
|
# Connect
|
8538
8526
|
#
|
8539
8527
|
# Threshold: For `ThresholdValue`, enter any whole number from 1 to
|
8540
|
-
# 604800 (inclusive), in seconds. For `Comparison`, you
|
8541
|
-
# `
|
8528
|
+
# 604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
|
8529
|
+
# (for "Less than") or `LTE` (for "Less than equal").
|
8542
8530
|
#
|
8543
8531
|
# UI name: [Service level X][72]
|
8544
8532
|
#
|
@@ -8603,8 +8591,8 @@ module Aws::Connect
|
|
8603
8591
|
# contact/segmentAttributes/connect:Subtype, Q in Connect
|
8604
8592
|
#
|
8605
8593
|
# Threshold: For `ThresholdValue`, enter any whole number from 1 to
|
8606
|
-
# 604800 (inclusive), in seconds. For `Comparison`, you
|
8607
|
-
# `
|
8594
|
+
# 604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
|
8595
|
+
# (for "Less than") or `LTE` (for "Less than equal").
|
8608
8596
|
#
|
8609
8597
|
# UI name: [Contacts abandoned in X seconds][76]
|
8610
8598
|
#
|
@@ -8616,8 +8604,8 @@ module Aws::Connect
|
|
8616
8604
|
# contact/segmentAttributes/connect:Subtype, Q in Connect
|
8617
8605
|
#
|
8618
8606
|
# Threshold: For `ThresholdValue`, enter any whole number from 1 to
|
8619
|
-
# 604800 (inclusive), in seconds. For `Comparison`, you
|
8620
|
-
# `
|
8607
|
+
# 604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
|
8608
|
+
# (for "Less than") or `LTE` (for "Less than equal").
|
8621
8609
|
#
|
8622
8610
|
# UI name: [Contacts answered in X seconds][77]
|
8623
8611
|
#
|
@@ -9226,9 +9214,6 @@ module Aws::Connect
|
|
9226
9214
|
req.send_request(options)
|
9227
9215
|
end
|
9228
9216
|
|
9229
|
-
# This API is in preview release for Amazon Connect and is subject to
|
9230
|
-
# change.
|
9231
|
-
#
|
9232
9217
|
# Lists the association status of requested dataset ID for a given
|
9233
9218
|
# Amazon Connect instance.
|
9234
9219
|
#
|
@@ -14630,6 +14615,174 @@ module Aws::Connect
|
|
14630
14615
|
req.send_request(options)
|
14631
14616
|
end
|
14632
14617
|
|
14618
|
+
# Initiates a new outbound SMS contact to a customer. Response of this
|
14619
|
+
# API provides the ContactId of the outbound SMS contact created.
|
14620
|
+
#
|
14621
|
+
# **SourceEndpoint** only supports Endpoints with
|
14622
|
+
# `CONNECT_PHONENUMBER_ARN` as Type and **DestinationEndpoint** only
|
14623
|
+
# supports Endpoints with `TELEPHONE_NUMBER` as Type. **ContactFlowId**
|
14624
|
+
# initiates the flow to manage the new SMS contact created.
|
14625
|
+
#
|
14626
|
+
# This API can be used to initiate outbound SMS contacts for an agent or
|
14627
|
+
# it can also deflect an ongoing contact to an outbound SMS contact by
|
14628
|
+
# using the [StartOutboundChatContact][1] Flow Action.
|
14629
|
+
#
|
14630
|
+
# For more information about using SMS in Amazon Connect, see the
|
14631
|
+
# following topics in the *Amazon Connect Administrator Guide*:
|
14632
|
+
#
|
14633
|
+
# * [Set up SMS messaging][2]
|
14634
|
+
#
|
14635
|
+
# * [Request an SMS-enabled phone number through AWS End User Messaging
|
14636
|
+
# SMS][3]
|
14637
|
+
#
|
14638
|
+
#
|
14639
|
+
#
|
14640
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_StartOutboundChatContact.html
|
14641
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/setup-sms-messaging.html
|
14642
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/adminguide/sms-number.html
|
14643
|
+
#
|
14644
|
+
# @option params [required, Types::Endpoint] :source_endpoint
|
14645
|
+
# Information about the endpoint.
|
14646
|
+
#
|
14647
|
+
# @option params [required, Types::Endpoint] :destination_endpoint
|
14648
|
+
# Information about the endpoint.
|
14649
|
+
#
|
14650
|
+
# @option params [required, String] :instance_id
|
14651
|
+
# The identifier of the Amazon Connect instance. You can find the
|
14652
|
+
# instance ID in the Amazon Resource Name (ARN) of the instance.
|
14653
|
+
#
|
14654
|
+
# @option params [required, Hash<String,Types::SegmentAttributeValue>] :segment_attributes
|
14655
|
+
# A set of system defined key-value pairs stored on individual contact
|
14656
|
+
# segments using an attribute map. The attributes are standard Amazon
|
14657
|
+
# Connect attributes. They can be accessed in flows.
|
14658
|
+
#
|
14659
|
+
# * Attribute keys can include only alphanumeric, `-`, and `_`.
|
14660
|
+
#
|
14661
|
+
# * This field can be used to show channel subtype, such as
|
14662
|
+
# `connect:Guide` and `connect:SMS`.
|
14663
|
+
#
|
14664
|
+
# @option params [Hash<String,String>] :attributes
|
14665
|
+
# A custom key-value pair using an attribute map. The attributes are
|
14666
|
+
# standard Amazon Connect attributes, and can be accessed in flows just
|
14667
|
+
# like any other contact attributes.
|
14668
|
+
#
|
14669
|
+
# @option params [required, String] :contact_flow_id
|
14670
|
+
# The identifier of the flow for the call. To see the ContactFlowId in
|
14671
|
+
# the Amazon Connect console user interface, on the navigation menu go
|
14672
|
+
# to **Routing, Contact Flows**. Choose the flow. On the flow page,
|
14673
|
+
# under the name of the flow, choose **Show additional flow
|
14674
|
+
# information**. The ContactFlowId is the last part of the ARN, shown
|
14675
|
+
# here in bold:
|
14676
|
+
#
|
14677
|
+
# * arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**123ec456-a007-89c0-1234-xxxxxxxxxxxx**
|
14678
|
+
#
|
14679
|
+
# ^
|
14680
|
+
#
|
14681
|
+
# @option params [Integer] :chat_duration_in_minutes
|
14682
|
+
# The total duration of the newly started chat session. If not
|
14683
|
+
# specified, the chat session duration defaults to 25 hour. The minimum
|
14684
|
+
# configurable time is 60 minutes. The maximum configurable time is
|
14685
|
+
# 10,080 minutes (7 days).
|
14686
|
+
#
|
14687
|
+
# @option params [Types::ParticipantDetails] :participant_details
|
14688
|
+
# The customer's details.
|
14689
|
+
#
|
14690
|
+
# @option params [Types::ChatMessage] :initial_system_message
|
14691
|
+
# A chat message.
|
14692
|
+
#
|
14693
|
+
# @option params [String] :related_contact_id
|
14694
|
+
# The unique identifier for an Amazon Connect contact. This identifier
|
14695
|
+
# is related to the contact starting.
|
14696
|
+
#
|
14697
|
+
# @option params [Array<String>] :supported_messaging_content_types
|
14698
|
+
# The supported chat message content types. Supported types are:
|
14699
|
+
#
|
14700
|
+
# * `text/plain`
|
14701
|
+
#
|
14702
|
+
# * `text/markdown`
|
14703
|
+
#
|
14704
|
+
# * `application/json,
|
14705
|
+
# application/vnd.amazonaws.connect.message.interactive`
|
14706
|
+
#
|
14707
|
+
# * `application/vnd.amazonaws.connect.message.interactive.response`
|
14708
|
+
#
|
14709
|
+
# Content types must always contain `text/plain`. You can then put any
|
14710
|
+
# other supported type in the list. For example, all the following lists
|
14711
|
+
# are valid because they contain `text/plain`:
|
14712
|
+
#
|
14713
|
+
# * `[text/plain, text/markdown, application/json]`
|
14714
|
+
#
|
14715
|
+
# * `[text/markdown, text/plain]`
|
14716
|
+
#
|
14717
|
+
# * `[text/plain, application/json,
|
14718
|
+
# application/vnd.amazonaws.connect.message.interactive.response]`
|
14719
|
+
#
|
14720
|
+
# @option params [String] :client_token
|
14721
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
14722
|
+
# idempotency of the request. If not provided, the AWS SDK populates
|
14723
|
+
# this field. For more information about idempotency, see [Making
|
14724
|
+
# retries safe with idempotent APIs][1]. The token is valid for 7 days
|
14725
|
+
# after creation. If a contact is already started, the contact ID is
|
14726
|
+
# returned.
|
14727
|
+
#
|
14728
|
+
# **A suitable default value is auto-generated.** You should normally
|
14729
|
+
# not need to pass this option.**
|
14730
|
+
#
|
14731
|
+
#
|
14732
|
+
#
|
14733
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
14734
|
+
#
|
14735
|
+
# @return [Types::StartOutboundChatContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
14736
|
+
#
|
14737
|
+
# * {Types::StartOutboundChatContactResponse#contact_id #contact_id} => String
|
14738
|
+
#
|
14739
|
+
# @example Request syntax with placeholder values
|
14740
|
+
#
|
14741
|
+
# resp = client.start_outbound_chat_contact({
|
14742
|
+
# source_endpoint: { # required
|
14743
|
+
# type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW, CONNECT_PHONENUMBER_ARN
|
14744
|
+
# address: "EndpointAddress",
|
14745
|
+
# },
|
14746
|
+
# destination_endpoint: { # required
|
14747
|
+
# type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW, CONNECT_PHONENUMBER_ARN
|
14748
|
+
# address: "EndpointAddress",
|
14749
|
+
# },
|
14750
|
+
# instance_id: "InstanceId", # required
|
14751
|
+
# segment_attributes: { # required
|
14752
|
+
# "SegmentAttributeName" => {
|
14753
|
+
# value_string: "SegmentAttributeValueString",
|
14754
|
+
# },
|
14755
|
+
# },
|
14756
|
+
# attributes: {
|
14757
|
+
# "AttributeName" => "AttributeValue",
|
14758
|
+
# },
|
14759
|
+
# contact_flow_id: "ContactFlowId", # required
|
14760
|
+
# chat_duration_in_minutes: 1,
|
14761
|
+
# participant_details: {
|
14762
|
+
# display_name: "DisplayName", # required
|
14763
|
+
# },
|
14764
|
+
# initial_system_message: {
|
14765
|
+
# content_type: "ChatContentType", # required
|
14766
|
+
# content: "ChatContent", # required
|
14767
|
+
# },
|
14768
|
+
# related_contact_id: "ContactId",
|
14769
|
+
# supported_messaging_content_types: ["SupportedMessagingContentType"],
|
14770
|
+
# client_token: "ClientToken",
|
14771
|
+
# })
|
14772
|
+
#
|
14773
|
+
# @example Response structure
|
14774
|
+
#
|
14775
|
+
# resp.contact_id #=> String
|
14776
|
+
#
|
14777
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartOutboundChatContact AWS API Documentation
|
14778
|
+
#
|
14779
|
+
# @overload start_outbound_chat_contact(params = {})
|
14780
|
+
# @param [Hash] params ({})
|
14781
|
+
def start_outbound_chat_contact(params = {}, options = {})
|
14782
|
+
req = build_request(:start_outbound_chat_contact, params)
|
14783
|
+
req.send_request(options)
|
14784
|
+
end
|
14785
|
+
|
14633
14786
|
# Places an outbound call to a contact, and then initiates the flow. It
|
14634
14787
|
# performs the actions in the flow that's specified (in
|
14635
14788
|
# `ContactFlowId`).
|
@@ -18319,7 +18472,7 @@ module Aws::Connect
|
|
18319
18472
|
tracer: tracer
|
18320
18473
|
)
|
18321
18474
|
context[:gem_name] = 'aws-sdk-connect'
|
18322
|
-
context[:gem_version] = '1.
|
18475
|
+
context[:gem_version] = '1.179.0'
|
18323
18476
|
Seahorse::Client::Request.new(handlers, context)
|
18324
18477
|
end
|
18325
18478
|
|
@@ -1113,6 +1113,8 @@ module Aws::Connect
|
|
1113
1113
|
StartContactRecordingResponse = Shapes::StructureShape.new(name: 'StartContactRecordingResponse')
|
1114
1114
|
StartContactStreamingRequest = Shapes::StructureShape.new(name: 'StartContactStreamingRequest')
|
1115
1115
|
StartContactStreamingResponse = Shapes::StructureShape.new(name: 'StartContactStreamingResponse')
|
1116
|
+
StartOutboundChatContactRequest = Shapes::StructureShape.new(name: 'StartOutboundChatContactRequest')
|
1117
|
+
StartOutboundChatContactResponse = Shapes::StructureShape.new(name: 'StartOutboundChatContactResponse')
|
1116
1118
|
StartOutboundVoiceContactRequest = Shapes::StructureShape.new(name: 'StartOutboundVoiceContactRequest')
|
1117
1119
|
StartOutboundVoiceContactResponse = Shapes::StructureShape.new(name: 'StartOutboundVoiceContactResponse')
|
1118
1120
|
StartTaskContactRequest = Shapes::StructureShape.new(name: 'StartTaskContactRequest')
|
@@ -4975,6 +4977,23 @@ module Aws::Connect
|
|
4975
4977
|
StartContactStreamingResponse.add_member(:streaming_id, Shapes::ShapeRef.new(shape: StreamingId, required: true, location_name: "StreamingId"))
|
4976
4978
|
StartContactStreamingResponse.struct_class = Types::StartContactStreamingResponse
|
4977
4979
|
|
4980
|
+
StartOutboundChatContactRequest.add_member(:source_endpoint, Shapes::ShapeRef.new(shape: Endpoint, required: true, location_name: "SourceEndpoint"))
|
4981
|
+
StartOutboundChatContactRequest.add_member(:destination_endpoint, Shapes::ShapeRef.new(shape: Endpoint, required: true, location_name: "DestinationEndpoint"))
|
4982
|
+
StartOutboundChatContactRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location_name: "InstanceId"))
|
4983
|
+
StartOutboundChatContactRequest.add_member(:segment_attributes, Shapes::ShapeRef.new(shape: SegmentAttributes, required: true, location_name: "SegmentAttributes"))
|
4984
|
+
StartOutboundChatContactRequest.add_member(:attributes, Shapes::ShapeRef.new(shape: Attributes, location_name: "Attributes"))
|
4985
|
+
StartOutboundChatContactRequest.add_member(:contact_flow_id, Shapes::ShapeRef.new(shape: ContactFlowId, required: true, location_name: "ContactFlowId"))
|
4986
|
+
StartOutboundChatContactRequest.add_member(:chat_duration_in_minutes, Shapes::ShapeRef.new(shape: ChatDurationInMinutes, location_name: "ChatDurationInMinutes"))
|
4987
|
+
StartOutboundChatContactRequest.add_member(:participant_details, Shapes::ShapeRef.new(shape: ParticipantDetails, location_name: "ParticipantDetails"))
|
4988
|
+
StartOutboundChatContactRequest.add_member(:initial_system_message, Shapes::ShapeRef.new(shape: ChatMessage, location_name: "InitialSystemMessage"))
|
4989
|
+
StartOutboundChatContactRequest.add_member(:related_contact_id, Shapes::ShapeRef.new(shape: ContactId, location_name: "RelatedContactId"))
|
4990
|
+
StartOutboundChatContactRequest.add_member(:supported_messaging_content_types, Shapes::ShapeRef.new(shape: SupportedMessagingContentTypes, location_name: "SupportedMessagingContentTypes"))
|
4991
|
+
StartOutboundChatContactRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "ClientToken", metadata: {"idempotencyToken"=>true}))
|
4992
|
+
StartOutboundChatContactRequest.struct_class = Types::StartOutboundChatContactRequest
|
4993
|
+
|
4994
|
+
StartOutboundChatContactResponse.add_member(:contact_id, Shapes::ShapeRef.new(shape: ContactId, location_name: "ContactId"))
|
4995
|
+
StartOutboundChatContactResponse.struct_class = Types::StartOutboundChatContactResponse
|
4996
|
+
|
4978
4997
|
StartOutboundVoiceContactRequest.add_member(:name, Shapes::ShapeRef.new(shape: Name, location_name: "Name"))
|
4979
4998
|
StartOutboundVoiceContactRequest.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
|
4980
4999
|
StartOutboundVoiceContactRequest.add_member(:references, Shapes::ShapeRef.new(shape: ContactReferences, location_name: "References"))
|
@@ -8839,6 +8858,21 @@ module Aws::Connect
|
|
8839
8858
|
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
8840
8859
|
end)
|
8841
8860
|
|
8861
|
+
api.add_operation(:start_outbound_chat_contact, Seahorse::Model::Operation.new.tap do |o|
|
8862
|
+
o.name = "StartOutboundChatContact"
|
8863
|
+
o.http_method = "PUT"
|
8864
|
+
o.http_request_uri = "/contact/outbound-chat"
|
8865
|
+
o.input = Shapes::ShapeRef.new(shape: StartOutboundChatContactRequest)
|
8866
|
+
o.output = Shapes::ShapeRef.new(shape: StartOutboundChatContactResponse)
|
8867
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
8868
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
8869
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
|
8870
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
8871
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
8872
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
8873
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
8874
|
+
end)
|
8875
|
+
|
8842
8876
|
api.add_operation(:start_outbound_voice_contact, Seahorse::Model::Operation.new.tap do |o|
|
8843
8877
|
o.name = "StartOutboundVoiceContact"
|
8844
8878
|
o.http_method = "PUT"
|
@@ -2157,6 +2157,17 @@ module Aws::Connect
|
|
2157
2157
|
end
|
2158
2158
|
end
|
2159
2159
|
|
2160
|
+
class StartOutboundChatContact
|
2161
|
+
def self.build(context)
|
2162
|
+
Aws::Connect::EndpointParameters.new(
|
2163
|
+
region: context.config.region,
|
2164
|
+
use_dual_stack: context.config.use_dualstack_endpoint,
|
2165
|
+
use_fips: context.config.use_fips_endpoint,
|
2166
|
+
endpoint: context.config.regional_endpoint ? nil : context.config.endpoint.to_s,
|
2167
|
+
)
|
2168
|
+
end
|
2169
|
+
end
|
2170
|
+
|
2160
2171
|
class StartOutboundVoiceContact
|
2161
2172
|
def self.build(context)
|
2162
2173
|
Aws::Connect::EndpointParameters.new(
|
@@ -460,6 +460,8 @@ The endpoint provider used to resolve endpoints. Any object that responds to
|
|
460
460
|
Aws::Connect::Endpoints::StartContactRecording.build(context)
|
461
461
|
when :start_contact_streaming
|
462
462
|
Aws::Connect::Endpoints::StartContactStreaming.build(context)
|
463
|
+
when :start_outbound_chat_contact
|
464
|
+
Aws::Connect::Endpoints::StartOutboundChatContact.build(context)
|
463
465
|
when :start_outbound_voice_contact
|
464
466
|
Aws::Connect::Endpoints::StartOutboundVoiceContact.build(context)
|
465
467
|
when :start_task_contact
|
@@ -9796,8 +9796,8 @@ module Aws::Connect
|
|
9796
9796
|
# Connect
|
9797
9797
|
#
|
9798
9798
|
# Threshold: For `ThresholdValue`, enter any whole number from 1 to
|
9799
|
-
# 604800 (inclusive), in seconds. For `Comparison`, you
|
9800
|
-
# `
|
9799
|
+
# 604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
|
9800
|
+
# (for "Less than") or `LTE` (for "Less than equal").
|
9801
9801
|
#
|
9802
9802
|
# UI name: [Contacts removed from queue in X seconds][51]
|
9803
9803
|
#
|
@@ -9809,8 +9809,8 @@ module Aws::Connect
|
|
9809
9809
|
# contact/segmentAttributes/connect:Subtype, Q in Connect
|
9810
9810
|
#
|
9811
9811
|
# Threshold: For `ThresholdValue` enter any whole number from 1 to
|
9812
|
-
# 604800 (inclusive), in seconds. For `Comparison`, you
|
9813
|
-
# `
|
9812
|
+
# 604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
|
9813
|
+
# (for "Less than") or `LTE` (for "Less than equal").
|
9814
9814
|
#
|
9815
9815
|
# UI name: [Contacts resolved in X][52]
|
9816
9816
|
#
|
@@ -10091,8 +10091,8 @@ module Aws::Connect
|
|
10091
10091
|
# Connect
|
10092
10092
|
#
|
10093
10093
|
# Threshold: For `ThresholdValue`, enter any whole number from 1 to
|
10094
|
-
# 604800 (inclusive), in seconds. For `Comparison`, you
|
10095
|
-
# `
|
10094
|
+
# 604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
|
10095
|
+
# (for "Less than") or `LTE` (for "Less than equal").
|
10096
10096
|
#
|
10097
10097
|
# UI name: [Service level X][72]
|
10098
10098
|
#
|
@@ -10157,8 +10157,8 @@ module Aws::Connect
|
|
10157
10157
|
# contact/segmentAttributes/connect:Subtype, Q in Connect
|
10158
10158
|
#
|
10159
10159
|
# Threshold: For `ThresholdValue`, enter any whole number from 1 to
|
10160
|
-
# 604800 (inclusive), in seconds. For `Comparison`, you
|
10161
|
-
# `
|
10160
|
+
# 604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
|
10161
|
+
# (for "Less than") or `LTE` (for "Less than equal").
|
10162
10162
|
#
|
10163
10163
|
# UI name: [Contacts abandoned in X seconds][76]
|
10164
10164
|
#
|
@@ -10170,8 +10170,8 @@ module Aws::Connect
|
|
10170
10170
|
# contact/segmentAttributes/connect:Subtype, Q in Connect
|
10171
10171
|
#
|
10172
10172
|
# Threshold: For `ThresholdValue`, enter any whole number from 1 to
|
10173
|
-
# 604800 (inclusive), in seconds. For `Comparison`, you
|
10174
|
-
# `
|
10173
|
+
# 604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
|
10174
|
+
# (for "Less than") or `LTE` (for "Less than equal").
|
10175
10175
|
#
|
10176
10176
|
# UI name: [Contacts answered in X seconds][77]
|
10177
10177
|
#
|
@@ -14514,6 +14514,7 @@ module Aws::Connect
|
|
14514
14514
|
#
|
14515
14515
|
# Valid metric filter values for `INITIATION_METHOD`: `INBOUND` \|
|
14516
14516
|
# `OUTBOUND` \| `TRANSFER` \| `QUEUE_TRANSFER` \| `CALLBACK` \| `API`
|
14517
|
+
# \| `WEBRTC_API` \| `MONITOR` \| `DISCONNECT` \| `EXTERNAL_OUTBOUND`
|
14517
14518
|
#
|
14518
14519
|
# Valid metric filter values for `DISCONNECT_REASON`:
|
14519
14520
|
# `CUSTOMER_DISCONNECT` \| `AGENT_DISCONNECT` \|
|
@@ -14813,7 +14814,7 @@ module Aws::Connect
|
|
14813
14814
|
#
|
14814
14815
|
# * Duration labels, such as `NON_TALK_TIME`, `CONTACT_DURATION`,
|
14815
14816
|
# `AGENT_INTERACTION_DURATION`, `CUSTOMER_HOLD_TIME` have a minimum
|
14816
|
-
# value of 0 and maximum value of
|
14817
|
+
# value of 0 and maximum value of 63072000.
|
14817
14818
|
#
|
14818
14819
|
# * Percentages have a minimum value of 0 and maximum value of 100.
|
14819
14820
|
#
|
@@ -19573,6 +19574,140 @@ module Aws::Connect
|
|
19573
19574
|
include Aws::Structure
|
19574
19575
|
end
|
19575
19576
|
|
19577
|
+
# @!attribute [rw] source_endpoint
|
19578
|
+
# Information about the endpoint.
|
19579
|
+
# @return [Types::Endpoint]
|
19580
|
+
#
|
19581
|
+
# @!attribute [rw] destination_endpoint
|
19582
|
+
# Information about the endpoint.
|
19583
|
+
# @return [Types::Endpoint]
|
19584
|
+
#
|
19585
|
+
# @!attribute [rw] instance_id
|
19586
|
+
# The identifier of the Amazon Connect instance. You can find the
|
19587
|
+
# instance ID in the Amazon Resource Name (ARN) of the instance.
|
19588
|
+
# @return [String]
|
19589
|
+
#
|
19590
|
+
# @!attribute [rw] segment_attributes
|
19591
|
+
# A set of system defined key-value pairs stored on individual contact
|
19592
|
+
# segments using an attribute map. The attributes are standard Amazon
|
19593
|
+
# Connect attributes. They can be accessed in flows.
|
19594
|
+
#
|
19595
|
+
# * Attribute keys can include only alphanumeric, `-`, and `_`.
|
19596
|
+
#
|
19597
|
+
# * This field can be used to show channel subtype, such as
|
19598
|
+
# `connect:Guide` and `connect:SMS`.
|
19599
|
+
# @return [Hash<String,Types::SegmentAttributeValue>]
|
19600
|
+
#
|
19601
|
+
# @!attribute [rw] attributes
|
19602
|
+
# A custom key-value pair using an attribute map. The attributes are
|
19603
|
+
# standard Amazon Connect attributes, and can be accessed in flows
|
19604
|
+
# just like any other contact attributes.
|
19605
|
+
# @return [Hash<String,String>]
|
19606
|
+
#
|
19607
|
+
# @!attribute [rw] contact_flow_id
|
19608
|
+
# The identifier of the flow for the call. To see the ContactFlowId in
|
19609
|
+
# the Amazon Connect console user interface, on the navigation menu go
|
19610
|
+
# to **Routing, Contact Flows**. Choose the flow. On the flow page,
|
19611
|
+
# under the name of the flow, choose **Show additional flow
|
19612
|
+
# information**. The ContactFlowId is the last part of the ARN, shown
|
19613
|
+
# here in bold:
|
19614
|
+
#
|
19615
|
+
# * arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**123ec456-a007-89c0-1234-xxxxxxxxxxxx**
|
19616
|
+
#
|
19617
|
+
# ^
|
19618
|
+
# @return [String]
|
19619
|
+
#
|
19620
|
+
# @!attribute [rw] chat_duration_in_minutes
|
19621
|
+
# The total duration of the newly started chat session. If not
|
19622
|
+
# specified, the chat session duration defaults to 25 hour. The
|
19623
|
+
# minimum configurable time is 60 minutes. The maximum configurable
|
19624
|
+
# time is 10,080 minutes (7 days).
|
19625
|
+
# @return [Integer]
|
19626
|
+
#
|
19627
|
+
# @!attribute [rw] participant_details
|
19628
|
+
# The customer's details.
|
19629
|
+
# @return [Types::ParticipantDetails]
|
19630
|
+
#
|
19631
|
+
# @!attribute [rw] initial_system_message
|
19632
|
+
# A chat message.
|
19633
|
+
# @return [Types::ChatMessage]
|
19634
|
+
#
|
19635
|
+
# @!attribute [rw] related_contact_id
|
19636
|
+
# The unique identifier for an Amazon Connect contact. This identifier
|
19637
|
+
# is related to the contact starting.
|
19638
|
+
# @return [String]
|
19639
|
+
#
|
19640
|
+
# @!attribute [rw] supported_messaging_content_types
|
19641
|
+
# The supported chat message content types. Supported types are:
|
19642
|
+
#
|
19643
|
+
# * `text/plain`
|
19644
|
+
#
|
19645
|
+
# * `text/markdown`
|
19646
|
+
#
|
19647
|
+
# * `application/json,
|
19648
|
+
# application/vnd.amazonaws.connect.message.interactive`
|
19649
|
+
#
|
19650
|
+
# * `application/vnd.amazonaws.connect.message.interactive.response`
|
19651
|
+
#
|
19652
|
+
# Content types must always contain `text/plain`. You can then put any
|
19653
|
+
# other supported type in the list. For example, all the following
|
19654
|
+
# lists are valid because they contain `text/plain`:
|
19655
|
+
#
|
19656
|
+
# * `[text/plain, text/markdown, application/json]`
|
19657
|
+
#
|
19658
|
+
# * `[text/markdown, text/plain]`
|
19659
|
+
#
|
19660
|
+
# * `[text/plain, application/json,
|
19661
|
+
# application/vnd.amazonaws.connect.message.interactive.response]`
|
19662
|
+
# @return [Array<String>]
|
19663
|
+
#
|
19664
|
+
# @!attribute [rw] client_token
|
19665
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
19666
|
+
# idempotency of the request. If not provided, the AWS SDK populates
|
19667
|
+
# this field. For more information about idempotency, see [Making
|
19668
|
+
# retries safe with idempotent APIs][1]. The token is valid for 7 days
|
19669
|
+
# after creation. If a contact is already started, the contact ID is
|
19670
|
+
# returned.
|
19671
|
+
#
|
19672
|
+
# **A suitable default value is auto-generated.** You should normally
|
19673
|
+
# not need to pass this option.
|
19674
|
+
#
|
19675
|
+
#
|
19676
|
+
#
|
19677
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
19678
|
+
# @return [String]
|
19679
|
+
#
|
19680
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartOutboundChatContactRequest AWS API Documentation
|
19681
|
+
#
|
19682
|
+
class StartOutboundChatContactRequest < Struct.new(
|
19683
|
+
:source_endpoint,
|
19684
|
+
:destination_endpoint,
|
19685
|
+
:instance_id,
|
19686
|
+
:segment_attributes,
|
19687
|
+
:attributes,
|
19688
|
+
:contact_flow_id,
|
19689
|
+
:chat_duration_in_minutes,
|
19690
|
+
:participant_details,
|
19691
|
+
:initial_system_message,
|
19692
|
+
:related_contact_id,
|
19693
|
+
:supported_messaging_content_types,
|
19694
|
+
:client_token)
|
19695
|
+
SENSITIVE = []
|
19696
|
+
include Aws::Structure
|
19697
|
+
end
|
19698
|
+
|
19699
|
+
# @!attribute [rw] contact_id
|
19700
|
+
# The identifier of this contact within the Amazon Connect instance.
|
19701
|
+
# @return [String]
|
19702
|
+
#
|
19703
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartOutboundChatContactResponse AWS API Documentation
|
19704
|
+
#
|
19705
|
+
class StartOutboundChatContactResponse < Struct.new(
|
19706
|
+
:contact_id)
|
19707
|
+
SENSITIVE = []
|
19708
|
+
include Aws::Structure
|
19709
|
+
end
|
19710
|
+
|
19576
19711
|
# @!attribute [rw] name
|
19577
19712
|
# The name of a voice contact that is shown to an agent in the Contact
|
19578
19713
|
# Control Panel (CCP).
|
@@ -20609,8 +20744,8 @@ module Aws::Connect
|
|
20609
20744
|
# Contains information about the threshold for service level metrics.
|
20610
20745
|
#
|
20611
20746
|
# @!attribute [rw] comparison
|
20612
|
-
# The type of comparison.
|
20613
|
-
# (GT) comparisons are supported.
|
20747
|
+
# The type of comparison. Currently, "less than" (LT), "less than
|
20748
|
+
# equal" (LTE), and "greater than" (GT) comparisons are supported.
|
20614
20749
|
# @return [String]
|
20615
20750
|
#
|
20616
20751
|
# @!attribute [rw] threshold_value
|
data/lib/aws-sdk-connect.rb
CHANGED
data/sig/client.rbs
CHANGED
@@ -333,11 +333,11 @@ module Aws
|
|
333
333
|
contact_data_request_list: Array[
|
334
334
|
{
|
335
335
|
system_endpoint: {
|
336
|
-
type: ("TELEPHONE_NUMBER" | "VOIP" | "CONTACT_FLOW")?,
|
336
|
+
type: ("TELEPHONE_NUMBER" | "VOIP" | "CONTACT_FLOW" | "CONNECT_PHONENUMBER_ARN")?,
|
337
337
|
address: ::String?
|
338
338
|
}?,
|
339
339
|
customer_endpoint: {
|
340
|
-
type: ("TELEPHONE_NUMBER" | "VOIP" | "CONTACT_FLOW")?,
|
340
|
+
type: ("TELEPHONE_NUMBER" | "VOIP" | "CONTACT_FLOW" | "CONNECT_PHONENUMBER_ARN")?,
|
341
341
|
address: ::String?
|
342
342
|
}?,
|
343
343
|
request_identifier: ::String?,
|
@@ -3456,6 +3456,40 @@ module Aws
|
|
3456
3456
|
) -> _StartContactStreamingResponseSuccess
|
3457
3457
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartContactStreamingResponseSuccess
|
3458
3458
|
|
3459
|
+
interface _StartOutboundChatContactResponseSuccess
|
3460
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::StartOutboundChatContactResponse]
|
3461
|
+
def contact_id: () -> ::String
|
3462
|
+
end
|
3463
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Connect/Client.html#start_outbound_chat_contact-instance_method
|
3464
|
+
def start_outbound_chat_contact: (
|
3465
|
+
source_endpoint: {
|
3466
|
+
type: ("TELEPHONE_NUMBER" | "VOIP" | "CONTACT_FLOW" | "CONNECT_PHONENUMBER_ARN")?,
|
3467
|
+
address: ::String?
|
3468
|
+
},
|
3469
|
+
destination_endpoint: {
|
3470
|
+
type: ("TELEPHONE_NUMBER" | "VOIP" | "CONTACT_FLOW" | "CONNECT_PHONENUMBER_ARN")?,
|
3471
|
+
address: ::String?
|
3472
|
+
},
|
3473
|
+
instance_id: ::String,
|
3474
|
+
segment_attributes: Hash[::String, {
|
3475
|
+
value_string: ::String?
|
3476
|
+
}],
|
3477
|
+
?attributes: Hash[::String, ::String],
|
3478
|
+
contact_flow_id: ::String,
|
3479
|
+
?chat_duration_in_minutes: ::Integer,
|
3480
|
+
?participant_details: {
|
3481
|
+
display_name: ::String
|
3482
|
+
},
|
3483
|
+
?initial_system_message: {
|
3484
|
+
content_type: ::String,
|
3485
|
+
content: ::String
|
3486
|
+
},
|
3487
|
+
?related_contact_id: ::String,
|
3488
|
+
?supported_messaging_content_types: Array[::String],
|
3489
|
+
?client_token: ::String
|
3490
|
+
) -> _StartOutboundChatContactResponseSuccess
|
3491
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartOutboundChatContactResponseSuccess
|
3492
|
+
|
3459
3493
|
interface _StartOutboundVoiceContactResponseSuccess
|
3460
3494
|
include ::Seahorse::Client::_ResponseSuccess[Types::StartOutboundVoiceContactResponse]
|
3461
3495
|
def contact_id: () -> ::String
|
data/sig/types.rbs
CHANGED
@@ -1810,7 +1810,7 @@ module Aws::Connect
|
|
1810
1810
|
end
|
1811
1811
|
|
1812
1812
|
class Endpoint
|
1813
|
-
attr_accessor type: ("TELEPHONE_NUMBER" | "VOIP" | "CONTACT_FLOW")
|
1813
|
+
attr_accessor type: ("TELEPHONE_NUMBER" | "VOIP" | "CONTACT_FLOW" | "CONNECT_PHONENUMBER_ARN")
|
1814
1814
|
attr_accessor address: ::String
|
1815
1815
|
SENSITIVE: []
|
1816
1816
|
end
|
@@ -4577,6 +4577,27 @@ module Aws::Connect
|
|
4577
4577
|
SENSITIVE: []
|
4578
4578
|
end
|
4579
4579
|
|
4580
|
+
class StartOutboundChatContactRequest
|
4581
|
+
attr_accessor source_endpoint: Types::Endpoint
|
4582
|
+
attr_accessor destination_endpoint: Types::Endpoint
|
4583
|
+
attr_accessor instance_id: ::String
|
4584
|
+
attr_accessor segment_attributes: ::Hash[::String, Types::SegmentAttributeValue]
|
4585
|
+
attr_accessor attributes: ::Hash[::String, ::String]
|
4586
|
+
attr_accessor contact_flow_id: ::String
|
4587
|
+
attr_accessor chat_duration_in_minutes: ::Integer
|
4588
|
+
attr_accessor participant_details: Types::ParticipantDetails
|
4589
|
+
attr_accessor initial_system_message: Types::ChatMessage
|
4590
|
+
attr_accessor related_contact_id: ::String
|
4591
|
+
attr_accessor supported_messaging_content_types: ::Array[::String]
|
4592
|
+
attr_accessor client_token: ::String
|
4593
|
+
SENSITIVE: []
|
4594
|
+
end
|
4595
|
+
|
4596
|
+
class StartOutboundChatContactResponse
|
4597
|
+
attr_accessor contact_id: ::String
|
4598
|
+
SENSITIVE: []
|
4599
|
+
end
|
4600
|
+
|
4580
4601
|
class StartOutboundVoiceContactRequest
|
4581
4602
|
attr_accessor name: ::String
|
4582
4603
|
attr_accessor description: ::String
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-connect
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.179.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2024-09-
|
11
|
+
date: 2024-09-30 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|