aws-sdk-connect 1.73.0 → 1.76.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -600,8 +600,8 @@ module Aws::Connect
600
600
  req.send_request(options)
601
601
  end
602
602
 
603
- # Associates a contact flow with a phone number claimed to your Amazon
604
- # Connect instance.
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 contact flow.
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 contact flow for the specified Amazon Connect instance.
859
+ # Creates a flow for the specified Amazon Connect instance.
856
860
  #
857
- # You can also create and update contact flows using the [Amazon Connect
858
- # Flow language][1].
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 contact flow.
872
+ # The name of the flow.
869
873
  #
870
874
  # @option params [required, String] :type
871
- # The type of the contact flow. For descriptions of the available types,
872
- # see [Choose a Contact Flow Type][1] in the *Amazon Connect
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 contact flow.
883
+ # The description of the flow.
881
884
  #
882
885
  # @option params [required, String] :content
883
- # The content of the contact flow.
886
+ # The content of the flow.
884
887
  #
885
888
  # @option params [Hash<String,String>] :tags
886
- # One or more tags.
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 contact flow module for the specified Amazon Connect
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 contact flow module.
932
+ # The name of the flow module.
929
933
  #
930
934
  # @option params [String] :description
931
- # The description of the contact flow module.
935
+ # The description of the flow module.
932
936
  #
933
937
  # @option params [required, String] :content
934
- # The content of the contact flow module.
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
- # One or more tags.
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
  #
@@ -1385,7 +1406,12 @@ module Aws::Connect
1385
1406
  # The description of the security profile.
1386
1407
  #
1387
1408
  # @option params [Array<String>] :permissions
1388
- # Permissions assigned to the security profile.
1409
+ # Permissions assigned to the security profile. For a list of valid
1410
+ # permissions, see [List of security profile permissions][1].
1411
+ #
1412
+ #
1413
+ #
1414
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html
1389
1415
  #
1390
1416
  # @option params [required, String] :instance_id
1391
1417
  # The identifier of the Amazon Connect instance. You can find the
@@ -1393,6 +1419,8 @@ module Aws::Connect
1393
1419
  #
1394
1420
  # @option params [Hash<String,String>] :tags
1395
1421
  # The tags used to organize, track, or control access for this resource.
1422
+ # For example, \\\{ "tags": \\\{"key1":"value1",
1423
+ # "key2":"value2"\\} \\}.
1396
1424
  #
1397
1425
  # @return [Types::CreateSecurityProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1398
1426
  #
@@ -1552,6 +1580,8 @@ module Aws::Connect
1552
1580
  #
1553
1581
  # @option params [Hash<String,String>] :tags
1554
1582
  # The tags used to organize, track, or control access for this resource.
1583
+ # For example, \\\{ "tags": \\\{"key1":"value1",
1584
+ # "key2":"value2"\\} \\}.
1555
1585
  #
1556
1586
  # @return [Types::CreateUseCaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1557
1587
  #
@@ -1637,7 +1667,9 @@ module Aws::Connect
1637
1667
  # instanceId in the ARN of the instance.
1638
1668
  #
1639
1669
  # @option params [Hash<String,String>] :tags
1640
- # One or more tags.
1670
+ # The tags used to organize, track, or control access for this resource.
1671
+ # For example, \\\{ "tags": \\\{"key1":"value1",
1672
+ # "key2":"value2"\\} \\}.
1641
1673
  #
1642
1674
  # @return [Types::CreateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1643
1675
  #
@@ -1700,6 +1732,8 @@ module Aws::Connect
1700
1732
  #
1701
1733
  # @option params [Hash<String,String>] :tags
1702
1734
  # The tags used to organize, track, or control access for this resource.
1735
+ # For example, \\\{ "tags": \\\{"key1":"value1",
1736
+ # "key2":"value2"\\} \\}.
1703
1737
  #
1704
1738
  # @return [Types::CreateUserHierarchyGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1705
1739
  #
@@ -1775,6 +1809,8 @@ module Aws::Connect
1775
1809
  #
1776
1810
  # @option params [Hash<String,String>] :tags
1777
1811
  # The tags used to organize, track, or control access for this resource.
1812
+ # For example, \\\{ "tags": \\\{"key1":"value1",
1813
+ # "key2":"value2"\\} \\}.
1778
1814
  #
1779
1815
  # @return [Types::CreateVocabularyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1780
1816
  #
@@ -1810,14 +1846,14 @@ module Aws::Connect
1810
1846
  req.send_request(options)
1811
1847
  end
1812
1848
 
1813
- # Deletes a contact flow for the specified Amazon Connect instance.
1849
+ # Deletes a flow for the specified Amazon Connect instance.
1814
1850
  #
1815
1851
  # @option params [required, String] :instance_id
1816
1852
  # The identifier of the Amazon Connect instance. You can find the
1817
1853
  # instanceId in the ARN of the instance.
1818
1854
  #
1819
1855
  # @option params [required, String] :contact_flow_id
1820
- # The identifier of the contact flow.
1856
+ # The identifier of the flow.
1821
1857
  #
1822
1858
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1823
1859
  #
@@ -1837,14 +1873,14 @@ module Aws::Connect
1837
1873
  req.send_request(options)
1838
1874
  end
1839
1875
 
1840
- # Deletes the specified contact flow module.
1876
+ # Deletes the specified flow module.
1841
1877
  #
1842
1878
  # @option params [required, String] :instance_id
1843
1879
  # The identifier of the Amazon Connect instance. You can find the
1844
1880
  # instanceId in the ARN of the instance.
1845
1881
  #
1846
1882
  # @option params [required, String] :contact_flow_module_id
1847
- # The identifier of the contact flow module.
1883
+ # The identifier of the flow module.
1848
1884
  #
1849
1885
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1850
1886
  #
@@ -2223,6 +2259,8 @@ module Aws::Connect
2223
2259
  # Contact information remains available in Amazon Connect for 24 months,
2224
2260
  # and then it is deleted.
2225
2261
  #
2262
+ # Only data from November 12, 2021, and later is returned by this API.
2263
+ #
2226
2264
  # @option params [required, String] :instance_id
2227
2265
  # The identifier of the Amazon Connect instance. You can find the
2228
2266
  # instanceId in the ARN of the instance.
@@ -2269,10 +2307,10 @@ module Aws::Connect
2269
2307
  req.send_request(options)
2270
2308
  end
2271
2309
 
2272
- # Describes the specified contact flow.
2310
+ # Describes the specified flow.
2273
2311
  #
2274
- # You can also create and update contact flows using the [Amazon Connect
2275
- # Flow language][1].
2312
+ # You can also create and update flows using the [Amazon Connect Flow
2313
+ # language][1].
2276
2314
  #
2277
2315
  #
2278
2316
  #
@@ -2282,7 +2320,7 @@ module Aws::Connect
2282
2320
  # The identifier of the Amazon Connect instance.
