aws-sdk-connect 1.72.0 → 1.75.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 +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +380 -155
- data/lib/aws-sdk-connect/client_api.rb +162 -0
- data/lib/aws-sdk-connect/types.rb +819 -155
- 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
|
@@ -74,7 +127,8 @@ module Aws::Connect
|
|
74
127
|
#
|
75
128
|
# @!attribute [rw] tags
|
76
129
|
# The tags used to organize, track, or control access for this
|
77
|
-
# resource.
|
130
|
+
# resource. For example, \\\{ "tags": \\\{"key1":"value1",
|
131
|
+
# "key2":"value2"\\} \\}.
|
78
132
|
# @return [Hash<String,String>]
|
79
133
|
#
|
80
134
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AgentStatus AWS API Documentation
|
@@ -92,6 +146,25 @@ module Aws::Connect
|
|
92
146
|
include Aws::Structure
|
93
147
|
end
|
94
148
|
|
149
|
+
# Information about the agent's status.
|
150
|
+
#
|
151
|
+
# @!attribute [rw] status_start_timestamp
|
152
|
+
# The start timestamp of the agent's status.
|
153
|
+
# @return [Time]
|
154
|
+
#
|
155
|
+
# @!attribute [rw] status_arn
|
156
|
+
# The Amazon Resource Name (ARN) of the agent's status.
|
157
|
+
# @return [String]
|
158
|
+
#
|
159
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AgentStatusReference AWS API Documentation
|
160
|
+
#
|
161
|
+
class AgentStatusReference < Struct.new(
|
162
|
+
:status_start_timestamp,
|
163
|
+
:status_arn)
|
164
|
+
SENSITIVE = []
|
165
|
+
include Aws::Structure
|
166
|
+
end
|
167
|
+
|
95
168
|
# Summary information for an agent status.
|
96
169
|
#
|
97
170
|
# @!attribute [rw] id
|
@@ -401,7 +474,7 @@ module Aws::Connect
|
|
401
474
|
# @return [String]
|
402
475
|
#
|
403
476
|
# @!attribute [rw] contact_flow_id
|
404
|
-
# The identifier of the
|
477
|
+
# The identifier of the flow.
|
405
478
|
# @return [String]
|
406
479
|
#
|
407
480
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociatePhoneNumberContactFlowRequest AWS API Documentation
|
@@ -675,7 +748,8 @@ module Aws::Connect
|
|
675
748
|
#
|
676
749
|
# @!attribute [rw] tags
|
677
750
|
# The tags used to organize, track, or control access for this
|
678
|
-
# resource.
|
751
|
+
# resource. For example, \\\{ "tags": \\\{"key1":"value1",
|
752
|
+
# "key2":"value2"\\} \\}.
|
679
753
|
# @return [Hash<String,String>]
|
680
754
|
#
|
681
755
|
# @!attribute [rw] client_token
|
@@ -750,7 +824,8 @@ module Aws::Connect
|
|
750
824
|
#
|
751
825
|
# @!attribute [rw] tags
|
752
826
|
# The tags used to organize, track, or control access for this
|
753
|
-
# resource.
|
827
|
+
# resource. For example, \\\{ "tags": \\\{"key1":"value1",
|
828
|
+
# "key2":"value2"\\} \\}.
|
754
829
|
# @return [Hash<String,String>]
|
755
830
|
#
|
756
831
|
# @!attribute [rw] phone_number_status
|
@@ -862,24 +937,53 @@ module Aws::Connect
|
|
862
937
|
include Aws::Structure
|
863
938
|
end
|
864
939
|
|
865
|
-
#
|
940
|
+
# Filters user data based on the contact information that is associated
|
941
|
+
# to the users. It contains a list of [contact states][1].
|
942
|
+
#
|
943
|
+
#
|
944
|
+
#
|
945
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html
|
946
|
+
#
|
947
|
+
# @note When making an API call, you may pass ContactFilter
|
948
|
+
# data as a hash:
|
949
|
+
#
|
950
|
+
# {
|
951
|
+
# contact_states: ["INCOMING"], # accepts INCOMING, PENDING, CONNECTING, CONNECTED, CONNECTED_ONHOLD, MISSED, ERROR, ENDED, REJECTED
|
952
|
+
# }
|
953
|
+
#
|
954
|
+
# @!attribute [rw] contact_states
|
955
|
+
# A list of up to 9 [contact states][1].
|
956
|
+
#
|
957
|
+
#
|
958
|
+
#
|
959
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html
|
960
|
+
# @return [Array<String>]
|
961
|
+
#
|
962
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactFilter AWS API Documentation
|
963
|
+
#
|
964
|
+
class ContactFilter < Struct.new(
|
965
|
+
:contact_states)
|
966
|
+
SENSITIVE = []
|
967
|
+
include Aws::Structure
|
968
|
+
end
|
969
|
+
|
970
|
+
# Contains information about a flow.
|
866
971
|
#
|
867
972
|
# @!attribute [rw] arn
|
868
|
-
# The Amazon Resource Name (ARN) of the
|
973
|
+
# The Amazon Resource Name (ARN) of the flow.
|
869
974
|
# @return [String]
|
870
975
|
#
|
871
976
|
# @!attribute [rw] id
|
872
|
-
# The identifier of the
|
977
|
+
# The identifier of the flow.
|
873
978
|
# @return [String]
|
874
979
|
#
|
875
980
|
# @!attribute [rw] name
|
876
|
-
# The name of the
|
981
|
+
# The name of the flow.
|
877
982
|
# @return [String]
|
878
983
|
#
|
879
984
|
# @!attribute [rw] type
|
880
|
-
# The type of the
|
881
|
-
#
|
882
|
-
# Administrator Guide*.
|
985
|
+
# The type of the flow. For descriptions of the available types, see
|
986
|
+
# [Choose a flow type][1] in the *Amazon Connect Administrator Guide*.
|
883
987
|
#
|
884
988
|
#
|
885
989
|
#
|
@@ -887,19 +991,21 @@ module Aws::Connect
|
|
887
991
|
# @return [String]
|
888
992
|
#
|
889
993
|
# @!attribute [rw] state
|
890
|
-
# The type of
|
994
|
+
# The type of flow.
|
891
995
|
# @return [String]
|
892
996
|
#
|
893
997
|
# @!attribute [rw] description
|
894
|
-
# The description of the
|
998
|
+
# The description of the flow.
|
895
999
|
# @return [String]
|
896
1000
|
#
|
897
1001
|
# @!attribute [rw] content
|
898
|
-
# The content of the
|
1002
|
+
# The content of the flow.
|
899
1003
|
# @return [String]
|
900
1004
|
#
|
901
1005
|
# @!attribute [rw] tags
|
902
|
-
#
|
1006
|
+
# The tags used to organize, track, or control access for this
|
1007
|
+
# resource. For example, \\\{ "tags": \\\{"key1":"value1",
|
1008
|
+
# "key2":"value2"\\} \\}.
|
903
1009
|
# @return [Hash<String,String>]
|
904
1010
|
#
|
905
1011
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactFlow AWS API Documentation
|
@@ -917,39 +1023,40 @@ module Aws::Connect
|
|
917
1023
|
include Aws::Structure
|
918
1024
|
end
|
919
1025
|
|
920
|
-
# Contains information about a
|
1026
|
+
# Contains information about a flow module.
|
921
1027
|
#
|
922
1028
|
# @!attribute [rw] arn
|
923
1029
|
# The Amazon Resource Name (ARN).
|
924
1030
|
# @return [String]
|
925
1031
|
#
|
926
1032
|
# @!attribute [rw] id
|
927
|
-
# The identifier of the
|
1033
|
+
# The identifier of the flow module.
|
928
1034
|
# @return [String]
|
929
1035
|
#
|
930
1036
|
# @!attribute [rw] name
|
931
|
-
# The name of the
|
1037
|
+
# The name of the flow module.
|
932
1038
|
# @return [String]
|
933
1039
|
#
|
934
1040
|
# @!attribute [rw] content
|
935
|
-
# The content of the
|
1041
|
+
# The content of the flow module.
|
936
1042
|
# @return [String]
|
937
1043
|
#
|
938
1044
|
# @!attribute [rw] description
|
939
|
-
# The description of the
|
1045
|
+
# The description of the flow module.
|
940
1046
|
# @return [String]
|
941
1047
|
#
|
942
1048
|
# @!attribute [rw] state
|
943
|
-
# The type of
|
1049
|
+
# The type of flow module.
|
944
1050
|
# @return [String]
|
945
1051
|
#
|
946
1052
|
# @!attribute [rw] status
|
947
|
-
# The status of the
|
1053
|
+
# The status of the flow module.
|
948
1054
|
# @return [String]
|
949
1055
|
#
|
950
1056
|
# @!attribute [rw] tags
|
951
1057
|
# The tags used to organize, track, or control access for this
|
952
|
-
# resource.
|
1058
|
+
# resource. For example, \\\{ "tags": \\\{"key1":"value1",
|
1059
|
+
# "key2":"value2"\\} \\}.
|
953
1060
|
# @return [Hash<String,String>]
|
954
1061
|
#
|
955
1062
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactFlowModule AWS API Documentation
|
@@ -967,22 +1074,22 @@ module Aws::Connect
|
|
967
1074
|
include Aws::Structure
|
968
1075
|
end
|
969
1076
|
|
970
|
-
# Contains summary information about a
|
1077
|
+
# Contains summary information about a flow.
|
971
1078
|
#
|
972
1079
|
# @!attribute [rw] id
|
973
|
-
# The identifier of the
|
1080
|
+
# The identifier of the flow module.
|
974
1081
|
# @return [String]
|
975
1082
|
#
|
976
1083
|
# @!attribute [rw] arn
|
977
|
-
# The Amazon Resource Name (ARN) of the
|
1084
|
+
# The Amazon Resource Name (ARN) of the flow module.
|
978
1085
|
# @return [String]
|
979
1086
|
#
|
980
1087
|
# @!attribute [rw] name
|
981
|
-
# The name of the
|
1088
|
+
# The name of the flow module.
|
982
1089
|
# @return [String]
|
983
1090
|
#
|
984
1091
|
# @!attribute [rw] state
|
985
|
-
# The type of
|
1092
|
+
# The type of flow module.
|
986
1093
|
# @return [String]
|
987
1094
|
#
|
988
1095
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactFlowModuleSummary AWS API Documentation
|
@@ -996,7 +1103,7 @@ module Aws::Connect
|
|
996
1103
|
include Aws::Structure
|
997
1104
|
end
|
998
1105
|
|
999
|
-
# The
|
1106
|
+
# The flow has not been published.
|
1000
1107
|
#
|
1001
1108
|
# @!attribute [rw] message
|
1002
1109
|
# @return [String]
|
@@ -1009,33 +1116,33 @@ module Aws::Connect
|
|
1009
1116
|
include Aws::Structure
|
1010
1117
|
end
|
1011
1118
|
|
1012
|
-
# Contains summary information about a
|
1119
|
+
# Contains summary information about a flow.
|
1013
1120
|
#
|
1014
|
-
# You can also create and update
|
1015
|
-
#
|
1121
|
+
# You can also create and update flows using the [Amazon Connect Flow
|
1122
|
+
# language][1].
|
1016
1123
|
#
|
1017
1124
|
#
|
1018
1125
|
#
|
1019
1126
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/flow-language.html
|
1020
1127
|
#
|
1021
1128
|
# @!attribute [rw] id
|
1022
|
-
# The identifier of the
|
1129
|
+
# The identifier of the flow.
|
1023
1130
|
# @return [String]
|
1024
1131
|
#
|
1025
1132
|
# @!attribute [rw] arn
|
1026
|
-
# The Amazon Resource Name (ARN) of the
|
1133
|
+
# The Amazon Resource Name (ARN) of the flow.
|
1027
1134
|
# @return [String]
|
1028
1135
|
#
|
1029
1136
|
# @!attribute [rw] name
|
1030
|
-
# The name of the
|
1137
|
+
# The name of the flow.
|
1031
1138
|
# @return [String]
|
1032
1139
|
#
|
1033
1140
|
# @!attribute [rw] contact_flow_type
|
1034
|
-
# The type of
|
1141
|
+
# The type of flow.
|
1035
1142
|
# @return [String]
|
1036
1143
|
#
|
1037
1144
|
# @!attribute [rw] contact_flow_state
|
1038
|
-
# The type of
|
1145
|
+
# The type of flow.
|
1039
1146
|
# @return [String]
|
1040
1147
|
#
|
1041
1148
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactFlowSummary AWS API Documentation
|
@@ -1159,7 +1266,8 @@ module Aws::Connect
|
|
1159
1266
|
#
|
1160
1267
|
# @!attribute [rw] tags
|
1161
1268
|
# The tags used to organize, track, or control access for this
|
1162
|
-
# resource.
|
1269
|
+
# resource. For example, \\\{ "tags": \\\{"key1":"value1",
|
1270
|
+
# "key2":"value2"\\} \\}.
|
1163
1271
|
# @return [Hash<String,String>]
|
1164
1272
|
#
|
1165
1273
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateAgentStatusRequest AWS API Documentation
|
@@ -1212,20 +1320,21 @@ module Aws::Connect
|
|
1212
1320
|
# @return [String]
|
1213
1321
|
#
|
1214
1322
|
# @!attribute [rw] name
|
1215
|
-
# The name of the
|
1323
|
+
# The name of the flow module.
|
1216
1324
|
# @return [String]
|
1217
1325
|
#
|
1218
1326
|
# @!attribute [rw] description
|
1219
|
-
# The description of the
|
1327
|
+
# The description of the flow module.
|
1220
1328
|
# @return [String]
|
1221
1329
|
#
|
1222
1330
|
# @!attribute [rw] content
|
1223
|
-
# The content of the
|
1331
|
+
# The content of the flow module.
|
1224
1332
|
# @return [String]
|
1225
1333
|
#
|
1226
1334
|
# @!attribute [rw] tags
|
1227
1335
|
# The tags used to organize, track, or control access for this
|
1228
|
-
# resource.
|
1336
|
+
# resource. For example, \\\{ "tags": \\\{"key1":"value1",
|
1337
|
+
# "key2":"value2"\\} \\}.
|
1229
1338
|
# @return [Hash<String,String>]
|
1230
1339
|
#
|
1231
1340
|
# @!attribute [rw] client_token
|
@@ -1250,11 +1359,11 @@ module Aws::Connect
|
|
1250
1359
|
end
|
1251
1360
|
|
1252
1361
|
# @!attribute [rw] id
|
1253
|
-
# The identifier of the
|
1362
|
+
# The identifier of the flow module.
|
1254
1363
|
# @return [String]
|
1255
1364
|
#
|
1256
1365
|
# @!attribute [rw] arn
|
1257
|
-
# The Amazon Resource Name (ARN) of the
|
1366
|
+
# The Amazon Resource Name (ARN) of the flow module.
|
1258
1367
|
# @return [String]
|
1259
1368
|
#
|
1260
1369
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateContactFlowModuleResponse AWS API Documentation
|
@@ -1285,13 +1394,12 @@ module Aws::Connect
|
|
1285
1394
|
# @return [String]
|
1286
1395
|
#
|
1287
1396
|
# @!attribute [rw] name
|
1288
|
-
# The name of the
|
1397
|
+
# The name of the flow.
|
1289
1398
|
# @return [String]
|
1290
1399
|
#
|
1291
1400
|
# @!attribute [rw] type
|
1292
|
-
# The type of the
|
1293
|
-
#
|
1294
|
-
# Administrator Guide*.
|
1401
|
+
# The type of the flow. For descriptions of the available types, see
|
1402
|
+
# [Choose a flow type][1] in the *Amazon Connect Administrator Guide*.
|
1295
1403
|
#
|
1296
1404
|
#
|
1297
1405
|
#
|
@@ -1299,15 +1407,17 @@ module Aws::Connect
|
|
1299
1407
|
# @return [String]
|
1300
1408
|
#
|
1301
1409
|
# @!attribute [rw] description
|
1302
|
-
# The description of the
|
1410
|
+
# The description of the flow.
|
1303
1411
|
# @return [String]
|
1304
1412
|
#
|
1305
1413
|
# @!attribute [rw] content
|
1306
|
-
# The content of the
|
1414
|
+
# The content of the flow.
|
1307
1415
|
# @return [String]
|
1308
1416
|
#
|
1309
1417
|
# @!attribute [rw] tags
|
1310
|
-
#
|
1418
|
+
# The tags used to organize, track, or control access for this
|
1419
|
+
# resource. For example, \\\{ "tags": \\\{"key1":"value1",
|
1420
|
+
# "key2":"value2"\\} \\}.
|
1311
1421
|
# @return [Hash<String,String>]
|
1312
1422
|
#
|
1313
1423
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateContactFlowRequest AWS API Documentation
|
@@ -1324,11 +1434,11 @@ module Aws::Connect
|
|
1324
1434
|
end
|
1325
1435
|
|
1326
1436
|
# @!attribute [rw] contact_flow_id
|
1327
|
-
# The identifier of the
|
1437
|
+
# The identifier of the flow.
|
1328
1438
|
# @return [String]
|
1329
1439
|
#
|
1330
1440
|
# @!attribute [rw] contact_flow_arn
|
1331
|
-
# The Amazon Resource Name (ARN) of the
|
1441
|
+
# The Amazon Resource Name (ARN) of the flow.
|
1332
1442
|
# @return [String]
|
1333
1443
|
#
|
1334
1444
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateContactFlowResponse AWS API Documentation
|
@@ -1390,7 +1500,8 @@ module Aws::Connect
|
|
1390
1500
|
#
|
1391
1501
|
# @!attribute [rw] tags
|
1392
1502
|
# The tags used to organize, track, or control access for this
|
1393
|
-
# resource.
|
1503
|
+
# resource. For example, \\\{ "tags": \\\{"key1":"value1",
|
1504
|
+
# "key2":"value2"\\} \\}.
|
1394
1505
|
# @return [Hash<String,String>]
|
1395
1506
|
#
|
1396
1507
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateHoursOfOperationRequest AWS API Documentation
|
@@ -1515,6 +1626,11 @@ module Aws::Connect
|
|
1515
1626
|
#
|
1516
1627
|
# @!attribute [rw] integration_arn
|
1517
1628
|
# The Amazon Resource Name (ARN) of the integration.
|
1629
|
+
#
|
1630
|
+
# <note markdown="1"> When integrating with Amazon Pinpoint, the Amazon Connect and Amazon
|
1631
|
+
# Pinpoint instances must be in the same account.
|
1632
|
+
#
|
1633
|
+
# </note>
|
1518
1634
|
# @return [String]
|
1519
1635
|
#
|
1520
1636
|
# @!attribute [rw] source_application_url
|
@@ -1534,7 +1650,8 @@ module Aws::Connect
|
|
1534
1650
|
#
|
1535
1651
|
# @!attribute [rw] tags
|
1536
1652
|
# The tags used to organize, track, or control access for this
|
1537
|
-
# resource.
|
1653
|
+
# resource. For example, \\\{ "tags": \\\{"key1":"value1",
|
1654
|
+
# "key2":"value2"\\} \\}.
|
1538
1655
|
# @return [Hash<String,String>]
|
1539
1656
|
#
|
1540
1657
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateIntegrationAssociationRequest AWS API Documentation
|
@@ -1620,7 +1737,8 @@ module Aws::Connect
|
|
1620
1737
|
#
|
1621
1738
|
# @!attribute [rw] tags
|
1622
1739
|
# The tags used to organize, track, or control access for this
|
1623
|
-
# resource.
|
1740
|
+
# resource. For example, \\\{ "tags": \\\{"key1":"value1",
|
1741
|
+
# "key2":"value2"\\} \\}.
|
1624
1742
|
# @return [Hash<String,String>]
|
1625
1743
|
#
|
1626
1744
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateQueueRequest AWS API Documentation
|
@@ -1700,7 +1818,8 @@ module Aws::Connect
|
|
1700
1818
|
#
|
1701
1819
|
# @!attribute [rw] tags
|
1702
1820
|
# The tags used to organize, track, or control access for this
|
1703
|
-
# resource.
|
1821
|
+
# resource. For example, \\\{ "tags": \\\{"key1":"value1",
|
1822
|
+
# "key2":"value2"\\} \\}.
|
1704
1823
|
# @return [Hash<String,String>]
|
1705
1824
|
#
|
1706
1825
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateQuickConnectRequest AWS API Documentation
|
@@ -1791,7 +1910,9 @@ module Aws::Connect
|
|
1791
1910
|
# @return [Array<Types::MediaConcurrency>]
|
1792
1911
|
#
|
1793
1912
|
# @!attribute [rw] tags
|
1794
|
-
#
|
1913
|
+
# The tags used to organize, track, or control access for this
|
1914
|
+
# resource. For example, \\\{ "tags": \\\{"key1":"value1",
|
1915
|
+
# "key2":"value2"\\} \\}.
|
1795
1916
|
# @return [Hash<String,String>]
|
1796
1917
|
#
|
1797
1918
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateRoutingProfileRequest AWS API Documentation
|
@@ -1857,7 +1978,8 @@ module Aws::Connect
|
|
1857
1978
|
#
|
1858
1979
|
# @!attribute [rw] tags
|
1859
1980
|
# The tags used to organize, track, or control access for this
|
1860
|
-
# resource.
|
1981
|
+
# resource. For example, \\\{ "tags": \\\{"key1":"value1",
|
1982
|
+
# "key2":"value2"\\} \\}.
|
1861
1983
|
# @return [Hash<String,String>]
|
1862
1984
|
#
|
1863
1985
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateSecurityProfileRequest AWS API Documentation
|
@@ -2052,7 +2174,8 @@ module Aws::Connect
|
|
2052
2174
|
#
|
2053
2175
|
# @!attribute [rw] tags
|
2054
2176
|
# The tags used to organize, track, or control access for this
|
2055
|
-
# resource.
|
2177
|
+
# resource. For example, \\\{ "tags": \\\{"key1":"value1",
|
2178
|
+
# "key2":"value2"\\} \\}.
|
2056
2179
|
# @return [Hash<String,String>]
|
2057
2180
|
#
|
2058
2181
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUseCaseRequest AWS API Documentation
|
@@ -2112,7 +2235,8 @@ module Aws::Connect
|
|
2112
2235
|
#
|
2113
2236
|
# @!attribute [rw] tags
|
2114
2237
|
# The tags used to organize, track, or control access for this
|
2115
|
-
# resource.
|
2238
|
+
# resource. For example, \\\{ "tags": \\\{"key1":"value1",
|
2239
|
+
# "key2":"value2"\\} \\}.
|
2116
2240
|
# @return [Hash<String,String>]
|
2117
2241
|
#
|
2118
2242
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUserHierarchyGroupRequest AWS API Documentation
|
@@ -2224,7 +2348,9 @@ module Aws::Connect
|
|
2224
2348
|
# @return [String]
|
2225
2349
|
#
|
2226
2350
|
# @!attribute [rw] tags
|
2227
|
-
#
|
2351
|
+
# The tags used to organize, track, or control access for this
|
2352
|
+
# resource. For example, \\\{ "tags": \\\{"key1":"value1",
|
2353
|
+
# "key2":"value2"\\} \\}.
|
2228
2354
|
# @return [Hash<String,String>]
|
2229
2355
|
#
|
2230
2356
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateUserRequest AWS API Documentation
|
@@ -2319,7 +2445,8 @@ module Aws::Connect
|
|
2319
2445
|
#
|
2320
2446
|
# @!attribute [rw] tags
|
2321
2447
|
# The tags used to organize, track, or control access for this
|
2322
|
-
# resource.
|
2448
|
+
# resource. For example, \\\{ "tags": \\\{"key1":"value1",
|
2449
|
+
# "key2":"value2"\\} \\}.
|
2323
2450
|
# @return [Hash<String,String>]
|
2324
2451
|
#
|
2325
2452
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateVocabularyRequest AWS API Documentation
|
@@ -2530,7 +2657,7 @@ module Aws::Connect
|
|
2530
2657
|
# @return [String]
|
2531
2658
|
#
|
2532
2659
|
# @!attribute [rw] contact_flow_module_id
|
2533
|
-
# The identifier of the
|
2660
|
+
# The identifier of the flow module.
|
2534
2661
|
# @return [String]
|
2535
2662
|
#
|
2536
2663
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteContactFlowModuleRequest AWS API Documentation
|
@@ -2560,7 +2687,7 @@ module Aws::Connect
|
|
2560
2687
|
# @return [String]
|
2561
2688
|
#
|
2562
2689
|
# @!attribute [rw] contact_flow_id
|
2563
|
-
# The identifier of the
|
2690
|
+
# The identifier of the flow.
|
2564
2691
|
# @return [String]
|
2565
2692
|
#
|
2566
2693
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteContactFlowRequest AWS API Documentation
|
@@ -2910,7 +3037,7 @@ module Aws::Connect
|
|
2910
3037
|
# @return [String]
|
2911
3038
|
#
|
2912
3039
|
# @!attribute [rw] contact_flow_module_id
|
2913
|
-
# The identifier of the
|
3040
|
+
# The identifier of the flow module.
|
2914
3041
|
# @return [String]
|
2915
3042
|
#
|
2916
3043
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContactFlowModuleRequest AWS API Documentation
|
@@ -2923,7 +3050,7 @@ module Aws::Connect
|
|
2923
3050
|
end
|
2924
3051
|
|
2925
3052
|
# @!attribute [rw] contact_flow_module
|
2926
|
-
# Information about the
|
3053
|
+
# Information about the flow module.
|
2927
3054
|
# @return [Types::ContactFlowModule]
|
2928
3055
|
#
|
2929
3056
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContactFlowModuleResponse AWS API Documentation
|
@@ -2947,7 +3074,7 @@ module Aws::Connect
|
|
2947
3074
|
# @return [String]
|
2948
3075
|
#
|
2949
3076
|
# @!attribute [rw] contact_flow_id
|
2950
|
-
# The identifier of the
|
3077
|
+
# The identifier of the flow.
|
2951
3078
|
# @return [String]
|
2952
3079
|
#
|
2953
3080
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContactFlowRequest AWS API Documentation
|
@@ -2960,7 +3087,7 @@ module Aws::Connect
|
|
2960
3087
|
end
|
2961
3088
|
|
2962
3089
|
# @!attribute [rw] contact_flow
|
2963
|
-
# Information about the
|
3090
|
+
# Information about the flow.
|
2964
3091
|
# @return [Types::ContactFlow]
|
2965
3092
|
#
|
2966
3093
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContactFlowResponse AWS API Documentation
|
@@ -3052,7 +3179,7 @@ module Aws::Connect
|
|
3052
3179
|
#
|
3053
3180
|
# {
|
3054
3181
|
# instance_id: "InstanceId", # required
|
3055
|
-
# attribute_type: "INBOUND_CALLS", # required, accepts INBOUND_CALLS, OUTBOUND_CALLS, CONTACTFLOW_LOGS, CONTACT_LENS, AUTO_RESOLVE_BEST_VOICES, USE_CUSTOM_TTS_VOICES, EARLY_MEDIA, MULTI_PARTY_CONFERENCE
|
3182
|
+
# attribute_type: "INBOUND_CALLS", # required, accepts INBOUND_CALLS, OUTBOUND_CALLS, CONTACTFLOW_LOGS, CONTACT_LENS, AUTO_RESOLVE_BEST_VOICES, USE_CUSTOM_TTS_VOICES, EARLY_MEDIA, MULTI_PARTY_CONFERENCE, HIGH_VOLUME_OUTBOUND
|
3056
3183
|
# }
|
3057
3184
|
#
|
3058
3185
|
# @!attribute [rw] instance_id
|
@@ -4149,6 +4276,71 @@ module Aws::Connect
|
|
4149
4276
|
include Aws::Structure
|
4150
4277
|
end
|
4151
4278
|
|
4279
|
+
# @note When making an API call, you may pass GetCurrentUserDataRequest
|
4280
|
+
# data as a hash:
|
4281
|
+
#
|
4282
|
+
# {
|
4283
|
+
# instance_id: "InstanceId", # required
|
4284
|
+
# filters: { # required
|
4285
|
+
# queues: ["QueueId"],
|
4286
|
+
# contact_filter: {
|
4287
|
+
# contact_states: ["INCOMING"], # accepts INCOMING, PENDING, CONNECTING, CONNECTED, CONNECTED_ONHOLD, MISSED, ERROR, ENDED, REJECTED
|
4288
|
+
# },
|
4289
|
+
# },
|
4290
|
+
# next_token: "NextToken",
|
4291
|
+
# max_results: 1,
|
4292
|
+
# }
|
4293
|
+
#
|
4294
|
+
# @!attribute [rw] instance_id
|
4295
|
+
# The identifier of the Amazon Connect instance. You can find the
|
4296
|
+
# instanceId in the ARN of the instance.
|
4297
|
+
# @return [String]
|
4298
|
+
#
|
4299
|
+
# @!attribute [rw] filters
|
4300
|
+
# Filters up to 100 `Queues`, or up to 9 `ContactStates`. The user
|
4301
|
+
# data is retrieved only for those users who are associated with the
|
4302
|
+
# queues and have contacts that are in the specified `ContactState`.
|
4303
|
+
# @return [Types::UserDataFilters]
|
4304
|
+
#
|
4305
|
+
# @!attribute [rw] next_token
|
4306
|
+
# The token for the next set of results. Use the value returned in the
|
4307
|
+
# previous response in the next request to retrieve the next set of
|
4308
|
+
# results.
|
4309
|
+
# @return [String]
|
4310
|
+
#
|
4311
|
+
# @!attribute [rw] max_results
|
4312
|
+
# The maximum number of results to return per page.
|
4313
|
+
# @return [Integer]
|
4314
|
+
#
|
4315
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetCurrentUserDataRequest AWS API Documentation
|
4316
|
+
#
|
4317
|
+
class GetCurrentUserDataRequest < Struct.new(
|
4318
|
+
:instance_id,
|
4319
|
+
:filters,
|
4320
|
+
:next_token,
|
4321
|
+
:max_results)
|
4322
|
+
SENSITIVE = []
|
4323
|
+
include Aws::Structure
|
4324
|
+
end
|
4325
|
+
|
4326
|
+
# @!attribute [rw] next_token
|
4327
|
+
# If there are additional results, this is the token for the next set
|
4328
|
+
# of results.
|
4329
|
+
# @return [String]
|
4330
|
+
#
|
4331
|
+
# @!attribute [rw] user_data_list
|
4332
|
+
# A list of the user data that is returned.
|
4333
|
+
# @return [Array<Types::UserData>]
|
4334
|
+
#
|
4335
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetCurrentUserDataResponse AWS API Documentation
|
4336
|
+
#
|
4337
|
+
class GetCurrentUserDataResponse < Struct.new(
|
4338
|
+
:next_token,
|
4339
|
+
:user_data_list)
|
4340
|
+
SENSITIVE = []
|
4341
|
+
include Aws::Structure
|
4342
|
+
end
|
4343
|
+
|
4152
4344
|
# @note When making an API call, you may pass GetFederationTokenRequest
|
4153
4345
|
# data as a hash:
|
4154
4346
|
#
|
@@ -4567,7 +4759,8 @@ module Aws::Connect
|
|
4567
4759
|
#
|
4568
4760
|
# @!attribute [rw] tags
|
4569
4761
|
# The tags used to organize, track, or control access for this
|
4570
|
-
# resource.
|
4762
|
+
# resource. For example, \\\{ "tags": \\\{"key1":"value1",
|
4763
|
+
# "key2":"value2"\\} \\}.
|
4571
4764
|
# @return [Hash<String,String>]
|
4572
4765
|
#
|
4573
4766
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetTaskTemplateResponse AWS API Documentation
|
@@ -4614,7 +4807,8 @@ module Aws::Connect
|
|
4614
4807
|
#
|
4615
4808
|
# @!attribute [rw] tags
|
4616
4809
|
# The tags used to organize, track, or control access for this
|
4617
|
-
# resource.
|
4810
|
+
# resource. For example, \\\{ "tags": \\\{"key1":"value1",
|
4811
|
+
# "key2":"value2"\\} \\}.
|
4618
4812
|
# @return [Hash<String,String>]
|
4619
4813
|
#
|
4620
4814
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HierarchyGroup AWS API Documentation
|
@@ -4682,6 +4876,25 @@ module Aws::Connect
|
|
4682
4876
|
include Aws::Structure
|
4683
4877
|
end
|
4684
4878
|
|
4879
|
+
# Information about the hierarchy group.
|
4880
|
+
#
|
4881
|
+
# @!attribute [rw] id
|
4882
|
+
# The unique identifier for the hierarchy group.
|
4883
|
+
# @return [String]
|
4884
|
+
#
|
4885
|
+
# @!attribute [rw] arn
|
4886
|
+
# The Amazon Resource Name (ARN) for the hierarchy group.
|
4887
|
+
# @return [String]
|
4888
|
+
#
|
4889
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HierarchyGroupSummaryReference AWS API Documentation
|
4890
|
+
#
|
4891
|
+
class HierarchyGroupSummaryReference < Struct.new(
|
4892
|
+
:id,
|
4893
|
+
:arn)
|
4894
|
+
SENSITIVE = []
|
4895
|
+
include Aws::Structure
|
4896
|
+
end
|
4897
|
+
|
4685
4898
|
# Contains information about a hierarchy level.
|
4686
4899
|
#
|
4687
4900
|
# @!attribute [rw] id
|
@@ -4762,6 +4975,40 @@ module Aws::Connect
|
|
4762
4975
|
include Aws::Structure
|
4763
4976
|
end
|
4764
4977
|
|
4978
|
+
# Information about the levels in the hierarchy group.
|
4979
|
+
#
|
4980
|
+
# @!attribute [rw] level_one
|
4981
|
+
# Information about level one.
|
4982
|
+
# @return [Types::HierarchyGroupSummaryReference]
|
4983
|
+
#
|
4984
|
+
# @!attribute [rw] level_two
|
4985
|
+
# Information about level two.
|
4986
|
+
# @return [Types::HierarchyGroupSummaryReference]
|
4987
|
+
#
|
4988
|
+
# @!attribute [rw] level_three
|
4989
|
+
# Information about level three.
|
4990
|
+
# @return [Types::HierarchyGroupSummaryReference]
|
4991
|
+
#
|
4992
|
+
# @!attribute [rw] level_four
|
4993
|
+
# Information about level four.
|
4994
|
+
# @return [Types::HierarchyGroupSummaryReference]
|
4995
|
+
#
|
4996
|
+
# @!attribute [rw] level_five
|
4997
|
+
# Information about level five.
|
4998
|
+
# @return [Types::HierarchyGroupSummaryReference]
|
4999
|
+
#
|
5000
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HierarchyPathReference AWS API Documentation
|
5001
|
+
#
|
5002
|
+
class HierarchyPathReference < Struct.new(
|
5003
|
+
:level_one,
|
5004
|
+
:level_two,
|
5005
|
+
:level_three,
|
5006
|
+
:level_four,
|
5007
|
+
:level_five)
|
5008
|
+
SENSITIVE = []
|
5009
|
+
include Aws::Structure
|
5010
|
+
end
|
5011
|
+
|
4765
5012
|
# Contains information about a hierarchy structure.
|
4766
5013
|
#
|
4767
5014
|
# @!attribute [rw] level_one
|
@@ -4965,7 +5212,8 @@ module Aws::Connect
|
|
4965
5212
|
#
|
4966
5213
|
# @!attribute [rw] tags
|
4967
5214
|
# The tags used to organize, track, or control access for this
|
4968
|
-
# resource.
|
5215
|
+
# resource. For example, \\\{ "tags": \\\{"key1":"value1",
|
5216
|
+
# "key2":"value2"\\} \\}.
|
4969
5217
|
# @return [Hash<String,String>]
|
4970
5218
|
#
|
4971
5219
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/HoursOfOperation AWS API Documentation
|
@@ -5349,10 +5597,10 @@ module Aws::Connect
|
|
5349
5597
|
include Aws::Structure
|
5350
5598
|
end
|
5351
5599
|
|
5352
|
-
# The
|
5600
|
+
# The flow is not valid.
|
5353
5601
|
#
|
5354
5602
|
# @!attribute [rw] problems
|
5355
|
-
# The problems with the
|
5603
|
+
# The problems with the flow. Please fix before trying again.
|
5356
5604
|
# @return [Array<Types::ProblemDetail>]
|
5357
5605
|
#
|
5358
5606
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/InvalidContactFlowException AWS API Documentation
|
@@ -5786,7 +6034,7 @@ module Aws::Connect
|
|
5786
6034
|
# @return [Integer]
|
5787
6035
|
#
|
5788
6036
|
# @!attribute [rw] contact_flow_module_state
|
5789
|
-
# The state of the
|
6037
|
+
# The state of the flow module.
|
5790
6038
|
# @return [String]
|
5791
6039
|
#
|
5792
6040
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactFlowModulesRequest AWS API Documentation
|
@@ -5801,7 +6049,7 @@ module Aws::Connect
|
|
5801
6049
|
end
|
5802
6050
|
|
5803
6051
|
# @!attribute [rw] contact_flow_modules_summary_list
|
5804
|
-
# Information about the
|
6052
|
+
# Information about the flow module.
|
5805
6053
|
# @return [Array<Types::ContactFlowModuleSummary>]
|
5806
6054
|
#
|
5807
6055
|
# @!attribute [rw] next_token
|
@@ -5834,7 +6082,7 @@ module Aws::Connect
|
|
5834
6082
|
# @return [String]
|
5835
6083
|
#
|
5836
6084
|
# @!attribute [rw] contact_flow_types
|
5837
|
-
# The type of
|
6085
|
+
# The type of flow.
|
5838
6086
|
# @return [Array<String>]
|
5839
6087
|
#
|
5840
6088
|
# @!attribute [rw] next_token
|
@@ -5844,7 +6092,8 @@ module Aws::Connect
|
|
5844
6092
|
# @return [String]
|
5845
6093
|
#
|
5846
6094
|
# @!attribute [rw] max_results
|
5847
|
-
# The maximum number of results to return per page.
|
6095
|
+
# The maximum number of results to return per page. The default
|
6096
|
+
# MaxResult size is 100.
|
5848
6097
|
# @return [Integer]
|
5849
6098
|
#
|
5850
6099
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactFlowsRequest AWS API Documentation
|
@@ -5859,7 +6108,7 @@ module Aws::Connect
|
|
5859
6108
|
end
|
5860
6109
|
|
5861
6110
|
# @!attribute [rw] contact_flow_summary_list
|
5862
|
-
# Information about the
|
6111
|
+
# Information about the flows.
|
5863
6112
|
# @return [Array<Types::ContactFlowSummary>]
|
5864
6113
|
#
|
5865
6114
|
# @!attribute [rw] next_token
|
@@ -5920,7 +6169,7 @@ module Aws::Connect
|
|
5920
6169
|
end
|
5921
6170
|
|
5922
6171
|
# @!attribute [rw] reference_summary_list
|
5923
|
-
# Information about the
|
6172
|
+
# Information about the flows.
|
5924
6173
|
# @return [Array<Types::ReferenceSummary>]
|
5925
6174
|
#
|
5926
6175
|
# @!attribute [rw] next_token
|
@@ -6024,7 +6273,8 @@ module Aws::Connect
|
|
6024
6273
|
# @return [String]
|
6025
6274
|
#
|
6026
6275
|
# @!attribute [rw] max_results
|
6027
|
-
# The maximum number of results to return per page.
|
6276
|
+
# The maximum number of results to return per page. The default
|
6277
|
+
# MaxResult size is 100.
|
6028
6278
|
# @return [Integer]
|
6029
6279
|
#
|
6030
6280
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListHoursOfOperationsRequest AWS API Documentation
|
@@ -6405,7 +6655,8 @@ module Aws::Connect
|
|
6405
6655
|
# @return [String]
|
6406
6656
|
#
|
6407
6657
|
# @!attribute [rw] max_results
|
6408
|
-
# The maximum number of results to return per page.
|
6658
|
+
# The maximum number of results to return per page. The default
|
6659
|
+
# MaxResult size is 100.
|
6409
6660
|
# @return [Integer]
|
6410
6661
|
#
|
6411
6662
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPhoneNumbersRequest AWS API Documentation
|
@@ -6574,7 +6825,8 @@ module Aws::Connect
|
|
6574
6825
|
# @return [String]
|
6575
6826
|
#
|
6576
6827
|
# @!attribute [rw] max_results
|
6577
|
-
# The maximum number of results to return per page.
|
6828
|
+
# The maximum number of results to return per page. The default
|
6829
|
+
# MaxResult size is 100.
|
6578
6830
|
# @return [Integer]
|
6579
6831
|
#
|
6580
6832
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPromptsRequest AWS API Documentation
|
@@ -6631,7 +6883,8 @@ module Aws::Connect
|
|
6631
6883
|
# @return [String]
|
6632
6884
|
#
|
6633
6885
|
# @!attribute [rw] max_results
|
6634
|
-
# The maximum number of results to return per page.
|
6886
|
+
# The maximum number of results to return per page. The default
|
6887
|
+
# MaxResult size is 100.
|
6635
6888
|
# @return [Integer]
|
6636
6889
|
#
|
6637
6890
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListQueueQuickConnectsRequest AWS API Documentation
|
@@ -6689,7 +6942,8 @@ module Aws::Connect
|
|
6689
6942
|
# @return [String]
|
6690
6943
|
#
|
6691
6944
|
# @!attribute [rw] max_results
|
6692
|
-
# The maximum number of results to return per page.
|
6945
|
+
# The maximum number of results to return per page. The default
|
6946
|
+
# MaxResult size is 100.
|
6693
6947
|
# @return [Integer]
|
6694
6948
|
#
|
6695
6949
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListQueuesRequest AWS API Documentation
|
@@ -6743,7 +6997,8 @@ module Aws::Connect
|
|
6743
6997
|
# @return [String]
|
6744
6998
|
#
|
6745
6999
|
# @!attribute [rw] max_results
|
6746
|
-
# The maximum number of results to return per page.
|
7000
|
+
# The maximum number of results to return per page. The default
|
7001
|
+
# MaxResult size is 100.
|
6747
7002
|
# @return [Integer]
|
6748
7003
|
#
|
6749
7004
|
# @!attribute [rw] quick_connect_types
|
@@ -6808,7 +7063,8 @@ module Aws::Connect
|
|
6808
7063
|
# @return [String]
|
6809
7064
|
#
|
6810
7065
|
# @!attribute [rw] max_results
|
6811
|
-
# The maximum number of results to return per page.
|
7066
|
+
# The maximum number of results to return per page. The default
|
7067
|
+
# MaxResult size is 100.
|
6812
7068
|
# @return [Integer]
|
6813
7069
|
#
|
6814
7070
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfileQueuesRequest AWS API Documentation
|
@@ -6861,7 +7117,8 @@ module Aws::Connect
|
|
6861
7117
|
# @return [String]
|
6862
7118
|
#
|
6863
7119
|
# @!attribute [rw] max_results
|
6864
|
-
# The maximum number of results to return per page.
|
7120
|
+
# The maximum number of results to return per page. The default
|
7121
|
+
# MaxResult size is 100.
|
6865
7122
|
# @return [Integer]
|
6866
7123
|
#
|
6867
7124
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfilesRequest AWS API Documentation
|
@@ -7023,7 +7280,8 @@ module Aws::Connect
|
|
7023
7280
|
# @return [String]
|
7024
7281
|
#
|
7025
7282
|
# @!attribute [rw] max_results
|
7026
|
-
# The maximum number of results to return per page.
|
7283
|
+
# The maximum number of results to return per page. The default
|
7284
|
+
# MaxResult size is 100.
|
7027
7285
|
# @return [Integer]
|
7028
7286
|
#
|
7029
7287
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListSecurityProfilesRequest AWS API Documentation
|
@@ -7242,7 +7500,8 @@ module Aws::Connect
|
|
7242
7500
|
# @return [String]
|
7243
7501
|
#
|
7244
7502
|
# @!attribute [rw] max_results
|
7245
|
-
# The maximum number of results to return per page.
|
7503
|
+
# The maximum number of results to return per page. The default
|
7504
|
+
# MaxResult size is 100.
|
7246
7505
|
# @return [Integer]
|
7247
7506
|
#
|
7248
7507
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUserHierarchyGroupsRequest AWS API Documentation
|
@@ -7294,7 +7553,8 @@ module Aws::Connect
|
|
7294
7553
|
# @return [String]
|
7295
7554
|
#
|
7296
7555
|
# @!attribute [rw] max_results
|
7297
|
-
# The maximum number of results to return per page.
|
7556
|
+
# The maximum number of results to return per page. The default
|
7557
|
+
# MaxResult size is 100.
|
7298
7558
|
# @return [Integer]
|
7299
7559
|
#
|
7300
7560
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListUsersRequest AWS API Documentation
|
@@ -7562,6 +7822,8 @@ module Aws::Connect
|
|
7562
7822
|
include Aws::Structure
|
7563
7823
|
end
|
7564
7824
|
|
7825
|
+
# The property is not valid.
|
7826
|
+
#
|
7565
7827
|
# @!attribute [rw] message
|
7566
7828
|
# @return [String]
|
7567
7829
|
#
|
@@ -7674,7 +7936,8 @@ module Aws::Connect
|
|
7674
7936
|
#
|
7675
7937
|
# @!attribute [rw] tags
|
7676
7938
|
# The tags used to organize, track, or control access for this
|
7677
|
-
# resource.
|
7939
|
+
# resource. For example, \\\{ "tags": \\\{"key1":"value1",
|
7940
|
+
# "key2":"value2"\\} \\}.
|
7678
7941
|
# @return [Hash<String,String>]
|
7679
7942
|
#
|
7680
7943
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Queue AWS API Documentation
|
@@ -7712,8 +7975,8 @@ module Aws::Connect
|
|
7712
7975
|
include Aws::Structure
|
7713
7976
|
end
|
7714
7977
|
|
7715
|
-
# Contains information about a queue for a quick connect. The
|
7716
|
-
#
|
7978
|
+
# Contains information about a queue for a quick connect. The flow must
|
7979
|
+
# be of type Transfer to Queue.
|
7717
7980
|
#
|
7718
7981
|
# @note When making an API call, you may pass QueueQuickConnectConfig
|
7719
7982
|
# data as a hash:
|
@@ -7728,7 +7991,7 @@ module Aws::Connect
|
|
7728
7991
|
# @return [String]
|
7729
7992
|
#
|
7730
7993
|
# @!attribute [rw] contact_flow_id
|
7731
|
-
# The identifier of the
|
7994
|
+
# The identifier of the flow.
|
7732
7995
|
# @return [String]
|
7733
7996
|
#
|
7734
7997
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/QueueQuickConnectConfig AWS API Documentation
|
@@ -7813,7 +8076,8 @@ module Aws::Connect
|
|
7813
8076
|
#
|
7814
8077
|
# @!attribute [rw] tags
|
7815
8078
|
# The tags used to organize, track, or control access for this
|
7816
|
-
# resource.
|
8079
|
+
# resource. For example, \\\{ "tags": \\\{"key1":"value1",
|
8080
|
+
# "key2":"value2"\\} \\}.
|
7817
8081
|
# @return [Hash<String,String>]
|
7818
8082
|
#
|
7819
8083
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/QuickConnect AWS API Documentation
|
@@ -8200,7 +8464,9 @@ module Aws::Connect
|
|
8200
8464
|
# @return [String]
|
8201
8465
|
#
|
8202
8466
|
# @!attribute [rw] tags
|
8203
|
-
#
|
8467
|
+
# The tags used to organize, track, or control access for this
|
8468
|
+
# resource. For example, \\\{ "tags": \\\{"key1":"value1",
|
8469
|
+
# "key2":"value2"\\} \\}.
|
8204
8470
|
# @return [Hash<String,String>]
|
8205
8471
|
#
|
8206
8472
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RoutingProfile AWS API Documentation
|
@@ -8345,6 +8611,25 @@ module Aws::Connect
|
|
8345
8611
|
include Aws::Structure
|
8346
8612
|
end
|
8347
8613
|
|
8614
|
+
# Information about the routing profile assigned to the user.
|
8615
|
+
#
|
8616
|
+
# @!attribute [rw] id
|
8617
|
+
# The identifier of the routing profile.
|
8618
|
+
# @return [String]
|
8619
|
+
#
|
8620
|
+
# @!attribute [rw] arn
|
8621
|
+
# The Amazon Resource Name (ARN) of the routing profile.
|
8622
|
+
# @return [String]
|
8623
|
+
#
|
8624
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RoutingProfileReference AWS API Documentation
|
8625
|
+
#
|
8626
|
+
class RoutingProfileReference < Struct.new(
|
8627
|
+
:id,
|
8628
|
+
:arn)
|
8629
|
+
SENSITIVE = []
|
8630
|
+
include Aws::Structure
|
8631
|
+
end
|
8632
|
+
|
8348
8633
|
# Contains summary information about a routing profile.
|
8349
8634
|
#
|
8350
8635
|
# @!attribute [rw] id
|
@@ -8478,6 +8763,113 @@ module Aws::Connect
|
|
8478
8763
|
include Aws::Structure
|
8479
8764
|
end
|
8480
8765
|
|
8766
|
+
# @note When making an API call, you may pass SearchSecurityProfilesRequest
|
8767
|
+
# data as a hash:
|
8768
|
+
#
|
8769
|
+
# {
|
8770
|
+
# instance_id: "InstanceId", # required
|
8771
|
+
# next_token: "NextToken2500",
|
8772
|
+
# max_results: 1,
|
8773
|
+
# search_criteria: {
|
8774
|
+
# or_conditions: [
|
8775
|
+
# {
|
8776
|
+
# # recursive SecurityProfileSearchCriteria
|
8777
|
+
# },
|
8778
|
+
# ],
|
8779
|
+
# and_conditions: [
|
8780
|
+
# {
|
8781
|
+
# # recursive SecurityProfileSearchCriteria
|
8782
|
+
# },
|
8783
|
+
# ],
|
8784
|
+
# string_condition: {
|
8785
|
+
# field_name: "String",
|
8786
|
+
# value: "String",
|
8787
|
+
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
8788
|
+
# },
|
8789
|
+
# },
|
8790
|
+
# search_filter: {
|
8791
|
+
# tag_filter: {
|
8792
|
+
# or_conditions: [
|
8793
|
+
# [
|
8794
|
+
# {
|
8795
|
+
# tag_key: "String",
|
8796
|
+
# tag_value: "String",
|
8797
|
+
# },
|
8798
|
+
# ],
|
8799
|
+
# ],
|
8800
|
+
# and_conditions: [
|
8801
|
+
# {
|
8802
|
+
# tag_key: "String",
|
8803
|
+
# tag_value: "String",
|
8804
|
+
# },
|
8805
|
+
# ],
|
8806
|
+
# tag_condition: {
|
8807
|
+
# tag_key: "String",
|
8808
|
+
# tag_value: "String",
|
8809
|
+
# },
|
8810
|
+
# },
|
8811
|
+
# },
|
8812
|
+
# }
|
8813
|
+
#
|
8814
|
+
# @!attribute [rw] instance_id
|
8815
|
+
# The identifier of the Amazon Connect instance. You can find the
|
8816
|
+
# instanceId in the ARN of the instance.
|
8817
|
+
# @return [String]
|
8818
|
+
#
|
8819
|
+
# @!attribute [rw] next_token
|
8820
|
+
# The token for the next set of results. Use the value returned in the
|
8821
|
+
# previous response in the next request to retrieve the next set of
|
8822
|
+
# results.
|
8823
|
+
# @return [String]
|
8824
|
+
#
|
8825
|
+
# @!attribute [rw] max_results
|
8826
|
+
# The maximum number of results to return per page.
|
8827
|
+
# @return [Integer]
|
8828
|
+
#
|
8829
|
+
# @!attribute [rw] search_criteria
|
8830
|
+
# The search criteria to be used to return security profiles.
|
8831
|
+
# @return [Types::SecurityProfileSearchCriteria]
|
8832
|
+
#
|
8833
|
+
# @!attribute [rw] search_filter
|
8834
|
+
# Filters to be applied to search results.
|
8835
|
+
# @return [Types::SecurityProfilesSearchFilter]
|
8836
|
+
#
|
8837
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchSecurityProfilesRequest AWS API Documentation
|
8838
|
+
#
|
8839
|
+
class SearchSecurityProfilesRequest < Struct.new(
|
8840
|
+
:instance_id,
|
8841
|
+
:next_token,
|
8842
|
+
:max_results,
|
8843
|
+
:search_criteria,
|
8844
|
+
:search_filter)
|
8845
|
+
SENSITIVE = []
|
8846
|
+
include Aws::Structure
|
8847
|
+
end
|
8848
|
+
|
8849
|
+
# @!attribute [rw] security_profiles
|
8850
|
+
# Information about the security profiles.
|
8851
|
+
# @return [Array<Types::SecurityProfileSearchSummary>]
|
8852
|
+
#
|
8853
|
+
# @!attribute [rw] next_token
|
8854
|
+
# If there are additional results, this is the token for the next set
|
8855
|
+
# of results.
|
8856
|
+
# @return [String]
|
8857
|
+
#
|
8858
|
+
# @!attribute [rw] approximate_total_count
|
8859
|
+
# The total number of security profiles which matched your search
|
8860
|
+
# query.
|
8861
|
+
# @return [Integer]
|
8862
|
+
#
|
8863
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchSecurityProfilesResponse AWS API Documentation
|
8864
|
+
#
|
8865
|
+
class SearchSecurityProfilesResponse < Struct.new(
|
8866
|
+
:security_profiles,
|
8867
|
+
:next_token,
|
8868
|
+
:approximate_total_count)
|
8869
|
+
SENSITIVE = []
|
8870
|
+
include Aws::Structure
|
8871
|
+
end
|
8872
|
+
|
8481
8873
|
# @note When making an API call, you may pass SearchUsersRequest
|
8482
8874
|
# data as a hash:
|
8483
8875
|
#
|
@@ -8713,7 +9105,8 @@ module Aws::Connect
|
|
8713
9105
|
#
|
8714
9106
|
# @!attribute [rw] tags
|
8715
9107
|
# The tags used to organize, track, or control access for this
|
8716
|
-
# resource.
|
9108
|
+
# resource. For example, \\\{ "tags": \\\{"key1":"value1",
|
9109
|
+
# "key2":"value2"\\} \\}.
|
8717
9110
|
# @return [Hash<String,String>]
|
8718
9111
|
#
|
8719
9112
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SecurityProfile AWS API Documentation
|
@@ -8729,6 +9122,115 @@ module Aws::Connect
|
|
8729
9122
|
include Aws::Structure
|
8730
9123
|
end
|
8731
9124
|
|
9125
|
+
# The search criteria to be used to return security profiles.
|
9126
|
+
#
|
9127
|
+
# @note When making an API call, you may pass SecurityProfileSearchCriteria
|
9128
|
+
# data as a hash:
|
9129
|
+
#
|
9130
|
+
# {
|
9131
|
+
# or_conditions: [
|
9132
|
+
# {
|
9133
|
+
# or_conditions: {
|
9134
|
+
# # recursive SecurityProfileSearchConditionList
|
9135
|
+
# },
|
9136
|
+
# and_conditions: {
|
9137
|
+
# # recursive SecurityProfileSearchConditionList
|
9138
|
+
# },
|
9139
|
+
# string_condition: {
|
9140
|
+
# field_name: "String",
|
9141
|
+
# value: "String",
|
9142
|
+
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
9143
|
+
# },
|
9144
|
+
# },
|
9145
|
+
# ],
|
9146
|
+
# and_conditions: [
|
9147
|
+
# {
|
9148
|
+
# or_conditions: {
|
9149
|
+
# # recursive SecurityProfileSearchConditionList
|
9150
|
+
# },
|
9151
|
+
# and_conditions: {
|
9152
|
+
# # recursive SecurityProfileSearchConditionList
|
9153
|
+
# },
|
9154
|
+
# string_condition: {
|
9155
|
+
# field_name: "String",
|
9156
|
+
# value: "String",
|
9157
|
+
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
9158
|
+
# },
|
9159
|
+
# },
|
9160
|
+
# ],
|
9161
|
+
# string_condition: {
|
9162
|
+
# field_name: "String",
|
9163
|
+
# value: "String",
|
9164
|
+
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
9165
|
+
# },
|
9166
|
+
# }
|
9167
|
+
#
|
9168
|
+
# @!attribute [rw] or_conditions
|
9169
|
+
# A list of conditions which would be applied together with an OR
|
9170
|
+
# condition.
|
9171
|
+
# @return [Array<Types::SecurityProfileSearchCriteria>]
|
9172
|
+
#
|
9173
|
+
# @!attribute [rw] and_conditions
|
9174
|
+
# A list of conditions which would be applied together with an AND
|
9175
|
+
# condition.
|
9176
|
+
# @return [Array<Types::SecurityProfileSearchCriteria>]
|
9177
|
+
#
|
9178
|
+
# @!attribute [rw] string_condition
|
9179
|
+
# A leaf node condition which can be used to specify a string
|
9180
|
+
# condition, for example, `username = 'abc'`.
|
9181
|
+
# @return [Types::StringCondition]
|
9182
|
+
#
|
9183
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SecurityProfileSearchCriteria AWS API Documentation
|
9184
|
+
#
|
9185
|
+
class SecurityProfileSearchCriteria < Struct.new(
|
9186
|
+
:or_conditions,
|
9187
|
+
:and_conditions,
|
9188
|
+
:string_condition)
|
9189
|
+
SENSITIVE = []
|
9190
|
+
include Aws::Structure
|
9191
|
+
end
|
9192
|
+
|
9193
|
+
# Information about the returned security profiles.
|
9194
|
+
#
|
9195
|
+
# @!attribute [rw] id
|
9196
|
+
# The identifier of the security profile.
|
9197
|
+
# @return [String]
|
9198
|
+
#
|
9199
|
+
# @!attribute [rw] organization_resource_id
|
9200
|
+
# The organization resource identifier.
|
9201
|
+
# @return [String]
|
9202
|
+
#
|
9203
|
+
# @!attribute [rw] arn
|
9204
|
+
# The Amazon Resource Name (ARN) of the security profile.
|
9205
|
+
# @return [String]
|
9206
|
+
#
|
9207
|
+
# @!attribute [rw] security_profile_name
|
9208
|
+
# The name of the security profile.
|
9209
|
+
# @return [String]
|
9210
|
+
#
|
9211
|
+
# @!attribute [rw] description
|
9212
|
+
# The description of the security profile.
|
9213
|
+
# @return [String]
|
9214
|
+
#
|
9215
|
+
# @!attribute [rw] tags
|
9216
|
+
# The tags used to organize, track, or control access for this
|
9217
|
+
# resource. For example, \\\{ "tags": \\\{"key1":"value1",
|
9218
|
+
# "key2":"value2"\\} \\}.
|
9219
|
+
# @return [Hash<String,String>]
|
9220
|
+
#
|
9221
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SecurityProfileSearchSummary AWS API Documentation
|
9222
|
+
#
|
9223
|
+
class SecurityProfileSearchSummary < Struct.new(
|
9224
|
+
:id,
|
9225
|
+
:organization_resource_id,
|
9226
|
+
:arn,
|
9227
|
+
:security_profile_name,
|
9228
|
+
:description,
|
9229
|
+
:tags)
|
9230
|
+
SENSITIVE = []
|
9231
|
+
include Aws::Structure
|
9232
|
+
end
|
9233
|
+
|
8732
9234
|
# Contains information about a security profile.
|
8733
9235
|
#
|
8734
9236
|
# @!attribute [rw] id
|
@@ -8753,6 +9255,54 @@ module Aws::Connect
|
|
8753
9255
|
include Aws::Structure
|
8754
9256
|
end
|
8755
9257
|
|
9258
|
+
# Filters to be applied to search results.
|
9259
|
+
#
|
9260
|
+
# @note When making an API call, you may pass SecurityProfilesSearchFilter
|
9261
|
+
# data as a hash:
|
9262
|
+
#
|
9263
|
+
# {
|
9264
|
+
# tag_filter: {
|
9265
|
+
# or_conditions: [
|
9266
|
+
# [
|
9267
|
+
# {
|
9268
|
+
# tag_key: "String",
|
9269
|
+
# tag_value: "String",
|
9270
|
+
# },
|
9271
|
+
# ],
|
9272
|
+
# ],
|
9273
|
+
# and_conditions: [
|
9274
|
+
# {
|
9275
|
+
# tag_key: "String",
|
9276
|
+
# tag_value: "String",
|
9277
|
+
# },
|
9278
|
+
# ],
|
9279
|
+
# tag_condition: {
|
9280
|
+
# tag_key: "String",
|
9281
|
+
# tag_value: "String",
|
9282
|
+
# },
|
9283
|
+
# },
|
9284
|
+
# }
|
9285
|
+
#
|
9286
|
+
# @!attribute [rw] tag_filter
|
9287
|
+
# An object that can be used to specify Tag conditions inside the
|
9288
|
+
# `SearchFilter`. This accepts an `OR` of `AND` (List of List) input
|
9289
|
+
# where:
|
9290
|
+
#
|
9291
|
+
# * Top level list specifies conditions that need to be applied with
|
9292
|
+
# `OR` operator
|
9293
|
+
#
|
9294
|
+
# * Inner list specifies conditions that need to be applied with `AND`
|
9295
|
+
# operator.
|
9296
|
+
# @return [Types::ControlPlaneTagFilter]
|
9297
|
+
#
|
9298
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SecurityProfilesSearchFilter AWS API Documentation
|
9299
|
+
#
|
9300
|
+
class SecurityProfilesSearchFilter < Struct.new(
|
9301
|
+
:tag_filter)
|
9302
|
+
SENSITIVE = []
|
9303
|
+
include Aws::Structure
|
9304
|
+
end
|
9305
|
+
|
8756
9306
|
# The service quota has been exceeded.
|
8757
9307
|
#
|
8758
9308
|
# @!attribute [rw] message
|
@@ -8793,20 +9343,20 @@ module Aws::Connect
|
|
8793
9343
|
# @return [String]
|
8794
9344
|
#
|
8795
9345
|
# @!attribute [rw] contact_flow_id
|
8796
|
-
# The identifier of the
|
8797
|
-
#
|
8798
|
-
#
|
8799
|
-
#
|
8800
|
-
#
|
8801
|
-
#
|
9346
|
+
# The identifier of the flow for initiating the chat. To see the
|
9347
|
+
# ContactFlowId in the Amazon Connect console user interface, on the
|
9348
|
+
# navigation menu go to **Routing**, **Contact Flows**. Choose the
|
9349
|
+
# flow. On the flow page, under the name of the flow, choose **Show
|
9350
|
+
# additional flow information**. The ContactFlowId is the last part of
|
9351
|
+
# the ARN, shown here in bold:
|
8802
9352
|
#
|
8803
9353
|
# arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
|
8804
9354
|
# @return [String]
|
8805
9355
|
#
|
8806
9356
|
# @!attribute [rw] attributes
|
8807
9357
|
# A custom key-value pair using an attribute map. The attributes are
|
8808
|
-
# standard Amazon Connect attributes. They can be accessed in
|
8809
|
-
#
|
9358
|
+
# standard Amazon Connect attributes. They can be accessed in flows
|
9359
|
+
# just like any other contact attributes.
|
8810
9360
|
#
|
8811
9361
|
# There can be up to 32,768 UTF-8 bytes across all key-value pairs per
|
8812
9362
|
# contact. Attribute keys can include only alphanumeric, dash, and
|
@@ -9014,12 +9564,12 @@ module Aws::Connect
|
|
9014
9564
|
# @return [String]
|
9015
9565
|
#
|
9016
9566
|
# @!attribute [rw] contact_flow_id
|
9017
|
-
# The identifier of the
|
9567
|
+
# The identifier of the flow for the outbound call. To see the
|
9018
9568
|
# ContactFlowId in the Amazon Connect console user interface, on the
|
9019
9569
|
# navigation menu go to **Routing**, **Contact Flows**. Choose the
|
9020
|
-
#
|
9021
|
-
#
|
9022
|
-
#
|
9570
|
+
# flow. On the flow page, under the name of the flow, choose **Show
|
9571
|
+
# additional flow information**. The ContactFlowId is the last part of
|
9572
|
+
# the ARN, shown here in bold:
|
9023
9573
|
#
|
9024
9574
|
# arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
|
9025
9575
|
# @return [String]
|
@@ -9048,15 +9598,14 @@ module Aws::Connect
|
|
9048
9598
|
# @!attribute [rw] queue_id
|
9049
9599
|
# The queue for the call. If you specify a queue, the phone displayed
|
9050
9600
|
# for caller ID is the phone number specified in the queue. If you do
|
9051
|
-
# not specify a queue, the queue defined in the
|
9052
|
-
#
|
9053
|
-
# number.
|
9601
|
+
# not specify a queue, the queue defined in the flow is used. If you
|
9602
|
+
# do not specify a queue, you must specify a source phone number.
|
9054
9603
|
# @return [String]
|
9055
9604
|
#
|
9056
9605
|
# @!attribute [rw] attributes
|
9057
9606
|
# A custom key-value pair using an attribute map. The attributes are
|
9058
|
-
# standard Amazon Connect attributes, and can be accessed in
|
9059
|
-
#
|
9607
|
+
# standard Amazon Connect attributes, and can be accessed in flows
|
9608
|
+
# just like any other contact attributes.
|
9060
9609
|
#
|
9061
9610
|
# There can be up to 32,768 UTF-8 bytes across all key-value pairs per
|
9062
9611
|
# contact. Attribute keys can include only alphanumeric, dash, and
|
@@ -9142,20 +9691,20 @@ module Aws::Connect
|
|
9142
9691
|
# @return [String]
|
9143
9692
|
#
|
9144
9693
|
# @!attribute [rw] contact_flow_id
|
9145
|
-
# The identifier of the
|
9146
|
-
#
|
9147
|
-
#
|
9148
|
-
#
|
9149
|
-
#
|
9150
|
-
#
|
9694
|
+
# The identifier of the flow for initiating the tasks. To see the
|
9695
|
+
# ContactFlowId in the Amazon Connect console user interface, on the
|
9696
|
+
# navigation menu go to **Routing**, **Contact Flows**. Choose the
|
9697
|
+
# flow. On the flow page, under the name of the flow, choose **Show
|
9698
|
+
# additional flow information**. The ContactFlowId is the last part of
|
9699
|
+
# the ARN, shown here in bold:
|
9151
9700
|
#
|
9152
9701
|
# arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
|
9153
9702
|
# @return [String]
|
9154
9703
|
#
|
9155
9704
|
# @!attribute [rw] attributes
|
9156
9705
|
# A custom key-value pair using an attribute map. The attributes are
|
9157
|
-
# standard Amazon Connect attributes, and can be accessed in
|
9158
|
-
#
|
9706
|
+
# standard Amazon Connect attributes, and can be accessed in flows
|
9707
|
+
# just like any other contact attributes.
|
9159
9708
|
#
|
9160
9709
|
# There can be up to 32,768 UTF-8 bytes across all key-value pairs per
|
9161
9710
|
# contact. Attribute keys can include only alphanumeric, dash, and
|
@@ -9187,8 +9736,8 @@ module Aws::Connect
|
|
9187
9736
|
#
|
9188
9737
|
# @!attribute [rw] scheduled_time
|
9189
9738
|
# The timestamp, in Unix Epoch seconds format, at which to start
|
9190
|
-
# running the inbound
|
9191
|
-
#
|
9739
|
+
# running the inbound flow. The scheduled time cannot be in the past.
|
9740
|
+
# It must be within up to 6 days in future.
|
9192
9741
|
# @return [Time]
|
9193
9742
|
#
|
9194
9743
|
# @!attribute [rw] task_template_id
|
@@ -9469,8 +10018,9 @@ module Aws::Connect
|
|
9469
10018
|
# @return [String]
|
9470
10019
|
#
|
9471
10020
|
# @!attribute [rw] tags
|
9472
|
-
#
|
9473
|
-
# \\\{"
|
10021
|
+
# The tags used to organize, track, or control access for this
|
10022
|
+
# resource. For example, \\\{ "tags": \\\{"key1":"value1",
|
10023
|
+
# "key2":"value2"\\} \\}.
|
9474
10024
|
# @return [Hash<String,String>]
|
9475
10025
|
#
|
9476
10026
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/TagResourceRequest AWS API Documentation
|
@@ -9758,7 +10308,7 @@ module Aws::Connect
|
|
9758
10308
|
# @return [String]
|
9759
10309
|
#
|
9760
10310
|
# @!attribute [rw] contact_id
|
9761
|
-
# The identifier of the contact in this instance of Amazon Connect
|
10311
|
+
# The identifier of the contact in this instance of Amazon Connect.
|
9762
10312
|
# @return [String]
|
9763
10313
|
#
|
9764
10314
|
# @!attribute [rw] queue_id
|
@@ -9770,7 +10320,7 @@ module Aws::Connect
|
|
9770
10320
|
# @return [String]
|
9771
10321
|
#
|
9772
10322
|
# @!attribute [rw] contact_flow_id
|
9773
|
-
# The identifier of the
|
10323
|
+
# The identifier of the flow.
|
9774
10324
|
# @return [String]
|
9775
10325
|
#
|
9776
10326
|
# @!attribute [rw] client_token
|
@@ -9795,7 +10345,7 @@ module Aws::Connect
|
|
9795
10345
|
end
|
9796
10346
|
|
9797
10347
|
# @!attribute [rw] contact_id
|
9798
|
-
# The identifier of the contact in this instance of Amazon Connect
|
10348
|
+
# The identifier of the contact in this instance of Amazon Connect.
|
9799
10349
|
# @return [String]
|
9800
10350
|
#
|
9801
10351
|
# @!attribute [rw] contact_arn
|
@@ -9915,7 +10465,7 @@ module Aws::Connect
|
|
9915
10465
|
#
|
9916
10466
|
# @!attribute [rw] attributes
|
9917
10467
|
# The Amazon Connect attributes. These attributes can be accessed in
|
9918
|
-
#
|
10468
|
+
# flows just like any other contact attributes.
|
9919
10469
|
#
|
9920
10470
|
# You can have up to 32,768 UTF-8 bytes across all attributes for a
|
9921
10471
|
# contact. Attribute keys can include only alphanumeric, dash, and
|
@@ -9950,13 +10500,13 @@ module Aws::Connect
|
|
9950
10500
|
# @return [String]
|
9951
10501
|
#
|
9952
10502
|
# @!attribute [rw] contact_flow_id
|
9953
|
-
# The identifier of the
|
10503
|
+
# The identifier of the flow.
|
9954
10504
|
# @return [String]
|
9955
10505
|
#
|
9956
10506
|
# @!attribute [rw] content
|
9957
|
-
# The JSON string that represents
|
9958
|
-
#
|
9959
|
-
#
|
10507
|
+
# The JSON string that represents flow's content. For an example, see
|
10508
|
+
# [Example contact flow in Amazon Connect Flow language][1] in the
|
10509
|
+
# *Amazon Connect Administrator Guide*.
|
9960
10510
|
#
|
9961
10511
|
#
|
9962
10512
|
#
|
@@ -9990,19 +10540,19 @@ module Aws::Connect
|
|
9990
10540
|
# @return [String]
|
9991
10541
|
#
|
9992
10542
|
# @!attribute [rw] contact_flow_id
|
9993
|
-
# The identifier of the
|
10543
|
+
# The identifier of the flow.
|
9994
10544
|
# @return [String]
|
9995
10545
|
#
|
9996
10546
|
# @!attribute [rw] name
|
9997
|
-
# TThe name of the
|
10547
|
+
# TThe name of the flow.
|
9998
10548
|
# @return [String]
|
9999
10549
|
#
|
10000
10550
|
# @!attribute [rw] description
|
10001
|
-
# The description of the
|
10551
|
+
# The description of the flow.
|
10002
10552
|
# @return [String]
|
10003
10553
|
#
|
10004
10554
|
# @!attribute [rw] contact_flow_state
|
10005
|
-
# The state of
|
10555
|
+
# The state of flow.
|
10006
10556
|
# @return [String]
|
10007
10557
|
#
|
10008
10558
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowMetadataRequest AWS API Documentation
|
@@ -10032,11 +10582,11 @@ module Aws::Connect
|
|
10032
10582
|
# @return [String]
|
10033
10583
|
#
|
10034
10584
|
# @!attribute [rw] contact_flow_module_id
|
10035
|
-
# The identifier of the
|
10585
|
+
# The identifier of the flow module.
|
10036
10586
|
# @return [String]
|
10037
10587
|
#
|
10038
10588
|
# @!attribute [rw] content
|
10039
|
-
# The content of the
|
10589
|
+
# The content of the flow module.
|
10040
10590
|
# @return [String]
|
10041
10591
|
#
|
10042
10592
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowModuleContentRequest AWS API Documentation
|
@@ -10070,19 +10620,19 @@ module Aws::Connect
|
|
10070
10620
|
# @return [String]
|
10071
10621
|
#
|
10072
10622
|
# @!attribute [rw] contact_flow_module_id
|
10073
|
-
# The identifier of the
|
10623
|
+
# The identifier of the flow module.
|
10074
10624
|
# @return [String]
|
10075
10625
|
#
|
10076
10626
|
# @!attribute [rw] name
|
10077
|
-
# The name of the
|
10627
|
+
# The name of the flow module.
|
10078
10628
|
# @return [String]
|
10079
10629
|
#
|
10080
10630
|
# @!attribute [rw] description
|
10081
|
-
# The description of the
|
10631
|
+
# The description of the flow module.
|
10082
10632
|
# @return [String]
|
10083
10633
|
#
|
10084
10634
|
# @!attribute [rw] state
|
10085
|
-
# The state of
|
10635
|
+
# The state of flow module.
|
10086
10636
|
# @return [String]
|
10087
10637
|
#
|
10088
10638
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowModuleMetadataRequest AWS API Documentation
|
@@ -10116,15 +10666,15 @@ module Aws::Connect
|
|
10116
10666
|
# @return [String]
|
10117
10667
|
#
|
10118
10668
|
# @!attribute [rw] contact_flow_id
|
10119
|
-
# The identifier of the
|
10669
|
+
# The identifier of the flow.
|
10120
10670
|
# @return [String]
|
10121
10671
|
#
|
10122
10672
|
# @!attribute [rw] name
|
10123
|
-
# The name of the
|
10673
|
+
# The name of the flow.
|
10124
10674
|
# @return [String]
|
10125
10675
|
#
|
10126
10676
|
# @!attribute [rw] description
|
10127
|
-
# The description of the
|
10677
|
+
# The description of the flow.
|
10128
10678
|
# @return [String]
|
10129
10679
|
#
|
10130
10680
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactFlowNameRequest AWS API Documentation
|
@@ -10213,8 +10763,8 @@ module Aws::Connect
|
|
10213
10763
|
#
|
10214
10764
|
# @!attribute [rw] scheduled_time
|
10215
10765
|
# The timestamp, in Unix Epoch seconds format, at which to start
|
10216
|
-
# running the inbound
|
10217
|
-
#
|
10766
|
+
# running the inbound flow. The scheduled time cannot be in the past.
|
10767
|
+
# It must be within up to 6 days in future.
|
10218
10768
|
# @return [Time]
|
10219
10769
|
#
|
10220
10770
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactScheduleRequest AWS API Documentation
|
@@ -10298,7 +10848,7 @@ module Aws::Connect
|
|
10298
10848
|
#
|
10299
10849
|
# {
|
10300
10850
|
# instance_id: "InstanceId", # required
|
10301
|
-
# attribute_type: "INBOUND_CALLS", # required, accepts INBOUND_CALLS, OUTBOUND_CALLS, CONTACTFLOW_LOGS, CONTACT_LENS, AUTO_RESOLVE_BEST_VOICES, USE_CUSTOM_TTS_VOICES, EARLY_MEDIA, MULTI_PARTY_CONFERENCE
|
10851
|
+
# attribute_type: "INBOUND_CALLS", # required, accepts INBOUND_CALLS, OUTBOUND_CALLS, CONTACTFLOW_LOGS, CONTACT_LENS, AUTO_RESOLVE_BEST_VOICES, USE_CUSTOM_TTS_VOICES, EARLY_MEDIA, MULTI_PARTY_CONFERENCE, HIGH_VOLUME_OUTBOUND
|
10302
10852
|
# value: "InstanceAttributeValue", # required
|
10303
10853
|
# }
|
10304
10854
|
#
|
@@ -11429,6 +11979,99 @@ module Aws::Connect
|
|
11429
11979
|
include Aws::Structure
|
11430
11980
|
end
|
11431
11981
|
|
11982
|
+
# Data for a user.
|
11983
|
+
#
|
11984
|
+
# @!attribute [rw] user
|
11985
|
+
# Information about the user for the data that is returned. It
|
11986
|
+
# contains resourceId and ARN of the user.
|
11987
|
+
# @return [Types::UserReference]
|
11988
|
+
#
|
11989
|
+
# @!attribute [rw] routing_profile
|
11990
|
+
# Information about the routing profile that is assigned to the user.
|
11991
|
+
# @return [Types::RoutingProfileReference]
|
11992
|
+
#
|
11993
|
+
# @!attribute [rw] hierarchy_path
|
11994
|
+
# Contains information about the levels of a hierarchy group assigned
|
11995
|
+
# to a user.
|
11996
|
+
# @return [Types::HierarchyPathReference]
|
11997
|
+
#
|
11998
|
+
# @!attribute [rw] status
|
11999
|
+
# The status of the agent that they manually set in their Contact
|
12000
|
+
# Control Panel (CCP), or that the supervisor manually changes in the
|
12001
|
+
# real-time metrics report.
|
12002
|
+
# @return [Types::AgentStatusReference]
|
12003
|
+
#
|
12004
|
+
# @!attribute [rw] available_slots_by_channel
|
12005
|
+
# A map of available slots by channel. The key is a channel name. The
|
12006
|
+
# value is an integer: the available number of slots.
|
12007
|
+
# @return [Hash<String,Integer>]
|
12008
|
+
#
|
12009
|
+
# @!attribute [rw] max_slots_by_channel
|
12010
|
+
# A map of maximum slots by channel. The key is a channel name. The
|
12011
|
+
# value is an integer: the maximum number of slots. This is calculated
|
12012
|
+
# from [MediaConcurrency][1] of the RoutingProfile assigned to the
|
12013
|
+
# agent.
|
12014
|
+
#
|
12015
|
+
#
|
12016
|
+
#
|
12017
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_MediaConcurrency.html
|
12018
|
+
# @return [Hash<String,Integer>]
|
12019
|
+
#
|
12020
|
+
# @!attribute [rw] active_slots_by_channel
|
12021
|
+
# A map of active slots by channel. The key is a channel name. The
|
12022
|
+
# value is an integer: the number of active slots.
|
12023
|
+
# @return [Hash<String,Integer>]
|
12024
|
+
#
|
12025
|
+
# @!attribute [rw] contacts
|
12026
|
+
# A list of contact reference information.
|
12027
|
+
# @return [Array<Types::AgentContactReference>]
|
12028
|
+
#
|
12029
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UserData AWS API Documentation
|
12030
|
+
#
|
12031
|
+
class UserData < Struct.new(
|
12032
|
+
:user,
|
12033
|
+
:routing_profile,
|
12034
|
+
:hierarchy_path,
|
12035
|
+
:status,
|
12036
|
+
:available_slots_by_channel,
|
12037
|
+
:max_slots_by_channel,
|
12038
|
+
:active_slots_by_channel,
|
12039
|
+
:contacts)
|
12040
|
+
SENSITIVE = []
|
12041
|
+
include Aws::Structure
|
12042
|
+
end
|
12043
|
+
|
12044
|
+
# A filter for the user data.
|
12045
|
+
#
|
12046
|
+
# @note When making an API call, you may pass UserDataFilters
|
12047
|
+
# data as a hash:
|
12048
|
+
#
|
12049
|
+
# {
|
12050
|
+
# queues: ["QueueId"],
|
12051
|
+
# contact_filter: {
|
12052
|
+
# contact_states: ["INCOMING"], # accepts INCOMING, PENDING, CONNECTING, CONNECTED, CONNECTED_ONHOLD, MISSED, ERROR, ENDED, REJECTED
|
12053
|
+
# },
|
12054
|
+
# }
|
12055
|
+
#
|
12056
|
+
# @!attribute [rw] queues
|
12057
|
+
# Contains information about a queue resource for which metrics are
|
12058
|
+
# returned.
|
12059
|
+
# @return [Array<String>]
|
12060
|
+
#
|
12061
|
+
# @!attribute [rw] contact_filter
|
12062
|
+
# A filter for the user data based on the contact information that is
|
12063
|
+
# associated to the user. It contains a list of contact states.
|
12064
|
+
# @return [Types::ContactFilter]
|
12065
|
+
#
|
12066
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UserDataFilters AWS API Documentation
|
12067
|
+
#
|
12068
|
+
class UserDataFilters < Struct.new(
|
12069
|
+
:queues,
|
12070
|
+
:contact_filter)
|
12071
|
+
SENSITIVE = []
|
12072
|
+
include Aws::Structure
|
12073
|
+
end
|
12074
|
+
|
11432
12075
|
# Contains information about the identity of a user.
|
11433
12076
|
#
|
11434
12077
|
# @note When making an API call, you may pass UserIdentityInfo
|
@@ -11554,7 +12197,7 @@ module Aws::Connect
|
|
11554
12197
|
# @return [String]
|
11555
12198
|
#
|
11556
12199
|
# @!attribute [rw] contact_flow_id
|
11557
|
-
# The identifier of the
|
12200
|
+
# The identifier of the flow.
|
11558
12201
|
# @return [String]
|
11559
12202
|
#
|
11560
12203
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UserQuickConnectConfig AWS API Documentation
|
@@ -11566,6 +12209,25 @@ module Aws::Connect
|
|
11566
12209
|
include Aws::Structure
|
11567
12210
|
end
|
11568
12211
|
|
12212
|
+
# Information about the user.
|
12213
|
+
#
|
12214
|
+
# @!attribute [rw] id
|
12215
|
+
# The unique identifier for the user.
|
12216
|
+
# @return [String]
|
12217
|
+
#
|
12218
|
+
# @!attribute [rw] arn
|
12219
|
+
# The Amazon Resource Name (ARN) for the user.
|
12220
|
+
# @return [String]
|
12221
|
+
#
|
12222
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UserReference AWS API Documentation
|
12223
|
+
#
|
12224
|
+
class UserReference < Struct.new(
|
12225
|
+
:id,
|
12226
|
+
:arn)
|
12227
|
+
SENSITIVE = []
|
12228
|
+
include Aws::Structure
|
12229
|
+
end
|
12230
|
+
|
11569
12231
|
# The search criteria to be used to return users.
|
11570
12232
|
#
|
11571
12233
|
# @note When making an API call, you may pass UserSearchCriteria
|
@@ -11737,7 +12399,8 @@ module Aws::Connect
|
|
11737
12399
|
#
|
11738
12400
|
# @!attribute [rw] tags
|
11739
12401
|
# The tags used to organize, track, or control access for this
|
11740
|
-
# resource.
|
12402
|
+
# resource. For example, \\\{ "tags": \\\{"key1":"value1",
|
12403
|
+
# "key2":"value2"\\} \\}.
|
11741
12404
|
# @return [Hash<String,String>]
|
11742
12405
|
#
|
11743
12406
|
# @!attribute [rw] username
|
@@ -11835,7 +12498,8 @@ module Aws::Connect
|
|
11835
12498
|
#
|
11836
12499
|
# @!attribute [rw] tags
|
11837
12500
|
# The tags used to organize, track, or control access for this
|
11838
|
-
# resource.
|
12501
|
+
# resource. For example, \\\{ "tags": \\\{"key1":"value1",
|
12502
|
+
# "key2":"value2"\\} \\}.
|
11839
12503
|
# @return [Hash<String,String>]
|
11840
12504
|
#
|
11841
12505
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Vocabulary AWS API Documentation
|