aws-sdk-connect 1.53.0 → 1.57.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +527 -3
- data/lib/aws-sdk-connect/client_api.rb +346 -0
- data/lib/aws-sdk-connect/errors.rb +16 -0
- data/lib/aws-sdk-connect/types.rb +830 -29
- data/lib/aws-sdk-connect.rb +1 -1
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: dbb7cfb7c8be2ab91bd78574df4edc85633695a0da3480b4c565c68a6dea01ee
|
4
|
+
data.tar.gz: d7daa280947667b88700faff7ca806519c3fb90e91b7f05c8ce5c6eeb770fbd3
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c7a8c34bb4771466d48548dacf0796e950f288011981906eead049058655e921dbaa96a7558e4ecc4348913d4652438c0148fe9b99306d043e83c274ebf81940
|
7
|
+
data.tar.gz: fe64edf7d6f5dc711127ce41feb8fa9ae3c30e23acee5124c99d48507ca4a87be739033481dc0db986498c99d849b2ca77358b1959b101ad99bdb06c215c9702
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.57.0 (2021-11-12)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release adds APIs for creating and managing scheduled tasks. Additionally, adds APIs to describe and update a contact and list associated references.
|
8
|
+
|
9
|
+
1.56.0 (2021-11-04)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - This release adds CRUD operation support for Security profile resource in Amazon Connect
|
13
|
+
|
14
|
+
1.55.0 (2021-11-02)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Amazon Connect Chat now supports real-time message streaming.
|
18
|
+
|
19
|
+
1.54.0 (2021-10-29)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Amazon Connect Chat now supports real-time message streaming.
|
23
|
+
|
4
24
|
1.53.0 (2021-10-21)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.57.0
|
@@ -275,6 +275,15 @@ module Aws::Connect
|
|
275
275
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
276
276
|
# requests are made, and retries are disabled.
|
277
277
|
#
|
278
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
279
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
280
|
+
# will be used if available.
|
281
|
+
#
|
282
|
+
# @option options [Boolean] :use_fips_endpoint
|
283
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
284
|
+
# When a `fips` region is used, the region is normalized and this config
|
285
|
+
# is set to `true`.
|
286
|
+
#
|
278
287
|
# @option options [Boolean] :validate_params (true)
|
279
288
|
# When `true`, request parameters are validated before
|
280
289
|
# sending the request.
|
@@ -1161,6 +1170,58 @@ module Aws::Connect
|
|
1161
1170
|
req.send_request(options)
|
1162
1171
|
end
|
1163
1172
|
|
1173
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1174
|
+
# change.
|
1175
|
+
#
|
1176
|
+
# Creates a security profile.
|
1177
|
+
#
|
1178
|
+
# @option params [required, String] :security_profile_name
|
1179
|
+
# The name of the security profile.
|
1180
|
+
#
|
1181
|
+
# @option params [String] :description
|
1182
|
+
# The description of the security profile.
|
1183
|
+
#
|
1184
|
+
# @option params [Array<String>] :permissions
|
1185
|
+
# Permissions assigned to the security profile.
|
1186
|
+
#
|
1187
|
+
# @option params [required, String] :instance_id
|
1188
|
+
# The identifier of the Amazon Connect instance. You can find the
|
1189
|
+
# instanceId in the ARN of the instance.
|
1190
|
+
#
|
1191
|
+
# @option params [Hash<String,String>] :tags
|
1192
|
+
# One or more tags.
|
1193
|
+
#
|
1194
|
+
# @return [Types::CreateSecurityProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1195
|
+
#
|
1196
|
+
# * {Types::CreateSecurityProfileResponse#security_profile_id #security_profile_id} => String
|
1197
|
+
# * {Types::CreateSecurityProfileResponse#security_profile_arn #security_profile_arn} => String
|
1198
|
+
#
|
1199
|
+
# @example Request syntax with placeholder values
|
1200
|
+
#
|
1201
|
+
# resp = client.create_security_profile({
|
1202
|
+
# security_profile_name: "SecurityProfileName", # required
|
1203
|
+
# description: "SecurityProfileDescription",
|
1204
|
+
# permissions: ["SecurityProfilePermission"],
|
1205
|
+
# instance_id: "InstanceId", # required
|
1206
|
+
# tags: {
|
1207
|
+
# "TagKey" => "TagValue",
|
1208
|
+
# },
|
1209
|
+
# })
|
1210
|
+
#
|
1211
|
+
# @example Response structure
|
1212
|
+
#
|
1213
|
+
# resp.security_profile_id #=> String
|
1214
|
+
# resp.security_profile_arn #=> String
|
1215
|
+
#
|
1216
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateSecurityProfile AWS API Documentation
|
1217
|
+
#
|
1218
|
+
# @overload create_security_profile(params = {})
|
1219
|
+
# @param [Hash] params ({})
|
1220
|
+
def create_security_profile(params = {}, options = {})
|
1221
|
+
req = build_request(:create_security_profile, params)
|
1222
|
+
req.send_request(options)
|
1223
|
+
end
|
1224
|
+
|
1164
1225
|
# Creates a use case for an integration association.
|
1165
1226
|
#
|
1166
1227
|
# @option params [required, String] :instance_id
|
@@ -1464,6 +1525,36 @@ module Aws::Connect
|
|
1464
1525
|
req.send_request(options)
|
1465
1526
|
end
|
1466
1527
|
|
1528
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1529
|
+
# change.
|
1530
|
+
#
|
1531
|
+
# Deletes a security profile.
|
1532
|
+
#
|
1533
|
+
# @option params [required, String] :instance_id
|
1534
|
+
# The identifier of the Amazon Connect instance. You can find the
|
1535
|
+
# instanceId in the ARN of the instance.
|
1536
|
+
#
|
1537
|
+
# @option params [required, String] :security_profile_id
|
1538
|
+
# The identifier for the security profle.
|
1539
|
+
#
|
1540
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1541
|
+
#
|
1542
|
+
# @example Request syntax with placeholder values
|
1543
|
+
#
|
1544
|
+
# resp = client.delete_security_profile({
|
1545
|
+
# instance_id: "InstanceId", # required
|
1546
|
+
# security_profile_id: "SecurityProfileId", # required
|
1547
|
+
# })
|
1548
|
+
#
|
1549
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteSecurityProfile AWS API Documentation
|
1550
|
+
#
|
1551
|
+
# @overload delete_security_profile(params = {})
|
1552
|
+
# @param [Hash] params ({})
|
1553
|
+
def delete_security_profile(params = {}, options = {})
|
1554
|
+
req = build_request(:delete_security_profile, params)
|
1555
|
+
req.send_request(options)
|
1556
|
+
end
|
1557
|
+
|
1467
1558
|
# Deletes a use case from an integration association.
|
1468
1559
|
#
|
1469
1560
|
# @option params [required, String] :instance_id
|
@@ -1602,6 +1693,60 @@ module Aws::Connect
|
|
1602
1693
|
req.send_request(options)
|
1603
1694
|
end
|
1604
1695
|
|
1696
|
+
# This API is in preview release for Amazon Connect and is subject to
|
1697
|
+
# change.
|
1698
|
+
#
|
1699
|
+
# Describes the specified contact.
|
1700
|
+
#
|
1701
|
+
# Contact information is available in Amazon Connect for 24 months, and
|
1702
|
+
# then it is deleted.
|
1703
|
+
#
|
1704
|
+
# @option params [required, String] :instance_id
|
1705
|
+
# The identifier of the Amazon Connect instance. You can find the
|
1706
|
+
# instanceId in the ARN of the instance.
|
1707
|
+
#
|
1708
|
+
# @option params [required, String] :contact_id
|
1709
|
+
# The identifier of the initial contact.
|
1710
|
+
#
|
1711
|
+
# @return [Types::DescribeContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1712
|
+
#
|
1713
|
+
# * {Types::DescribeContactResponse#contact #contact} => Types::Contact
|
1714
|
+
#
|
1715
|
+
# @example Request syntax with placeholder values
|
1716
|
+
#
|
1717
|
+
# resp = client.describe_contact({
|
1718
|
+
# instance_id: "InstanceId", # required
|
1719
|
+
# contact_id: "ContactId", # required
|
1720
|
+
# })
|
1721
|
+
#
|
1722
|
+
# @example Response structure
|
1723
|
+
#
|
1724
|
+
# resp.contact.arn #=> String
|
1725
|
+
# resp.contact.id #=> String
|
1726
|
+
# resp.contact.initial_contact_id #=> String
|
1727
|
+
# resp.contact.previous_contact_id #=> String
|
1728
|
+
# resp.contact.initiation_method #=> String, one of "INBOUND", "OUTBOUND", "TRANSFER", "QUEUE_TRANSFER", "CALLBACK", "API"
|
1729
|
+
# resp.contact.name #=> String
|
1730
|
+
# resp.contact.description #=> String
|
1731
|
+
# resp.contact.channel #=> String, one of "VOICE", "CHAT", "TASK"
|
1732
|
+
# resp.contact.queue_info.id #=> String
|
1733
|
+
# resp.contact.queue_info.enqueue_timestamp #=> Time
|
1734
|
+
# resp.contact.agent_info.id #=> String
|
1735
|
+
# resp.contact.agent_info.connected_to_agent_timestamp #=> Time
|
1736
|
+
# resp.contact.initiation_timestamp #=> Time
|
1737
|
+
# resp.contact.disconnect_timestamp #=> Time
|
1738
|
+
# resp.contact.last_update_timestamp #=> Time
|
1739
|
+
# resp.contact.scheduled_timestamp #=> Time
|
1740
|
+
#
|
1741
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContact AWS API Documentation
|
1742
|
+
#
|
1743
|
+
# @overload describe_contact(params = {})
|
1744
|
+
# @param [Hash] params ({})
|
1745
|
+
def describe_contact(params = {}, options = {})
|
1746
|
+
req = build_request(:describe_contact, params)
|
1747
|
+
req.send_request(options)
|
1748
|
+
end
|
1749
|
+
|
1605
1750
|
# Describes the specified contact flow.
|
1606
1751
|
#
|
1607
1752
|
# You can also create and update contact flows using the [Amazon Connect
|
@@ -1965,6 +2110,48 @@ module Aws::Connect
|
|
1965
2110
|
req.send_request(options)
|
1966
2111
|
end
|
1967
2112
|
|
2113
|
+
# This API is in preview release for Amazon Connect and is subject to
|
2114
|
+
# change.
|
2115
|
+
#
|
2116
|
+
# Gets basic information about the security profle.
|
2117
|
+
#
|
2118
|
+
# @option params [required, String] :security_profile_id
|
2119
|
+
# The identifier for the security profle.
|
2120
|
+
#
|
2121
|
+
# @option params [required, String] :instance_id
|
2122
|
+
# The identifier of the Amazon Connect instance. You can find the
|
2123
|
+
# instanceId in the ARN of the instance.
|
2124
|
+
#
|
2125
|
+
# @return [Types::DescribeSecurityProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2126
|
+
#
|
2127
|
+
# * {Types::DescribeSecurityProfileResponse#security_profile #security_profile} => Types::SecurityProfile
|
2128
|
+
#
|
2129
|
+
# @example Request syntax with placeholder values
|
2130
|
+
#
|
2131
|
+
# resp = client.describe_security_profile({
|
2132
|
+
# security_profile_id: "SecurityProfileId", # required
|
2133
|
+
# instance_id: "InstanceId", # required
|
2134
|
+
# })
|
2135
|
+
#
|
2136
|
+
# @example Response structure
|
2137
|
+
#
|
2138
|
+
# resp.security_profile.id #=> String
|
2139
|
+
# resp.security_profile.organization_resource_id #=> String
|
2140
|
+
# resp.security_profile.arn #=> String
|
2141
|
+
# resp.security_profile.security_profile_name #=> String
|
2142
|
+
# resp.security_profile.description #=> String
|
2143
|
+
# resp.security_profile.tags #=> Hash
|
2144
|
+
# resp.security_profile.tags["TagKey"] #=> String
|
2145
|
+
#
|
2146
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeSecurityProfile AWS API Documentation
|
2147
|
+
#
|
2148
|
+
# @overload describe_security_profile(params = {})
|
2149
|
+
# @param [Hash] params ({})
|
2150
|
+
def describe_security_profile(params = {}, options = {})
|
2151
|
+
req = build_request(:describe_security_profile, params)
|
2152
|
+
req.send_request(options)
|
2153
|
+
end
|
2154
|
+
|
1968
2155
|
# Describes the specified user account. You can find the instance ID in
|
1969
2156
|
# the console (it’s the final part of the ARN). The console does not
|
1970
2157
|
# display the user IDs. Instead, list the users and note the IDs
|
@@ -3172,6 +3359,65 @@ module Aws::Connect
|
|
3172
3359
|
req.send_request(options)
|
3173
3360
|
end
|
3174
3361
|
|
3362
|
+
# This API is in preview release for Amazon Connect and is subject to
|
3363
|
+
# change.
|
3364
|
+
#
|
3365
|
+
# For the specified `referenceTypes`, returns a list of references
|
3366
|
+
# associated with the contact.
|
3367
|
+
#
|
3368
|
+
# @option params [required, String] :instance_id
|
3369
|
+
# The identifier of the Amazon Connect instance. You can find the
|
3370
|
+
# instanceId in the ARN of the instance.
|
3371
|
+
#
|
3372
|
+
# @option params [required, String] :contact_id
|
3373
|
+
# The identifier of the initial contact.
|
3374
|
+
#
|
3375
|
+
# @option params [required, Array<String>] :reference_types
|
3376
|
+
# The type of reference.
|
3377
|
+
#
|
3378
|
+
# @option params [String] :next_token
|
3379
|
+
# The token for the next set of results. Use the value returned in the
|
3380
|
+
# previous response in the next request to retrieve the next set of
|
3381
|
+
# results.
|
3382
|
+
#
|
3383
|
+
# This is not expected to be set since the value returned in the
|
3384
|
+
# previous response is always null.
|
3385
|
+
#
|
3386
|
+
# @return [Types::ListContactReferencesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3387
|
+
#
|
3388
|
+
# * {Types::ListContactReferencesResponse#reference_summary_list #reference_summary_list} => Array<Types::ReferenceSummary>
|
3389
|
+
# * {Types::ListContactReferencesResponse#next_token #next_token} => String
|
3390
|
+
#
|
3391
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3392
|
+
#
|
3393
|
+
# @example Request syntax with placeholder values
|
3394
|
+
#
|
3395
|
+
# resp = client.list_contact_references({
|
3396
|
+
# instance_id: "InstanceId", # required
|
3397
|
+
# contact_id: "ContactId", # required
|
3398
|
+
# reference_types: ["URL"], # required, accepts URL, ATTACHMENT
|
3399
|
+
# next_token: "NextToken",
|
3400
|
+
# })
|
3401
|
+
#
|
3402
|
+
# @example Response structure
|
3403
|
+
#
|
3404
|
+
# resp.reference_summary_list #=> Array
|
3405
|
+
# resp.reference_summary_list[0].url.name #=> String
|
3406
|
+
# resp.reference_summary_list[0].url.value #=> String
|
3407
|
+
# resp.reference_summary_list[0].attachment.name #=> String
|
3408
|
+
# resp.reference_summary_list[0].attachment.value #=> String
|
3409
|
+
# resp.reference_summary_list[0].attachment.status #=> String, one of "APPROVED", "REJECTED"
|
3410
|
+
# resp.next_token #=> String
|
3411
|
+
#
|
3412
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactReferences AWS API Documentation
|
3413
|
+
#
|
3414
|
+
# @overload list_contact_references(params = {})
|
3415
|
+
# @param [Hash] params ({})
|
3416
|
+
def list_contact_references(params = {}, options = {})
|
3417
|
+
req = build_request(:list_contact_references, params)
|
3418
|
+
req.send_request(options)
|
3419
|
+
end
|
3420
|
+
|
3175
3421
|
# Provides information about the hours of operation for the specified
|
3176
3422
|
# Amazon Connect instance.
|
3177
3423
|
#
|
@@ -3987,6 +4233,57 @@ module Aws::Connect
|
|
3987
4233
|
req.send_request(options)
|
3988
4234
|
end
|
3989
4235
|
|
4236
|
+
# This API is in preview release for Amazon Connect and is subject to
|
4237
|
+
# change.
|
4238
|
+
#
|
4239
|
+
# Lists the permissions granted to a security profile.
|
4240
|
+
#
|
4241
|
+
# @option params [required, String] :security_profile_id
|
4242
|
+
# The identifier for the security profle.
|
4243
|
+
#
|
4244
|
+
# @option params [required, String] :instance_id
|
4245
|
+
# The identifier of the Amazon Connect instance. You can find the
|
4246
|
+
# instanceId in the ARN of the instance.
|
4247
|
+
#
|
4248
|
+
# @option params [String] :next_token
|
4249
|
+
# The token for the next set of results. Use the value returned in the
|
4250
|
+
# previous response in the next request to retrieve the next set of
|
4251
|
+
# results.
|
4252
|
+
#
|
4253
|
+
# @option params [Integer] :max_results
|
4254
|
+
# The maximum number of results to return per page.
|
4255
|
+
#
|
4256
|
+
# @return [Types::ListSecurityProfilePermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4257
|
+
#
|
4258
|
+
# * {Types::ListSecurityProfilePermissionsResponse#permissions #permissions} => Array<String>
|
4259
|
+
# * {Types::ListSecurityProfilePermissionsResponse#next_token #next_token} => String
|
4260
|
+
#
|
4261
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4262
|
+
#
|
4263
|
+
# @example Request syntax with placeholder values
|
4264
|
+
#
|
4265
|
+
# resp = client.list_security_profile_permissions({
|
4266
|
+
# security_profile_id: "SecurityProfileId", # required
|
4267
|
+
# instance_id: "InstanceId", # required
|
4268
|
+
# next_token: "NextToken",
|
4269
|
+
# max_results: 1,
|
4270
|
+
# })
|
4271
|
+
#
|
4272
|
+
# @example Response structure
|
4273
|
+
#
|
4274
|
+
# resp.permissions #=> Array
|
4275
|
+
# resp.permissions[0] #=> String
|
4276
|
+
# resp.next_token #=> String
|
4277
|
+
#
|
4278
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListSecurityProfilePermissions AWS API Documentation
|
4279
|
+
#
|
4280
|
+
# @overload list_security_profile_permissions(params = {})
|
4281
|
+
# @param [Hash] params ({})
|
4282
|
+
def list_security_profile_permissions(params = {}, options = {})
|
4283
|
+
req = build_request(:list_security_profile_permissions, params)
|
4284
|
+
req.send_request(options)
|
4285
|
+
end
|
4286
|
+
|
3990
4287
|
# Provides summary information about the security profiles for the
|
3991
4288
|
# specified Amazon Connect instance.
|
3992
4289
|
#
|
@@ -4419,6 +4716,63 @@ module Aws::Connect
|
|
4419
4716
|
req.send_request(options)
|
4420
4717
|
end
|
4421
4718
|
|
4719
|
+
# Initiates real-time message streaming for a new chat contact.
|
4720
|
+
#
|
4721
|
+
# For more information about message streaming, see [Enable real-time
|
4722
|
+
# chat message streaming][1] in the *Amazon Connect Administrator
|
4723
|
+
# Guide*.
|
4724
|
+
#
|
4725
|
+
#
|
4726
|
+
#
|
4727
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/chat-message-streaming.html
|
4728
|
+
#
|
4729
|
+
# @option params [required, String] :instance_id
|
4730
|
+
# The identifier of the Amazon Connect instance. You can find the
|
4731
|
+
# instanceId in the ARN of the instance.
|
4732
|
+
#
|
4733
|
+
# @option params [required, String] :contact_id
|
4734
|
+
# The identifier of the contact. This is the identifier of the contact
|
4735
|
+
# associated with the first interaction with the contact center.
|
4736
|
+
#
|
4737
|
+
# @option params [required, Types::ChatStreamingConfiguration] :chat_streaming_configuration
|
4738
|
+
# The streaming configuration, such as the Amazon SNS streaming
|
4739
|
+
# endpoint.
|
4740
|
+
#
|
4741
|
+
# @option params [required, String] :client_token
|
4742
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
4743
|
+
# idempotency of the request.
|
4744
|
+
#
|
4745
|
+
# **A suitable default value is auto-generated.** You should normally
|
4746
|
+
# not need to pass this option.**
|
4747
|
+
#
|
4748
|
+
# @return [Types::StartContactStreamingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4749
|
+
#
|
4750
|
+
# * {Types::StartContactStreamingResponse#streaming_id #streaming_id} => String
|
4751
|
+
#
|
4752
|
+
# @example Request syntax with placeholder values
|
4753
|
+
#
|
4754
|
+
# resp = client.start_contact_streaming({
|
4755
|
+
# instance_id: "InstanceId", # required
|
4756
|
+
# contact_id: "ContactId", # required
|
4757
|
+
# chat_streaming_configuration: { # required
|
4758
|
+
# streaming_endpoint_arn: "ChatStreamingEndpointARN", # required
|
4759
|
+
# },
|
4760
|
+
# client_token: "ClientToken", # required
|
4761
|
+
# })
|
4762
|
+
#
|
4763
|
+
# @example Response structure
|
4764
|
+
#
|
4765
|
+
# resp.streaming_id #=> String
|
4766
|
+
#
|
4767
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartContactStreaming AWS API Documentation
|
4768
|
+
#
|
4769
|
+
# @overload start_contact_streaming(params = {})
|
4770
|
+
# @param [Hash] params ({})
|
4771
|
+
def start_contact_streaming(params = {}, options = {})
|
4772
|
+
req = build_request(:start_contact_streaming, params)
|
4773
|
+
req.send_request(options)
|
4774
|
+
end
|
4775
|
+
|
4422
4776
|
# Places an outbound call to a contact, and then initiates the contact
|
4423
4777
|
# flow. It performs the actions in the contact flow that's specified
|
4424
4778
|
# (in `ContactFlowId`).
|
@@ -4544,7 +4898,8 @@ module Aws::Connect
|
|
4544
4898
|
req.send_request(options)
|
4545
4899
|
end
|
4546
4900
|
|
4547
|
-
# Initiates a contact flow to start a new task
|
4901
|
+
# Initiates a contact flow to start a new task immediately or at a
|
4902
|
+
# future date and time.
|
4548
4903
|
#
|
4549
4904
|
# @option params [required, String] :instance_id
|
4550
4905
|
# The identifier of the Amazon Connect instance. You can find the
|
@@ -4591,6 +4946,11 @@ module Aws::Connect
|
|
4591
4946
|
# **A suitable default value is auto-generated.** You should normally
|
4592
4947
|
# not need to pass this option.**
|
4593
4948
|
#
|
4949
|
+
# @option params [Time,DateTime,Date,Integer,String] :scheduled_time
|
4950
|
+
# The timestamp, in Unix Epoch seconds format, at which to start running
|
4951
|
+
# the inbound contact flow. The scheduled time cannot be in the past. It
|
4952
|
+
# must be within up to 6 days in future.
|
4953
|
+
#
|
4594
4954
|
# @return [Types::StartTaskContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4595
4955
|
#
|
4596
4956
|
# * {Types::StartTaskContactResponse#contact_id #contact_id} => String
|
@@ -4608,11 +4968,12 @@ module Aws::Connect
|
|
4608
4968
|
# references: {
|
4609
4969
|
# "ReferenceKey" => {
|
4610
4970
|
# value: "ReferenceValue", # required
|
4611
|
-
# type: "URL", # required, accepts URL
|
4971
|
+
# type: "URL", # required, accepts URL, ATTACHMENT
|
4612
4972
|
# },
|
4613
4973
|
# },
|
4614
4974
|
# description: "Description",
|
4615
4975
|
# client_token: "ClientToken",
|
4976
|
+
# scheduled_time: Time.now,
|
4616
4977
|
# })
|
4617
4978
|
#
|
4618
4979
|
# @example Response structure
|
@@ -4695,6 +5056,43 @@ module Aws::Connect
|
|
4695
5056
|
req.send_request(options)
|
4696
5057
|
end
|
4697
5058
|
|
5059
|
+
# Ends message streaming on a specified contact. To restart message
|
5060
|
+
# streaming on that contact, call the [StartContactStreaming][1] API.
|
5061
|
+
#
|
5062
|
+
#
|
5063
|
+
#
|
5064
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_StartContactStreaming.html
|
5065
|
+
#
|
5066
|
+
# @option params [required, String] :instance_id
|
5067
|
+
# The identifier of the Amazon Connect instance. You can find the
|
5068
|
+
# instanceId in the ARN of the instance.
|
5069
|
+
#
|
5070
|
+
# @option params [required, String] :contact_id
|
5071
|
+
# The identifier of the contact. This is the identifier of the contact
|
5072
|
+
# that is associated with the first interaction with the contact center.
|
5073
|
+
#
|
5074
|
+
# @option params [required, String] :streaming_id
|
5075
|
+
# The identifier of the streaming configuration enabled.
|
5076
|
+
#
|
5077
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5078
|
+
#
|
5079
|
+
# @example Request syntax with placeholder values
|
5080
|
+
#
|
5081
|
+
# resp = client.stop_contact_streaming({
|
5082
|
+
# instance_id: "InstanceId", # required
|
5083
|
+
# contact_id: "ContactId", # required
|
5084
|
+
# streaming_id: "StreamingId", # required
|
5085
|
+
# })
|
5086
|
+
#
|
5087
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StopContactStreaming AWS API Documentation
|
5088
|
+
#
|
5089
|
+
# @overload stop_contact_streaming(params = {})
|
5090
|
+
# @param [Hash] params ({})
|
5091
|
+
def stop_contact_streaming(params = {}, options = {})
|
5092
|
+
req = build_request(:stop_contact_streaming, params)
|
5093
|
+
req.send_request(options)
|
5094
|
+
end
|
5095
|
+
|
4698
5096
|
# When a contact is being recorded, this API suspends recording the
|
4699
5097
|
# call. For example, you might suspend the call recording while
|
4700
5098
|
# collecting sensitive information, such as a credit card number. Then
|
@@ -4850,6 +5248,60 @@ module Aws::Connect
|
|
4850
5248
|
req.send_request(options)
|
4851
5249
|
end
|
4852
5250
|
|
5251
|
+
# This API is in preview release for Amazon Connect and is subject to
|
5252
|
+
# change.
|
5253
|
+
#
|
5254
|
+
# Adds or updates user defined contact information associated with the
|
5255
|
+
# specified contact. At least one field to be updated must be present in
|
5256
|
+
# the request.
|
5257
|
+
#
|
5258
|
+
# You can add or update user-defined contact information for both
|
5259
|
+
# ongoing and completed contacts.
|
5260
|
+
#
|
5261
|
+
# @option params [required, String] :instance_id
|
5262
|
+
# The identifier of the Amazon Connect instance. You can find the
|
5263
|
+
# instanceId in the ARN of the instance.
|
5264
|
+
#
|
5265
|
+
# @option params [required, String] :contact_id
|
5266
|
+
# The identifier of the contact. This is the identifier of the contact
|
5267
|
+
# associated with the first interaction with your contact center.
|
5268
|
+
#
|
5269
|
+
# @option params [String] :name
|
5270
|
+
# The name of the contact.
|
5271
|
+
#
|
5272
|
+
# @option params [String] :description
|
5273
|
+
# The description of the contact.
|
5274
|
+
#
|
5275
|
+
# @option params [Hash<String,Types::Reference>] :references
|
5276
|
+
# A formatted URL that is shown to an agent in the Contact Control Panel
|
5277
|
+
# (CCP).
|
5278
|
+
#
|
5279
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5280
|
+
#
|
5281
|
+
# @example Request syntax with placeholder values
|
5282
|
+
#
|
5283
|
+
# resp = client.update_contact({
|
5284
|
+
# instance_id: "InstanceId", # required
|
5285
|
+
# contact_id: "ContactId", # required
|
5286
|
+
# name: "Name",
|
5287
|
+
# description: "Description",
|
5288
|
+
# references: {
|
5289
|
+
# "ReferenceKey" => {
|
5290
|
+
# value: "ReferenceValue", # required
|
5291
|
+
# type: "URL", # required, accepts URL, ATTACHMENT
|
5292
|
+
# },
|
5293
|
+
# },
|
5294
|
+
# })
|
5295
|
+
#
|
5296
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContact AWS API Documentation
|
5297
|
+
#
|
5298
|
+
# @overload update_contact(params = {})
|
5299
|
+
# @param [Hash] params ({})
|
5300
|
+
def update_contact(params = {}, options = {})
|
5301
|
+
req = build_request(:update_contact, params)
|
5302
|
+
req.send_request(options)
|
5303
|
+
end
|
5304
|
+
|
4853
5305
|
# Creates or updates user-defined contact attributes associated with the
|
4854
5306
|
# specified contact.
|
4855
5307
|
#
|
@@ -5002,6 +5454,40 @@ module Aws::Connect
|
|
5002
5454
|
req.send_request(options)
|
5003
5455
|
end
|
5004
5456
|
|
5457
|
+
# Updates the scheduled time of a task contact that is already
|
5458
|
+
# scheduled.
|
5459
|
+
#
|
5460
|
+
# @option params [required, String] :instance_id
|
5461
|
+
# The identifier of the Amazon Connect instance. You can find the
|
5462
|
+
# instanceId in the ARN of the instance.
|
5463
|
+
#
|
5464
|
+
# @option params [required, String] :contact_id
|
5465
|
+
# The identifier of the contact.
|
5466
|
+
#
|
5467
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :scheduled_time
|
5468
|
+
# The timestamp, in Unix Epoch seconds format, at which to start running
|
5469
|
+
# the inbound contact flow. The scheduled time cannot be in the past. It
|
5470
|
+
# must be within up to 6 days in future.
|
5471
|
+
#
|
5472
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5473
|
+
#
|
5474
|
+
# @example Request syntax with placeholder values
|
5475
|
+
#
|
5476
|
+
# resp = client.update_contact_schedule({
|
5477
|
+
# instance_id: "InstanceId", # required
|
5478
|
+
# contact_id: "ContactId", # required
|
5479
|
+
# scheduled_time: Time.now, # required
|
5480
|
+
# })
|
5481
|
+
#
|
5482
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactSchedule AWS API Documentation
|
5483
|
+
#
|
5484
|
+
# @overload update_contact_schedule(params = {})
|
5485
|
+
# @param [Hash] params ({})
|
5486
|
+
def update_contact_schedule(params = {}, options = {})
|
5487
|
+
req = build_request(:update_contact_schedule, params)
|
5488
|
+
req.send_request(options)
|
5489
|
+
end
|
5490
|
+
|
5005
5491
|
# Updates the hours of operation.
|
5006
5492
|
#
|
5007
5493
|
# @option params [required, String] :instance_id
|
@@ -5574,6 +6060,44 @@ module Aws::Connect
|
|
5574
6060
|
req.send_request(options)
|
5575
6061
|
end
|
5576
6062
|
|
6063
|
+
# This API is in preview release for Amazon Connect and is subject to
|
6064
|
+
# change.
|
6065
|
+
#
|
6066
|
+
# Updates a security profile.
|
6067
|
+
#
|
6068
|
+
# @option params [String] :description
|
6069
|
+
# The description of the security profile.
|
6070
|
+
#
|
6071
|
+
# @option params [Array<String>] :permissions
|
6072
|
+
# The permissions granted to a security profile.
|
6073
|
+
#
|
6074
|
+
# @option params [required, String] :security_profile_id
|
6075
|
+
# The identifier for the security profle.
|
6076
|
+
#
|
6077
|
+
# @option params [required, String] :instance_id
|
6078
|
+
# The identifier of the Amazon Connect instance. You can find the
|
6079
|
+
# instanceId in the ARN of the instance.
|
6080
|
+
#
|
6081
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
6082
|
+
#
|
6083
|
+
# @example Request syntax with placeholder values
|
6084
|
+
#
|
6085
|
+
# resp = client.update_security_profile({
|
6086
|
+
# description: "SecurityProfileDescription",
|
6087
|
+
# permissions: ["SecurityProfilePermission"],
|
6088
|
+
# security_profile_id: "SecurityProfileId", # required
|
6089
|
+
# instance_id: "InstanceId", # required
|
6090
|
+
# })
|
6091
|
+
#
|
6092
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateSecurityProfile AWS API Documentation
|
6093
|
+
#
|
6094
|
+
# @overload update_security_profile(params = {})
|
6095
|
+
# @param [Hash] params ({})
|
6096
|
+
def update_security_profile(params = {}, options = {})
|
6097
|
+
req = build_request(:update_security_profile, params)
|
6098
|
+
req.send_request(options)
|
6099
|
+
end
|
6100
|
+
|
5577
6101
|
# Assigns the specified hierarchy group to the specified user.
|
5578
6102
|
#
|
5579
6103
|
# @option params [String] :hierarchy_group_id
|
@@ -5838,7 +6362,7 @@ module Aws::Connect
|
|
5838
6362
|
params: params,
|
5839
6363
|
config: config)
|
5840
6364
|
context[:gem_name] = 'aws-sdk-connect'
|
5841
|
-
context[:gem_version] = '1.
|
6365
|
+
context[:gem_version] = '1.57.0'
|
5842
6366
|
Seahorse::Client::Request.new(handlers, context)
|
5843
6367
|
end
|
5844
6368
|
|