2283
2321
  #
2284
2322
  # @option params [required, String] :contact_flow_id
2285
- # The identifier of the contact flow.
2323
+ # The identifier of the flow.
2286
2324
  #
2287
2325
  # @return [Types::DescribeContactFlowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2288
2326
  #
@@ -2316,14 +2354,14 @@ module Aws::Connect
2316
2354
  req.send_request(options)
2317
2355
  end
2318
2356
 
2319
- # Describes the specified contact flow module.
2357
+ # Describes the specified flow module.
2320
2358
  #
2321
2359
  # @option params [required, String] :instance_id
2322
2360
  # The identifier of the Amazon Connect instance. You can find the
2323
2361
  # instanceId in the ARN of the instance.
2324
2362
  #
2325
2363
  # @option params [required, String] :contact_flow_module_id
2326
- # The identifier of the contact flow module.
2364
+ # The identifier of the flow module.
2327
2365
  #
2328
2366
  # @return [Types::DescribeContactFlowModuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2329
2367
  #
@@ -2473,12 +2511,12 @@ module Aws::Connect
2473
2511
  #
2474
2512
  # resp = client.describe_instance_attribute({
2475
2513
  # 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
2514
+ # 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
2515
  # })
2478
2516
  #
2479
2517
  # @example Response structure
2480
2518
  #
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"
2519
+ # 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
2520
  # resp.attribute.value #=> String
2483
2521
  #
2484
2522
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeInstanceAttribute AWS API Documentation
@@ -2706,6 +2744,8 @@ module Aws::Connect
2706
2744
  # resp.routing_profile.default_outbound_queue_id #=> String
2707
2745
  # resp.routing_profile.tags #=> Hash
2708
2746
  # resp.routing_profile.tags["TagKey"] #=> String
2747
+ # resp.routing_profile.number_of_associated_queues #=> Integer
2748
+ # resp.routing_profile.number_of_associated_users #=> Integer
2709
2749
  #
2710
2750
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeRoutingProfile AWS API Documentation
2711
2751
  #
@@ -3059,7 +3099,7 @@ module Aws::Connect
3059
3099
  # change.
3060
3100
  #
3061
3101
  # Remove the Lambda function from the dropdown options available in the
3062
- # relevant contact flow blocks.
3102
+ # relevant flow blocks.
3063
3103
  #
3064
3104
  # @option params [required, String] :instance_id
3065
3105
  # The identifier of the Amazon Connect instance. You can find the
@@ -3122,8 +3162,8 @@ module Aws::Connect
3122
3162
  req.send_request(options)
3123
3163
  end
3124
3164
 
3125
- # Removes the contact flow association from a phone number claimed to
3126
- # your Amazon Connect instance, if a contact flow association exists.
3165
+ # Removes the flow association from a phone number claimed to your
3166
+ # Amazon Connect instance, if a flow association exists.
3127
3167
  #
3128
3168
  # @option params [required, String] :phone_number_id
3129
3169
  # A unique identifier for the phone number.
@@ -4086,7 +4126,8 @@ module Aws::Connect
4086
4126
  # change.
4087
4127
  #
4088
4128
  # For the specified version of Amazon Lex, returns a paginated list of
4089
- # all the Amazon Lex bots currently associated with the instance.
4129
+ # all the Amazon Lex bots currently associated with the instance. Use
4130
+ # this API to returns both Amazon Lex V1 and V2 bots.
4090
4131
  #
4091
4132
  # @option params [required, String] :instance_id
4092
4133
  # The identifier of the Amazon Connect instance. You can find the
@@ -4136,8 +4177,8 @@ module Aws::Connect
4136
4177
  req.send_request(options)
4137
4178
  end
4138
4179
 
4139
- # Provides information about the contact flow modules for the specified
4140
- # Amazon Connect instance.
4180
+ # Provides information about the flow modules for the specified Amazon
4181
+ # Connect instance.
4141
4182
  #
4142
4183
  # @option params [required, String] :instance_id
4143
4184
  # The identifier of the Amazon Connect instance. You can find the
@@ -4152,7 +4193,7 @@ module Aws::Connect
4152
4193
  # The maximum number of results to return per page.
4153
4194
  #
4154
4195
  # @option params [String] :contact_flow_module_state
4155
- # The state of the contact flow module.
4196
+ # The state of the flow module.
4156
4197
  #
4157
4198
  # @return [Types::ListContactFlowModulesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4158
4199
  #
@@ -4188,14 +4229,14 @@ module Aws::Connect
4188
4229
  req.send_request(options)
4189
4230
  end
4190
4231
 
4191
- # Provides information about the contact flows for the specified Amazon
4192
- # Connect instance.
4232
+ # Provides information about the flows for the specified Amazon Connect
4233
+ # instance.
4193
4234
  #
4194
- # You can also create and update contact flows using the [Amazon Connect
4195
- # Flow language][1].
4235
+ # You can also create and update flows using the [Amazon Connect Flow
4236
+ # language][1].
4196
4237
  #
4197
- # For more information about contact flows, see [Contact Flows][2] in
4198
- # the *Amazon Connect Administrator Guide*.
4238
+ # For more information about flows, see [Flows][2] in the *Amazon
4239
+ # Connect Administrator Guide*.
4199
4240
  #
4200
4241
  #
4201
4242
  #
@@ -4207,7 +4248,7 @@ module Aws::Connect
4207
4248
  # instanceId in the ARN of the instance.
4208
4249
  #
4209
4250
  # @option params [Array<String>] :contact_flow_types
4210
- # The type of contact flow.
4251
+ # The type of flow.
4211
4252
  #
4212
4253
  # @option params [String] :next_token
4213
4254
  # The token for the next set of results. Use the value returned in the
@@ -4215,7 +4256,8 @@ module Aws::Connect
4215
4256
  # results.
4216
4257
  #
4217
4258
  # @option params [Integer] :max_results
4218
- # The maximum number of results to return per page.
4259
+ # The maximum number of results to return per page. The default
4260
+ # MaxResult size is 100.
4219
4261
  #
4220
4262
  # @return [Types::ListContactFlowsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4221
4263
  #
@@ -4397,7 +4439,8 @@ module Aws::Connect
4397
4439
  # results.
4398
4440
  #
4399
4441
  # @option params [Integer] :max_results
4400
- # The maximum number of results to return per page.
4442
+ # The maximum number of results to return per page. The default
4443
+ # MaxResult size is 100.
4401
4444
  #
4402
4445
  # @return [Types::ListHoursOfOperationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4403
4446
  #
@@ -4467,7 +4510,7 @@ module Aws::Connect
4467
4510
  # @example Response structure
4468
4511
  #
4469
4512
  # resp.attributes #=> Array
4470
- # 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"
4513
+ # 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"
4471
4514
  # resp.attributes[0].value #=> String
