aws-sdk-connect 1.218.0 → 1.219.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +45 -20
- data/lib/aws-sdk-connect/client_api.rb +6 -0
- data/lib/aws-sdk-connect/endpoint_parameters.rb +4 -4
- data/lib/aws-sdk-connect/types.rb +42 -3
- data/lib/aws-sdk-connect.rb +1 -1
- data/sig/types.rbs +7 -0
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 81a50ddd5637c1f7d1c35117614539a19912bfe4a4038b5f4c3fae517b5c585e
|
4
|
+
data.tar.gz: a1c280286c08deeee9f7d79f141982ddae60e7d4fc809ef1a6646527d0bc40bf
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0df44476c1b3107bc60c45ee8c95174709805e656c016655b4029b887e0f05b8432d763ed04cef2d506d8fac0b2d9f7e934ea862064a9e815d3f4d8f3168372f
|
7
|
+
data.tar.gz: 73b5d1b08da2aa7b8dca68972600aa94f956ba09d1c696fa7fde8645a9c7cdf578c6b2b7d79db742d7826c8410341fd8af8c752547dd4c6de05e49df588cb83a
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.219.0
|
@@ -689,25 +689,15 @@ module Aws::Connect
|
|
689
689
|
#
|
690
690
|
# Following are common uses cases for this API:
|
691
691
|
#
|
692
|
-
# *
|
693
|
-
# mechanisms beyond the default system routing in Amazon Connect. You
|
694
|
-
# can create tailored contact distribution logic that offers queued
|
695
|
-
# contacts directly to specific agents.
|
692
|
+
# * Programmatically assign queued contacts to available users.
|
696
693
|
#
|
697
|
-
# *
|
698
|
-
#
|
699
|
-
# centers that require manual oversight or specialized routing
|
700
|
-
# workflows outside of standard queue management.
|
701
|
-
#
|
702
|
-
# For information about how manual contact assignment works in the
|
703
|
-
# agent workspace, see the [Access the Worklist app in the Amazon
|
704
|
-
# Connect agent workspace][1] in the *Amazon Connect Administrator
|
705
|
-
# Guide*.
|
694
|
+
# * Leverage the IAM context key `connect:PreferredUserArn` to restrict
|
695
|
+
# contact association to specific preferred user.
|
706
696
|
#
|
707
697
|
# **Important things to know**
|
708
698
|
#
|
709
|
-
# * Use this API chat
|
710
|
-
# voice contacts.
|
699
|
+
# * Use this API with chat, email, and task contacts. It does not
|
700
|
+
# support voice contacts.
|
711
701
|
#
|
712
702
|
# * Use it to associate contacts with users regardless of their current
|
713
703
|
# state, including custom states. Ensure your application logic
|
@@ -721,11 +711,16 @@ module Aws::Connect
|
|
721
711
|
# associations. Verify that your IAM policies are properly configured
|
722
712
|
# to support your intended use cases.
|
723
713
|
#
|
714
|
+
# * The service quota *Queues per routing profile per instance* applies
|
715
|
+
# to manually assigned queues, too. For more information about this
|
716
|
+
# quota, see [Amazon Connect quotas][1] in the *Amazon Connect
|
717
|
+
# Administrator Guide*.
|
718
|
+
#
|
724
719
|
# **Endpoints**: See [Amazon Connect endpoints and quotas][2].
|
725
720
|
#
|
726
721
|
#
|
727
722
|
#
|
728
|
-
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/
|
723
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas
|
729
724
|
# [2]: https://docs.aws.amazon.com/general/latest/gr/connect_region.html
|
730
725
|
#
|
731
726
|
# @option params [required, String] :instance_id
|
@@ -5527,6 +5522,25 @@ module Aws::Connect
|
|
5527
5522
|
#
|
5528
5523
|
# Describes the specified contact.
|
5529
5524
|
#
|
5525
|
+
# **Use cases**
|
5526
|
+
#
|
5527
|
+
# Following are common uses cases for this API:
|
5528
|
+
#
|
5529
|
+
# * Retrieve contact information such as the caller's phone number and
|
5530
|
+
# the specific number the caller dialed to integrate into custom
|
5531
|
+
# monitoring or custom agent experience solutions.
|
5532
|
+
#
|
5533
|
+
# * Detect when a customer chat session disconnects due to a network
|
5534
|
+
# issue on the agent's end. Use the DisconnectReason field in the
|
5535
|
+
# [ContactTraceRecord][1] to detect this event and then re-queue the
|
5536
|
+
# chat for followup.
|
5537
|
+
#
|
5538
|
+
# * Identify after contact work (ACW) duration and call recordings
|
5539
|
+
# information when a COMPLETED event is received by using the [contact
|
5540
|
+
# event stream][2].
|
5541
|
+
#
|
5542
|
+
# **Important things to know**
|
5543
|
+
#
|
5530
5544
|
# * `SystemEndpoint` is not populated for contacts with initiation
|
5531
5545
|
# method of MONITOR, QUEUE\_TRANSFER, or CALLBACK
|
5532
5546
|
#
|
@@ -5535,6 +5549,14 @@ module Aws::Connect
|
|
5535
5549
|
# contact information that is available in Amazon Connect is returned
|
5536
5550
|
# by this API.
|
5537
5551
|
#
|
5552
|
+
# **Endpoints**: See [Amazon Connect endpoints and quotas][3].
|
5553
|
+
#
|
5554
|
+
#
|
5555
|
+
#
|
5556
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord
|
5557
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/contact-events.html
|
5558
|
+
# [3]: https://docs.aws.amazon.com/general/latest/gr/connect_region.html
|
5559
|
+
#
|
5538
5560
|
# @option params [required, String] :instance_id
|
5539
5561
|
# The identifier of the Amazon Connect instance. You can [find the
|
5540
5562
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
@@ -5715,6 +5737,8 @@ module Aws::Connect
|
|
5715
5737
|
# resp.contact.contact_evaluations["EvaluationId"].end_timestamp #=> Time
|
5716
5738
|
# resp.contact.contact_evaluations["EvaluationId"].delete_timestamp #=> Time
|
5717
5739
|
# resp.contact.contact_evaluations["EvaluationId"].export_location #=> String
|
5740
|
+
# resp.contact.task_template_info.arn #=> String
|
5741
|
+
# resp.contact.task_template_info.name #=> String
|
5718
5742
|
# resp.contact.contact_details.name #=> String
|
5719
5743
|
# resp.contact.contact_details.description #=> String
|
5720
5744
|
# resp.contact.attributes #=> Hash
|
@@ -12980,6 +13004,7 @@ module Aws::Connect
|
|
12980
13004
|
# @option params [required, String] :instance_id
|
12981
13005
|
# The identifier of the Amazon Connect instance. You can [find the
|
12982
13006
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
13007
|
+
# Both Instance ID and Instance ARN are supported input formats.
|
12983
13008
|
#
|
12984
13009
|
#
|
12985
13010
|
#
|
@@ -13155,9 +13180,9 @@ module Aws::Connect
|
|
13155
13180
|
# Following are common uses cases for this API:
|
13156
13181
|
#
|
13157
13182
|
# * This API returns list of queues where contacts can be manually
|
13158
|
-
# assigned or picked
|
13159
|
-
#
|
13160
|
-
# exception will be thrown).
|
13183
|
+
# assigned or picked by an agent who has access to the Worklist app.
|
13184
|
+
# The user can additionally filter on queues, if they have access to
|
13185
|
+
# those queues (otherwise a invalid request exception will be thrown).
|
13161
13186
|
#
|
13162
13187
|
# For information about how manual contact assignment works in the
|
13163
13188
|
# agent workspace, see the [Access the Worklist app in the Amazon
|
@@ -22053,7 +22078,7 @@ module Aws::Connect
|
|
22053
22078
|
tracer: tracer
|
22054
22079
|
)
|
22055
22080
|
context[:gem_name] = 'aws-sdk-connect'
|
22056
|
-
context[:gem_version] = '1.
|
22081
|
+
context[:gem_version] = '1.219.0'
|
22057
22082
|
Seahorse::Client::Request.new(handlers, context)
|
22058
22083
|
end
|
22059
22084
|
|
@@ -1397,6 +1397,7 @@ module Aws::Connect
|
|
1397
1397
|
TaskTemplateFieldValue = Shapes::StringShape.new(name: 'TaskTemplateFieldValue')
|
1398
1398
|
TaskTemplateFields = Shapes::ListShape.new(name: 'TaskTemplateFields')
|
1399
1399
|
TaskTemplateId = Shapes::StringShape.new(name: 'TaskTemplateId')
|
1400
|
+
TaskTemplateInfoV2 = Shapes::StructureShape.new(name: 'TaskTemplateInfoV2')
|
1400
1401
|
TaskTemplateList = Shapes::ListShape.new(name: 'TaskTemplateList')
|
1401
1402
|
TaskTemplateMetadata = Shapes::StructureShape.new(name: 'TaskTemplateMetadata')
|
1402
1403
|
TaskTemplateName = Shapes::StringShape.new(name: 'TaskTemplateName')
|
@@ -2147,6 +2148,7 @@ module Aws::Connect
|
|
2147
2148
|
Contact.add_member(:recordings, Shapes::ShapeRef.new(shape: Recordings, location_name: "Recordings"))
|
2148
2149
|
Contact.add_member(:disconnect_reason, Shapes::ShapeRef.new(shape: String, location_name: "DisconnectReason"))
|
2149
2150
|
Contact.add_member(:contact_evaluations, Shapes::ShapeRef.new(shape: ContactEvaluations, location_name: "ContactEvaluations"))
|
2151
|
+
Contact.add_member(:task_template_info, Shapes::ShapeRef.new(shape: TaskTemplateInfoV2, location_name: "TaskTemplateInfo"))
|
2150
2152
|
Contact.add_member(:contact_details, Shapes::ShapeRef.new(shape: ContactDetails, location_name: "ContactDetails"))
|
2151
2153
|
Contact.add_member(:attributes, Shapes::ShapeRef.new(shape: Attributes, location_name: "Attributes"))
|
2152
2154
|
Contact.struct_class = Types::Contact
|
@@ -6112,6 +6114,10 @@ module Aws::Connect
|
|
6112
6114
|
|
6113
6115
|
TaskTemplateFields.member = Shapes::ShapeRef.new(shape: TaskTemplateField)
|
6114
6116
|
|
6117
|
+
TaskTemplateInfoV2.add_member(:arn, Shapes::ShapeRef.new(shape: ARN, location_name: "Arn"))
|
6118
|
+
TaskTemplateInfoV2.add_member(:name, Shapes::ShapeRef.new(shape: TaskTemplateName, location_name: "Name"))
|
6119
|
+
TaskTemplateInfoV2.struct_class = Types::TaskTemplateInfoV2
|
6120
|
+
|
6115
6121
|
TaskTemplateList.member = Shapes::ShapeRef.new(shape: TaskTemplateMetadata)
|
6116
6122
|
|
6117
6123
|
TaskTemplateMetadata.add_member(:id, Shapes::ShapeRef.new(shape: TaskTemplateId, location_name: "Id"))
|
@@ -13,22 +13,22 @@ module Aws::Connect
|
|
13
13
|
# @!attribute region
|
14
14
|
# The AWS region used to dispatch the request.
|
15
15
|
#
|
16
|
-
# @return [
|
16
|
+
# @return [string]
|
17
17
|
#
|
18
18
|
# @!attribute use_dual_stack
|
19
19
|
# When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.
|
20
20
|
#
|
21
|
-
# @return [
|
21
|
+
# @return [boolean]
|
22
22
|
#
|
23
23
|
# @!attribute use_fips
|
24
24
|
# When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.
|
25
25
|
#
|
26
|
-
# @return [
|
26
|
+
# @return [boolean]
|
27
27
|
#
|
28
28
|
# @!attribute endpoint
|
29
29
|
# Override the endpoint used to send this request
|
30
30
|
#
|
31
|
-
# @return [
|
31
|
+
# @return [string]
|
32
32
|
#
|
33
33
|
EndpointParameters = Struct.new(
|
34
34
|
:region,
|
@@ -2839,6 +2839,11 @@ module Aws::Connect
|
|
2839
2839
|
# FormId, which is a unique identifier for the form.
|
2840
2840
|
# @return [Hash<String,Types::ContactEvaluation>]
|
2841
2841
|
#
|
2842
|
+
# @!attribute [rw] task_template_info
|
2843
|
+
# If this contact was created using a task template, this contains
|
2844
|
+
# information about the task template.
|
2845
|
+
# @return [Types::TaskTemplateInfoV2]
|
2846
|
+
#
|
2842
2847
|
# @!attribute [rw] contact_details
|
2843
2848
|
# A map of string key/value pairs that contain user-defined attributes
|
2844
2849
|
# which are lightly typed within the contact. This object is used only
|
@@ -2893,6 +2898,7 @@ module Aws::Connect
|
|
2893
2898
|
:recordings,
|
2894
2899
|
:disconnect_reason,
|
2895
2900
|
:contact_evaluations,
|
2901
|
+
:task_template_info,
|
2896
2902
|
:contact_details,
|
2897
2903
|
:attributes)
|
2898
2904
|
SENSITIVE = [:name, :description]
|
@@ -16408,6 +16414,7 @@ module Aws::Connect
|
|
16408
16414
|
# @!attribute [rw] instance_id
|
16409
16415
|
# The identifier of the Amazon Connect instance. You can [find the
|
16410
16416
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
16417
|
+
# Both Instance ID and Instance ARN are supported input formats.
|
16411
16418
|
#
|
16412
16419
|
#
|
16413
16420
|
#
|
@@ -20682,6 +20689,9 @@ module Aws::Connect
|
|
20682
20689
|
# @!attribute [rw] channel
|
20683
20690
|
# The channels this queue supports. Valid Values: CHAT \| TASK \|
|
20684
20691
|
# EMAIL
|
20692
|
+
#
|
20693
|
+
# VOICE is not supported. The information shown below is incorrect.
|
20694
|
+
# We're working to correct it.
|
20685
20695
|
# @return [String]
|
20686
20696
|
#
|
20687
20697
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RoutingProfileManualAssignmentQueueConfigSummary AWS API Documentation
|
@@ -21430,7 +21440,15 @@ module Aws::Connect
|
|
21430
21440
|
include Aws::Structure
|
21431
21441
|
end
|
21432
21442
|
|
21433
|
-
# Time range that you additionally want to filter on.
|
21443
|
+
# Time range that you **additionally** want to filter on.
|
21444
|
+
#
|
21445
|
+
# <note markdown="1"> This is different from the [SearchContactsTimeRange][1] data type.
|
21446
|
+
#
|
21447
|
+
# </note>
|
21448
|
+
#
|
21449
|
+
#
|
21450
|
+
#
|
21451
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchContactsTimeRange.html
|
21434
21452
|
#
|
21435
21453
|
# @!attribute [rw] criteria
|
21436
21454
|
# List of criteria of the time range to additionally filter on.
|
@@ -21555,8 +21573,9 @@ module Aws::Connect
|
|
21555
21573
|
include Aws::Structure
|
21556
21574
|
end
|
21557
21575
|
|
21558
|
-
# The timestamp condition indicating which timestamp should be
|
21559
|
-
# how it should be filtered.
|
21576
|
+
# The timestamp condition indicating which contact timestamp should be
|
21577
|
+
# used and how it should be filtered. It is not an actual timestamp
|
21578
|
+
# value.
|
21560
21579
|
#
|
21561
21580
|
# @!attribute [rw] type
|
21562
21581
|
# Type of the timestamps to use for the filter.
|
@@ -25084,6 +25103,26 @@ module Aws::Connect
|
|
25084
25103
|
include Aws::Structure
|
25085
25104
|
end
|
25086
25105
|
|
25106
|
+
# Information about the task template used to create this contact.
|
25107
|
+
#
|
25108
|
+
# @!attribute [rw] arn
|
25109
|
+
# The Amazon Resource Name (ARN) of the task template used to create
|
25110
|
+
# this contact.
|
25111
|
+
# @return [String]
|
25112
|
+
#
|
25113
|
+
# @!attribute [rw] name
|
25114
|
+
# The name of the task template used to create this contact.
|
25115
|
+
# @return [String]
|
25116
|
+
#
|
25117
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TaskTemplateInfoV2 AWS API Documentation
|
25118
|
+
#
|
25119
|
+
class TaskTemplateInfoV2 < Struct.new(
|
25120
|
+
:arn,
|
25121
|
+
:name)
|
25122
|
+
SENSITIVE = []
|
25123
|
+
include Aws::Structure
|
25124
|
+
end
|
25125
|
+
|
25087
25126
|
# Contains summary information about the task template.
|
25088
25127
|
#
|
25089
25128
|
# @!attribute [rw] id
|
data/lib/aws-sdk-connect.rb
CHANGED
data/sig/types.rbs
CHANGED
@@ -667,6 +667,7 @@ module Aws::Connect
|
|
667
667
|
attr_accessor recordings: ::Array[Types::RecordingInfo]
|
668
668
|
attr_accessor disconnect_reason: ::String
|
669
669
|
attr_accessor contact_evaluations: ::Hash[::String, Types::ContactEvaluation]
|
670
|
+
attr_accessor task_template_info: Types::TaskTemplateInfoV2
|
670
671
|
attr_accessor contact_details: Types::ContactDetails
|
671
672
|
attr_accessor attributes: ::Hash[::String, ::String]
|
672
673
|
SENSITIVE: [:name, :description]
|
@@ -5681,6 +5682,12 @@ module Aws::Connect
|
|
5681
5682
|
SENSITIVE: []
|
5682
5683
|
end
|
5683
5684
|
|
5685
|
+
class TaskTemplateInfoV2
|
5686
|
+
attr_accessor arn: ::String
|
5687
|
+
attr_accessor name: ::String
|
5688
|
+
SENSITIVE: []
|
5689
|
+
end
|
5690
|
+
|
5684
5691
|
class TaskTemplateMetadata
|
5685
5692
|
attr_accessor id: ::String
|
5686
5693
|
attr_accessor arn: ::String
|