aws-sdk-connect 1.72.0 → 1.75.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 +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
@@ -600,8 +600,8 @@ module Aws::Connect
|
|
600
600
|
req.send_request(options)
|
601
601
|
end
|
602
602
|
|
603
|
-
# Associates a
|
604
|
-
#
|
603
|
+
# Associates a flow with a phone number claimed to your Amazon Connect
|
604
|
+
# instance.
|
605
605
|
#
|
606
606
|
# @option params [required, String] :phone_number_id
|
607
607
|
# A unique identifier for the phone number.
|
@@ -611,7 +611,7 @@ module Aws::Connect
|
|
611
611
|
# instanceId in the ARN of the instance.
|
612
612
|
#
|
613
613
|
# @option params [required, String] :contact_flow_id
|
614
|
-
# The identifier of the
|
614
|
+
# The identifier of the flow.
|
615
615
|
#
|
616
616
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
617
617
|
#
|
@@ -757,6 +757,8 @@ module Aws::Connect
|
|
757
757
|
#
|
758
758
|
# @option params [Hash<String,String>] :tags
|
759
759
|
# The tags used to organize, track, or control access for this resource.
|
760
|
+
# For example, \\\{ "tags": \\\{"key1":"value1",
|
761
|
+
# "key2":"value2"\\} \\}.
|
760
762
|
#
|
761
763
|
# @option params [String] :client_token
|
762
764
|
# A unique, case-sensitive identifier that you provide to ensure the
|
@@ -819,6 +821,8 @@ module Aws::Connect
|
|
819
821
|
#
|
820
822
|
# @option params [Hash<String,String>] :tags
|
821
823
|
# The tags used to organize, track, or control access for this resource.
|
824
|
+
# For example, \\\{ "tags": \\\{"key1":"value1",
|
825
|
+
# "key2":"value2"\\} \\}.
|
822
826
|
#
|
823
827
|
# @return [Types::CreateAgentStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
824
828
|
#
|
@@ -852,10 +856,10 @@ module Aws::Connect
|
|
852
856
|
req.send_request(options)
|
853
857
|
end
|
854
858
|
|
855
|
-
# Creates a
|
859
|
+
# Creates a flow for the specified Amazon Connect instance.
|
856
860
|
#
|
857
|
-
# You can also create and update
|
858
|
-
#
|
861
|
+
# You can also create and update flows using the [Amazon Connect Flow
|
862
|
+
# language][1].
|
859
863
|
#
|
860
864
|
#
|
861
865
|
#
|
@@ -865,25 +869,26 @@ module Aws::Connect
|
|
865
869
|
# The identifier of the Amazon Connect instance.
|
866
870
|
#
|
867
871
|
# @option params [required, String] :name
|
868
|
-
# The name of the
|
872
|
+
# The name of the flow.
|
869
873
|
#
|
870
874
|
# @option params [required, String] :type
|
871
|
-
# The type of the
|
872
|
-
#
|
873
|
-
# Administrator Guide*.
|
875
|
+
# The type of the flow. For descriptions of the available types, see
|
876
|
+
# [Choose a flow type][1] in the *Amazon Connect Administrator Guide*.
|
874
877
|
#
|
875
878
|
#
|
876
879
|
#
|
877
880
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types
|
878
881
|
#
|
879
882
|
# @option params [String] :description
|
880
|
-
# The description of the
|
883
|
+
# The description of the flow.
|
881
884
|
#
|
882
885
|
# @option params [required, String] :content
|
883
|
-
# The content of the
|
886
|
+
# The content of the flow.
|
884
887
|
#
|
885
888
|
# @option params [Hash<String,String>] :tags
|
886
|
-
#
|
889
|
+
# The tags used to organize, track, or control access for this resource.
|
890
|
+
# For example, \\\{ "tags": \\\{"key1":"value1",
|
891
|
+
# "key2":"value2"\\} \\}.
|
887
892
|
#
|
888
893
|
# @return [Types::CreateContactFlowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
889
894
|
#
|
@@ -917,24 +922,25 @@ module Aws::Connect
|
|
917
922
|
req.send_request(options)
|
918
923
|
end
|
919
924
|
|
920
|
-
# Creates a
|
921
|
-
# instance.
|
925
|
+
# Creates a flow module for the specified Amazon Connect instance.
|
922
926
|
#
|
923
927
|
# @option params [required, String] :instance_id
|
924
928
|
# The identifier of the Amazon Connect instance. You can find the
|
925
929
|
# instanceId in the ARN of the instance.
|
926
930
|
#
|
927
931
|
# @option params [required, String] :name
|
928
|
-
# The name of the
|
932
|
+
# The name of the flow module.
|
929
933
|
#
|
930
934
|
# @option params [String] :description
|
931
|
-
# The description of the
|
935
|
+
# The description of the flow module.
|
932
936
|
#
|
933
937
|
# @option params [required, String] :content
|
934
|
-
# The content of the
|
938
|
+
# The content of the flow module.
|
935
939
|
#
|
936
940
|
# @option params [Hash<String,String>] :tags
|
937
941
|
# The tags used to organize, track, or control access for this resource.
|
942
|
+
# For example, \\\{ "tags": \\\{"key1":"value1",
|
943
|
+
# "key2":"value2"\\} \\}.
|
938
944
|
#
|
939
945
|
# @option params [String] :client_token
|
940
946
|
# A unique, case-sensitive identifier that you provide to ensure the
|
@@ -999,6 +1005,8 @@ module Aws::Connect
|
|
999
1005
|
#
|
1000
1006
|
# @option params [Hash<String,String>] :tags
|
1001
1007
|
# The tags used to organize, track, or control access for this resource.
|
1008
|
+
# For example, \\\{ "tags": \\\{"key1":"value1",
|
1009
|
+
# "key2":"value2"\\} \\}.
|
1002
1010
|
#
|
1003
1011
|
# @return [Types::CreateHoursOfOperationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1004
1012
|
#
|
@@ -1120,6 +1128,11 @@ module Aws::Connect
|
|
1120
1128
|
# @option params [required, String] :integration_arn
|
1121
1129
|
# The Amazon Resource Name (ARN) of the integration.
|
1122
1130
|
#
|
1131
|
+
# <note markdown="1"> When integrating with Amazon Pinpoint, the Amazon Connect and Amazon
|
1132
|
+
# Pinpoint instances must be in the same account.
|
1133
|
+
#
|
1134
|
+
# </note>
|
1135
|
+
#
|
1123
1136
|
# @option params [String] :source_application_url
|
1124
1137
|
# The URL for the external application. This field is only required for
|
1125
1138
|
# the EVENT integration type.
|
@@ -1134,6 +1147,8 @@ module Aws::Connect
|
|
1134
1147
|
#
|
1135
1148
|
# @option params [Hash<String,String>] :tags
|
1136
1149
|
# The tags used to organize, track, or control access for this resource.
|
1150
|
+
# For example, \\\{ "tags": \\\{"key1":"value1",
|
1151
|
+
# "key2":"value2"\\} \\}.
|
1137
1152
|
#
|
1138
1153
|
# @return [Types::CreateIntegrationAssociationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1139
1154
|
#
|
@@ -1198,6 +1213,8 @@ module Aws::Connect
|
|
1198
1213
|
#
|
1199
1214
|
# @option params [Hash<String,String>] :tags
|
1200
1215
|
# The tags used to organize, track, or control access for this resource.
|
1216
|
+
# For example, \\\{ "tags": \\\{"key1":"value1",
|
1217
|
+
# "key2":"value2"\\} \\}.
|
1201
1218
|
#
|
1202
1219
|
# @return [Types::CreateQueueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1203
1220
|
#
|
@@ -1254,6 +1271,8 @@ module Aws::Connect
|
|
1254
1271
|
#
|
1255
1272
|
# @option params [Hash<String,String>] :tags
|
1256
1273
|
# The tags used to organize, track, or control access for this resource.
|
1274
|
+
# For example, \\\{ "tags": \\\{"key1":"value1",
|
1275
|
+
# "key2":"value2"\\} \\}.
|
1257
1276
|
#
|
1258
1277
|
# @return [Types::CreateQuickConnectResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1259
1278
|
#
|
@@ -1324,7 +1343,9 @@ module Aws::Connect
|
|
1324
1343
|
# for this routing profile.
|
1325
1344
|
#
|
1326
1345
|
# @option params [Hash<String,String>] :tags
|
1327
|
-
#
|
1346
|
+
# The tags used to organize, track, or control access for this resource.
|
1347
|
+
# For example, \\\{ "tags": \\\{"key1":"value1",
|
1348
|
+
# "key2":"value2"\\} \\}.
|
1328
1349
|
#
|
1329
1350
|
# @return [Types::CreateRoutingProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1330
1351
|
#
|
@@ -1393,6 +1414,8 @@ module Aws::Connect
|
|
1393
1414
|
#
|
1394
1415
|
# @option params [Hash<String,String>] :tags
|
1395
1416
|
# The tags used to organize, track, or control access for this resource.
|
1417
|
+
# For example, \\\{ "tags": \\\{"key1":"value1",
|
1418
|
+
# "key2":"value2"\\} \\}.
|
1396
1419
|
#
|
1397
1420
|
# @return [Types::CreateSecurityProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1398
1421
|
#
|
@@ -1552,6 +1575,8 @@ module Aws::Connect
|
|
1552
1575
|
#
|
1553
1576
|
# @option params [Hash<String,String>] :tags
|
1554
1577
|
# The tags used to organize, track, or control access for this resource.
|
1578
|
+
# For example, \\\{ "tags": \\\{"key1":"value1",
|
1579
|
+
# "key2":"value2"\\} \\}.
|
1555
1580
|
#
|
1556
1581
|
# @return [Types::CreateUseCaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1557
1582
|
#
|
@@ -1637,7 +1662,9 @@ module Aws::Connect
|
|
1637
1662
|
# instanceId in the ARN of the instance.
|
1638
1663
|
#
|
1639
1664
|
# @option params [Hash<String,String>] :tags
|
1640
|
-
#
|
1665
|
+
# The tags used to organize, track, or control access for this resource.
|
1666
|
+
# For example, \\\{ "tags": \\\{"key1":"value1",
|
1667
|
+
# "key2":"value2"\\} \\}.
|
1641
1668
|
#
|
1642
1669
|
# @return [Types::CreateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1643
1670
|
#
|
@@ -1700,6 +1727,8 @@ module Aws::Connect
|
|
1700
1727
|
#
|
1701
1728
|
# @option params [Hash<String,String>] :tags
|
1702
1729
|
# The tags used to organize, track, or control access for this resource.
|
1730
|
+
# For example, \\\{ "tags": \\\{"key1":"value1",
|
1731
|
+
# "key2":"value2"\\} \\}.
|
1703
1732
|
#
|
1704
1733
|
# @return [Types::CreateUserHierarchyGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1705
1734
|
#
|
@@ -1775,6 +1804,8 @@ module Aws::Connect
|
|
1775
1804
|
#
|
1776
1805
|
# @option params [Hash<String,String>] :tags
|
1777
1806
|
# The tags used to organize, track, or control access for this resource.
|
1807
|
+
# For example, \\\{ "tags": \\\{"key1":"value1",
|
1808
|
+
# "key2":"value2"\\} \\}.
|
1778
1809
|
#
|
1779
1810
|
# @return [Types::CreateVocabularyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1780
1811
|
#
|
@@ -1810,14 +1841,14 @@ module Aws::Connect
|
|
1810
1841
|
req.send_request(options)
|
1811
1842
|
end
|
1812
1843
|
|
1813
|
-
# Deletes a
|
1844
|
+
# Deletes a flow for the specified Amazon Connect instance.
|
1814
1845
|
#
|
1815
1846
|
# @option params [required, String] :instance_id
|
1816
1847
|
# The identifier of the Amazon Connect instance. You can find the
|
1817
1848
|
# instanceId in the ARN of the instance.
|
1818
1849
|
#
|
1819
1850
|
# @option params [required, String] :contact_flow_id
|
1820
|
-
# The identifier of the
|
1851
|
+
# The identifier of the flow.
|
1821
1852
|
#
|
1822
1853
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1823
1854
|
#
|
@@ -1837,14 +1868,14 @@ module Aws::Connect
|
|
1837
1868
|
req.send_request(options)
|
1838
1869
|
end
|
1839
1870
|
|
1840
|
-
# Deletes the specified
|
1871
|
+
# Deletes the specified flow module.
|
1841
1872
|
#
|
1842
1873
|
# @option params [required, String] :instance_id
|
1843
1874
|
# The identifier of the Amazon Connect instance. You can find the
|
1844
1875
|
# instanceId in the ARN of the instance.
|
1845
1876
|
#
|
1846
1877
|
# @option params [required, String] :contact_flow_module_id
|
1847
|
-
# The identifier of the
|
1878
|
+
# The identifier of the flow module.
|
1848
1879
|
#
|
1849
1880
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1850
1881
|
#
|
@@ -2269,10 +2300,10 @@ module Aws::Connect
|
|
2269
2300
|
req.send_request(options)
|
2270
2301
|
end
|
2271
2302
|
|
2272
|
-
# Describes the specified
|
2303
|
+
# Describes the specified flow.
|
2273
2304
|
#
|
2274
|
-
# You can also create and update
|
2275
|
-
#
|
2305
|
+
# You can also create and update flows using the [Amazon Connect Flow
|
2306
|
+
# language][1].
|
2276
2307
|
#
|
2277
2308
|
#
|
2278
2309
|
#
|
@@ -2282,7 +2313,7 @@ module Aws::Connect
|
|
2282
2313
|
# The identifier of the Amazon Connect instance.
|
2283
2314
|
#
|
2284
2315
|
# @option params [required, String] :contact_flow_id
|
2285
|
-
# The identifier of the
|
2316
|
+
# The identifier of the flow.
|
2286
2317
|
#
|
2287
2318
|
# @return [Types::DescribeContactFlowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2288
2319
|
#
|
@@ -2316,14 +2347,14 @@ module Aws::Connect
|
|
2316
2347
|
req.send_request(options)
|
2317
2348
|
end
|
2318
2349
|
|
2319
|
-
# Describes the specified
|
2350
|
+
# Describes the specified flow module.
|
2320
2351
|
#
|
2321
2352
|
# @option params [required, String] :instance_id
|
2322
2353
|
# The identifier of the Amazon Connect instance. You can find the
|
2323
2354
|
# instanceId in the ARN of the instance.
|
2324
2355
|
#
|
2325
2356
|
# @option params [required, String] :contact_flow_module_id
|
2326
|
-
# The identifier of the
|
2357
|
+
# The identifier of the flow module.
|
2327
2358
|
#
|
2328
2359
|
# @return [Types::DescribeContactFlowModuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2329
2360
|
#
|
@@ -2473,12 +2504,12 @@ module Aws::Connect
|
|
2473
2504
|
#
|
2474
2505
|
# resp = client.describe_instance_attribute({
|
2475
2506
|
# instance_id: "InstanceId", # required
|
2476
|
-
# 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
|
2507
|
+
# 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
|
2477
2508
|
# })
|
2478
2509
|
#
|
2479
2510
|
# @example Response structure
|
2480
2511
|
#
|
2481
|
-
# resp.attribute.attribute_type #=> String, one of "INBOUND_CALLS", "OUTBOUND_CALLS", "CONTACTFLOW_LOGS", "CONTACT_LENS", "AUTO_RESOLVE_BEST_VOICES", "USE_CUSTOM_TTS_VOICES", "EARLY_MEDIA", "MULTI_PARTY_CONFERENCE"
|
2512
|
+
# resp.attribute.attribute_type #=> String, one of "INBOUND_CALLS", "OUTBOUND_CALLS", "CONTACTFLOW_LOGS", "CONTACT_LENS", "AUTO_RESOLVE_BEST_VOICES", "USE_CUSTOM_TTS_VOICES", "EARLY_MEDIA", "MULTI_PARTY_CONFERENCE", "HIGH_VOLUME_OUTBOUND"
|
2482
2513
|
# resp.attribute.value #=> String
|
2483
2514
|
#
|
2484
2515
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeInstanceAttribute AWS API Documentation
|
@@ -3059,7 +3090,7 @@ module Aws::Connect
|
|
3059
3090
|
# change.
|
3060
3091
|
#
|
3061
3092
|
# Remove the Lambda function from the dropdown options available in the
|
3062
|
-
# relevant
|
3093
|
+
# relevant flow blocks.
|
3063
3094
|
#
|
3064
3095
|
# @option params [required, String] :instance_id
|
3065
3096
|
# The identifier of the Amazon Connect instance. You can find the
|
@@ -3122,8 +3153,8 @@ module Aws::Connect
|
|
3122
3153
|
req.send_request(options)
|
3123
3154
|
end
|
3124
3155
|
|
3125
|
-
# Removes the
|
3126
|
-
#
|
3156
|
+
# Removes the flow association from a phone number claimed to your
|
3157
|
+
# Amazon Connect instance, if a flow association exists.
|
3127
3158
|
#
|
3128
3159
|
# @option params [required, String] :phone_number_id
|
3129
3160
|
# A unique identifier for the phone number.
|
@@ -3488,6 +3519,92 @@ module Aws::Connect
|
|
3488
3519
|
req.send_request(options)
|
3489
3520
|
end
|
3490
3521
|
|
3522
|
+
# Gets the real-time active user data from the specified Amazon Connect
|
3523
|
+
# instance.
|
3524
|
+
#
|
3525
|
+
# @option params [required, String] :instance_id
|
3526
|
+
# The identifier of the Amazon Connect instance. You can find the
|
3527
|
+
# instanceId in the ARN of the instance.
|
3528
|
+
#
|
3529
|
+
# @option params [required, Types::UserDataFilters] :filters
|
3530
|
+
# Filters up to 100 `Queues`, or up to 9 `ContactStates`. The user data
|
3531
|
+
# is retrieved only for those users who are associated with the queues
|
3532
|
+
# and have contacts that are in the specified `ContactState`.
|
3533
|
+
#
|
3534
|
+
# @option params [String] :next_token
|
3535
|
+
# The token for the next set of results. Use the value returned in the
|
3536
|
+
# previous response in the next request to retrieve the next set of
|
3537
|
+
# results.
|
3538
|
+
#
|
3539
|
+
# @option params [Integer] :max_results
|
3540
|
+
# The maximum number of results to return per page.
|
3541
|
+
#
|
3542
|
+
# @return [Types::GetCurrentUserDataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3543
|
+
#
|
3544
|
+
# * {Types::GetCurrentUserDataResponse#next_token #next_token} => String
|
3545
|
+
# * {Types::GetCurrentUserDataResponse#user_data_list #user_data_list} => Array<Types::UserData>
|
3546
|
+
#
|
3547
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3548
|
+
#
|
3549
|
+
# @example Request syntax with placeholder values
|
3550
|
+
#
|
3551
|
+
# resp = client.get_current_user_data({
|
3552
|
+
# instance_id: "InstanceId", # required
|
3553
|
+
# filters: { # required
|
3554
|
+
# queues: ["QueueId"],
|
3555
|
+
# contact_filter: {
|
3556
|
+
# contact_states: ["INCOMING"], # accepts INCOMING, PENDING, CONNECTING, CONNECTED, CONNECTED_ONHOLD, MISSED, ERROR, ENDED, REJECTED
|
3557
|
+
# },
|
3558
|
+
# },
|
3559
|
+
# next_token: "NextToken",
|
3560
|
+
# max_results: 1,
|
3561
|
+
# })
|
3562
|
+
#
|
3563
|
+
# @example Response structure
|
3564
|
+
#
|
3565
|
+
# resp.next_token #=> String
|
3566
|
+
# resp.user_data_list #=> Array
|
3567
|
+
# resp.user_data_list[0].user.id #=> String
|
3568
|
+
# resp.user_data_list[0].user.arn #=> String
|
3569
|
+
# resp.user_data_list[0].routing_profile.id #=> String
|
3570
|
+
# resp.user_data_list[0].routing_profile.arn #=> String
|
3571
|
+
# resp.user_data_list[0].hierarchy_path.level_one.id #=> String
|
3572
|
+
# resp.user_data_list[0].hierarchy_path.level_one.arn #=> String
|
3573
|
+
# resp.user_data_list[0].hierarchy_path.level_two.id #=> String
|
3574
|
+
# resp.user_data_list[0].hierarchy_path.level_two.arn #=> String
|
3575
|
+
# resp.user_data_list[0].hierarchy_path.level_three.id #=> String
|
3576
|
+
# resp.user_data_list[0].hierarchy_path.level_three.arn #=> String
|
3577
|
+
# resp.user_data_list[0].hierarchy_path.level_four.id #=> String
|
3578
|
+
# resp.user_data_list[0].hierarchy_path.level_four.arn #=> String
|
3579
|
+
# resp.user_data_list[0].hierarchy_path.level_five.id #=> String
|
3580
|
+
# resp.user_data_list[0].hierarchy_path.level_five.arn #=> String
|
3581
|
+
# resp.user_data_list[0].status.status_start_timestamp #=> Time
|
3582
|
+
# resp.user_data_list[0].status.status_arn #=> String
|
3583
|
+
# resp.user_data_list[0].available_slots_by_channel #=> Hash
|
3584
|
+
# resp.user_data_list[0].available_slots_by_channel["Channel"] #=> Integer
|
3585
|
+
# resp.user_data_list[0].max_slots_by_channel #=> Hash
|
3586
|
+
# resp.user_data_list[0].max_slots_by_channel["Channel"] #=> Integer
|
3587
|
+
# resp.user_data_list[0].active_slots_by_channel #=> Hash
|
3588
|
+
# resp.user_data_list[0].active_slots_by_channel["Channel"] #=> Integer
|
3589
|
+
# resp.user_data_list[0].contacts #=> Array
|
3590
|
+
# resp.user_data_list[0].contacts[0].contact_id #=> String
|
3591
|
+
# resp.user_data_list[0].contacts[0].channel #=> String, one of "VOICE", "CHAT", "TASK"
|
3592
|
+
# resp.user_data_list[0].contacts[0].initiation_method #=> String, one of "INBOUND", "OUTBOUND", "TRANSFER", "QUEUE_TRANSFER", "CALLBACK", "API"
|
3593
|
+
# resp.user_data_list[0].contacts[0].agent_contact_state #=> String, one of "INCOMING", "PENDING", "CONNECTING", "CONNECTED", "CONNECTED_ONHOLD", "MISSED", "ERROR", "ENDED", "REJECTED"
|
3594
|
+
# resp.user_data_list[0].contacts[0].state_start_timestamp #=> Time
|
3595
|
+
# resp.user_data_list[0].contacts[0].connected_to_agent_timestamp #=> Time
|
3596
|
+
# resp.user_data_list[0].contacts[0].queue.id #=> String
|
3597
|
+
# resp.user_data_list[0].contacts[0].queue.arn #=> String
|
3598
|
+
#
|
3599
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetCurrentUserData AWS API Documentation
|
3600
|
+
#
|
3601
|
+
# @overload get_current_user_data(params = {})
|
3602
|
+
# @param [Hash] params ({})
|
3603
|
+
def get_current_user_data(params = {}, options = {})
|
3604
|
+
req = build_request(:get_current_user_data, params)
|
3605
|
+
req.send_request(options)
|
3606
|
+
end
|
3607
|
+
|
3491
3608
|
# Retrieves a token for federation.
|
3492
3609
|
#
|
3493
3610
|
# <note markdown="1"> This API doesn't support root users. If you try to invoke
|
@@ -4050,8 +4167,8 @@ module Aws::Connect
|
|
4050
4167
|
req.send_request(options)
|
4051
4168
|
end
|
4052
4169
|
|
4053
|
-
# Provides information about the
|
4054
|
-
#
|
4170
|
+
# Provides information about the flow modules for the specified Amazon
|
4171
|
+
# Connect instance.
|
4055
4172
|
#
|
4056
4173
|
# @option params [required, String] :instance_id
|
4057
4174
|
# The identifier of the Amazon Connect instance. You can find the
|
@@ -4066,7 +4183,7 @@ module Aws::Connect
|
|
4066
4183
|
# The maximum number of results to return per page.
|
4067
4184
|
#
|
4068
4185
|
# @option params [String] :contact_flow_module_state
|
4069
|
-
# The state of the
|
4186
|
+
# The state of the flow module.
|
4070
4187
|
#
|
4071
4188
|
# @return [Types::ListContactFlowModulesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4072
4189
|
#
|
@@ -4102,14 +4219,14 @@ module Aws::Connect
|
|
4102
4219
|
req.send_request(options)
|
4103
4220
|
end
|
4104
4221
|
|
4105
|
-
# Provides information about the
|
4106
|
-
#
|
4222
|
+
# Provides information about the flows for the specified Amazon Connect
|
4223
|
+
# instance.
|
4107
4224
|
#
|
4108
|
-
# You can also create and update
|
4109
|
-
#
|
4225
|
+
# You can also create and update flows using the [Amazon Connect Flow
|
4226
|
+
# language][1].
|
4110
4227
|
#
|
4111
|
-
# For more information about
|
4112
|
-
#
|
4228
|
+
# For more information about flows, see [Flows][2] in the *Amazon
|
4229
|
+
# Connect Administrator Guide*.
|
4113
4230
|
#
|
4114
4231
|
#
|
4115
4232
|
#
|
@@ -4121,7 +4238,7 @@ module Aws::Connect
|
|
4121
4238
|
# instanceId in the ARN of the instance.
|
4122
4239
|
#
|
4123
4240
|
# @option params [Array<String>] :contact_flow_types
|
4124
|
-
# The type of
|
4241
|
+
# The type of flow.
|
4125
4242
|
#
|
4126
4243
|
# @option params [String] :next_token
|
4127
4244
|
# The token for the next set of results. Use the value returned in the
|
@@ -4129,7 +4246,8 @@ module Aws::Connect
|
|
4129
4246
|
# results.
|
4130
4247
|
#
|
4131
4248
|
# @option params [Integer] :max_results
|
4132
|
-
# The maximum number of results to return per page.
|
4249
|
+
# The maximum number of results to return per page. The default
|
4250
|
+
# MaxResult size is 100.
|
4133
4251
|
#
|
4134
4252
|
# @return [Types::ListContactFlowsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4135
4253
|
#
|
@@ -4311,7 +4429,8 @@ module Aws::Connect
|
|
4311
4429
|
# results.
|
4312
4430
|
#
|
4313
4431
|
# @option params [Integer] :max_results
|
4314
|
-
# The maximum number of results to return per page.
|
4432
|
+
# The maximum number of results to return per page. The default
|
4433
|
+
# MaxResult size is 100.
|
4315
4434
|
#
|
4316
4435
|
# @return [Types::ListHoursOfOperationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4317
4436
|
#
|
@@ -4381,7 +4500,7 @@ module Aws::Connect
|
|
4381
4500
|
# @example Response structure
|
4382
4501
|
#
|
4383
4502
|
# resp.attributes #=> Array
|
4384
|
-
# resp.attributes[0].attribute_type #=> String, one of "INBOUND_CALLS", "OUTBOUND_CALLS", "CONTACTFLOW_LOGS", "CONTACT_LENS", "AUTO_RESOLVE_BEST_VOICES", "USE_CUSTOM_TTS_VOICES", "EARLY_MEDIA", "MULTI_PARTY_CONFERENCE"
|
4503
|
+
# resp.attributes[0].attribute_type #=> String, one of "INBOUND_CALLS", "OUTBOUND_CALLS", "CONTACTFLOW_LOGS", "CONTACT_LENS", "AUTO_RESOLVE_BEST_VOICES", "USE_CUSTOM_TTS_VOICES", "EARLY_MEDIA", "MULTI_PARTY_CONFERENCE", "HIGH_VOLUME_OUTBOUND"
|
4385
4504
|
# resp.attributes[0].value #=> String
|
4386
4505
|
# resp.next_token #=> String
|
4387
4506
|
#
|
@@ -4570,7 +4689,7 @@ module Aws::Connect
|
|
4570
4689
|
# change.
|
4571
4690
|
#
|
4572
4691
|
# Returns a paginated list of all Lambda functions that display in the
|
4573
|
-
# dropdown options in the relevant
|
4692
|
+
# dropdown options in the relevant flow blocks.
|
4574
4693
|
#
|
4575
4694
|
# @option params [required, String] :instance_id
|
4576
4695
|
# The identifier of the Amazon Connect instance. You can find the
|
@@ -4691,7 +4810,8 @@ module Aws::Connect
|
|
4691
4810
|
# results.
|
4692
4811
|
#
|
4693
4812
|
# @option params [Integer] :max_results
|
4694
|
-
# The maximum number of results to return per page.
|
4813
|
+
# The maximum number of results to return per page. The default
|
4814
|
+
# MaxResult size is 100.
|
4695
4815
|
#
|
4696
4816
|
# @return [Types::ListPhoneNumbersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4697
4817
|
#
|
@@ -4813,7 +4933,8 @@ module Aws::Connect
|
|
4813
4933
|
# results.
|
4814
4934
|
#
|
4815
4935
|
# @option params [Integer] :max_results
|
4816
|
-
# The maximum number of results to return per page.
|
4936
|
+
# The maximum number of results to return per page. The default
|
4937
|
+
# MaxResult size is 100.
|
4817
4938
|
#
|
4818
4939
|
# @return [Types::ListPromptsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4819
4940
|
#
|
@@ -4865,7 +4986,8 @@ module Aws::Connect
|
|
4865
4986
|
# results.
|
4866
4987
|
#
|
4867
4988
|
# @option params [Integer] :max_results
|
4868
|
-
# The maximum number of results to return per page.
|
4989
|
+
# The maximum number of results to return per page. The default
|
4990
|
+
# MaxResult size is 100.
|
4869
4991
|
#
|
4870
4992
|
# @return [Types::ListQueueQuickConnectsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4871
4993
|
#
|
@@ -4929,7 +5051,8 @@ module Aws::Connect
|
|
4929
5051
|
# results.
|
4930
5052
|
#
|
4931
5053
|
# @option params [Integer] :max_results
|
4932
|
-
# The maximum number of results to return per page.
|
5054
|
+
# The maximum number of results to return per page. The default
|
5055
|
+
# MaxResult size is 100.
|
4933
5056
|
#
|
4934
5057
|
# @return [Types::ListQueuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4935
5058
|
#
|
@@ -4978,7 +5101,8 @@ module Aws::Connect
|
|
4978
5101
|
# results.
|
4979
5102
|
#
|
4980
5103
|
# @option params [Integer] :max_results
|
4981
|
-
# The maximum number of results to return per page.
|
5104
|
+
# The maximum number of results to return per page. The default
|
5105
|
+
# MaxResult size is 100.
|
4982
5106
|
#
|
4983
5107
|
# @option params [Array<String>] :quick_connect_types
|
4984
5108
|
# The type of quick connect. In the Amazon Connect console, when you
|
@@ -5035,7 +5159,8 @@ module Aws::Connect
|
|
5035
5159
|
# results.
|
5036
5160
|
#
|
5037
5161
|
# @option params [Integer] :max_results
|
5038
|
-
# The maximum number of results to return per page.
|
5162
|
+
# The maximum number of results to return per page. The default
|
5163
|
+
# MaxResult size is 100.
|
5039
5164
|
#
|
5040
5165
|
# @return [Types::ListRoutingProfileQueuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5041
5166
|
#
|
@@ -5095,7 +5220,8 @@ module Aws::Connect
|
|
5095
5220
|
# results.
|
5096
5221
|
#
|
5097
5222
|
# @option params [Integer] :max_results
|
5098
|
-
# The maximum number of results to return per page.
|
5223
|
+
# The maximum number of results to return per page. The default
|
5224
|
+
# MaxResult size is 100.
|
5099
5225
|
#
|
5100
5226
|
# @return [Types::ListRoutingProfilesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5101
5227
|
#
|
@@ -5250,7 +5376,8 @@ module Aws::Connect
|
|
5250
5376
|
# results.
|
5251
5377
|
#
|
5252
5378
|
# @option params [Integer] :max_results
|
5253
|
-
# The maximum number of results to return per page.
|
5379
|
+
# The maximum number of results to return per page. The default
|
5380
|
+
# MaxResult size is 100.
|
5254
5381
|
#
|
5255
5382
|
# @return [Types::ListSecurityProfilesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5256
5383
|
#
|
@@ -5456,7 +5583,8 @@ module Aws::Connect
|
|
5456
5583
|
# results.
|
5457
5584
|
#
|
5458
5585
|
# @option params [Integer] :max_results
|
5459
|
-
# The maximum number of results to return per page.
|
5586
|
+
# The maximum number of results to return per page. The default
|
5587
|
+
# MaxResult size is 100.
|
5460
5588
|
#
|
5461
5589
|
# @return [Types::ListUserHierarchyGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5462
5590
|
#
|
@@ -5503,7 +5631,8 @@ module Aws::Connect
|
|
5503
5631
|
# results.
|
5504
5632
|
#
|
5505
5633
|
# @option params [Integer] :max_results
|
5506
|
-
# The maximum number of results to return per page.
|
5634
|
+
# The maximum number of results to return per page. The default
|
5635
|
+
# MaxResult size is 100.
|
5507
5636
|
#
|
5508
5637
|
# @return [Types::ListUsersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5509
5638
|
#
|
@@ -5704,6 +5833,107 @@ module Aws::Connect
|
|
5704
5833
|
req.send_request(options)
|
5705
5834
|
end
|
5706
5835
|
|
5836
|
+
# This API is in preview release for Amazon Connect and is subject to
|
5837
|
+
# change.
|
5838
|
+
#
|
5839
|
+
# Searches security profiles in an Amazon Connect instance, with
|
5840
|
+
# optional filtering.
|
5841
|
+
#
|
5842
|
+
# @option params [required, String] :instance_id
|
5843
|
+
# The identifier of the Amazon Connect instance. You can find the
|
5844
|
+
# instanceId in the ARN of the instance.
|
5845
|
+
#
|
5846
|
+
# @option params [String] :next_token
|
5847
|
+
# The token for the next set of results. Use the value returned in the
|
5848
|
+
# previous response in the next request to retrieve the next set of
|
5849
|
+
# results.
|
5850
|
+
#
|
5851
|
+
# @option params [Integer] :max_results
|
5852
|
+
# The maximum number of results to return per page.
|
5853
|
+
#
|
5854
|
+
# @option params [Types::SecurityProfileSearchCriteria] :search_criteria
|
5855
|
+
# The search criteria to be used to return security profiles.
|
5856
|
+
#
|
5857
|
+
# @option params [Types::SecurityProfilesSearchFilter] :search_filter
|
5858
|
+
# Filters to be applied to search results.
|
5859
|
+
#
|
5860
|
+
# @return [Types::SearchSecurityProfilesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5861
|
+
#
|
5862
|
+
# * {Types::SearchSecurityProfilesResponse#security_profiles #security_profiles} => Array<Types::SecurityProfileSearchSummary>
|
5863
|
+
# * {Types::SearchSecurityProfilesResponse#next_token #next_token} => String
|
5864
|
+
# * {Types::SearchSecurityProfilesResponse#approximate_total_count #approximate_total_count} => Integer
|
5865
|
+
#
|
5866
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5867
|
+
#
|
5868
|
+
# @example Request syntax with placeholder values
|
5869
|
+
#
|
5870
|
+
# resp = client.search_security_profiles({
|
5871
|
+
# instance_id: "InstanceId", # required
|
5872
|
+
# next_token: "NextToken2500",
|
5873
|
+
# max_results: 1,
|
5874
|
+
# search_criteria: {
|
5875
|
+
# or_conditions: [
|
5876
|
+
# {
|
5877
|
+
# # recursive SecurityProfileSearchCriteria
|
5878
|
+
# },
|
5879
|
+
# ],
|
5880
|
+
# and_conditions: [
|
5881
|
+
# {
|
5882
|
+
# # recursive SecurityProfileSearchCriteria
|
5883
|
+
# },
|
5884
|
+
# ],
|
5885
|
+
# string_condition: {
|
5886
|
+
# field_name: "String",
|
5887
|
+
# value: "String",
|
5888
|
+
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
5889
|
+
# },
|
5890
|
+
# },
|
5891
|
+
# search_filter: {
|
5892
|
+
# tag_filter: {
|
5893
|
+
# or_conditions: [
|
5894
|
+
# [
|
5895
|
+
# {
|
5896
|
+
# tag_key: "String",
|
5897
|
+
# tag_value: "String",
|
5898
|
+
# },
|
5899
|
+
# ],
|
5900
|
+
# ],
|
5901
|
+
# and_conditions: [
|
5902
|
+
# {
|
5903
|
+
# tag_key: "String",
|
5904
|
+
# tag_value: "String",
|
5905
|
+
# },
|
5906
|
+
# ],
|
5907
|
+
# tag_condition: {
|
5908
|
+
# tag_key: "String",
|
5909
|
+
# tag_value: "String",
|
5910
|
+
# },
|
5911
|
+
# },
|
5912
|
+
# },
|
5913
|
+
# })
|
5914
|
+
#
|
5915
|
+
# @example Response structure
|
5916
|
+
#
|
5917
|
+
# resp.security_profiles #=> Array
|
5918
|
+
# resp.security_profiles[0].id #=> String
|
5919
|
+
# resp.security_profiles[0].organization_resource_id #=> String
|
5920
|
+
# resp.security_profiles[0].arn #=> String
|
5921
|
+
# resp.security_profiles[0].security_profile_name #=> String
|
5922
|
+
# resp.security_profiles[0].description #=> String
|
5923
|
+
# resp.security_profiles[0].tags #=> Hash
|
5924
|
+
# resp.security_profiles[0].tags["TagKey"] #=> String
|
5925
|
+
# resp.next_token #=> String
|
5926
|
+
# resp.approximate_total_count #=> Integer
|
5927
|
+
#
|
5928
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchSecurityProfiles AWS API Documentation
|
5929
|
+
#
|
5930
|
+
# @overload search_security_profiles(params = {})
|
5931
|
+
# @param [Hash] params ({})
|
5932
|
+
def search_security_profiles(params = {}, options = {})
|
5933
|
+
req = build_request(:search_security_profiles, params)
|
5934
|
+
req.send_request(options)
|
5935
|
+
end
|
5936
|
+
|
5707
5937
|
# Searches users in an Amazon Connect instance, with optional filtering.
|
5708
5938
|
#
|
5709
5939
|
# @option params [String] :instance_id
|
@@ -5883,10 +6113,10 @@ module Aws::Connect
|
|
5883
6113
|
req.send_request(options)
|
5884
6114
|
end
|
5885
6115
|
|
5886
|
-
# Initiates a
|
5887
|
-
#
|
5888
|
-
#
|
5889
|
-
#
|
6116
|
+
# Initiates a flow to start a new chat for the customer. Response of
|
6117
|
+
# this API provides a token required to obtain credentials from the
|
6118
|
+
# [CreateParticipantConnection][1] API in the Amazon Connect Participant
|
6119
|
+
# Service.
|
5890
6120
|
#
|
5891
6121
|
# When a new chat contact is successfully created, clients must
|
5892
6122
|
# subscribe to the participant’s connection for the created chat within
|
@@ -5921,19 +6151,19 @@ module Aws::Connect
|
|
5921
6151
|
# instanceId in the ARN of the instance.
|
5922
6152
|
#
|
5923
6153
|
# @option params [required, String] :contact_flow_id
|
5924
|
-
# The identifier of the
|
6154
|
+
# The identifier of the flow for initiating the chat. To see the
|
5925
6155
|
# ContactFlowId in the Amazon Connect console user interface, on the
|
5926
|
-
# navigation menu go to **Routing**, **Contact Flows**. Choose the
|
5927
|
-
#
|
5928
|
-
# flow
|
5929
|
-
#
|
6156
|
+
# navigation menu go to **Routing**, **Contact Flows**. Choose the flow.
|
6157
|
+
# On the flow page, under the name of the flow, choose **Show additional
|
6158
|
+
# flow information**. The ContactFlowId is the last part of the ARN,
|
6159
|
+
# shown here in bold:
|
5930
6160
|
#
|
5931
6161
|
# arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
|
5932
6162
|
#
|
5933
6163
|
# @option params [Hash<String,String>] :attributes
|
5934
6164
|
# A custom key-value pair using an attribute map. The attributes are
|
5935
|
-
# standard Amazon Connect attributes. They can be accessed in
|
5936
|
-
#
|
6165
|
+
# standard Amazon Connect attributes. They can be accessed in flows just
|
6166
|
+
# like any other contact attributes.
|
5937
6167
|
#
|
5938
6168
|
# There can be up to 32,768 UTF-8 bytes across all key-value pairs per
|
5939
6169
|
# contact. Attribute keys can include only alphanumeric, dash, and
|
@@ -6120,14 +6350,14 @@ module Aws::Connect
|
|
6120
6350
|
req.send_request(options)
|
6121
6351
|
end
|
6122
6352
|
|
6123
|
-
# Places an outbound call to a contact, and then initiates the
|
6124
|
-
#
|
6125
|
-
#
|
6353
|
+
# Places an outbound call to a contact, and then initiates the flow. It
|
6354
|
+
# performs the actions in the flow that's specified (in
|
6355
|
+
# `ContactFlowId`).
|
6126
6356
|
#
|
6127
6357
|
# Agents do not initiate the outbound API, which means that they do not
|
6128
|
-
# dial the contact. If the
|
6129
|
-
#
|
6130
|
-
#
|
6358
|
+
# dial the contact. If the flow places an outbound call to a contact,
|
6359
|
+
# and then puts the contact in queue, the call is then routed to the
|
6360
|
+
# agent, like any other inbound case.
|
6131
6361
|
#
|
6132
6362
|
# There is a 60-second dialing timeout for this operation. If the call
|
6133
6363
|
# is not connected after 60 seconds, it fails.
|
@@ -6141,25 +6371,25 @@ module Aws::Connect
|
|
6141
6371
|
#
|
6142
6372
|
# <note markdown="1"> Campaign calls are not allowed by default. Before you can make a call
|
6143
6373
|
# with `TrafficType` = `CAMPAIGN`, you must submit a service quota
|
6144
|
-
# increase request
|
6145
|
-
# Quotas][1] in the *Amazon Connect Administrator Guide*.
|
6374
|
+
# increase request to the quota [Amazon Connect campaigns][2].
|
6146
6375
|
#
|
6147
6376
|
# </note>
|
6148
6377
|
#
|
6149
6378
|
#
|
6150
6379
|
#
|
6151
6380
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html
|
6381
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#outbound-communications-quotas
|
6152
6382
|
#
|
6153
6383
|
# @option params [required, String] :destination_phone_number
|
6154
6384
|
# The phone number of the customer, in E.164 format.
|
6155
6385
|
#
|
6156
6386
|
# @option params [required, String] :contact_flow_id
|
6157
|
-
# The identifier of the
|
6387
|
+
# The identifier of the flow for the outbound call. To see the
|
6158
6388
|
# ContactFlowId in the Amazon Connect console user interface, on the
|
6159
|
-
# navigation menu go to **Routing**, **Contact Flows**. Choose the
|
6160
|
-
#
|
6161
|
-
# flow
|
6162
|
-
#
|
6389
|
+
# navigation menu go to **Routing**, **Contact Flows**. Choose the flow.
|
6390
|
+
# On the flow page, under the name of the flow, choose **Show additional
|
6391
|
+
# flow information**. The ContactFlowId is the last part of the ARN,
|
6392
|
+
# shown here in bold:
|
6163
6393
|
#
|
6164
6394
|
# arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
|
6165
6395
|
#
|
@@ -6183,13 +6413,13 @@ module Aws::Connect
|
|
6183
6413
|
# @option params [String] :queue_id
|
6184
6414
|
# The queue for the call. If you specify a queue, the phone displayed
|
6185
6415
|
# for caller ID is the phone number specified in the queue. If you do
|
6186
|
-
# not specify a queue, the queue defined in the
|
6187
|
-
#
|
6416
|
+
# not specify a queue, the queue defined in the flow is used. If you do
|
6417
|
+
# not specify a queue, you must specify a source phone number.
|
6188
6418
|
#
|
6189
6419
|
# @option params [Hash<String,String>] :attributes
|
6190
6420
|
# A custom key-value pair using an attribute map. The attributes are
|
6191
|
-
# standard Amazon Connect attributes, and can be accessed in
|
6192
|
-
#
|
6421
|
+
# standard Amazon Connect attributes, and can be accessed in flows just
|
6422
|
+
# like any other contact attributes.
|
6193
6423
|
#
|
6194
6424
|
# There can be up to 32,768 UTF-8 bytes across all key-value pairs per
|
6195
6425
|
# contact. Attribute keys can include only alphanumeric, dash, and
|
@@ -6245,7 +6475,7 @@ module Aws::Connect
|
|
6245
6475
|
req.send_request(options)
|
6246
6476
|
end
|
6247
6477
|
|
6248
|
-
# Initiates a
|
6478
|
+
# Initiates a flow to start a new task.
|
6249
6479
|
#
|
6250
6480
|
# @option params [required, String] :instance_id
|
6251
6481
|
# The identifier of the Amazon Connect instance. You can find the
|
@@ -6255,19 +6485,19 @@ module Aws::Connect
|
|
6255
6485
|
# The identifier of the previous chat, voice, or task contact.
|
6256
6486
|
#
|
6257
6487
|
# @option params [String] :contact_flow_id
|
6258
|
-
# The identifier of the
|
6259
|
-
#
|
6260
|
-
# navigation menu go to **Routing**, **Contact Flows**. Choose the
|
6261
|
-
#
|
6262
|
-
# flow
|
6263
|
-
#
|
6488
|
+
# The identifier of the flow for initiating the tasks. To see the
|
6489
|
+
# ContactFlowId in the Amazon Connect console user interface, on the
|
6490
|
+
# navigation menu go to **Routing**, **Contact Flows**. Choose the flow.
|
6491
|
+
# On the flow page, under the name of the flow, choose **Show additional
|
6492
|
+
# flow information**. The ContactFlowId is the last part of the ARN,
|
6493
|
+
# shown here in bold:
|
6264
6494
|
#
|
6265
6495
|
# arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
|
6266
6496
|
#
|
6267
6497
|
# @option params [Hash<String,String>] :attributes
|
6268
6498
|
# A custom key-value pair using an attribute map. The attributes are
|
6269
|
-
# standard Amazon Connect attributes, and can be accessed in
|
6270
|
-
#
|
6499
|
+
# standard Amazon Connect attributes, and can be accessed in flows just
|
6500
|
+
# like any other contact attributes.
|
6271
6501
|
#
|
6272
6502
|
# There can be up to 32,768 UTF-8 bytes across all key-value pairs per
|
6273
6503
|
# contact. Attribute keys can include only alphanumeric, dash, and
|
@@ -6294,8 +6524,8 @@ module Aws::Connect
|
|
6294
6524
|
#
|
6295
6525
|
# @option params [Time,DateTime,Date,Integer,String] :scheduled_time
|
6296
6526
|
# The timestamp, in Unix Epoch seconds format, at which to start running
|
6297
|
-
# the inbound
|
6298
|
-
#
|
6527
|
+
# the inbound flow. The scheduled time cannot be in the past. It must be
|
6528
|
+
# within up to 6 days in future.
|
6299
6529
|
#
|
6300
6530
|
# @option params [String] :task_template_id
|
6301
6531
|
# A unique identifier for the task template.
|
@@ -6496,22 +6726,25 @@ module Aws::Connect
|
|
6496
6726
|
|
6497
6727
|
# Adds the specified tags to the specified resource.
|
6498
6728
|
#
|
6499
|
-
#
|
6500
|
-
# quick connects, contact flows, agent
|
6501
|
-
#
|
6729
|
+
# Some of the supported resource types are agents, routing profiles,
|
6730
|
+
# queues, quick connects, contact flows, agent statuses, hours of
|
6731
|
+
# operation, phone numbers, security profiles, and task templates. For a
|
6732
|
+
# complete list, see [Tagging resources in Amazon Connect][1].
|
6502
6733
|
#
|
6503
6734
|
# For sample policies that use tags, see [Amazon Connect Identity-Based
|
6504
|
-
# Policy Examples][
|
6735
|
+
# Policy Examples][2] in the *Amazon Connect Administrator Guide*.
|
6505
6736
|
#
|
6506
6737
|
#
|
6507
6738
|
#
|
6508
|
-
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/
|
6739
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/tagging.html
|
6740
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html
|
6509
6741
|
#
|
6510
6742
|
# @option params [required, String] :resource_arn
|
6511
6743
|
# The Amazon Resource Name (ARN) of the resource.
|
6512
6744
|
#
|
6513
6745
|
# @option params [required, Hash<String,String>] :tags
|
6514
|
-
#
|
6746
|
+
# The tags used to organize, track, or control access for this resource.
|
6747
|
+
# For example, \\\{ "tags": \\\{"key1":"value1",
|
6515
6748
|
# "key2":"value2"\\} \\}.
|
6516
6749
|
#
|
6517
6750
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
@@ -6536,10 +6769,10 @@ module Aws::Connect
|
|
6536
6769
|
|
6537
6770
|
# Transfers contacts from one agent or queue to another agent or queue
|
6538
6771
|
# at any point after a contact is created. You can transfer a contact to
|
6539
|
-
# another queue by providing the
|
6540
|
-
#
|
6541
|
-
#
|
6542
|
-
#
|
6772
|
+
# another queue by providing the flow which orchestrates the contact to
|
6773
|
+
# the destination queue. This gives you more control over contact
|
6774
|
+
# handling and helps you adhere to the service level agreement (SLA)
|
6775
|
+
# guaranteed to your customers.
|
6543
6776
|
#
|
6544
6777
|
# Note the following requirements:
|
6545
6778
|
#
|
@@ -6547,8 +6780,8 @@ module Aws::Connect
|
|
6547
6780
|
#
|
6548
6781
|
# * Do not use both `QueueId` and `UserId` in the same call.
|
6549
6782
|
#
|
6550
|
-
# * The following
|
6551
|
-
#
|
6783
|
+
# * The following flow types are supported: Inbound flow, Transfer to
|
6784
|
+
# agent flow, and Transfer to queue flow.
|
6552
6785
|
#
|
6553
6786
|
# * The `TransferContact` API can be called only on active contacts.
|
6554
6787
|
#
|
@@ -6559,7 +6792,7 @@ module Aws::Connect
|
|
6559
6792
|
# instanceId in the ARN of the instance.
|
6560
6793
|
#
|
6561
6794
|
# @option params [required, String] :contact_id
|
6562
|
-
# The identifier of the contact in this instance of Amazon Connect
|
6795
|
+
# The identifier of the contact in this instance of Amazon Connect.
|
6563
6796
|
#
|
6564
6797
|
# @option params [String] :queue_id
|
6565
6798
|
# The identifier for the queue.
|
@@ -6568,7 +6801,7 @@ module Aws::Connect
|
|
6568
6801
|
# The identifier for the user.
|
6569
6802
|
#
|
6570
6803
|
# @option params [required, String] :contact_flow_id
|
6571
|
-
# The identifier of the
|
6804
|
+
# The identifier of the flow.
|
6572
6805
|
#
|
6573
6806
|
# @option params [String] :client_token
|
6574
6807
|
# A unique, case-sensitive identifier that you provide to ensure the
|
@@ -6751,18 +6984,10 @@ module Aws::Connect
|
|
6751
6984
|
# callers.
|
6752
6985
|
#
|
6753
6986
|
# Contact attributes are available in Amazon Connect for 24 months, and
|
6754
|
-
# are then deleted. For information about
|
6755
|
-
# size of the
|
6756
|
-
# the *Amazon Connect Administrator
|
6757
|
-
#
|
6758
|
-
# **Important:** You cannot use the operation to update attributes for
|
6759
|
-
# contacts that occurred prior to the release of the API, which was
|
6760
|
-
# September 12, 2018. You can update attributes only for contacts that
|
6761
|
-
# started after the release of the API. If you attempt to update
|
6762
|
-
# attributes for a contact that occurred prior to the release of the
|
6763
|
-
# API, a 400 error is returned. This applies also to queued callbacks
|
6764
|
-
# that were initiated prior to the release of the API but are still
|
6765
|
-
# active in your instance.
|
6987
|
+
# are then deleted. For information about contact record retention and
|
6988
|
+
# the maximum size of the contact record attributes section, see
|
6989
|
+
# [Feature specifications][1] in the *Amazon Connect Administrator
|
6990
|
+
# Guide*.
|
6766
6991
|
#
|
6767
6992
|
#
|
6768
6993
|
#
|
@@ -6778,7 +7003,7 @@ module Aws::Connect
|
|
6778
7003
|
#
|
6779
7004
|
# @option params [required, Hash<String,String>] :attributes
|
6780
7005
|
# The Amazon Connect attributes. These attributes can be accessed in
|
6781
|
-
#
|
7006
|
+
# flows just like any other contact attributes.
|
6782
7007
|
#
|
6783
7008
|
# You can have up to 32,768 UTF-8 bytes across all attributes for a
|
6784
7009
|
# contact. Attribute keys can include only alphanumeric, dash, and
|
@@ -6805,10 +7030,10 @@ module Aws::Connect
|
|
6805
7030
|
req.send_request(options)
|
6806
7031
|
end
|
6807
7032
|
|
6808
|
-
# Updates the specified
|
7033
|
+
# Updates the specified flow.
|
6809
7034
|
#
|
6810
|
-
# You can also create and update
|
6811
|
-
#
|
7035
|
+
# You can also create and update flows using the [Amazon Connect Flow
|
7036
|
+
# language][1].
|
6812
7037
|
#
|
6813
7038
|
#
|
6814
7039
|
#
|
@@ -6818,12 +7043,12 @@ module Aws::Connect
|
|
6818
7043
|
# The identifier of the Amazon Connect instance.
|
6819
7044
|
#
|
6820
7045
|
# @option params [required, String] :contact_flow_id
|
6821
|
-
# The identifier of the
|
7046
|
+
# The identifier of the flow.
|
6822
7047
|
#
|
6823
7048
|
# @option params [required, String] :content
|
6824
|
-
# The JSON string that represents
|
6825
|
-
#
|
6826
|
-
#
|
7049
|
+
# The JSON string that represents flow's content. For an example, see
|
7050
|
+
# [Example contact flow in Amazon Connect Flow language][1] in the
|
7051
|
+
# *Amazon Connect Administrator Guide*.
|
6827
7052
|
#
|
6828
7053
|
#
|
6829
7054
|
#
|
@@ -6848,23 +7073,23 @@ module Aws::Connect
|
|
6848
7073
|
req.send_request(options)
|
6849
7074
|
end
|
6850
7075
|
|
6851
|
-
# Updates metadata about specified
|
7076
|
+
# Updates metadata about specified flow.
|
6852
7077
|
#
|
6853
7078
|
# @option params [required, String] :instance_id
|
6854
7079
|
# The identifier of the Amazon Connect instance. You can find the
|
6855
7080
|
# instanceId in the ARN of the instance.
|
6856
7081
|
#
|
6857
7082
|
# @option params [required, String] :contact_flow_id
|
6858
|
-
# The identifier of the
|
7083
|
+
# The identifier of the flow.
|
6859
7084
|
#
|
6860
7085
|
# @option params [String] :name
|
6861
|
-
# TThe name of the
|
7086
|
+
# TThe name of the flow.
|
6862
7087
|
#
|
6863
7088
|
# @option params [String] :description
|
6864
|
-
# The description of the
|
7089
|
+
# The description of the flow.
|
6865
7090
|
#
|
6866
7091
|
# @option params [String] :contact_flow_state
|
6867
|
-
# The state of
|
7092
|
+
# The state of flow.
|
6868
7093
|
#
|
6869
7094
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
6870
7095
|
#
|
@@ -6887,7 +7112,7 @@ module Aws::Connect
|
|
6887
7112
|
req.send_request(options)
|
6888
7113
|
end
|
6889
7114
|
|
6890
|
-
# Updates specified
|
7115
|
+
# Updates specified flow module for the specified Amazon Connect
|
6891
7116
|
# instance.
|
6892
7117
|
#
|
6893
7118
|
# @option params [required, String] :instance_id
|
@@ -6895,10 +7120,10 @@ module Aws::Connect
|
|
6895
7120
|
# instanceId in the ARN of the instance.
|
6896
7121
|
#
|
6897
7122
|
# @option params [required, String] :contact_flow_module_id
|
6898
|
-
# The identifier of the
|
7123
|
+
# The identifier of the flow module.
|
6899
7124
|
#
|
6900
7125
|
# @option params [required, String] :content
|
6901
|
-
# The content of the
|
7126
|
+
# The content of the flow module.
|
6902
7127
|
#
|
6903
7128
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
6904
7129
|
#
|
@@ -6919,23 +7144,23 @@ module Aws::Connect
|
|
6919
7144
|
req.send_request(options)
|
6920
7145
|
end
|
6921
7146
|
|
6922
|
-
# Updates metadata about specified
|
7147
|
+
# Updates metadata about specified flow module.
|
6923
7148
|
#
|
6924
7149
|
# @option params [required, String] :instance_id
|
6925
7150
|
# The identifier of the Amazon Connect instance. You can find the
|
6926
7151
|
# instanceId in the ARN of the instance.
|
6927
7152
|
#
|
6928
7153
|
# @option params [required, String] :contact_flow_module_id
|
6929
|
-
# The identifier of the
|
7154
|
+
# The identifier of the flow module.
|
6930
7155
|
#
|
6931
7156
|
# @option params [String] :name
|
6932
|
-
# The name of the
|
7157
|
+
# The name of the flow module.
|
6933
7158
|
#
|
6934
7159
|
# @option params [String] :description
|
6935
|
-
# The description of the
|
7160
|
+
# The description of the flow module.
|
6936
7161
|
#
|
6937
7162
|
# @option params [String] :state
|
6938
|
-
# The state of
|
7163
|
+
# The state of flow module.
|
6939
7164
|
#
|
6940
7165
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
6941
7166
|
#
|
@@ -6958,10 +7183,10 @@ module Aws::Connect
|
|
6958
7183
|
req.send_request(options)
|
6959
7184
|
end
|
6960
7185
|
|
6961
|
-
# The name of the
|
7186
|
+
# The name of the flow.
|
6962
7187
|
#
|
6963
|
-
# You can also create and update
|
6964
|
-
#
|
7188
|
+
# You can also create and update flows using the [Amazon Connect Flow
|
7189
|
+
# language][1].
|
6965
7190
|
#
|
6966
7191
|
#
|
6967
7192
|
#
|
@@ -6971,13 +7196,13 @@ module Aws::Connect
|
|
6971
7196
|
# The identifier of the Amazon Connect instance.
|
6972
7197
|
#
|
6973
7198
|
# @option params [required, String] :contact_flow_id
|
6974
|
-
# The identifier of the
|
7199
|
+
# The identifier of the flow.
|
6975
7200
|
#
|
6976
7201
|
# @option params [String] :name
|
6977
|
-
# The name of the
|
7202
|
+
# The name of the flow.
|
6978
7203
|
#
|
6979
7204
|
# @option params [String] :description
|
6980
|
-
# The description of the
|
7205
|
+
# The description of the flow.
|
6981
7206
|
#
|
6982
7207
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
6983
7208
|
#
|
@@ -7011,8 +7236,8 @@ module Aws::Connect
|
|
7011
7236
|
#
|
7012
7237
|
# @option params [required, Time,DateTime,Date,Integer,String] :scheduled_time
|
7013
7238
|
# The timestamp, in Unix Epoch seconds format, at which to start running
|
7014
|
-
# the inbound
|
7015
|
-
#
|
7239
|
+
# the inbound flow. The scheduled time cannot be in the past. It must be
|
7240
|
+
# within up to 6 days in future.
|
7016
7241
|
#
|
7017
7242
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
7018
7243
|
#
|
@@ -7118,7 +7343,7 @@ module Aws::Connect
|
|
7118
7343
|
#
|
7119
7344
|
# resp = client.update_instance_attribute({
|
7120
7345
|
# instance_id: "InstanceId", # required
|
7121
|
-
# 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
|
7346
|
+
# 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
|
7122
7347
|
# value: "InstanceAttributeValue", # required
|
7123
7348
|
# })
|
7124
7349
|
#
|
@@ -8097,7 +8322,7 @@ module Aws::Connect
|
|
8097
8322
|
params: params,
|
8098
8323
|
config: config)
|
8099
8324
|
context[:gem_name] = 'aws-sdk-connect'
|
8100
|
-
context[:gem_version] = '1.
|
8325
|
+
context[:gem_version] = '1.75.0'
|
8101
8326
|
Seahorse::Client::Request.new(handlers, context)
|
8102
8327
|
end
|
8103
8328
|
|