4472
4515
  # resp.next_token #=> String
4473
4516
  #
@@ -4656,7 +4699,7 @@ module Aws::Connect
4656
4699
  # change.
4657
4700
  #
4658
4701
  # Returns a paginated list of all Lambda functions that display in the
4659
- # dropdown options in the relevant contact flow blocks.
4702
+ # dropdown options in the relevant flow blocks.
4660
4703
  #
4661
4704
  # @option params [required, String] :instance_id
4662
4705
  # The identifier of the Amazon Connect instance. You can find the
@@ -4703,8 +4746,13 @@ module Aws::Connect
4703
4746
  # This API is in preview release for Amazon Connect and is subject to
4704
4747
  # change.
4705
4748
  #
4706
- # Returns a paginated list of all the Amazon Lex bots currently
4707
- # associated with the instance.
4749
+ # Returns a paginated list of all the Amazon Lex V1 bots currently
4750
+ # associated with the instance. To return both Amazon Lex V1 and V2
4751
+ # bots, use the [ListBots][1] API.
4752
+ #
4753
+ #
4754
+ #
4755
+ # [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_ListBots.html
4708
4756
  #
4709
4757
  # @option params [required, String] :instance_id
4710
4758
  # The identifier of the Amazon Connect instance. You can find the
@@ -4777,7 +4825,8 @@ module Aws::Connect
4777
4825
  # results.
4778
4826
  #
4779
4827
  # @option params [Integer] :max_results
4780
- # The maximum number of results to return per page.
4828
+ # The maximum number of results to return per page. The default
4829
+ # MaxResult size is 100.
4781
4830
  #
4782
4831
  # @return [Types::ListPhoneNumbersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4783
4832
  #
@@ -4899,7 +4948,8 @@ module Aws::Connect
4899
4948
  # results.
4900
4949
  #
4901
4950
  # @option params [Integer] :max_results
4902
- # The maximum number of results to return per page.
4951
+ # The maximum number of results to return per page. The default
4952
+ # MaxResult size is 100.
4903
4953
  #
4904
4954
  # @return [Types::ListPromptsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4905
4955
  #
@@ -4951,7 +5001,8 @@ module Aws::Connect
4951
5001
  # results.
4952
5002
  #
4953
5003
  # @option params [Integer] :max_results
4954
- # The maximum number of results to return per page.
5004
+ # The maximum number of results to return per page. The default
5005
+ # MaxResult size is 100.
4955
5006
  #
4956
5007
  # @return [Types::ListQueueQuickConnectsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4957
5008
  #
@@ -5015,7 +5066,8 @@ module Aws::Connect
5015
5066
  # results.
5016
5067
  #
5017
5068
  # @option params [Integer] :max_results
5018
- # The maximum number of results to return per page.
5069
+ # The maximum number of results to return per page. The default
5070
+ # MaxResult size is 100.
5019
5071
  #
5020
5072
  # @return [Types::ListQueuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5021
5073
  #
@@ -5064,7 +5116,8 @@ module Aws::Connect
5064
5116
  # results.
5065
5117
  #
5066
5118
  # @option params [Integer] :max_results
5067
- # The maximum number of results to return per page.
5119
+ # The maximum number of results to return per page. The default
5120
+ # MaxResult size is 100.
5068
5121
  #
5069
5122
  # @option params [Array<String>] :quick_connect_types
5070
5123
  # The type of quick connect. In the Amazon Connect console, when you
@@ -5121,7 +5174,8 @@ module Aws::Connect
5121
5174
  # results.
5122
5175
  #
5123
5176
  # @option params [Integer] :max_results
5124
- # The maximum number of results to return per page.
5177
+ # The maximum number of results to return per page. The default
5178
+ # MaxResult size is 100.
5125
5179
  #
5126
5180
  # @return [Types::ListRoutingProfileQueuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5127
5181
  #
@@ -5181,7 +5235,8 @@ module Aws::Connect
5181
5235
  # results.
5182
5236
  #
5183
5237
  # @option params [Integer] :max_results
5184
- # The maximum number of results to return per page.
5238
+ # The maximum number of results to return per page. The default
5239
+ # MaxResult size is 100.
5185
5240
  #
5186
5241
  # @return [Types::ListRoutingProfilesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5187
5242
  #
@@ -5336,7 +5391,8 @@ module Aws::Connect
5336
5391
  # results.
5337
5392
  #
5338
5393
  # @option params [Integer] :max_results
5339
- # The maximum number of results to return per page.
5394
+ # The maximum number of results to return per page. The default
5395
+ # MaxResult size is 100.
5340
5396
  #
5341
5397
  # @return [Types::ListSecurityProfilesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5342
5398
  #
@@ -5542,7 +5598,8 @@ module Aws::Connect
5542
5598
  # results.
5543
5599
  #
5544
5600
  # @option params [Integer] :max_results
5545
- # The maximum number of results to return per page.
5601
+ # The maximum number of results to return per page. The default
5602
+ # MaxResult size is 100.
5546
5603
  #
5547
5604
  # @return [Types::ListUserHierarchyGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5548
5605
  #
@@ -5589,7 +5646,8 @@ module Aws::Connect
5589
5646
  # results.
5590
5647
  #
5591
5648
  # @option params [Integer] :max_results
5592
- # The maximum number of results to return per page.
5649
+ # The maximum number of results to return per page. The default
5650
+ # MaxResult size is 100.
5593
5651
  #
5594
5652
  # @return [Types::ListUsersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5595
5653
  #
@@ -5790,6 +5848,321 @@ module Aws::Connect
5790
5848
  req.send_request(options)
5791
5849
  end
5792
5850
 
