aws-sdk-connect 1.70.0 → 1.73.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 +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +648 -9
- data/lib/aws-sdk-connect/client_api.rb +442 -1
- data/lib/aws-sdk-connect/errors.rb +21 -0
- data/lib/aws-sdk-connect/types.rb +1466 -26
- data/lib/aws-sdk-connect.rb +1 -1
- metadata +2 -2
@@ -23,6 +23,59 @@ module Aws::Connect
|
|
23
23
|
include Aws::Structure
|
24
24
|
end
|
25
25
|
|
26
|
+
# Information about the [contact][1] associated to the user.
|
27
|
+
#
|
28
|
+
#
|
29
|
+
#
|
30
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_Contact.html
|
31
|
+
#
|
32
|
+
# @!attribute [rw] contact_id
|
33
|
+
# The identifier of the contact in this instance of Amazon Connect.
|
34
|
+
# @return [String]
|
35
|
+
#
|
36
|
+
# @!attribute [rw] channel
|
37
|
+
# The channel of the contact.
|
38
|
+
# @return [String]
|
39
|
+
#
|
40
|
+
# @!attribute [rw] initiation_method
|
41
|
+
# How the contact was initiated.
|
42
|
+
# @return [String]
|
43
|
+
#
|
44
|
+
# @!attribute [rw] agent_contact_state
|
45
|
+
# The [state of the contact][1].
|
46
|
+
#
|
47
|
+
#
|
48
|
+
#
|
49
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html
|
50
|
+
# @return [String]
|
51
|
+
#
|
52
|
+
# @!attribute [rw] state_start_timestamp
|
53
|
+
# The epoch timestamp when the contact state started.
|
54
|
+
# @return [Time]
|
55
|
+
#
|
56
|
+
# @!attribute [rw] connected_to_agent_timestamp
|
57
|
+
# The time at which the contact was connected to an agent.
|
58
|
+
# @return [Time]
|
59
|
+
#
|
60
|
+
# @!attribute [rw] queue
|
61
|
+
# Contains information about a queue resource for which metrics are
|
62
|
+
# returned.
|
63
|
+
# @return [Types::QueueReference]
|
64
|
+
#
|
65
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AgentContactReference AWS API Documentation
|
66
|
+
#
|
67
|
+
class AgentContactReference < Struct.new(
|
68
|
+
:contact_id,
|
69
|
+
:channel,
|
70
|
+
:initiation_method,
|
71
|
+
:agent_contact_state,
|
72
|
+
:state_start_timestamp,
|
73
|
+
:connected_to_agent_timestamp,
|
74
|
+
:queue)
|
75
|
+
SENSITIVE = []
|
76
|
+
include Aws::Structure
|
77
|
+
end
|
78
|
+
|
26
79
|
# Information about the agent who accepted the contact.
|
27
80
|
#
|
28
81
|
# @!attribute [rw] id
|
@@ -92,6 +145,25 @@ module Aws::Connect
|
|
92
145
|
include Aws::Structure
|
93
146
|
end
|
94
147
|
|
148
|
+
# Information about the agent's status.
|
149
|
+
#
|
150
|
+
# @!attribute [rw] status_start_timestamp
|
151
|
+
# The start timestamp of the agent's status.
|
152
|
+
# @return [Time]
|
153
|
+
#
|
154
|
+
# @!attribute [rw] status_arn
|
155
|
+
# The Amazon Resource Name (ARN) of the agent's status.
|
156
|
+
# @return [String]
|
157
|
+
#
|
158
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AgentStatusReference AWS API Documentation
|
159
|
+
#
|
160
|
+
class AgentStatusReference < Struct.new(
|
161
|
+
:status_start_timestamp,
|
162
|
+
:status_arn)
|
163
|
+
SENSITIVE = []
|
164
|
+
include Aws::Structure
|
165
|
+
end
|
166
|
+
|
95
167
|
# Summary information for an agent status.
|
96
168
|
#
|
97
169
|
# @!attribute [rw] id
|
@@ -526,7 +598,7 @@ module Aws::Connect
|
|
526
598
|
include Aws::Structure
|
527
599
|
end
|
528
600
|
|
529
|
-
# Information about
|
601
|
+
# Information about a reference when the `referenceType` is
|
530
602
|
# `ATTACHMENT`. Otherwise, null.
|
531
603
|
#
|
532
604
|
# @!attribute [rw] name
|
@@ -534,11 +606,11 @@ module Aws::Connect
|
|
534
606
|
# @return [String]
|
535
607
|
#
|
536
608
|
# @!attribute [rw] value
|
537
|
-
#
|
609
|
+
# The location path of the attachment reference.
|
538
610
|
# @return [String]
|
539
611
|
#
|
540
612
|
# @!attribute [rw] status
|
541
|
-
# Status of
|
613
|
+
# Status of the attachment reference type.
|
542
614
|
# @return [String]
|
543
615
|
#
|
544
616
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AttachmentReference AWS API Documentation
|
@@ -862,6 +934,36 @@ module Aws::Connect
|
|
862
934
|
include Aws::Structure
|
863
935
|
end
|
864
936
|
|
937
|
+
# Filters user data based on the contact information that is associated
|
938
|
+
# to the users. It contains a list of [contact states][1].
|
939
|
+
#
|
940
|
+
#
|
941
|
+
#
|
942
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html
|
943
|
+
#
|
944
|
+
# @note When making an API call, you may pass ContactFilter
|
945
|
+
# data as a hash:
|
946
|
+
#
|
947
|
+
# {
|
948
|
+
# contact_states: ["INCOMING"], # accepts INCOMING, PENDING, CONNECTING, CONNECTED, CONNECTED_ONHOLD, MISSED, ERROR, ENDED, REJECTED
|
949
|
+
# }
|
950
|
+
#
|
951
|
+
# @!attribute [rw] contact_states
|
952
|
+
# A list of up to 9 [contact states][1].
|
953
|
+
#
|
954
|
+
#
|
955
|
+
#
|
956
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html
|
957
|
+
# @return [Array<String>]
|
958
|
+
#
|
959
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactFilter AWS API Documentation
|
960
|
+
#
|
961
|
+
class ContactFilter < Struct.new(
|
962
|
+
:contact_states)
|
963
|
+
SENSITIVE = []
|
964
|
+
include Aws::Structure
|
965
|
+
end
|
966
|
+
|
865
967
|
# Contains information about a contact flow.
|
866
968
|
#
|
867
969
|
# @!attribute [rw] arn
|
@@ -1889,6 +1991,140 @@ module Aws::Connect
|
|
1889
1991
|
include Aws::Structure
|
1890
1992
|
end
|
1891
1993
|
|
1994
|
+
# @note When making an API call, you may pass CreateTaskTemplateRequest
|
1995
|
+
# data as a hash:
|
1996
|
+
#
|
1997
|
+
# {
|
1998
|
+
# instance_id: "InstanceId", # required
|
1999
|
+
# name: "TaskTemplateName", # required
|
2000
|
+
# description: "TaskTemplateDescription",
|
2001
|
+
# contact_flow_id: "ContactFlowId",
|
2002
|
+
# constraints: {
|
2003
|
+
# required_fields: [
|
2004
|
+
# {
|
2005
|
+
# id: {
|
2006
|
+
# name: "TaskTemplateFieldName",
|
2007
|
+
# },
|
2008
|
+
# },
|
2009
|
+
# ],
|
2010
|
+
# read_only_fields: [
|
2011
|
+
# {
|
2012
|
+
# id: {
|
2013
|
+
# name: "TaskTemplateFieldName",
|
2014
|
+
# },
|
2015
|
+
# },
|
2016
|
+
# ],
|
2017
|
+
# invisible_fields: [
|
2018
|
+
# {
|
2019
|
+
# id: {
|
2020
|
+
# name: "TaskTemplateFieldName",
|
2021
|
+
# },
|
2022
|
+
# },
|
2023
|
+
# ],
|
2024
|
+
# },
|
2025
|
+
# defaults: {
|
2026
|
+
# default_field_values: [
|
2027
|
+
# {
|
2028
|
+
# id: {
|
2029
|
+
# name: "TaskTemplateFieldName",
|
2030
|
+
# },
|
2031
|
+
# default_value: "TaskTemplateFieldValue",
|
2032
|
+
# },
|
2033
|
+
# ],
|
2034
|
+
# },
|
2035
|
+
# status: "ACTIVE", # accepts ACTIVE, INACTIVE
|
2036
|
+
# fields: [ # required
|
2037
|
+
# {
|
2038
|
+
# id: { # required
|
2039
|
+
# name: "TaskTemplateFieldName",
|
2040
|
+
# },
|
2041
|
+
# description: "TaskTemplateFieldDescription",
|
2042
|
+
# type: "NAME", # accepts NAME, DESCRIPTION, SCHEDULED_TIME, QUICK_CONNECT, URL, NUMBER, TEXT, TEXT_AREA, DATE_TIME, BOOLEAN, SINGLE_SELECT, EMAIL
|
2043
|
+
# single_select_options: ["TaskTemplateSingleSelectOption"],
|
2044
|
+
# },
|
2045
|
+
# ],
|
2046
|
+
# client_token: "ClientToken",
|
2047
|
+
# }
|
2048
|
+
#
|
2049
|
+
# @!attribute [rw] instance_id
|
2050
|
+
# The identifier of the Amazon Connect instance. You can find the
|
2051
|
+
# instanceId in the ARN of the instance.
|
2052
|
+
# @return [String]
|
2053
|
+
#
|
2054
|
+
# @!attribute [rw] name
|
2055
|
+
# The name of the task template.
|
2056
|
+
# @return [String]
|
2057
|
+
#
|
2058
|
+
# @!attribute [rw] description
|
2059
|
+
# The description of the task template.
|
2060
|
+
# @return [String]
|
2061
|
+
#
|
2062
|
+
# @!attribute [rw] contact_flow_id
|
2063
|
+
# The identifier of the flow that runs by default when a task is
|
2064
|
+
# created by referencing this template.
|
2065
|
+
# @return [String]
|
2066
|
+
#
|
2067
|
+
# @!attribute [rw] constraints
|
2068
|
+
# Constraints that are applicable to the fields listed.
|
2069
|
+
# @return [Types::TaskTemplateConstraints]
|
2070
|
+
#
|
2071
|
+
# @!attribute [rw] defaults
|
2072
|
+
# The default values for fields when a task is created by referencing
|
2073
|
+
# this template.
|
2074
|
+
# @return [Types::TaskTemplateDefaults]
|
2075
|
+
#
|
2076
|
+
# @!attribute [rw] status
|
2077
|
+
# Marks a template as `ACTIVE` or `INACTIVE` for a task to refer to
|
2078
|
+
# it. Tasks can only be created from `ACTIVE` templates. If a template
|
2079
|
+
# is marked as `INACTIVE`, then a task that refers to this template
|
2080
|
+
# cannot be created.
|
2081
|
+
# @return [String]
|
2082
|
+
#
|
2083
|
+
# @!attribute [rw] fields
|
2084
|
+
# Fields that are part of the template.
|
2085
|
+
# @return [Array<Types::TaskTemplateField>]
|
2086
|
+
#
|
2087
|
+
# @!attribute [rw] client_token
|
2088
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
2089
|
+
# idempotency of the request.
|
2090
|
+
#
|
2091
|
+
# **A suitable default value is auto-generated.** You should normally
|
2092
|
+
# not need to pass this option.
|
2093
|
+
# @return [String]
|
2094
|
+
#
|
2095
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateTaskTemplateRequest AWS API Documentation
|
2096
|
+
#
|
2097
|
+
class CreateTaskTemplateRequest < Struct.new(
|
2098
|
+
:instance_id,
|
2099
|
+
:name,
|
2100
|
+
:description,
|
2101
|
+
:contact_flow_id,
|
2102
|
+
:constraints,
|
2103
|
+
:defaults,
|
2104
|
+
:status,
|
2105
|
+
:fields,
|
2106
|
+
:client_token)
|
2107
|
+
SENSITIVE = []
|
2108
|
+
include Aws::Structure
|
2109
|
+
end
|
2110
|
+
|
2111
|
+
# @!attribute [rw] id
|
2112
|
+
# The identifier of the task template resource.
|
2113
|
+
# @return [String]
|
2114
|
+
#
|
2115
|
+
# @!attribute [rw] arn
|
2116
|
+
# The Amazon Resource Name (ARN) for the task template resource.
|
2117
|
+
# @return [String]
|
2118
|
+
#
|
2119
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateTaskTemplateResponse AWS API Documentation
|
2120
|
+
#
|
2121
|
+
class CreateTaskTemplateResponse < Struct.new(
|
2122
|
+
:id,
|
2123
|
+
:arn)
|
2124
|
+
SENSITIVE = []
|
2125
|
+
include Aws::Structure
|
2126
|
+
end
|
2127
|
+
|
1892
2128
|
# @note When making an API call, you may pass CreateUseCaseRequest
|
1893
2129
|
# data as a hash:
|
1894
2130
|
#
|
@@ -2326,6 +2562,26 @@ module Aws::Connect
|
|
2326
2562
|
include Aws::Structure
|
2327
2563
|
end
|
2328
2564
|
|
2565
|
+
# Information about a reference when the `referenceType` is `DATE`.
|
2566
|
+
# Otherwise, null.
|
2567
|
+
#
|
2568
|
+
# @!attribute [rw] name
|
2569
|
+
# Identifier of the date reference.
|
2570
|
+
# @return [String]
|
2571
|
+
#
|
2572
|
+
# @!attribute [rw] value
|
2573
|
+
# A valid date.
|
2574
|
+
# @return [String]
|
2575
|
+
#
|
2576
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DateReference AWS API Documentation
|
2577
|
+
#
|
2578
|
+
class DateReference < Struct.new(
|
2579
|
+
:name,
|
2580
|
+
:value)
|
2581
|
+
SENSITIVE = []
|
2582
|
+
include Aws::Structure
|
2583
|
+
end
|
2584
|
+
|
2329
2585
|
# Contains information about a default vocabulary.
|
2330
2586
|
#
|
2331
2587
|
# @!attribute [rw] instance_id
|
@@ -2542,6 +2798,36 @@ module Aws::Connect
|
|
2542
2798
|
include Aws::Structure
|
2543
2799
|
end
|
2544
2800
|
|
2801
|
+
# @note When making an API call, you may pass DeleteTaskTemplateRequest
|
2802
|
+
# data as a hash:
|
2803
|
+
#
|
2804
|
+
# {
|
2805
|
+
# instance_id: "InstanceId", # required
|
2806
|
+
# task_template_id: "TaskTemplateId", # required
|
2807
|
+
# }
|
2808
|
+
#
|
2809
|
+
# @!attribute [rw] instance_id
|
2810
|
+
# The identifier of the Amazon Connect instance. You can find the
|
2811
|
+
# instanceId in the ARN of the instance.
|
2812
|
+
# @return [String]
|
2813
|
+
#
|
2814
|
+
# @!attribute [rw] task_template_id
|
2815
|
+
# A unique identifier for the task template.
|
2816
|
+
# @return [String]
|
2817
|
+
#
|
2818
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteTaskTemplateRequest AWS API Documentation
|
2819
|
+
#
|
2820
|
+
class DeleteTaskTemplateRequest < Struct.new(
|
2821
|
+
:instance_id,
|
2822
|
+
:task_template_id)
|
2823
|
+
SENSITIVE = []
|
2824
|
+
include Aws::Structure
|
2825
|
+
end
|
2826
|
+
|
2827
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteTaskTemplateResponse AWS API Documentation
|
2828
|
+
#
|
2829
|
+
class DeleteTaskTemplateResponse < Aws::EmptyStructure; end
|
2830
|
+
|
2545
2831
|
# @note When making an API call, you may pass DeleteUseCaseRequest
|
2546
2832
|
# data as a hash:
|
2547
2833
|
#
|
@@ -3634,6 +3920,26 @@ module Aws::Connect
|
|
3634
3920
|
include Aws::Structure
|
3635
3921
|
end
|
3636
3922
|
|
3923
|
+
# Information about a reference when the `referenceType` is `EMAIL`.
|
3924
|
+
# Otherwise, null.
|
3925
|
+
#
|
3926
|
+
# @!attribute [rw] name
|
3927
|
+
# Identifier of the email reference.
|
3928
|
+
# @return [String]
|
3929
|
+
#
|
3930
|
+
# @!attribute [rw] value
|
3931
|
+
# A valid email address.
|
3932
|
+
# @return [String]
|
3933
|
+
#
|
3934
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EmailReference AWS API Documentation
|
3935
|
+
#
|
3936
|
+
class EmailReference < Struct.new(
|
3937
|
+
:name,
|
3938
|
+
:value)
|
3939
|
+
SENSITIVE = []
|
3940
|
+
include Aws::Structure
|
3941
|
+
end
|
3942
|
+
|
3637
3943
|
# The encryption configuration.
|
3638
3944
|
#
|
3639
3945
|
# @note When making an API call, you may pass EncryptionConfig
|
@@ -3945,6 +4251,71 @@ module Aws::Connect
|
|
3945
4251
|
include Aws::Structure
|
3946
4252
|
end
|
3947
4253
|
|
4254
|
+
# @note When making an API call, you may pass GetCurrentUserDataRequest
|
4255
|
+
# data as a hash:
|
4256
|
+
#
|
4257
|
+
# {
|
4258
|
+
# instance_id: "InstanceId", # required
|
4259
|
+
# filters: { # required
|
4260
|
+
# queues: ["QueueId"],
|
4261
|
+
# contact_filter: {
|
4262
|
+
# contact_states: ["INCOMING"], # accepts INCOMING, PENDING, CONNECTING, CONNECTED, CONNECTED_ONHOLD, MISSED, ERROR, ENDED, REJECTED
|
4263
|
+
# },
|
4264
|
+
# },
|
4265
|
+
# next_token: "NextToken",
|
4266
|
+
# max_results: 1,
|
4267
|
+
# }
|
4268
|
+
#
|
4269
|
+
# @!attribute [rw] instance_id
|
4270
|
+
# The identifier of the Amazon Connect instance. You can find the
|
4271
|
+
# instanceId in the ARN of the instance.
|
4272
|
+
# @return [String]
|
4273
|
+
#
|
4274
|
+
# @!attribute [rw] filters
|
4275
|
+
# Filters up to 100 `Queues`, or up to 9 `ContactStates`. The user
|
4276
|
+
# data is retrieved only for those users who are associated with the
|
4277
|
+
# queues and have contacts that are in the specified `ContactState`.
|
4278
|
+
# @return [Types::UserDataFilters]
|
4279
|
+
#
|
4280
|
+
# @!attribute [rw] next_token
|
4281
|
+
# The token for the next set of results. Use the value returned in the
|
4282
|
+
# previous response in the next request to retrieve the next set of
|
4283
|
+
# results.
|
4284
|
+
# @return [String]
|
4285
|
+
#
|
4286
|
+
# @!attribute [rw] max_results
|
4287
|
+
# The maximum number of results to return per page.
|
4288
|
+
# @return [Integer]
|
4289
|
+
#
|
4290
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetCurrentUserDataRequest AWS API Documentation
|
4291
|
+
#
|
4292
|
+
class GetCurrentUserDataRequest < Struct.new(
|
4293
|
+
:instance_id,
|
4294
|
+
:filters,
|
4295
|
+
:next_token,
|
4296
|
+
:max_results)
|
4297
|
+
SENSITIVE = []
|
4298
|
+
include Aws::Structure
|
4299
|
+
end
|
4300
|
+
|
4301
|
+
# @!attribute [rw] next_token
|
4302
|
+
# If there are additional results, this is the token for the next set
|
4303
|
+
# of results.
|
4304
|
+
# @return [String]
|
4305
|
+
#
|
4306
|
+
# @!attribute [rw] user_data_list
|
4307
|
+
# A list of the user data that is returned.
|
4308
|
+
# @return [Array<Types::UserData>]
|
4309
|
+
#
|
4310
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetCurrentUserDataResponse AWS API Documentation
|
4311
|
+
#
|
4312
|
+
class GetCurrentUserDataResponse < Struct.new(
|
4313
|
+
:next_token,
|
4314
|
+
:user_data_list)
|
4315
|
+
SENSITIVE = []
|
4316
|
+
include Aws::Structure
|
4317
|
+
end
|
4318
|
+
|
3948
4319
|
# @note When making an API call, you may pass GetFederationTokenRequest
|
3949
4320
|
# data as a hash:
|
3950
4321
|
#
|
@@ -4274,10 +4645,122 @@ module Aws::Connect
|
|
4274
4645
|
include Aws::Structure
|
4275
4646
|
end
|
4276
4647
|
|
4277
|
-
#
|
4648
|
+
# @note When making an API call, you may pass GetTaskTemplateRequest
|
4649
|
+
# data as a hash:
|
4278
4650
|
#
|
4279
|
-
#
|
4280
|
-
#
|
4651
|
+
# {
|
4652
|
+
# instance_id: "InstanceId", # required
|
4653
|
+
# task_template_id: "TaskTemplateId", # required
|
4654
|
+
# snapshot_version: "SnapshotVersion",
|
4655
|
+
# }
|
4656
|
+
#
|
4657
|
+
# @!attribute [rw] instance_id
|
4658
|
+
# The identifier of the Amazon Connect instance. You can find the
|
4659
|
+
# instanceId in the ARN of the instance.
|
4660
|
+
# @return [String]
|
4661
|
+
#
|
4662
|
+
# @!attribute [rw] task_template_id
|
4663
|
+
# A unique identifier for the task template.
|
4664
|
+
# @return [String]
|
4665
|
+
#
|
4666
|
+
# @!attribute [rw] snapshot_version
|
4667
|
+
# The system generated version of a task template that is associated
|
4668
|
+
# with a task, when the task is created.
|
4669
|
+
# @return [String]
|
4670
|
+
#
|
4671
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetTaskTemplateRequest AWS API Documentation
|
4672
|
+
#
|
4673
|
+
class GetTaskTemplateRequest < Struct.new(
|
4674
|
+
:instance_id,
|
4675
|
+
:task_template_id,
|
4676
|
+
:snapshot_version)
|
4677
|
+
SENSITIVE = []
|
4678
|
+
include Aws::Structure
|
4679
|
+
end
|
4680
|
+
|
4681
|
+
# @!attribute [rw] instance_id
|
4682
|
+
# The identifier of the Amazon Connect instance. You can find the
|
4683
|
+
# instanceId in the ARN of the instance.
|
4684
|
+
# @return [String]
|
4685
|
+
#
|
4686
|
+
# @!attribute [rw] id
|
4687
|
+
# A unique identifier for the task template.
|
4688
|
+
# @return [String]
|
4689
|
+
#
|
4690
|
+
# @!attribute [rw] arn
|
4691
|
+
# The Amazon Resource Name (ARN).
|
4692
|
+
# @return [String]
|
4693
|
+
#
|
4694
|
+
# @!attribute [rw] name
|
4695
|
+
# The name of the task template.
|
4696
|
+
# @return [String]
|
4697
|
+
#
|
4698
|
+
# @!attribute [rw] description
|
4699
|
+
# The description of the task template.
|
4700
|
+
# @return [String]
|
4701
|
+
#
|
4702
|
+
# @!attribute [rw] contact_flow_id
|
4703
|
+
# The identifier of the flow that runs by default when a task is
|
4704
|
+
# created by referencing this template.
|
4705
|
+
# @return [String]
|
4706
|
+
#
|
4707
|
+
# @!attribute [rw] constraints
|
4708
|
+
# Constraints that are applicable to the fields listed.
|
4709
|
+
# @return [Types::TaskTemplateConstraints]
|
4710
|
+
#
|
4711
|
+
# @!attribute [rw] defaults
|
4712
|
+
# The default values for fields when a task is created by referencing
|
4713
|
+
# this template.
|
4714
|
+
# @return [Types::TaskTemplateDefaults]
|
4715
|
+
#
|
4716
|
+
# @!attribute [rw] fields
|
4717
|
+
# Fields that are part of the template.
|
4718
|
+
# @return [Array<Types::TaskTemplateField>]
|
4719
|
+
#
|
4720
|
+
# @!attribute [rw] status
|
4721
|
+
# Marks a template as `ACTIVE` or `INACTIVE` for a task to refer to
|
4722
|
+
# it. Tasks can only be created from `ACTIVE` templates. If a template
|
4723
|
+
# is marked as `INACTIVE`, then a task that refers to this template
|
4724
|
+
# cannot be created.
|
4725
|
+
# @return [String]
|
4726
|
+
#
|
4727
|
+
# @!attribute [rw] last_modified_time
|
4728
|
+
# The timestamp when the task template was last modified.
|
4729
|
+
# @return [Time]
|
4730
|
+
#
|
4731
|
+
# @!attribute [rw] created_time
|
4732
|
+
# The timestamp when the task template was created.
|
4733
|
+
# @return [Time]
|
4734
|
+
#
|
4735
|
+
# @!attribute [rw] tags
|
4736
|
+
# The tags used to organize, track, or control access for this
|
4737
|
+
# resource.
|
4738
|
+
# @return [Hash<String,String>]
|
4739
|
+
#
|
4740
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetTaskTemplateResponse AWS API Documentation
|
4741
|
+
#
|
4742
|
+
class GetTaskTemplateResponse < Struct.new(
|
4743
|
+
:instance_id,
|
4744
|
+
:id,
|
4745
|
+
:arn,
|
4746
|
+
:name,
|
4747
|
+
:description,
|
4748
|
+
:contact_flow_id,
|
4749
|
+
:constraints,
|
4750
|
+
:defaults,
|
4751
|
+
:fields,
|
4752
|
+
:status,
|
4753
|
+
:last_modified_time,
|
4754
|
+
:created_time,
|
4755
|
+
:tags)
|
4756
|
+
SENSITIVE = []
|
4757
|
+
include Aws::Structure
|
4758
|
+
end
|
4759
|
+
|
4760
|
+
# Contains information about a hierarchy group.
|
4761
|
+
#
|
4762
|
+
# @!attribute [rw] id
|
4763
|
+
# The identifier of the hierarchy group.
|
4281
4764
|
# @return [String]
|
4282
4765
|
#
|
4283
4766
|
# @!attribute [rw] arn
|
@@ -4366,6 +4849,25 @@ module Aws::Connect
|
|
4366
4849
|
include Aws::Structure
|
4367
4850
|
end
|
4368
4851
|
|
4852
|
+
# Information about the hierarchy group.
|
4853
|
+
#
|
4854
|
+
# @!attribute [rw] id
|
4855
|
+
# The unique identifier for the hierarchy group.
|
4856
|
+
# @return [String]
|
4857
|
+
#
|
4858
|
+
# @!attribute [rw] arn
|
4859
|
+
# The Amazon Resource Name (ARN) for the hierarchy group.
|
4860
|
+
# @return [String]
|
4861
|
+
#
|
4862
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HierarchyGroupSummaryReference AWS API Documentation
|
4863
|
+
#
|
4864
|
+
class HierarchyGroupSummaryReference < Struct.new(
|
4865
|
+
:id,
|
4866
|
+
:arn)
|
4867
|
+
SENSITIVE = []
|
4868
|
+
include Aws::Structure
|
4869
|
+
end
|
4870
|
+
|
4369
4871
|
# Contains information about a hierarchy level.
|
4370
4872
|
#
|
4371
4873
|
# @!attribute [rw] id
|
@@ -4446,6 +4948,40 @@ module Aws::Connect
|
|
4446
4948
|
include Aws::Structure
|
4447
4949
|
end
|
4448
4950
|
|
4951
|
+
# Information about the levels in the hierarchy group.
|
4952
|
+
#
|
4953
|
+
# @!attribute [rw] level_one
|
4954
|
+
# Information about level one.
|
4955
|
+
# @return [Types::HierarchyGroupSummaryReference]
|
4956
|
+
#
|
4957
|
+
# @!attribute [rw] level_two
|
4958
|
+
# Information about level two.
|
4959
|
+
# @return [Types::HierarchyGroupSummaryReference]
|
4960
|
+
#
|
4961
|
+
# @!attribute [rw] level_three
|
4962
|
+
# Information about level three.
|
4963
|
+
# @return [Types::HierarchyGroupSummaryReference]
|
4964
|
+
#
|
4965
|
+
# @!attribute [rw] level_four
|
4966
|
+
# Information about level four.
|
4967
|
+
# @return [Types::HierarchyGroupSummaryReference]
|
4968
|
+
#
|
4969
|
+
# @!attribute [rw] level_five
|
4970
|
+
# Information about level five.
|
4971
|
+
# @return [Types::HierarchyGroupSummaryReference]
|
4972
|
+
#
|
4973
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HierarchyPathReference AWS API Documentation
|
4974
|
+
#
|
4975
|
+
class HierarchyPathReference < Struct.new(
|
4976
|
+
:level_one,
|
4977
|
+
:level_two,
|
4978
|
+
:level_three,
|
4979
|
+
:level_four,
|
4980
|
+
:level_five)
|
4981
|
+
SENSITIVE = []
|
4982
|
+
include Aws::Structure
|
4983
|
+
end
|
4984
|
+
|
4449
4985
|
# Contains information about a hierarchy structure.
|
4450
4986
|
#
|
4451
4987
|
# @!attribute [rw] level_one
|
@@ -5088,6 +5624,29 @@ module Aws::Connect
|
|
5088
5624
|
include Aws::Structure
|
5089
5625
|
end
|
5090
5626
|
|
5627
|
+
# A field that is invisible to an agent.
|
5628
|
+
#
|
5629
|
+
# @note When making an API call, you may pass InvisibleFieldInfo
|
5630
|
+
# data as a hash:
|
5631
|
+
#
|
5632
|
+
# {
|
5633
|
+
# id: {
|
5634
|
+
# name: "TaskTemplateFieldName",
|
5635
|
+
# },
|
5636
|
+
# }
|
5637
|
+
#
|
5638
|
+
# @!attribute [rw] id
|
5639
|
+
# Identifier of the invisible field.
|
5640
|
+
# @return [Types::TaskTemplateFieldIdentifier]
|
5641
|
+
#
|
5642
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/InvisibleFieldInfo AWS API Documentation
|
5643
|
+
#
|
5644
|
+
class InvisibleFieldInfo < Struct.new(
|
5645
|
+
:id)
|
5646
|
+
SENSITIVE = []
|
5647
|
+
include Aws::Structure
|
5648
|
+
end
|
5649
|
+
|
5091
5650
|
# Configuration information of a Kinesis Data Firehose delivery stream.
|
5092
5651
|
#
|
5093
5652
|
# @note When making an API call, you may pass KinesisFirehoseConfig
|
@@ -5543,7 +6102,7 @@ module Aws::Connect
|
|
5543
6102
|
# {
|
5544
6103
|
# instance_id: "InstanceId", # required
|
5545
6104
|
# contact_id: "ContactId", # required
|
5546
|
-
# reference_types: ["URL"], # required, accepts URL, ATTACHMENT
|
6105
|
+
# reference_types: ["URL"], # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
|
5547
6106
|
# next_token: "NextToken",
|
5548
6107
|
# }
|
5549
6108
|
#
|
@@ -6746,6 +7305,81 @@ module Aws::Connect
|
|
6746
7305
|
include Aws::Structure
|
6747
7306
|
end
|
6748
7307
|
|
7308
|
+
# @note When making an API call, you may pass ListTaskTemplatesRequest
|
7309
|
+
# data as a hash:
|
7310
|
+
#
|
7311
|
+
# {
|
7312
|
+
# instance_id: "InstanceId", # required
|
7313
|
+
# next_token: "NextToken",
|
7314
|
+
# max_results: 1,
|
7315
|
+
# status: "ACTIVE", # accepts ACTIVE, INACTIVE
|
7316
|
+
# name: "TaskTemplateName",
|
7317
|
+
# }
|
7318
|
+
#
|
7319
|
+
# @!attribute [rw] instance_id
|
7320
|
+
# The identifier of the Amazon Connect instance. You can find the
|
7321
|
+
# instanceId in the ARN of the instance.
|
7322
|
+
# @return [String]
|
7323
|
+
#
|
7324
|
+
# @!attribute [rw] next_token
|
7325
|
+
# The token for the next set of results. Use the value returned in the
|
7326
|
+
# previous response in the next request to retrieve the next set of
|
7327
|
+
# results.
|
7328
|
+
#
|
7329
|
+
# It is not expected that you set this because the value returned in
|
7330
|
+
# the previous response is always null.
|
7331
|
+
# @return [String]
|
7332
|
+
#
|
7333
|
+
# @!attribute [rw] max_results
|
7334
|
+
# The maximum number of results to return per page.
|
7335
|
+
#
|
7336
|
+
# It is not expected that you set this.
|
7337
|
+
# @return [Integer]
|
7338
|
+
#
|
7339
|
+
# @!attribute [rw] status
|
7340
|
+
# Marks a template as `ACTIVE` or `INACTIVE` for a task to refer to
|
7341
|
+
# it. Tasks can only be created from `ACTIVE` templates. If a template
|
7342
|
+
# is marked as `INACTIVE`, then a task that refers to this template
|
7343
|
+
# cannot be created.
|
7344
|
+
# @return [String]
|
7345
|
+
#
|
7346
|
+
# @!attribute [rw] name
|
7347
|
+
# The name of the task template.
|
7348
|
+
# @return [String]
|
7349
|
+
#
|
7350
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListTaskTemplatesRequest AWS API Documentation
|
7351
|
+
#
|
7352
|
+
class ListTaskTemplatesRequest < Struct.new(
|
7353
|
+
:instance_id,
|
7354
|
+
:next_token,
|
7355
|
+
:max_results,
|
7356
|
+
:status,
|
7357
|
+
:name)
|
7358
|
+
SENSITIVE = []
|
7359
|
+
include Aws::Structure
|
7360
|
+
end
|
7361
|
+
|
7362
|
+
# @!attribute [rw] task_templates
|
7363
|
+
# Provides details about a list of task templates belonging to an
|
7364
|
+
# instance.
|
7365
|
+
# @return [Array<Types::TaskTemplateMetadata>]
|
7366
|
+
#
|
7367
|
+
# @!attribute [rw] next_token
|
7368
|
+
# If there are additional results, this is the token for the next set
|
7369
|
+
# of results.
|
7370
|
+
#
|
7371
|
+
# This is always returned as a null in the response.
|
7372
|
+
# @return [String]
|
7373
|
+
#
|
7374
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListTaskTemplatesResponse AWS API Documentation
|
7375
|
+
#
|
7376
|
+
class ListTaskTemplatesResponse < Struct.new(
|
7377
|
+
:task_templates,
|
7378
|
+
:next_token)
|
7379
|
+
SENSITIVE = []
|
7380
|
+
include Aws::Structure
|
7381
|
+
end
|
7382
|
+
|
6749
7383
|
# Provides summary information about the use cases for the specified
|
6750
7384
|
# integration association.
|
6751
7385
|
#
|
@@ -6947,6 +7581,26 @@ module Aws::Connect
|
|
6947
7581
|
include Aws::Structure
|
6948
7582
|
end
|
6949
7583
|
|
7584
|
+
# Information about a reference when the `referenceType` is `NUMBER`.
|
7585
|
+
# Otherwise, null.
|
7586
|
+
#
|
7587
|
+
# @!attribute [rw] name
|
7588
|
+
# Identifier of the number reference.
|
7589
|
+
# @return [String]
|
7590
|
+
#
|
7591
|
+
# @!attribute [rw] value
|
7592
|
+
# A valid number.
|
7593
|
+
# @return [String]
|
7594
|
+
#
|
7595
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/NumberReference AWS API Documentation
|
7596
|
+
#
|
7597
|
+
class NumberReference < Struct.new(
|
7598
|
+
:name,
|
7599
|
+
:value)
|
7600
|
+
SENSITIVE = []
|
7601
|
+
include Aws::Structure
|
7602
|
+
end
|
7603
|
+
|
6950
7604
|
# The outbound caller ID name, number, and outbound whisper flow.
|
6951
7605
|
#
|
6952
7606
|
# @note When making an API call, you may pass OutboundCallerConfig
|
@@ -7128,6 +7782,81 @@ module Aws::Connect
|
|
7128
7782
|
include Aws::Structure
|
7129
7783
|
end
|
7130
7784
|
|
7785
|
+
# @!attribute [rw] message
|
7786
|
+
# @return [String]
|
7787
|
+
#
|
7788
|
+
# @!attribute [rw] property_list
|
7789
|
+
# @return [Array<Types::PropertyValidationExceptionProperty>]
|
7790
|
+
#
|
7791
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/PropertyValidationException AWS API Documentation
|
7792
|
+
#
|
7793
|
+
class PropertyValidationException < Struct.new(
|
7794
|
+
:message,
|
7795
|
+
:property_list)
|
7796
|
+
SENSITIVE = []
|
7797
|
+
include Aws::Structure
|
7798
|
+
end
|
7799
|
+
|
7800
|
+
# Contains information about why a property is not valid.
|
7801
|
+
#
|
7802
|
+
# @!attribute [rw] property_path
|
7803
|
+
# The full property path.
|
7804
|
+
# @return [String]
|
7805
|
+
#
|
7806
|
+
# @!attribute [rw] reason
|
7807
|
+
# Why the property is not valid.
|
7808
|
+
# @return [String]
|
7809
|
+
#
|
7810
|
+
# @!attribute [rw] message
|
7811
|
+
# A message describing why the property is not valid.
|
7812
|
+
# @return [String]
|
7813
|
+
#
|
7814
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/PropertyValidationExceptionProperty AWS API Documentation
|
7815
|
+
#
|
7816
|
+
class PropertyValidationExceptionProperty < Struct.new(
|
7817
|
+
:property_path,
|
7818
|
+
:reason,
|
7819
|
+
:message)
|
7820
|
+
SENSITIVE = []
|
7821
|
+
include Aws::Structure
|
7822
|
+
end
|
7823
|
+
|
7824
|
+
# @note When making an API call, you may pass PutUserStatusRequest
|
7825
|
+
# data as a hash:
|
7826
|
+
#
|
7827
|
+
# {
|
7828
|
+
# user_id: "UserId", # required
|
7829
|
+
# instance_id: "InstanceId", # required
|
7830
|
+
# agent_status_id: "AgentStatusId", # required
|
7831
|
+
# }
|
7832
|
+
#
|
7833
|
+
# @!attribute [rw] user_id
|
7834
|
+
# The identifier of the user.
|
7835
|
+
# @return [String]
|
7836
|
+
#
|
7837
|
+
# @!attribute [rw] instance_id
|
7838
|
+
# The identifier of the Amazon Connect instance. You can find the
|
7839
|
+
# instanceId in the ARN of the instance.
|
7840
|
+
# @return [String]
|
7841
|
+
#
|
7842
|
+
# @!attribute [rw] agent_status_id
|
7843
|
+
# The identifier of the agent status.
|
7844
|
+
# @return [String]
|
7845
|
+
#
|
7846
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/PutUserStatusRequest AWS API Documentation
|
7847
|
+
#
|
7848
|
+
class PutUserStatusRequest < Struct.new(
|
7849
|
+
:user_id,
|
7850
|
+
:instance_id,
|
7851
|
+
:agent_status_id)
|
7852
|
+
SENSITIVE = []
|
7853
|
+
include Aws::Structure
|
7854
|
+
end
|
7855
|
+
|
7856
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/PutUserStatusResponse AWS API Documentation
|
7857
|
+
#
|
7858
|
+
class PutUserStatusResponse < Aws::EmptyStructure; end
|
7859
|
+
|
7131
7860
|
# Contains information about a queue.
|
7132
7861
|
#
|
7133
7862
|
# @!attribute [rw] name
|
@@ -7405,26 +8134,49 @@ module Aws::Connect
|
|
7405
8134
|
include Aws::Structure
|
7406
8135
|
end
|
7407
8136
|
|
7408
|
-
#
|
7409
|
-
# to 4,096 UTF-8 bytes across all references for a contact.
|
8137
|
+
# Indicates a field that is read-only to an agent.
|
7410
8138
|
#
|
7411
|
-
# @note When making an API call, you may pass
|
8139
|
+
# @note When making an API call, you may pass ReadOnlyFieldInfo
|
7412
8140
|
# data as a hash:
|
7413
8141
|
#
|
7414
8142
|
# {
|
7415
|
-
#
|
7416
|
-
#
|
8143
|
+
# id: {
|
8144
|
+
# name: "TaskTemplateFieldName",
|
8145
|
+
# },
|
7417
8146
|
# }
|
7418
8147
|
#
|
7419
|
-
# @!attribute [rw]
|
7420
|
-
#
|
7421
|
-
#
|
7422
|
-
#
|
7423
|
-
#
|
8148
|
+
# @!attribute [rw] id
|
8149
|
+
# Identifier of the read-only field.
|
8150
|
+
# @return [Types::TaskTemplateFieldIdentifier]
|
8151
|
+
#
|
8152
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ReadOnlyFieldInfo AWS API Documentation
|
8153
|
+
#
|
8154
|
+
class ReadOnlyFieldInfo < Struct.new(
|
8155
|
+
:id)
|
8156
|
+
SENSITIVE = []
|
8157
|
+
include Aws::Structure
|
8158
|
+
end
|
8159
|
+
|
8160
|
+
# Well-formed data on a contact, used by agents to complete a contact
|
8161
|
+
# request. You can have up to 4,096 UTF-8 bytes across all references
|
8162
|
+
# for a contact.
|
8163
|
+
#
|
8164
|
+
# @note When making an API call, you may pass Reference
|
8165
|
+
# data as a hash:
|
8166
|
+
#
|
8167
|
+
# {
|
8168
|
+
# value: "ReferenceValue", # required
|
8169
|
+
# type: "URL", # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
|
8170
|
+
# }
|
8171
|
+
#
|
8172
|
+
# @!attribute [rw] value
|
8173
|
+
# A valid value for the reference. For example, for a URL reference, a
|
8174
|
+
# formatted URL that is displayed to an agent in the Contact Control
|
8175
|
+
# Panel (CCP).
|
8176
|
+
# @return [String]
|
7424
8177
|
#
|
7425
8178
|
# @!attribute [rw] type
|
7426
|
-
# The type of the reference.
|
7427
|
-
# on a contact.
|
8179
|
+
# The type of the reference.
|
7428
8180
|
# @return [String]
|
7429
8181
|
#
|
7430
8182
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Reference AWS API Documentation
|
@@ -7443,20 +8195,44 @@ module Aws::Connect
|
|
7443
8195
|
# @note ReferenceSummary is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ReferenceSummary corresponding to the set member.
|
7444
8196
|
#
|
7445
8197
|
# @!attribute [rw] url
|
7446
|
-
# Information about the
|
8198
|
+
# Information about the reference when the `referenceType` is `URL`.
|
7447
8199
|
# Otherwise, null.
|
7448
8200
|
# @return [Types::UrlReference]
|
7449
8201
|
#
|
7450
8202
|
# @!attribute [rw] attachment
|
7451
|
-
# Information about the
|
8203
|
+
# Information about the reference when the `referenceType` is
|
7452
8204
|
# `ATTACHMENT`. Otherwise, null.
|
7453
8205
|
# @return [Types::AttachmentReference]
|
7454
8206
|
#
|
8207
|
+
# @!attribute [rw] string
|
8208
|
+
# Information about a reference when the `referenceType` is `STRING`.
|
8209
|
+
# Otherwise, null.
|
8210
|
+
# @return [Types::StringReference]
|
8211
|
+
#
|
8212
|
+
# @!attribute [rw] number
|
8213
|
+
# Information about a reference when the `referenceType` is `NUMBER`.
|
8214
|
+
# Otherwise, null.
|
8215
|
+
# @return [Types::NumberReference]
|
8216
|
+
#
|
8217
|
+
# @!attribute [rw] date
|
8218
|
+
# Information about a reference when the `referenceType` is `DATE`.
|
8219
|
+
# Otherwise, null.
|
8220
|
+
# @return [Types::DateReference]
|
8221
|
+
#
|
8222
|
+
# @!attribute [rw] email
|
8223
|
+
# Information about a reference when the `referenceType` is `EMAIL`.
|
8224
|
+
# Otherwise, null.
|
8225
|
+
# @return [Types::EmailReference]
|
8226
|
+
#
|
7455
8227
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ReferenceSummary AWS API Documentation
|
7456
8228
|
#
|
7457
8229
|
class ReferenceSummary < Struct.new(
|
7458
8230
|
:url,
|
7459
8231
|
:attachment,
|
8232
|
+
:string,
|
8233
|
+
:number,
|
8234
|
+
:date,
|
8235
|
+
:email,
|
7460
8236
|
:unknown)
|
7461
8237
|
SENSITIVE = []
|
7462
8238
|
include Aws::Structure
|
@@ -7464,6 +8240,10 @@ module Aws::Connect
|
|
7464
8240
|
|
7465
8241
|
class Url < ReferenceSummary; end
|
7466
8242
|
class Attachment < ReferenceSummary; end
|
8243
|
+
class String < ReferenceSummary; end
|
8244
|
+
class Number < ReferenceSummary; end
|
8245
|
+
class Date < ReferenceSummary; end
|
8246
|
+
class Email < ReferenceSummary; end
|
7467
8247
|
class Unknown < ReferenceSummary; end
|
7468
8248
|
end
|
7469
8249
|
|
@@ -7496,6 +8276,29 @@ module Aws::Connect
|
|
7496
8276
|
include Aws::Structure
|
7497
8277
|
end
|
7498
8278
|
|
8279
|
+
# Information about a required field.
|
8280
|
+
#
|
8281
|
+
# @note When making an API call, you may pass RequiredFieldInfo
|
8282
|
+
# data as a hash:
|
8283
|
+
#
|
8284
|
+
# {
|
8285
|
+
# id: {
|
8286
|
+
# name: "TaskTemplateFieldName",
|
8287
|
+
# },
|
8288
|
+
# }
|
8289
|
+
#
|
8290
|
+
# @!attribute [rw] id
|
8291
|
+
# The unique identifier for the field.
|
8292
|
+
# @return [Types::TaskTemplateFieldIdentifier]
|
8293
|
+
#
|
8294
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RequiredFieldInfo AWS API Documentation
|
8295
|
+
#
|
8296
|
+
class RequiredFieldInfo < Struct.new(
|
8297
|
+
:id)
|
8298
|
+
SENSITIVE = []
|
8299
|
+
include Aws::Structure
|
8300
|
+
end
|
8301
|
+
|
7499
8302
|
# A resource already has that name.
|
7500
8303
|
#
|
7501
8304
|
# @!attribute [rw] message
|
@@ -7762,6 +8565,25 @@ module Aws::Connect
|
|
7762
8565
|
include Aws::Structure
|
7763
8566
|
end
|
7764
8567
|
|
8568
|
+
# Information about the routing profile assigned to the user.
|
8569
|
+
#
|
8570
|
+
# @!attribute [rw] id
|
8571
|
+
# The identifier of the routing profile.
|
8572
|
+
# @return [String]
|
8573
|
+
#
|
8574
|
+
# @!attribute [rw] arn
|
8575
|
+
# The Amazon Resource Name (ARN) of the routing profile.
|
8576
|
+
# @return [String]
|
8577
|
+
#
|
8578
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RoutingProfileReference AWS API Documentation
|
8579
|
+
#
|
8580
|
+
class RoutingProfileReference < Struct.new(
|
8581
|
+
:id,
|
8582
|
+
:arn)
|
8583
|
+
SENSITIVE = []
|
8584
|
+
include Aws::Structure
|
8585
|
+
end
|
8586
|
+
|
7765
8587
|
# Contains summary information about a routing profile.
|
7766
8588
|
#
|
7767
8589
|
# @!attribute [rw] id
|
@@ -8531,7 +9353,7 @@ module Aws::Connect
|
|
8531
9353
|
# {
|
8532
9354
|
# instance_id: "InstanceId", # required
|
8533
9355
|
# previous_contact_id: "ContactId",
|
8534
|
-
# contact_flow_id: "ContactFlowId",
|
9356
|
+
# contact_flow_id: "ContactFlowId",
|
8535
9357
|
# attributes: {
|
8536
9358
|
# "AttributeName" => "AttributeValue",
|
8537
9359
|
# },
|
@@ -8539,12 +9361,14 @@ module Aws::Connect
|
|
8539
9361
|
# references: {
|
8540
9362
|
# "ReferenceKey" => {
|
8541
9363
|
# value: "ReferenceValue", # required
|
8542
|
-
# type: "URL", # required, accepts URL, ATTACHMENT
|
9364
|
+
# type: "URL", # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
|
8543
9365
|
# },
|
8544
9366
|
# },
|
8545
9367
|
# description: "Description",
|
8546
9368
|
# client_token: "ClientToken",
|
8547
9369
|
# scheduled_time: Time.now,
|
9370
|
+
# task_template_id: "TaskTemplateId",
|
9371
|
+
# quick_connect_id: "QuickConnectId",
|
8548
9372
|
# }
|
8549
9373
|
#
|
8550
9374
|
# @!attribute [rw] instance_id
|
@@ -8606,6 +9430,14 @@ module Aws::Connect
|
|
8606
9430
|
# the past. It must be within up to 6 days in future.
|
8607
9431
|
# @return [Time]
|
8608
9432
|
#
|
9433
|
+
# @!attribute [rw] task_template_id
|
9434
|
+
# A unique identifier for the task template.
|
9435
|
+
# @return [String]
|
9436
|
+
#
|
9437
|
+
# @!attribute [rw] quick_connect_id
|
9438
|
+
# The identifier for the quick connect.
|
9439
|
+
# @return [String]
|
9440
|
+
#
|
8609
9441
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartTaskContactRequest AWS API Documentation
|
8610
9442
|
#
|
8611
9443
|
class StartTaskContactRequest < Struct.new(
|
@@ -8617,7 +9449,9 @@ module Aws::Connect
|
|
8617
9449
|
:references,
|
8618
9450
|
:description,
|
8619
9451
|
:client_token,
|
8620
|
-
:scheduled_time
|
9452
|
+
:scheduled_time,
|
9453
|
+
:task_template_id,
|
9454
|
+
:quick_connect_id)
|
8621
9455
|
SENSITIVE = []
|
8622
9456
|
include Aws::Structure
|
8623
9457
|
end
|
@@ -8774,6 +9608,26 @@ module Aws::Connect
|
|
8774
9608
|
include Aws::Structure
|
8775
9609
|
end
|
8776
9610
|
|
9611
|
+
# Information about a reference when the `referenceType` is `STRING`.
|
9612
|
+
# Otherwise, null.
|
9613
|
+
#
|
9614
|
+
# @!attribute [rw] name
|
9615
|
+
# Identifier of the string reference.
|
9616
|
+
# @return [String]
|
9617
|
+
#
|
9618
|
+
# @!attribute [rw] value
|
9619
|
+
# A valid string.
|
9620
|
+
# @return [String]
|
9621
|
+
#
|
9622
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StringReference AWS API Documentation
|
9623
|
+
#
|
9624
|
+
class StringReference < Struct.new(
|
9625
|
+
:name,
|
9626
|
+
:value)
|
9627
|
+
SENSITIVE = []
|
9628
|
+
include Aws::Structure
|
9629
|
+
end
|
9630
|
+
|
8777
9631
|
# @note When making an API call, you may pass SuspendContactRecordingRequest
|
8778
9632
|
# data as a hash:
|
8779
9633
|
#
|
@@ -8867,6 +9721,223 @@ module Aws::Connect
|
|
8867
9721
|
include Aws::Structure
|
8868
9722
|
end
|
8869
9723
|
|
9724
|
+
# Describes constraints that apply to the template fields.
|
9725
|
+
#
|
9726
|
+
# @note When making an API call, you may pass TaskTemplateConstraints
|
9727
|
+
# data as a hash:
|
9728
|
+
#
|
9729
|
+
# {
|
9730
|
+
# required_fields: [
|
9731
|
+
# {
|
9732
|
+
# id: {
|
9733
|
+
# name: "TaskTemplateFieldName",
|
9734
|
+
# },
|
9735
|
+
# },
|
9736
|
+
# ],
|
9737
|
+
# read_only_fields: [
|
9738
|
+
# {
|
9739
|
+
# id: {
|
9740
|
+
# name: "TaskTemplateFieldName",
|
9741
|
+
# },
|
9742
|
+
# },
|
9743
|
+
# ],
|
9744
|
+
# invisible_fields: [
|
9745
|
+
# {
|
9746
|
+
# id: {
|
9747
|
+
# name: "TaskTemplateFieldName",
|
9748
|
+
# },
|
9749
|
+
# },
|
9750
|
+
# ],
|
9751
|
+
# }
|
9752
|
+
#
|
9753
|
+
# @!attribute [rw] required_fields
|
9754
|
+
# Lists the fields that are required to be filled by agents.
|
9755
|
+
# @return [Array<Types::RequiredFieldInfo>]
|
9756
|
+
#
|
9757
|
+
# @!attribute [rw] read_only_fields
|
9758
|
+
# Lists the fields that are read-only to agents, and cannot be edited.
|
9759
|
+
# @return [Array<Types::ReadOnlyFieldInfo>]
|
9760
|
+
#
|
9761
|
+
# @!attribute [rw] invisible_fields
|
9762
|
+
# Lists the fields that are invisible to agents.
|
9763
|
+
# @return [Array<Types::InvisibleFieldInfo>]
|
9764
|
+
#
|
9765
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TaskTemplateConstraints AWS API Documentation
|
9766
|
+
#
|
9767
|
+
class TaskTemplateConstraints < Struct.new(
|
9768
|
+
:required_fields,
|
9769
|
+
:read_only_fields,
|
9770
|
+
:invisible_fields)
|
9771
|
+
SENSITIVE = []
|
9772
|
+
include Aws::Structure
|
9773
|
+
end
|
9774
|
+
|
9775
|
+
# Describes a default field and its corresponding value.
|
9776
|
+
#
|
9777
|
+
# @note When making an API call, you may pass TaskTemplateDefaultFieldValue
|
9778
|
+
# data as a hash:
|
9779
|
+
#
|
9780
|
+
# {
|
9781
|
+
# id: {
|
9782
|
+
# name: "TaskTemplateFieldName",
|
9783
|
+
# },
|
9784
|
+
# default_value: "TaskTemplateFieldValue",
|
9785
|
+
# }
|
9786
|
+
#
|
9787
|
+
# @!attribute [rw] id
|
9788
|
+
# Identifier of a field.
|
9789
|
+
# @return [Types::TaskTemplateFieldIdentifier]
|
9790
|
+
#
|
9791
|
+
# @!attribute [rw] default_value
|
9792
|
+
# Default value for the field.
|
9793
|
+
# @return [String]
|
9794
|
+
#
|
9795
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TaskTemplateDefaultFieldValue AWS API Documentation
|
9796
|
+
#
|
9797
|
+
class TaskTemplateDefaultFieldValue < Struct.new(
|
9798
|
+
:id,
|
9799
|
+
:default_value)
|
9800
|
+
SENSITIVE = []
|
9801
|
+
include Aws::Structure
|
9802
|
+
end
|
9803
|
+
|
9804
|
+
# Describes default values for fields on a template.
|
9805
|
+
#
|
9806
|
+
# @note When making an API call, you may pass TaskTemplateDefaults
|
9807
|
+
# data as a hash:
|
9808
|
+
#
|
9809
|
+
# {
|
9810
|
+
# default_field_values: [
|
9811
|
+
# {
|
9812
|
+
# id: {
|
9813
|
+
# name: "TaskTemplateFieldName",
|
9814
|
+
# },
|
9815
|
+
# default_value: "TaskTemplateFieldValue",
|
9816
|
+
# },
|
9817
|
+
# ],
|
9818
|
+
# }
|
9819
|
+
#
|
9820
|
+
# @!attribute [rw] default_field_values
|
9821
|
+
# Default value for the field.
|
9822
|
+
# @return [Array<Types::TaskTemplateDefaultFieldValue>]
|
9823
|
+
#
|
9824
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TaskTemplateDefaults AWS API Documentation
|
9825
|
+
#
|
9826
|
+
class TaskTemplateDefaults < Struct.new(
|
9827
|
+
:default_field_values)
|
9828
|
+
SENSITIVE = []
|
9829
|
+
include Aws::Structure
|
9830
|
+
end
|
9831
|
+
|
9832
|
+
# Describes a single task template field.
|
9833
|
+
#
|
9834
|
+
# @note When making an API call, you may pass TaskTemplateField
|
9835
|
+
# data as a hash:
|
9836
|
+
#
|
9837
|
+
# {
|
9838
|
+
# id: { # required
|
9839
|
+
# name: "TaskTemplateFieldName",
|
9840
|
+
# },
|
9841
|
+
# description: "TaskTemplateFieldDescription",
|
9842
|
+
# type: "NAME", # accepts NAME, DESCRIPTION, SCHEDULED_TIME, QUICK_CONNECT, URL, NUMBER, TEXT, TEXT_AREA, DATE_TIME, BOOLEAN, SINGLE_SELECT, EMAIL
|
9843
|
+
# single_select_options: ["TaskTemplateSingleSelectOption"],
|
9844
|
+
# }
|
9845
|
+
#
|
9846
|
+
# @!attribute [rw] id
|
9847
|
+
# The unique identifier for the field.
|
9848
|
+
# @return [Types::TaskTemplateFieldIdentifier]
|
9849
|
+
#
|
9850
|
+
# @!attribute [rw] description
|
9851
|
+
# The description of the field.
|
9852
|
+
# @return [String]
|
9853
|
+
#
|
9854
|
+
# @!attribute [rw] type
|
9855
|
+
# Indicates the type of field.
|
9856
|
+
# @return [String]
|
9857
|
+
#
|
9858
|
+
# @!attribute [rw] single_select_options
|
9859
|
+
# A list of options for a single select field.
|
9860
|
+
# @return [Array<String>]
|
9861
|
+
#
|
9862
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TaskTemplateField AWS API Documentation
|
9863
|
+
#
|
9864
|
+
class TaskTemplateField < Struct.new(
|
9865
|
+
:id,
|
9866
|
+
:description,
|
9867
|
+
:type,
|
9868
|
+
:single_select_options)
|
9869
|
+
SENSITIVE = []
|
9870
|
+
include Aws::Structure
|
9871
|
+
end
|
9872
|
+
|
9873
|
+
# The identifier of the task template field.
|
9874
|
+
#
|
9875
|
+
# @note When making an API call, you may pass TaskTemplateFieldIdentifier
|
9876
|
+
# data as a hash:
|
9877
|
+
#
|
9878
|
+
# {
|
9879
|
+
# name: "TaskTemplateFieldName",
|
9880
|
+
# }
|
9881
|
+
#
|
9882
|
+
# @!attribute [rw] name
|
9883
|
+
# The name of the task template field.
|
9884
|
+
# @return [String]
|
9885
|
+
#
|
9886
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TaskTemplateFieldIdentifier AWS API Documentation
|
9887
|
+
#
|
9888
|
+
class TaskTemplateFieldIdentifier < Struct.new(
|
9889
|
+
:name)
|
9890
|
+
SENSITIVE = []
|
9891
|
+
include Aws::Structure
|
9892
|
+
end
|
9893
|
+
|
9894
|
+
# Contains summary information about the task template.
|
9895
|
+
#
|
9896
|
+
# @!attribute [rw] id
|
9897
|
+
# A unique identifier for the task template.
|
9898
|
+
# @return [String]
|
9899
|
+
#
|
9900
|
+
# @!attribute [rw] arn
|
9901
|
+
# The Amazon Resource Name (ARN) of the task template.
|
9902
|
+
# @return [String]
|
9903
|
+
#
|
9904
|
+
# @!attribute [rw] name
|
9905
|
+
# The name of the task template.
|
9906
|
+
# @return [String]
|
9907
|
+
#
|
9908
|
+
# @!attribute [rw] description
|
9909
|
+
# The description of the task template.
|
9910
|
+
# @return [String]
|
9911
|
+
#
|
9912
|
+
# @!attribute [rw] status
|
9913
|
+
# Marks a template as `ACTIVE` or `INACTIVE` for a task to refer to
|
9914
|
+
# it. Tasks can only be created from `ACTIVE` templates. If a template
|
9915
|
+
# is marked as `INACTIVE`, then a task that refers to this template
|
9916
|
+
# cannot be created.
|
9917
|
+
# @return [String]
|
9918
|
+
#
|
9919
|
+
# @!attribute [rw] last_modified_time
|
9920
|
+
# The timestamp when the task template was last modified.
|
9921
|
+
# @return [Time]
|
9922
|
+
#
|
9923
|
+
# @!attribute [rw] created_time
|
9924
|
+
# The timestamp when the task template was created.
|
9925
|
+
# @return [Time]
|
9926
|
+
#
|
9927
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TaskTemplateMetadata AWS API Documentation
|
9928
|
+
#
|
9929
|
+
class TaskTemplateMetadata < Struct.new(
|
9930
|
+
:id,
|
9931
|
+
:arn,
|
9932
|
+
:name,
|
9933
|
+
:description,
|
9934
|
+
:status,
|
9935
|
+
:last_modified_time,
|
9936
|
+
:created_time)
|
9937
|
+
SENSITIVE = []
|
9938
|
+
include Aws::Structure
|
9939
|
+
end
|
9940
|
+
|
8870
9941
|
# Contains information about the threshold for service level metrics.
|
8871
9942
|
#
|
8872
9943
|
# @note When making an API call, you may pass Threshold
|
@@ -8908,6 +9979,77 @@ module Aws::Connect
|
|
8908
9979
|
include Aws::Structure
|
8909
9980
|
end
|
8910
9981
|
|
9982
|
+
# @note When making an API call, you may pass TransferContactRequest
|
9983
|
+
# data as a hash:
|
9984
|
+
#
|
9985
|
+
# {
|
9986
|
+
# instance_id: "InstanceId", # required
|
9987
|
+
# contact_id: "ContactId", # required
|
9988
|
+
# queue_id: "QueueId",
|
9989
|
+
# user_id: "AgentResourceId",
|
9990
|
+
# contact_flow_id: "ContactFlowId", # required
|
9991
|
+
# client_token: "ClientToken",
|
9992
|
+
# }
|
9993
|
+
#
|
9994
|
+
# @!attribute [rw] instance_id
|
9995
|
+
# The identifier of the Amazon Connect instance. You can find the
|
9996
|
+
# instanceId in the ARN of the instance.
|
9997
|
+
# @return [String]
|
9998
|
+
#
|
9999
|
+
# @!attribute [rw] contact_id
|
10000
|
+
# The identifier of the contact in this instance of Amazon Connect.
|
10001
|
+
# @return [String]
|
10002
|
+
#
|
10003
|
+
# @!attribute [rw] queue_id
|
10004
|
+
# The identifier for the queue.
|
10005
|
+
# @return [String]
|
10006
|
+
#
|
10007
|
+
# @!attribute [rw] user_id
|
10008
|
+
# The identifier for the user.
|
10009
|
+
# @return [String]
|
10010
|
+
#
|
10011
|
+
# @!attribute [rw] contact_flow_id
|
10012
|
+
# The identifier of the contact flow.
|
10013
|
+
# @return [String]
|
10014
|
+
#
|
10015
|
+
# @!attribute [rw] client_token
|
10016
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
10017
|
+
# idempotency of the request.
|
10018
|
+
#
|
10019
|
+
# **A suitable default value is auto-generated.** You should normally
|
10020
|
+
# not need to pass this option.
|
10021
|
+
# @return [String]
|
10022
|
+
#
|
10023
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TransferContactRequest AWS API Documentation
|
10024
|
+
#
|
10025
|
+
class TransferContactRequest < Struct.new(
|
10026
|
+
:instance_id,
|
10027
|
+
:contact_id,
|
10028
|
+
:queue_id,
|
10029
|
+
:user_id,
|
10030
|
+
:contact_flow_id,
|
10031
|
+
:client_token)
|
10032
|
+
SENSITIVE = []
|
10033
|
+
include Aws::Structure
|
10034
|
+
end
|
10035
|
+
|
10036
|
+
# @!attribute [rw] contact_id
|
10037
|
+
# The identifier of the contact in this instance of Amazon Connect.
|
10038
|
+
# @return [String]
|
10039
|
+
#
|
10040
|
+
# @!attribute [rw] contact_arn
|
10041
|
+
# The Amazon Resource Name (ARN) of the contact.
|
10042
|
+
# @return [String]
|
10043
|
+
#
|
10044
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TransferContactResponse AWS API Documentation
|
10045
|
+
#
|
10046
|
+
class TransferContactResponse < Struct.new(
|
10047
|
+
:contact_id,
|
10048
|
+
:contact_arn)
|
10049
|
+
SENSITIVE = []
|
10050
|
+
include Aws::Structure
|
10051
|
+
end
|
10052
|
+
|
8911
10053
|
# @note When making an API call, you may pass UntagResourceRequest
|
8912
10054
|
# data as a hash:
|
8913
10055
|
#
|
@@ -9246,7 +10388,7 @@ module Aws::Connect
|
|
9246
10388
|
# references: {
|
9247
10389
|
# "ReferenceKey" => {
|
9248
10390
|
# value: "ReferenceValue", # required
|
9249
|
-
# type: "URL", # required, accepts URL, ATTACHMENT
|
10391
|
+
# type: "URL", # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
|
9250
10392
|
# },
|
9251
10393
|
# },
|
9252
10394
|
# }
|
@@ -9270,7 +10412,7 @@ module Aws::Connect
|
|
9270
10412
|
# @return [String]
|
9271
10413
|
#
|
9272
10414
|
# @!attribute [rw] references
|
9273
|
-
#
|
10415
|
+
# Well-formed data on contact, shown to agents on Contact Control
|
9274
10416
|
# Panel (CCP).
|
9275
10417
|
# @return [Hash<String,Types::Reference>]
|
9276
10418
|
#
|
@@ -9990,6 +11132,192 @@ module Aws::Connect
|
|
9990
11132
|
include Aws::Structure
|
9991
11133
|
end
|
9992
11134
|
|
11135
|
+
# @note When making an API call, you may pass UpdateTaskTemplateRequest
|
11136
|
+
# data as a hash:
|
11137
|
+
#
|
11138
|
+
# {
|
11139
|
+
# task_template_id: "TaskTemplateId", # required
|
11140
|
+
# instance_id: "InstanceId", # required
|
11141
|
+
# name: "TaskTemplateName",
|
11142
|
+
# description: "TaskTemplateDescription",
|
11143
|
+
# contact_flow_id: "ContactFlowId",
|
11144
|
+
# constraints: {
|
11145
|
+
# required_fields: [
|
11146
|
+
# {
|
11147
|
+
# id: {
|
11148
|
+
# name: "TaskTemplateFieldName",
|
11149
|
+
# },
|
11150
|
+
# },
|
11151
|
+
# ],
|
11152
|
+
# read_only_fields: [
|
11153
|
+
# {
|
11154
|
+
# id: {
|
11155
|
+
# name: "TaskTemplateFieldName",
|
11156
|
+
# },
|
11157
|
+
# },
|
11158
|
+
# ],
|
11159
|
+
# invisible_fields: [
|
11160
|
+
# {
|
11161
|
+
# id: {
|
11162
|
+
# name: "TaskTemplateFieldName",
|
11163
|
+
# },
|
11164
|
+
# },
|
11165
|
+
# ],
|
11166
|
+
# },
|
11167
|
+
# defaults: {
|
11168
|
+
# default_field_values: [
|
11169
|
+
# {
|
11170
|
+
# id: {
|
11171
|
+
# name: "TaskTemplateFieldName",
|
11172
|
+
# },
|
11173
|
+
# default_value: "TaskTemplateFieldValue",
|
11174
|
+
# },
|
11175
|
+
# ],
|
11176
|
+
# },
|
11177
|
+
# status: "ACTIVE", # accepts ACTIVE, INACTIVE
|
11178
|
+
# fields: [
|
11179
|
+
# {
|
11180
|
+
# id: { # required
|
11181
|
+
# name: "TaskTemplateFieldName",
|
11182
|
+
# },
|
11183
|
+
# description: "TaskTemplateFieldDescription",
|
11184
|
+
# type: "NAME", # accepts NAME, DESCRIPTION, SCHEDULED_TIME, QUICK_CONNECT, URL, NUMBER, TEXT, TEXT_AREA, DATE_TIME, BOOLEAN, SINGLE_SELECT, EMAIL
|
11185
|
+
# single_select_options: ["TaskTemplateSingleSelectOption"],
|
11186
|
+
# },
|
11187
|
+
# ],
|
11188
|
+
# }
|
11189
|
+
#
|
11190
|
+
# @!attribute [rw] task_template_id
|
11191
|
+
# A unique identifier for the task template.
|
11192
|
+
# @return [String]
|
11193
|
+
#
|
11194
|
+
# @!attribute [rw] instance_id
|
11195
|
+
# The identifier of the Amazon Connect instance. You can find the
|
11196
|
+
# instanceId in the ARN of the instance.
|
11197
|
+
# @return [String]
|
11198
|
+
#
|
11199
|
+
# @!attribute [rw] name
|
11200
|
+
# The name of the task template.
|
11201
|
+
# @return [String]
|
11202
|
+
#
|
11203
|
+
# @!attribute [rw] description
|
11204
|
+
# The description of the task template.
|
11205
|
+
# @return [String]
|
11206
|
+
#
|
11207
|
+
# @!attribute [rw] contact_flow_id
|
11208
|
+
# The identifier of the flow that runs by default when a task is
|
11209
|
+
# created by referencing this template.
|
11210
|
+
# @return [String]
|
11211
|
+
#
|
11212
|
+
# @!attribute [rw] constraints
|
11213
|
+
# Constraints that are applicable to the fields listed.
|
11214
|
+
# @return [Types::TaskTemplateConstraints]
|
11215
|
+
#
|
11216
|
+
# @!attribute [rw] defaults
|
11217
|
+
# The default values for fields when a task is created by referencing
|
11218
|
+
# this template.
|
11219
|
+
# @return [Types::TaskTemplateDefaults]
|
11220
|
+
#
|
11221
|
+
# @!attribute [rw] status
|
11222
|
+
# Marks a template as `ACTIVE` or `INACTIVE` for a task to refer to
|
11223
|
+
# it. Tasks can only be created from `ACTIVE` templates. If a template
|
11224
|
+
# is marked as `INACTIVE`, then a task that refers to this template
|
11225
|
+
# cannot be created.
|
11226
|
+
# @return [String]
|
11227
|
+
#
|
11228
|
+
# @!attribute [rw] fields
|
11229
|
+
# Fields that are part of the template.
|
11230
|
+
# @return [Array<Types::TaskTemplateField>]
|
11231
|
+
#
|
11232
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateTaskTemplateRequest AWS API Documentation
|
11233
|
+
#
|
11234
|
+
class UpdateTaskTemplateRequest < Struct.new(
|
11235
|
+
:task_template_id,
|
11236
|
+
:instance_id,
|
11237
|
+
:name,
|
11238
|
+
:description,
|
11239
|
+
:contact_flow_id,
|
11240
|
+
:constraints,
|
11241
|
+
:defaults,
|
11242
|
+
:status,
|
11243
|
+
:fields)
|
11244
|
+
SENSITIVE = []
|
11245
|
+
include Aws::Structure
|
11246
|
+
end
|
11247
|
+
|
11248
|
+
# @!attribute [rw] instance_id
|
11249
|
+
# The identifier of the Amazon Connect instance. You can find the
|
11250
|
+
# instanceId in the ARN of the instance.
|
11251
|
+
# @return [String]
|
11252
|
+
#
|
11253
|
+
# @!attribute [rw] id
|
11254
|
+
# The identifier of the task template resource.
|
11255
|
+
# @return [String]
|
11256
|
+
#
|
11257
|
+
# @!attribute [rw] arn
|
11258
|
+
# The Amazon Resource Name (ARN) for the task template resource.
|
11259
|
+
# @return [String]
|
11260
|
+
#
|
11261
|
+
# @!attribute [rw] name
|
11262
|
+
# The name of the task template.
|
11263
|
+
# @return [String]
|
11264
|
+
#
|
11265
|
+
# @!attribute [rw] description
|
11266
|
+
# The description of the task template.
|
11267
|
+
# @return [String]
|
11268
|
+
#
|
11269
|
+
# @!attribute [rw] contact_flow_id
|
11270
|
+
# The identifier of the flow that runs by default when a task is
|
11271
|
+
# created by referencing this template.
|
11272
|
+
# @return [String]
|
11273
|
+
#
|
11274
|
+
# @!attribute [rw] constraints
|
11275
|
+
# Constraints that are applicable to the fields listed.
|
11276
|
+
# @return [Types::TaskTemplateConstraints]
|
11277
|
+
#
|
11278
|
+
# @!attribute [rw] defaults
|
11279
|
+
# The default values for fields when a task is created by referencing
|
11280
|
+
# this template.
|
11281
|
+
# @return [Types::TaskTemplateDefaults]
|
11282
|
+
#
|
11283
|
+
# @!attribute [rw] fields
|
11284
|
+
# Fields that are part of the template.
|
11285
|
+
# @return [Array<Types::TaskTemplateField>]
|
11286
|
+
#
|
11287
|
+
# @!attribute [rw] status
|
11288
|
+
# Marks a template as `ACTIVE` or `INACTIVE` for a task to refer to
|
11289
|
+
# it. Tasks can only be created from `ACTIVE` templates. If a template
|
11290
|
+
# is marked as `INACTIVE`, then a task that refers to this template
|
11291
|
+
# cannot be created.
|
11292
|
+
# @return [String]
|
11293
|
+
#
|
11294
|
+
# @!attribute [rw] last_modified_time
|
11295
|
+
# The timestamp when the task template was last modified.
|
11296
|
+
# @return [Time]
|
11297
|
+
#
|
11298
|
+
# @!attribute [rw] created_time
|
11299
|
+
# The timestamp when the task template was created.
|
11300
|
+
# @return [Time]
|
11301
|
+
#
|
11302
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateTaskTemplateResponse AWS API Documentation
|
11303
|
+
#
|
11304
|
+
class UpdateTaskTemplateResponse < Struct.new(
|
11305
|
+
:instance_id,
|
11306
|
+
:id,
|
11307
|
+
:arn,
|
11308
|
+
:name,
|
11309
|
+
:description,
|
11310
|
+
:contact_flow_id,
|
11311
|
+
:constraints,
|
11312
|
+
:defaults,
|
11313
|
+
:fields,
|
11314
|
+
:status,
|
11315
|
+
:last_modified_time,
|
11316
|
+
:created_time)
|
11317
|
+
SENSITIVE = []
|
11318
|
+
include Aws::Structure
|
11319
|
+
end
|
11320
|
+
|
9993
11321
|
# @note When making an API call, you may pass UpdateUserHierarchyGroupNameRequest
|
9994
11322
|
# data as a hash:
|
9995
11323
|
#
|
@@ -10340,6 +11668,99 @@ module Aws::Connect
|
|
10340
11668
|
include Aws::Structure
|
10341
11669
|
end
|
10342
11670
|
|
11671
|
+
# Data for a user.
|
11672
|
+
#
|
11673
|
+
# @!attribute [rw] user
|
11674
|
+
# Information about the user for the data that is returned. It
|
11675
|
+
# contains resourceId and ARN of the user.
|
11676
|
+
# @return [Types::UserReference]
|
11677
|
+
#
|
11678
|
+
# @!attribute [rw] routing_profile
|
11679
|
+
# Information about the routing profile that is assigned to the user.
|
11680
|
+
# @return [Types::RoutingProfileReference]
|
11681
|
+
#
|
11682
|
+
# @!attribute [rw] hierarchy_path
|
11683
|
+
# Contains information about the levels of a hierarchy group assigned
|
11684
|
+
# to a user.
|
11685
|
+
# @return [Types::HierarchyPathReference]
|
11686
|
+
#
|
11687
|
+
# @!attribute [rw] status
|
11688
|
+
# The status of the agent that they manually set in their Contact
|
11689
|
+
# Control Panel (CCP), or that the supervisor manually changes in the
|
11690
|
+
# real-time metrics report.
|
11691
|
+
# @return [Types::AgentStatusReference]
|
11692
|
+
#
|
11693
|
+
# @!attribute [rw] available_slots_by_channel
|
11694
|
+
# A map of available slots by channel. The key is a channel name. The
|
11695
|
+
# value is an integer: the available number of slots.
|
11696
|
+
# @return [Hash<String,Integer>]
|
11697
|
+
#
|
11698
|
+
# @!attribute [rw] max_slots_by_channel
|
11699
|
+
# A map of maximum slots by channel. The key is a channel name. The
|
11700
|
+
# value is an integer: the maximum number of slots. This is calculated
|
11701
|
+
# from [MediaConcurrency][1] of the RoutingProfile assigned to the
|
11702
|
+
# agent.
|
11703
|
+
#
|
11704
|
+
#
|
11705
|
+
#
|
11706
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_MediaConcurrency.html
|
11707
|
+
# @return [Hash<String,Integer>]
|
11708
|
+
#
|
11709
|
+
# @!attribute [rw] active_slots_by_channel
|
11710
|
+
# A map of active slots by channel. The key is a channel name. The
|
11711
|
+
# value is an integer: the number of active slots.
|
11712
|
+
# @return [Hash<String,Integer>]
|
11713
|
+
#
|
11714
|
+
# @!attribute [rw] contacts
|
11715
|
+
# A list of contact reference information.
|
11716
|
+
# @return [Array<Types::AgentContactReference>]
|
11717
|
+
#
|
11718
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UserData AWS API Documentation
|
11719
|
+
#
|
11720
|
+
class UserData < Struct.new(
|
11721
|
+
:user,
|
11722
|
+
:routing_profile,
|
11723
|
+
:hierarchy_path,
|
11724
|
+
:status,
|
11725
|
+
:available_slots_by_channel,
|
11726
|
+
:max_slots_by_channel,
|
11727
|
+
:active_slots_by_channel,
|
11728
|
+
:contacts)
|
11729
|
+
SENSITIVE = []
|
11730
|
+
include Aws::Structure
|
11731
|
+
end
|
11732
|
+
|
11733
|
+
# A filter for the user data.
|
11734
|
+
#
|
11735
|
+
# @note When making an API call, you may pass UserDataFilters
|
11736
|
+
# data as a hash:
|
11737
|
+
#
|
11738
|
+
# {
|
11739
|
+
# queues: ["QueueId"],
|
11740
|
+
# contact_filter: {
|
11741
|
+
# contact_states: ["INCOMING"], # accepts INCOMING, PENDING, CONNECTING, CONNECTED, CONNECTED_ONHOLD, MISSED, ERROR, ENDED, REJECTED
|
11742
|
+
# },
|
11743
|
+
# }
|
11744
|
+
#
|
11745
|
+
# @!attribute [rw] queues
|
11746
|
+
# Contains information about a queue resource for which metrics are
|
11747
|
+
# returned.
|
11748
|
+
# @return [Array<String>]
|
11749
|
+
#
|
11750
|
+
# @!attribute [rw] contact_filter
|
11751
|
+
# A filter for the user data based on the contact information that is
|
11752
|
+
# associated to the user. It contains a list of contact states.
|
11753
|
+
# @return [Types::ContactFilter]
|
11754
|
+
#
|
11755
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UserDataFilters AWS API Documentation
|
11756
|
+
#
|
11757
|
+
class UserDataFilters < Struct.new(
|
11758
|
+
:queues,
|
11759
|
+
:contact_filter)
|
11760
|
+
SENSITIVE = []
|
11761
|
+
include Aws::Structure
|
11762
|
+
end
|
11763
|
+
|
10343
11764
|
# Contains information about the identity of a user.
|
10344
11765
|
#
|
10345
11766
|
# @note When making an API call, you may pass UserIdentityInfo
|
@@ -10477,6 +11898,25 @@ module Aws::Connect
|
|
10477
11898
|
include Aws::Structure
|
10478
11899
|
end
|
10479
11900
|
|
11901
|
+
# Information about the user.
|
11902
|
+
#
|
11903
|
+
# @!attribute [rw] id
|
11904
|
+
# The unique identifier for the user.
|
11905
|
+
# @return [String]
|
11906
|
+
#
|
11907
|
+
# @!attribute [rw] arn
|
11908
|
+
# The Amazon Resource Name (ARN) for the user.
|
11909
|
+
# @return [String]
|
11910
|
+
#
|
11911
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UserReference AWS API Documentation
|
11912
|
+
#
|
11913
|
+
class UserReference < Struct.new(
|
11914
|
+
:id,
|
11915
|
+
:arn)
|
11916
|
+
SENSITIVE = []
|
11917
|
+
include Aws::Structure
|
11918
|
+
end
|
11919
|
+
|
10480
11920
|
# The search criteria to be used to return users.
|
10481
11921
|
#
|
10482
11922
|
# @note When making an API call, you may pass UserSearchCriteria
|