5851
+ # This API is in preview release for Amazon Connect and is subject to
5852
+ # change.
5853
+ #
5854
+ # Searches queues in an Amazon Connect instance, with optional
5855
+ # filtering.
5856
+ #
5857
+ # @option params [required, String] :instance_id
5858
+ # The identifier of the Amazon Connect instance. You can find the
5859
+ # instanceId in the ARN of the instance.
5860
+ #
5861
+ # @option params [String] :next_token
5862
+ # The token for the next set of results. Use the value returned in the
5863
+ # previous response in the next request to retrieve the next set of
5864
+ # results.
5865
+ #
5866
+ # @option params [Integer] :max_results
5867
+ # The maximum number of results to return per page.
5868
+ #
5869
+ # @option params [Types::QueueSearchFilter] :search_filter
5870
+ # Filters to be applied to search results.
5871
+ #
5872
+ # @option params [Types::QueueSearchCriteria] :search_criteria
5873
+ # The search criteria to be used to return queues.
5874
+ #
5875
+ # @return [Types::SearchQueuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5876
+ #
5877
+ # * {Types::SearchQueuesResponse#queues #queues} => Array&lt;Types::Queue&gt;
5878
+ # * {Types::SearchQueuesResponse#next_token #next_token} => String
5879
+ # * {Types::SearchQueuesResponse#approximate_total_count #approximate_total_count} => Integer
5880
+ #
5881
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
5882
+ #
5883
+ # @example Request syntax with placeholder values
5884
+ #
5885
+ # resp = client.search_queues({
5886
+ # instance_id: "InstanceId", # required
5887
+ # next_token: "NextToken2500",
5888
+ # max_results: 1,
5889
+ # search_filter: {
5890
+ # tag_filter: {
5891
+ # or_conditions: [
5892
+ # [
5893
+ # {
5894
+ # tag_key: "String",
5895
+ # tag_value: "String",
5896
+ # },
5897
+ # ],
5898
+ # ],
5899
+ # and_conditions: [
5900
+ # {
5901
+ # tag_key: "String",
5902
+ # tag_value: "String",
5903
+ # },
5904
+ # ],
5905
+ # tag_condition: {
5906
+ # tag_key: "String",
5907
+ # tag_value: "String",
5908
+ # },
5909
+ # },
5910
+ # },
5911
+ # search_criteria: {
5912
+ # or_conditions: [
5913
+ # {
5914
+ # # recursive QueueSearchCriteria
5915
+ # },
5916
+ # ],
5917
+ # and_conditions: [
5918
+ # {
5919
+ # # recursive QueueSearchCriteria
5920
+ # },
5921
+ # ],
5922
+ # string_condition: {
5923
+ # field_name: "String",
5924
+ # value: "String",
5925
+ # comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
5926
+ # },
5927
+ # queue_type_condition: "STANDARD", # accepts STANDARD
5928
+ # },
5929
+ # })
5930
+ #
5931
+ # @example Response structure
5932
+ #
5933
+ # resp.queues #=> Array
5934
+ # resp.queues[0].name #=> String
5935
+ # resp.queues[0].queue_arn #=> String
5936
+ # resp.queues[0].queue_id #=> String
5937
+ # resp.queues[0].description #=> String
5938
+ # resp.queues[0].outbound_caller_config.outbound_caller_id_name #=> String
5939
+ # resp.queues[0].outbound_caller_config.outbound_caller_id_number_id #=> String
5940
+ # resp.queues[0].outbound_caller_config.outbound_flow_id #=> String
5941
+ # resp.queues[0].hours_of_operation_id #=> String
5942
+ # resp.queues[0].max_contacts #=> Integer
5943
+ # resp.queues[0].status #=> String, one of "ENABLED", "DISABLED"
5944
+ # resp.queues[0].tags #=> Hash
5945
+ # resp.queues[0].tags["TagKey"] #=> String
5946
+ # resp.next_token #=> String
5947
+ # resp.approximate_total_count #=> Integer
5948
+ #
5949
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchQueues AWS API Documentation
5950
+ #
5951
+ # @overload search_queues(params = {})
5952
+ # @param [Hash] params ({})
5953
+ def search_queues(params = {}, options = {})
5954
+ req = build_request(:search_queues, params)
5955
+ req.send_request(options)
5956
+ end
5957
+
5958
+ # This API is in preview release for Amazon Connect and is subject to
5959
+ # change.
5960
+ #
5961
+ # Searches routing profiles in an Amazon Connect instance, with optional
5962
+ # filtering.
5963
+ #
5964
+ # @option params [required, String] :instance_id
5965
+ # The identifier of the Amazon Connect instance. You can find the
5966
+ # instanceId in the ARN of the instance.
5967
+ #
5968
+ # @option params [String] :next_token
5969
+ # The token for the next set of results. Use the value returned in the
5970
+ # previous response in the next request to retrieve the next set of
5971
+ # results.
5972
+ #
5973
+ # @option params [Integer] :max_results
5974
+ # The maximum number of results to return per page.
5975
+ #
5976
+ # @option params [Types::RoutingProfileSearchFilter] :search_filter
5977
+ # Filters to be applied to search results.
5978
+ #
5979
+ # @option params [Types::RoutingProfileSearchCriteria] :search_criteria
5980
+ # The search criteria to be used to return routing profiles.
5981
+ #
5982
+ # @return [Types::SearchRoutingProfilesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5983
+ #
5984
+ # * {Types::SearchRoutingProfilesResponse#routing_profiles #routing_profiles} => Array&lt;Types::RoutingProfile&gt;
5985
+ # * {Types::SearchRoutingProfilesResponse#next_token #next_token} => String
5986
+ # * {Types::SearchRoutingProfilesResponse#approximate_total_count #approximate_total_count} => Integer
5987
+ #
5988
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
5989
+ #
5990
+ # @example Request syntax with placeholder values
5991
+ #
5992
+ # resp = client.search_routing_profiles({
5993
+ # instance_id: "InstanceId", # required
5994
+ # next_token: "NextToken2500",
5995
+ # max_results: 1,
5996
+ # search_filter: {
5997
+ # tag_filter: {
5998
+ # or_conditions: [
5999
+ # [
6000
+ # {
6001
+ # tag_key: "String",
6002
+ # tag_value: "String",
6003
+ # },
6004
+ # ],
6005
+ # ],
6006
+ # and_conditions: [
6007
+ # {
6008
+ # tag_key: "String",
6009
+ # tag_value: "String",
6010
+ # },
6011
+ # ],
6012
+ # tag_condition: {
6013
+ # tag_key: "String",
6014
+ # tag_value: "String",
6015
+ # },
6016
+ # },
6017
+ # },
6018
+ # search_criteria: {
6019
+ # or_conditions: [
6020
+ # {
6021
+ # # recursive RoutingProfileSearchCriteria
6022
+ # },
6023
+ # ],
6024
+ # and_conditions: [
6025
+ # {
6026
+ # # recursive RoutingProfileSearchCriteria
6027
+ # },
6028
+ # ],
6029
+ # string_condition: {
6030
+ # field_name: "String",
6031
+ # value: "String",
6032
+ # comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
6033
+ # },
6034
+ # },
6035
+ # })
6036
+ #
6037
+ # @example Response structure
6038
+ #
6039
+ # resp.routing_profiles #=> Array
6040
+ # resp.routing_profiles[0].instance_id #=> String
6041
+ # resp.routing_profiles[0].name #=> String
6042
+ # resp.routing_profiles[0].routing_profile_arn #=> String
6043
+ # resp.routing_profiles[0].routing_profile_id #=> String
6044
+ # resp.routing_profiles[0].description #=> String
6045
+ # resp.routing_profiles[0].media_concurrencies #=> Array
6046
+ # resp.routing_profiles[0].media_concurrencies[0].channel #=> String, one of "VOICE", "CHAT", "TASK"
6047
+ # resp.routing_profiles[0].media_concurrencies[0].concurrency #=> Integer
6048
+ # resp.routing_profiles[0].default_outbound_queue_id #=> String
6049
+ # resp.routing_profiles[0].tags #=> Hash
6050
+ # resp.routing_profiles[0].tags["TagKey"] #=> String
6051
+ # resp.routing_profiles[0].number_of_associated_queues #=> Integer
6052
+ # resp.routing_profiles[0].number_of_associated_users #=> Integer
6053
+ # resp.next_token #=> String
6054
+ # resp.approximate_total_count #=> Integer
6055
+ #
6056
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchRoutingProfiles AWS API Documentation
6057
+ #
6058
+ # @overload search_routing_profiles(params = {})
6059
+ # @param [Hash] params ({})
6060
+ def search_routing_profiles(params = {}, options = {})
6061
+ req = build_request(:search_routing_profiles, params)
6062
+ req.send_request(options)
6063
+ end
6064
+
6065
+ # This API is in preview release for Amazon Connect and is subject to
6066
+ # change.
6067
+ #
6068
+ # Searches security profiles in an Amazon Connect instance, with
6069
+ # optional filtering.
6070
+ #
6071
+ # @option params [required, String] :instance_id
6072
+ # The identifier of the Amazon Connect instance. You can find the
6073
+ # instanceId in the ARN of the instance.
6074
+ #
6075
+ # @option params [String] :next_token
6076
+ # The token for the next set of results. Use the value returned in the
6077
+ # previous response in the next request to retrieve the next set of
6078
+ # results.
6079
+ #
6080
+ # @option params [Integer] :max_results
6081
+ # The maximum number of results to return per page.
6082
+ #
6083
+ # @option params [Types::SecurityProfileSearchCriteria] :search_criteria
6084
+ # The search criteria to be used to return security profiles.
6085
+ #
6086
+ # @option params [Types::SecurityProfilesSearchFilter] :search_filter
6087
+ # Filters to be applied to search results.
6088
+ #
6089
+ # @return [Types::SearchSecurityProfilesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6090
+ #
6091
+ # * {Types::SearchSecurityProfilesResponse#security_profiles #security_profiles} => Array&lt;Types::SecurityProfileSearchSummary&gt;
6092
+ # * {Types::SearchSecurityProfilesResponse#next_token #next_token} => String
6093
+ # * {Types::SearchSecurityProfilesResponse#approximate_total_count #approximate_total_count} => Integer
6094
+ #
6095
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
6096
+ #
6097
+ # @example Request syntax with placeholder values
6098
+ #
6099
+ # resp = client.search_security_profiles({
6100
+ # instance_id: "InstanceId", # required
6101
+ # next_token: "NextToken2500",
6102
+ # max_results: 1,
6103
+ # search_criteria: {
6104
+ # or_conditions: [
6105
+ # {
6106
+ # # recursive SecurityProfileSearchCriteria
6107
+ # },
6108
+ # ],
6109
+ # and_conditions: [
6110
+ # {
6111
+ # # recursive SecurityProfileSearchCriteria
6112
+ # },
6113
+ # ],
6114
+ # string_condition: {
6115
+ # field_name: "String",
6116
+ # value: "String",
6117
+ # comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
6118
+ # },
6119
+ # },
6120
+ # search_filter: {
6121
+ # tag_filter: {
6122
+ # or_conditions: [
6123
+ # [
6124
+ # {
6125
+ # tag_key: "String",
6126
+ # tag_value: "String",
6127
+ # },
6128
+ # ],
6129
+ # ],
6130
+ # and_conditions: [
6131
+ # {
6132
+ # tag_key: "String",
6133
+ # tag_value: "String",
6134
+ # },
6135
+ # ],
6136
+ # tag_condition: {
6137
+ # tag_key: "String",
6138
+ # tag_value: "String",
6139
+ # },
6140
+ # },
6141
+ # },
6142
+ # })
6143
+ #
6144
+ # @example Response structure
6145
+ #
6146
+ # resp.security_profiles #=> Array
6147
+ # resp.security_profiles[0].id #=> String
6148
+ # resp.security_profiles[0].organization_resource_id #=> String
6149
+ # resp.security_profiles[0].arn #=> String
6150
+ # resp.security_profiles[0].security_profile_name #=> String
6151
+ # resp.security_profiles[0].description #=> String
6152
+ # resp.security_profiles[0].tags #=> Hash
6153
+ # resp.security_profiles[0].tags["TagKey"] #=> String
6154
+ # resp.next_token #=> String
6155
+ # resp.approximate_total_count #=> Integer
6156
+ #
6157
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchSecurityProfiles AWS API Documentation
6158
+ #
6159
+ # @overload search_security_profiles(params = {})
6160
+ # @param [Hash] params ({})
6161
+ def search_security_profiles(params = {}, options = {})
6162
+ req = build_request(:search_security_profiles, params)
6163
+ req.send_request(options)
6164
+ end
6165
+
5793
6166
  # Searches users in an Amazon Connect instance, with optional filtering.
5794
6167
  #
5795
6168
  # @option params [String] :instance_id
@@ -5810,6 +6183,13 @@ module Aws::Connect
5810
6183
  # @option params [Types::UserSearchCriteria] :search_criteria
5811
6184
  # The search criteria to be used to return users.
5812
6185
  #
6186
+ # <note markdown="1"> The `Username`, `Firstname`, and `Lastname` fields support
6187
+ # "contains" queries with a minimum of 2 characters and a maximum of
6188
+ # 25 characters. Any queries with character lengths outside of this
6189
+ # range result in empty results.
6190
+ #
6191
+ # </note>
6192
+ #
5813
6193
  # @return [Types::SearchUsersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5814
6194
  #
5815
6195
  # * {Types::SearchUsersResponse#users #users} => Array&lt;Types::UserSearchSummary&gt;
@@ -5969,10 +6349,10 @@ module Aws::Connect
5969
6349
  req.send_request(options)
5970
6350
  end
5971
6351
 
5972
- # Initiates a contact flow to start a new chat for the customer.
5973
- # Response of this API provides a token required to obtain credentials
5974
- # from the [CreateParticipantConnection][1] API in the Amazon Connect
5975
- # Participant Service.
6352
+ # Initiates a flow to start a new chat for the customer. Response of
6353
+ # this API provides a token required to obtain credentials from the
6354
+ # [CreateParticipantConnection][1] API in the Amazon Connect Participant
6355
+ # Service.
5976
6356
  #
5977
6357
  # When a new chat contact is successfully created, clients must
5978
6358
  # subscribe to the participant’s connection for the created chat within
@@ -6007,19 +6387,19 @@ module Aws::Connect
6007
6387
  # instanceId in the ARN of the instance.
6008
6388
  #
6009
6389
  # @option params [required, String] :contact_flow_id
6010
- # The identifier of the contact flow for initiating the chat. To see the
6390
+ # The identifier of the flow for initiating the chat. To see the
6011
6391
  # ContactFlowId in the Amazon Connect console user interface, on the
6012
- # navigation menu go to **Routing**, **Contact Flows**. Choose the
6013
- # contact flow. On the contact flow page, under the name of the contact
6014
- # flow, choose **Show additional flow information**. The ContactFlowId
6015
- # is the last part of the ARN, shown here in bold:
6392
+ # navigation menu go to **Routing**, **Contact Flows**. Choose the flow.
6393
+ # On the flow page, under the name of the flow, choose **Show additional
6394
+ # flow information**. The ContactFlowId is the last part of the ARN,
6395
+ # shown here in bold:
6016
6396
  #
6017
6397
  # arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
6018
6398
  #
6019
6399
  # @option params [Hash<String,String>] :attributes
6020
6400
  # A custom key-value pair using an attribute map. The attributes are
6021
- # standard Amazon Connect attributes. They can be accessed in contact
6022
- # flows just like any other contact attributes.
6401
+ # standard Amazon Connect attributes. They can be accessed in flows just
6402
+ # like any other contact attributes.
6023
6403
  #
6024
6404
  # There can be up to 32,768 UTF-8 bytes across all key-value pairs per
6025
6405
  # contact. Attribute keys can include only alphanumeric, dash, and
@@ -6206,14 +6586,14 @@ module Aws::Connect
6206
6586
  req.send_request(options)
6207
6587
  end
6208
6588
 
6209
- # Places an outbound call to a contact, and then initiates the contact
6210
- # flow. It performs the actions in the contact flow that's specified
6211
- # (in `ContactFlowId`).
6589
+ # Places an outbound call to a contact, and then initiates the flow. It
6590
+ # performs the actions in the flow that's specified (in
6591
+ # `ContactFlowId`).
6212
6592
  #
6213
6593
  # Agents do not initiate the outbound API, which means that they do not
6214
- # dial the contact. If the contact flow places an outbound call to a
6215
- # contact, and then puts the contact in queue, the call is then routed
6216
- # to the agent, like any other inbound case.
6594
+ # dial the contact. If the flow places an outbound call to a contact,
6595
+ # and then puts the contact in queue, the call is then routed to the
6596
+ # agent, like any other inbound case.
6217
6597
  #
6218
6598
  # There is a 60-second dialing timeout for this operation. If the call
6219
6599
  # is not connected after 60 seconds, it fails.
@@ -6227,25 +6607,25 @@ module Aws::Connect
6227
6607
  #
6228
6608
  # <note markdown="1"> Campaign calls are not allowed by default. Before you can make a call
6229
6609
  # with `TrafficType` = `CAMPAIGN`, you must submit a service quota
6230
- # increase request. For more information, see [Amazon Connect Service
6231
- # Quotas][1] in the *Amazon Connect Administrator Guide*.
6610
+ # increase request to the quota [Amazon Connect campaigns][2].
6232
6611
  #
6233
6612
  # </note>
6234
6613
  #
6235
6614
  #
6236
6615
  #
6237
6616
  # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html
6617
+ # [2]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#outbound-communications-quotas
6238
6618
  #
6239
6619
  # @option params [required, String] :destination_phone_number
6240
6620
  # The phone number of the customer, in E.164 format.
6241
6621
  #
6242
6622
  # @option params [required, String] :contact_flow_id
6243
- # The identifier of the contact flow for the outbound call. To see the
6623
+ # The identifier of the flow for the outbound call. To see the
6244
6624
  # ContactFlowId in the Amazon Connect console user interface, on the
6245
- # navigation menu go to **Routing**, **Contact Flows**. Choose the
6246
- # contact flow. On the contact flow page, under the name of the contact
6247
- # flow, choose **Show additional flow information**. The ContactFlowId
6248
- # is the last part of the ARN, shown here in bold:
6625
+ # navigation menu go to **Routing**, **Contact Flows**. Choose the flow.
6626
+ # On the flow page, under the name of the flow, choose **Show additional
6627
+ # flow information**. The ContactFlowId is the last part of the ARN,
6628
+ # shown here in bold:
6249
6629
  #
6250
6630
  # arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
6251
6631
  #
@@ -6269,13 +6649,13 @@ module Aws::Connect
6269
6649
  # @option params [String] :queue_id
6270
6650
  # The queue for the call. If you specify a queue, the phone displayed
6271
6651
  # for caller ID is the phone number specified in the queue. If you do
6272
- # not specify a queue, the queue defined in the contact flow is used. If
6273
- # you do not specify a queue, you must specify a source phone number.
6652
+ # not specify a queue, the queue defined in the flow is used. If you do
6653
+ # not specify a queue, you must specify a source phone number.
6274
6654
  #
6275
6655
  # @option params [Hash<String,String>] :attributes
6276
6656
  # A custom key-value pair using an attribute map. The attributes are
6277
- # standard Amazon Connect attributes, and can be accessed in contact
6278
- # flows just like any other contact attributes.
6657
+ # standard Amazon Connect attributes, and can be accessed in flows just
6658
+ # like any other contact attributes.
6279
6659
  #
6280
6660
  # There can be up to 32,768 UTF-8 bytes across all key-value pairs per
6281
6661
  # contact. Attribute keys can include only alphanumeric, dash, and
@@ -6331,7 +6711,7 @@ module Aws::Connect
6331
6711
  req.send_request(options)
6332
6712
  end
6333
6713
 
6334
- # Initiates a contact flow to start a new task.
6714
+ # Initiates a flow to start a new task.
6335
6715
  #
6336
6716
  # @option params [required, String] :instance_id
6337
6717
  # The identifier of the Amazon Connect instance. You can find the
@@ -6341,19 +6721,19 @@ module Aws::Connect
6341
6721
  # The identifier of the previous chat, voice, or task contact.
6342
6722
  #
6343
6723
  # @option params [String] :contact_flow_id
6344
- # The identifier of the contact flow for initiating the tasks. To see
6345
- # the ContactFlowId in the Amazon Connect console user interface, on the
6346
- # navigation menu go to **Routing**, **Contact Flows**. Choose the
6347
- # contact flow. On the contact flow page, under the name of the contact
6348
- # flow, choose **Show additional flow information**. The ContactFlowId
6349
- # is the last part of the ARN, shown here in bold:
6724
+ # The identifier of the flow for initiating the tasks. To see the
6725
+ # ContactFlowId in the Amazon Connect console user interface, on the
6726
+ # navigation menu go to **Routing**, **Contact Flows**. Choose the flow.
6727
+ # On the flow page, under the name of the flow, choose **Show additional
6728
+ # flow information**. The ContactFlowId is the last part of the ARN,
6729
+ # shown here in bold:
6350
6730
  #
6351
6731
  # arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
6352
6732
  #
6353
6733
  # @option params [Hash<String,String>] :attributes
6354
6734
  # A custom key-value pair using an attribute map. The attributes are
6355
- # standard Amazon Connect attributes, and can be accessed in contact
6356
- # flows just like any other contact attributes.
6735
+ # standard Amazon Connect attributes, and can be accessed in flows just
6736
+ # like any other contact attributes.
6357
6737
  #
6358
6738
  # There can be up to 32,768 UTF-8 bytes across all key-value pairs per
6359
6739
  # contact. Attribute keys can include only alphanumeric, dash, and
@@ -6380,8 +6760,8 @@ module Aws::Connect
6380
6760
  #
6381
6761
  # @option params [Time,DateTime,Date,Integer,String] :scheduled_time
6382
6762
  # The timestamp, in Unix Epoch seconds format, at which to start running
6383
- # the inbound contact flow. The scheduled time cannot be in the past. It
6384
- # must be within up to 6 days in future.
6763
+ # the inbound flow. The scheduled time cannot be in the past. It must be
6764
+ # within up to 6 days in future.
6385
6765
  #
6386
6766
  # @option params [String] :task_template_id
6387
6767
  # A unique identifier for the task template.
@@ -6582,22 +6962,25 @@ module Aws::Connect
6582
6962
 
6583
6963
  # Adds the specified tags to the specified resource.
6584
6964
  #
6585
- # The supported resource types are users, routing profiles, queues,
6586
- # quick connects, contact flows, agent status, hours of operation, phone
6587
- # number, security profiles, and task templates.
6965
+ # Some of the supported resource types are agents, routing profiles,
6966
+ # queues, quick connects, contact flows, agent statuses, hours of
6967
+ # operation, phone numbers, security profiles, and task templates. For a
6968
+ # complete list, see [Tagging resources in Amazon Connect][1].
6588
6969
  #
6589
6970
  # For sample policies that use tags, see [Amazon Connect Identity-Based
6590
- # Policy Examples][1] in the *Amazon Connect Administrator Guide*.
6971
+ # Policy Examples][2] in the *Amazon Connect Administrator Guide*.
6591
6972
  #
6592
6973
  #
6593
6974
  #
6594
- # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html
6975
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/tagging.html
6976
+ # [2]: https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html
6595
6977
  #
6596
6978
  # @option params [required, String] :resource_arn
6597
6979
  # The Amazon Resource Name (ARN) of the resource.
6598
6980
  #
6599
6981
  # @option params [required, Hash<String,String>] :tags
6600
- # One or more tags. For example, \\\{ "tags": \\\{"key1":"value1",
6982
+ # The tags used to organize, track, or control access for this resource.
6983
+ # For example, \\\{ "tags": \\\{"key1":"value1",
6601
6984
  # "key2":"value2"\\} \\}.
6602
6985
  #
6603
6986
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
@@ -6622,10 +7005,10 @@ module Aws::Connect
6622
7005
 
6623
7006
  # Transfers contacts from one agent or queue to another agent or queue
6624
7007
  # at any point after a contact is created. You can transfer a contact to
6625
- # another queue by providing the contact flow which orchestrates the
6626
- # contact to the destination queue. This gives you more control over
6627
- # contact handling and helps you adhere to the service level agreement
6628
- # (SLA) guaranteed to your customers.
7008
+ # another queue by providing the flow which orchestrates the contact to
7009
+ # the destination queue. This gives you more control over contact
7010
+ # handling and helps you adhere to the service level agreement (SLA)
7011
+ # guaranteed to your customers.
6629
7012
  #
6630
7013
  # Note the following requirements:
6631
7014
  #
@@ -6633,8 +7016,8 @@ module Aws::Connect
6633
7016
  #
6634
7017
  # * Do not use both `QueueId` and `UserId` in the same call.
6635
7018
  #
6636
- # * The following contact flow types are supported: Inbound contact
6637
- # flow, Transfer to agent flow, and Transfer to queue flow.
7019
+ # * The following flow types are supported: Inbound flow, Transfer to
7020
+ # agent flow, and Transfer to queue flow.
6638
7021
  #
6639
7022
  # * The `TransferContact` API can be called only on active contacts.
6640
7023
  #
@@ -6654,7 +7037,7 @@ module Aws::Connect
6654
7037
  # The identifier for the user.
6655
7038
  #
6656
7039
  # @option params [required, String] :contact_flow_id
6657
- # The identifier of the contact flow.
7040
+ # The identifier of the flow.
6658
7041
  #
6659
7042
  # @option params [String] :client_token
6660
7043
  # A unique, case-sensitive identifier that you provide to ensure the
@@ -6837,18 +7220,10 @@ module Aws::Connect
6837
7220
  # callers.
6838
7221
  #
6839
7222
  # Contact attributes are available in Amazon Connect for 24 months, and
6840
- # are then deleted. For information about CTR retention and the maximum
6841
- # size of the CTR attributes section, see [Feature specifications][1] in
6842
- # the *Amazon Connect Administrator Guide*.
6843
- #
6844
- # **Important:** You cannot use the operation to update attributes for
6845
- # contacts that occurred prior to the release of the API, which was
6846
- # September 12, 2018. You can update attributes only for contacts that
6847
- # started after the release of the API. If you attempt to update
6848
- # attributes for a contact that occurred prior to the release of the
6849
- # API, a 400 error is returned. This applies also to queued callbacks
6850
- # that were initiated prior to the release of the API but are still
6851
- # active in your instance.
7223
+ # are then deleted. For information about contact record retention and
7224
+ # the maximum size of the contact record attributes section, see
7225
+ # [Feature specifications][1] in the *Amazon Connect Administrator
7226
+ # Guide*.
6852
7227
  #
6853
7228
  #
6854
7229
  #
@@ -6864,7 +7239,7 @@ module Aws::Connect
6864
7239
  #
6865
7240
  # @option params [required, Hash<String,String>] :attributes
6866
7241
  # The Amazon Connect attributes. These attributes can be accessed in
6867
- # contact flows just like any other contact attributes.
7242
+ # flows just like any other contact attributes.
6868
7243
  #
6869
7244
  # You can have up to 32,768 UTF-8 bytes across all attributes for a
6870
7245
  # contact. Attribute keys can include only alphanumeric, dash, and
@@ -6891,10 +7266,10 @@ module Aws::Connect
6891
7266
  req.send_request(options)
6892
7267
  end
6893
7268
 
6894
- # Updates the specified contact flow.
7269
+ # Updates the specified flow.
6895
7270
  #
6896
- # You can also create and update contact flows using the [Amazon Connect
6897
- # Flow language][1].
7271
+ # You can also create and update flows using the [Amazon Connect Flow
7272
+ # language][1].
6898
7273
  #
6899
7274
  #
6900
7275
  #
@@ -6904,12 +7279,12 @@ module Aws::Connect
6904
7279
  # The identifier of the Amazon Connect instance.
6905
7280
  #
6906
7281
  # @option params [required, String] :contact_flow_id
6907
- # The identifier of the contact flow.
7282
+ # The identifier of the flow.
6908
7283
  #
6909
7284
  # @option params [required, String] :content
6910
- # The JSON string that represents contact flows content. For an
6911
- # example, see [Example contact flow in Amazon Connect Flow language][1]
6912
- # in the *Amazon Connect Administrator Guide*.
7285
+ # The JSON string that represents flow's content. For an example, see
7286
+ # [Example contact flow in Amazon Connect Flow language][1] in the
7287
+ # *Amazon Connect Administrator Guide*.
6913
7288
  #
6914
7289
  #
6915
7290
  #
@@ -6934,23 +7309,23 @@ module Aws::Connect
6934
7309
  req.send_request(options)
6935
7310
  end
6936
7311
 
6937
- # Updates metadata about specified contact flow.
7312
+ # Updates metadata about specified flow.
6938
7313
  #
6939
7314
  # @option params [required, String] :instance_id
6940
7315
  # The identifier of the Amazon Connect instance. You can find the
6941
7316
  # instanceId in the ARN of the instance.
6942
7317
  #
6943
7318
  # @option params [required, String] :contact_flow_id
6944
- # The identifier of the contact flow.
7319
+ # The identifier of the flow.
6945
7320
  #
6946
7321
  # @option params [String] :name
6947
- # TThe name of the contact flow.
7322
+ # The name of the flow.
6948
7323
  #
6949
7324
  # @option params [String] :description
6950
- # The description of the contact flow.
7325
+ # The description of the flow.
6951
7326
  #
6952
7327
  # @option params [String] :contact_flow_state
6953
- # The state of contact flow.
7328
+ # The state of flow.
6954
7329
  #
6955
7330
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
6956
7331
  #
@@ -6973,7 +7348,7 @@ module Aws::Connect
6973
7348
  req.send_request(options)
6974
7349
  end
6975
7350
 
6976
- # Updates specified contact flow module for the specified Amazon Connect
7351
+ # Updates specified flow module for the specified Amazon Connect
6977
7352
  # instance.
6978
7353
  #
6979
7354
  # @option params [required, String] :instance_id
@@ -6981,10 +7356,10 @@ module Aws::Connect
6981
7356
  # instanceId in the ARN of the instance.
6982
7357
  #
6983
7358
  # @option params [required, String] :contact_flow_module_id
6984
- # The identifier of the contact flow module.
7359
+ # The identifier of the flow module.
6985
7360
  #
6986
7361
  # @option params [required, String] :content
6987
- # The content of the contact flow module.
7362
+ # The content of the flow module.
6988
7363
  #
6989
7364
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
6990
7365
  #
@@ -7005,23 +7380,23 @@ module Aws::Connect
7005
7380
  req.send_request(options)
7006
7381
  end
7007
7382
 
7008
- # Updates metadata about specified contact flow module.
7383
+ # Updates metadata about specified flow module.
7009
7384
  #
7010
7385
  # @option params [required, String] :instance_id
7011
7386
  # The identifier of the Amazon Connect instance. You can find the
7012
7387
  # instanceId in the ARN of the instance.
7013
7388
  #
7014
7389
  # @option params [required, String] :contact_flow_module_id
7015
- # The identifier of the contact flow module.
7390
+ # The identifier of the flow module.
7016
7391
  #
7017
7392
  # @option params [String] :name
7018
- # The name of the contact flow module.
7393
+ # The name of the flow module.
7019
7394
  #
7020
7395
  # @option params [String] :description
7021
- # The description of the contact flow module.
7396
+ # The description of the flow module.
7022
7397
  #
7023
7398
  # @option params [String] :state
7024
- # The state of contact flow module.
7399
+ # The state of flow module.
7025
7400
  #
7026
7401
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
7027
7402
  #
@@ -7044,10 +7419,10 @@ module Aws::Connect
7044
7419
  req.send_request(options)
7045
7420
  end
7046
7421
 
7047
- # The name of the contact flow.
7422
+ # The name of the flow.
7048
7423
  #
7049
- # You can also create and update contact flows using the [Amazon Connect
7050
- # Flow language][1].
7424
+ # You can also create and update flows using the [Amazon Connect Flow
7425
+ # language][1].
7051
7426
  #
7052
7427
  #
7053
7428
  #
@@ -7057,13 +7432,13 @@ module Aws::Connect
7057
7432
  # The identifier of the Amazon Connect instance.
7058
7433
  #
7059
7434
  # @option params [required, String] :contact_flow_id
7060
- # The identifier of the contact flow.
7435
+ # The identifier of the flow.
7061
7436
  #
7062
7437
  # @option params [String] :name
7063
- # The name of the contact flow.
7438
+ # The name of the flow.
7064
7439
  #
7065
7440
  # @option params [String] :description
7066
- # The description of the contact flow.
7441
+ # The description of the flow.
7067
7442
  #
7068
7443
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
7069
7444
  #
@@ -7097,8 +7472,8 @@ module Aws::Connect
7097
7472
  #
7098
7473
  # @option params [required, Time,DateTime,Date,Integer,String] :scheduled_time
7099
7474
  # The timestamp, in Unix Epoch seconds format, at which to start running
7100
- # the inbound contact flow. The scheduled time cannot be in the past. It
7101
- # must be within up to 6 days in future.
7475
+ # the inbound flow. The scheduled time cannot be in the past. It must be
7476
+ # within up to 6 days in future.
7102
7477
  #
7103
7478
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
7104
7479
  #
@@ -7204,7 +7579,7 @@ module Aws::Connect
7204
7579
  #
7205
7580
  # resp = client.update_instance_attribute({
7206
7581
  # instance_id: "InstanceId", # required
7207
- # 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
7582
+ # 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
7208
7583
  # value: "InstanceAttributeValue", # required
7209
7584
  # })
7210
7585
  #
@@ -7748,7 +8123,12 @@ module Aws::Connect
7748
8123
  # The description of the security profile.
7749
8124
  #
7750
8125
  # @option params [Array<String>] :permissions
7751
- # The permissions granted to a security profile.
8126
+ # The permissions granted to a security profile. For a list of valid
8127
+ # permissions, see [List of security profile permissions][1].
8128
+ #
8129
+ #
8130
+ #
8131
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html
7752
8132
  #
7753
8133
  # @option params [required, String] :security_profile_id
7754
8134
  # The identifier for the security profle.
@@ -8183,7 +8563,7 @@ module Aws::Connect
8183
8563
  params: params,
8184
8564
  config: config)
8185
8565
  context[:gem_name] = 'aws-sdk-connect'
8186
- context[:gem_version] = '1.73.0'
8566
+ context[:gem_version] = '1.76.0'
8187
8567
  Seahorse::Client::Request.new(handlers, context)
8188
8568
  end
8189
8569