aws-sdk-connect 1.85.0 → 1.87.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +368 -21
- data/lib/aws-sdk-connect/client_api.rb +224 -0
- data/lib/aws-sdk-connect/endpoint_parameters.rb +3 -0
- data/lib/aws-sdk-connect/endpoint_provider.rb +73 -74
- data/lib/aws-sdk-connect/endpoints.rb +70 -0
- data/lib/aws-sdk-connect/plugins/endpoints.rb +10 -0
- data/lib/aws-sdk-connect/types.rb +531 -2879
- data/lib/aws-sdk-connect.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 010f96c9d7298f5deb15f13d0444cee084444c6872dc0ae76516b67592682c0f
|
4
|
+
data.tar.gz: 3554400d2e5960cae425809b72d703f6a804464d469838aef13b4b73f760241e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ab0fc8469ae0331966463e6c8e201b667b0aeb51cd2bfa8a4c011aa1f07aa14357638efa002174585990c9bb8c5620564f223f108d4336d86988eefac541c705
|
7
|
+
data.tar.gz: 3e8d92d006d037abb079295152c27b2c0101298a6dbb95068caa00c241f204e4560925079422ae84f0f3c3200ad19fae9f5bbd9526f1f88dc915bc651643a287
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.87.0 (2022-12-15)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Added support for "English - New Zealand" and "English - South African" to be used with Amazon Connect Custom Vocabulary APIs.
|
8
|
+
|
9
|
+
1.86.0 (2022-12-06)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - This release provides APIs that enable you to programmatically manage rules for Contact Lens conversational analytics and third party applications. For more information, see https://docs.aws.amazon.com/connect/latest/APIReference/rules-api.html
|
13
|
+
|
4
14
|
1.85.0 (2022-11-18)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.87.0
|
@@ -465,7 +465,7 @@ module Aws::Connect
|
|
465
465
|
#
|
466
466
|
# resp = client.associate_default_vocabulary({
|
467
467
|
# instance_id: "InstanceId", # required
|
468
|
-
# language_code: "ar-AE", # required, accepts ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN
|
468
|
+
# language_code: "ar-AE", # required, accepts ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN, en-NZ, en-ZA
|
469
469
|
# vocabulary_id: "VocabularyId",
|
470
470
|
# })
|
471
471
|
#
|
@@ -775,13 +775,22 @@ module Aws::Connect
|
|
775
775
|
# Amazon Web Services Region where the Amazon Connect instance or
|
776
776
|
# traffic distribution group was created.
|
777
777
|
#
|
778
|
-
#
|
779
|
-
#
|
778
|
+
# For more information about how to use this operation, see [Claim a
|
779
|
+
# phone number in your country][1] and [Claim phone numbers to traffic
|
780
|
+
# distribution groups][2] in the *Amazon Connect Administrator Guide*.
|
780
781
|
#
|
782
|
+
# You can call the [SearchAvailablePhoneNumbers][3] API for available
|
783
|
+
# phone numbers that you can claim. Call the [DescribePhoneNumber][4]
|
784
|
+
# API to verify the status of a previous [ClaimPhoneNumber][5]
|
785
|
+
# operation.
|
781
786
|
#
|
782
787
|
#
|
783
|
-
#
|
784
|
-
# [
|
788
|
+
#
|
789
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/claim-phone-number.html
|
790
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/claim-phone-numbers-traffic-distribution-groups.html
|
791
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchAvailablePhoneNumbers.html
|
792
|
+
# [4]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html
|
793
|
+
# [5]: https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html
|
785
794
|
#
|
786
795
|
# @option params [required, String] :target_arn
|
787
796
|
# The Amazon Resource Name (ARN) for Amazon Connect instances or traffic
|
@@ -911,7 +920,7 @@ module Aws::Connect
|
|
911
920
|
#
|
912
921
|
#
|
913
922
|
#
|
914
|
-
# [1]: https://docs.aws.amazon.com/connect/latest/
|
923
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html
|
915
924
|
#
|
916
925
|
# @option params [required, String] :instance_id
|
917
926
|
# The identifier of the Amazon Connect instance.
|
@@ -1464,6 +1473,112 @@ module Aws::Connect
|
|
1464
1473
|
req.send_request(options)
|
1465
1474
|
end
|
1466
1475
|
|
1476
|
+
# Creates a rule for the specified Amazon Connect instance.
|
1477
|
+
#
|
1478
|
+
# Use the [Rules Function language][1] to code conditions for the rule.
|
1479
|
+
#
|
1480
|
+
#
|
1481
|
+
#
|
1482
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/connect-rules-language.html
|
1483
|
+
#
|
1484
|
+
# @option params [required, String] :instance_id
|
1485
|
+
# The identifier of the Amazon Connect instance. You can find the
|
1486
|
+
# instanceId in the ARN of the instance.
|
1487
|
+
#
|
1488
|
+
# @option params [required, String] :name
|
1489
|
+
# A unique name for the rule.
|
1490
|
+
#
|
1491
|
+
# @option params [required, Types::RuleTriggerEventSource] :trigger_event_source
|
1492
|
+
# The event source to trigger the rule.
|
1493
|
+
#
|
1494
|
+
# @option params [required, String] :function
|
1495
|
+
# The conditions of the rule.
|
1496
|
+
#
|
1497
|
+
# @option params [required, Array<Types::RuleAction>] :actions
|
1498
|
+
# A list of actions to be run when the rule is triggered.
|
1499
|
+
#
|
1500
|
+
# @option params [required, String] :publish_status
|
1501
|
+
# The publish status of the rule.
|
1502
|
+
#
|
1503
|
+
# @option params [String] :client_token
|
1504
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
1505
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
1506
|
+
# SDK populates this field. For more information about idempotency, see
|
1507
|
+
# [Making retries safe with idempotent APIs][1].
|
1508
|
+
#
|
1509
|
+
# **A suitable default value is auto-generated.** You should normally
|
1510
|
+
# not need to pass this option.**
|
1511
|
+
#
|
1512
|
+
#
|
1513
|
+
#
|
1514
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
1515
|
+
#
|
1516
|
+
# @return [Types::CreateRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1517
|
+
#
|
1518
|
+
# * {Types::CreateRuleResponse#rule_arn #rule_arn} => String
|
1519
|
+
# * {Types::CreateRuleResponse#rule_id #rule_id} => String
|
1520
|
+
#
|
1521
|
+
# @example Request syntax with placeholder values
|
1522
|
+
#
|
1523
|
+
# resp = client.create_rule({
|
1524
|
+
# instance_id: "InstanceId", # required
|
1525
|
+
# name: "RuleName", # required
|
1526
|
+
# trigger_event_source: { # required
|
1527
|
+
# event_source_name: "OnPostCallAnalysisAvailable", # required, accepts OnPostCallAnalysisAvailable, OnRealTimeCallAnalysisAvailable, OnPostChatAnalysisAvailable, OnZendeskTicketCreate, OnZendeskTicketStatusUpdate, OnSalesforceCaseCreate
|
1528
|
+
# integration_association_id: "IntegrationAssociationId",
|
1529
|
+
# },
|
1530
|
+
# function: "RuleFunction", # required
|
1531
|
+
# actions: [ # required
|
1532
|
+
# {
|
1533
|
+
# action_type: "CREATE_TASK", # required, accepts CREATE_TASK, ASSIGN_CONTACT_CATEGORY, GENERATE_EVENTBRIDGE_EVENT, SEND_NOTIFICATION
|
1534
|
+
# task_action: {
|
1535
|
+
# name: "TaskNameExpression", # required
|
1536
|
+
# description: "TaskDescriptionExpression",
|
1537
|
+
# contact_flow_id: "ContactFlowId", # required
|
1538
|
+
# references: {
|
1539
|
+
# "ReferenceKey" => {
|
1540
|
+
# value: "ReferenceValue", # required
|
1541
|
+
# type: "URL", # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
|
1542
|
+
# },
|
1543
|
+
# },
|
1544
|
+
# },
|
1545
|
+
# event_bridge_action: {
|
1546
|
+
# name: "EventBridgeActionName", # required
|
1547
|
+
# },
|
1548
|
+
# assign_contact_category_action: {
|
1549
|
+
# },
|
1550
|
+
# send_notification_action: {
|
1551
|
+
# delivery_method: "EMAIL", # required, accepts EMAIL
|
1552
|
+
# subject: "Subject",
|
1553
|
+
# content: "Content", # required
|
1554
|
+
# content_type: "PLAIN_TEXT", # required, accepts PLAIN_TEXT
|
1555
|
+
# recipient: { # required
|
1556
|
+
# user_tags: {
|
1557
|
+
# "String" => "String",
|
1558
|
+
# },
|
1559
|
+
# user_ids: ["UserId"],
|
1560
|
+
# },
|
1561
|
+
# },
|
1562
|
+
# },
|
1563
|
+
# ],
|
1564
|
+
# publish_status: "DRAFT", # required, accepts DRAFT, PUBLISHED
|
1565
|
+
# client_token: "ClientToken",
|
1566
|
+
# })
|
1567
|
+
#
|
1568
|
+
# @example Response structure
|
1569
|
+
#
|
1570
|
+
# resp.rule_arn #=> String
|
1571
|
+
# resp.rule_id #=> String
|
1572
|
+
#
|
1573
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateRule AWS API Documentation
|
1574
|
+
#
|
1575
|
+
# @overload create_rule(params = {})
|
1576
|
+
# @param [Hash] params ({})
|
1577
|
+
def create_rule(params = {}, options = {})
|
1578
|
+
req = build_request(:create_rule, params)
|
1579
|
+
req.send_request(options)
|
1580
|
+
end
|
1581
|
+
|
1467
1582
|
# This API is in preview release for Amazon Connect and is subject to
|
1468
1583
|
# change.
|
1469
1584
|
#
|
@@ -1498,7 +1613,8 @@ module Aws::Connect
|
|
1498
1613
|
#
|
1499
1614
|
# @option params [Array<String>] :tag_restricted_resources
|
1500
1615
|
# The list of resources that a security profile applies tag restrictions
|
1501
|
-
# to in Amazon Connect.
|
1616
|
+
# to in Amazon Connect. Following are acceptable ResourceNames: `User`
|
1617
|
+
# \| `SecurityProfile` \| `Queue` \| `RoutingProfile`
|
1502
1618
|
#
|
1503
1619
|
# @return [Types::CreateSecurityProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1504
1620
|
#
|
@@ -1990,7 +2106,7 @@ module Aws::Connect
|
|
1990
2106
|
# client_token: "ClientToken",
|
1991
2107
|
# instance_id: "InstanceId", # required
|
1992
2108
|
# vocabulary_name: "VocabularyName", # required
|
1993
|
-
# language_code: "ar-AE", # required, accepts ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN
|
2109
|
+
# language_code: "ar-AE", # required, accepts ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN, en-NZ, en-ZA
|
1994
2110
|
# content: "VocabularyContent", # required
|
1995
2111
|
# tags: {
|
1996
2112
|
# "TagKey" => "TagValue",
|
@@ -2185,6 +2301,33 @@ module Aws::Connect
|
|
2185
2301
|
req.send_request(options)
|
2186
2302
|
end
|
2187
2303
|
|
2304
|
+
# Deletes a rule for the specified Amazon Connect instance.
|
2305
|
+
#
|
2306
|
+
# @option params [required, String] :instance_id
|
2307
|
+
# The identifier of the Amazon Connect instance. You can find the
|
2308
|
+
# instanceId in the ARN of the instance.
|
2309
|
+
#
|
2310
|
+
# @option params [required, String] :rule_id
|
2311
|
+
# A unique identifier for the rule.
|
2312
|
+
#
|
2313
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2314
|
+
#
|
2315
|
+
# @example Request syntax with placeholder values
|
2316
|
+
#
|
2317
|
+
# resp = client.delete_rule({
|
2318
|
+
# instance_id: "InstanceId", # required
|
2319
|
+
# rule_id: "RuleId", # required
|
2320
|
+
# })
|
2321
|
+
#
|
2322
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteRule AWS API Documentation
|
2323
|
+
#
|
2324
|
+
# @overload delete_rule(params = {})
|
2325
|
+
# @param [Hash] params ({})
|
2326
|
+
def delete_rule(params = {}, options = {})
|
2327
|
+
req = build_request(:delete_rule, params)
|
2328
|
+
req.send_request(options)
|
2329
|
+
end
|
2330
|
+
|
2188
2331
|
# This API is in preview release for Amazon Connect and is subject to
|
2189
2332
|
# change.
|
2190
2333
|
#
|
@@ -2514,7 +2657,7 @@ module Aws::Connect
|
|
2514
2657
|
#
|
2515
2658
|
#
|
2516
2659
|
#
|
2517
|
-
# [1]: https://docs.aws.amazon.com/connect/latest/
|
2660
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html
|
2518
2661
|
#
|
2519
2662
|
# @option params [required, String] :instance_id
|
2520
2663
|
# The identifier of the Amazon Connect instance.
|
@@ -2966,6 +3109,67 @@ module Aws::Connect
|
|
2966
3109
|
req.send_request(options)
|
2967
3110
|
end
|
2968
3111
|
|
3112
|
+
# Describes a rule for the specified Amazon Connect instance.
|
3113
|
+
#
|
3114
|
+
# @option params [required, String] :instance_id
|
3115
|
+
# The identifier of the Amazon Connect instance. You can find the
|
3116
|
+
# instanceId in the ARN of the instance.
|
3117
|
+
#
|
3118
|
+
# @option params [required, String] :rule_id
|
3119
|
+
# A unique identifier for the rule.
|
3120
|
+
#
|
3121
|
+
# @return [Types::DescribeRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3122
|
+
#
|
3123
|
+
# * {Types::DescribeRuleResponse#rule #rule} => Types::Rule
|
3124
|
+
#
|
3125
|
+
# @example Request syntax with placeholder values
|
3126
|
+
#
|
3127
|
+
# resp = client.describe_rule({
|
3128
|
+
# instance_id: "InstanceId", # required
|
3129
|
+
# rule_id: "RuleId", # required
|
3130
|
+
# })
|
3131
|
+
#
|
3132
|
+
# @example Response structure
|
3133
|
+
#
|
3134
|
+
# resp.rule.name #=> String
|
3135
|
+
# resp.rule.rule_id #=> String
|
3136
|
+
# resp.rule.rule_arn #=> String
|
3137
|
+
# resp.rule.trigger_event_source.event_source_name #=> String, one of "OnPostCallAnalysisAvailable", "OnRealTimeCallAnalysisAvailable", "OnPostChatAnalysisAvailable", "OnZendeskTicketCreate", "OnZendeskTicketStatusUpdate", "OnSalesforceCaseCreate"
|
3138
|
+
# resp.rule.trigger_event_source.integration_association_id #=> String
|
3139
|
+
# resp.rule.function #=> String
|
3140
|
+
# resp.rule.actions #=> Array
|
3141
|
+
# resp.rule.actions[0].action_type #=> String, one of "CREATE_TASK", "ASSIGN_CONTACT_CATEGORY", "GENERATE_EVENTBRIDGE_EVENT", "SEND_NOTIFICATION"
|
3142
|
+
# resp.rule.actions[0].task_action.name #=> String
|
3143
|
+
# resp.rule.actions[0].task_action.description #=> String
|
3144
|
+
# resp.rule.actions[0].task_action.contact_flow_id #=> String
|
3145
|
+
# resp.rule.actions[0].task_action.references #=> Hash
|
3146
|
+
# resp.rule.actions[0].task_action.references["ReferenceKey"].value #=> String
|
3147
|
+
# resp.rule.actions[0].task_action.references["ReferenceKey"].type #=> String, one of "URL", "ATTACHMENT", "NUMBER", "STRING", "DATE", "EMAIL"
|
3148
|
+
# resp.rule.actions[0].event_bridge_action.name #=> String
|
3149
|
+
# resp.rule.actions[0].send_notification_action.delivery_method #=> String, one of "EMAIL"
|
3150
|
+
# resp.rule.actions[0].send_notification_action.subject #=> String
|
3151
|
+
# resp.rule.actions[0].send_notification_action.content #=> String
|
3152
|
+
# resp.rule.actions[0].send_notification_action.content_type #=> String, one of "PLAIN_TEXT"
|
3153
|
+
# resp.rule.actions[0].send_notification_action.recipient.user_tags #=> Hash
|
3154
|
+
# resp.rule.actions[0].send_notification_action.recipient.user_tags["String"] #=> String
|
3155
|
+
# resp.rule.actions[0].send_notification_action.recipient.user_ids #=> Array
|
3156
|
+
# resp.rule.actions[0].send_notification_action.recipient.user_ids[0] #=> String
|
3157
|
+
# resp.rule.publish_status #=> String, one of "DRAFT", "PUBLISHED"
|
3158
|
+
# resp.rule.created_time #=> Time
|
3159
|
+
# resp.rule.last_updated_time #=> Time
|
3160
|
+
# resp.rule.last_updated_by #=> String
|
3161
|
+
# resp.rule.tags #=> Hash
|
3162
|
+
# resp.rule.tags["TagKey"] #=> String
|
3163
|
+
#
|
3164
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeRule AWS API Documentation
|
3165
|
+
#
|
3166
|
+
# @overload describe_rule(params = {})
|
3167
|
+
# @param [Hash] params ({})
|
3168
|
+
def describe_rule(params = {}, options = {})
|
3169
|
+
req = build_request(:describe_rule, params)
|
3170
|
+
req.send_request(options)
|
3171
|
+
end
|
3172
|
+
|
2969
3173
|
# This API is in preview release for Amazon Connect and is subject to
|
2970
3174
|
# change.
|
2971
3175
|
#
|
@@ -3226,7 +3430,7 @@ module Aws::Connect
|
|
3226
3430
|
# resp.vocabulary.name #=> String
|
3227
3431
|
# resp.vocabulary.id #=> String
|
3228
3432
|
# resp.vocabulary.arn #=> String
|
3229
|
-
# resp.vocabulary.language_code #=> String, one of "ar-AE", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fr-CA", "fr-FR", "hi-IN", "it-IT", "ja-JP", "ko-KR", "pt-BR", "pt-PT", "zh-CN"
|
3433
|
+
# resp.vocabulary.language_code #=> String, one of "ar-AE", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fr-CA", "fr-FR", "hi-IN", "it-IT", "ja-JP", "ko-KR", "pt-BR", "pt-PT", "zh-CN", "en-NZ", "en-ZA"
|
3230
3434
|
# resp.vocabulary.state #=> String, one of "CREATION_IN_PROGRESS", "ACTIVE", "CREATION_FAILED", "DELETE_IN_PROGRESS"
|
3231
3435
|
# resp.vocabulary.last_modified_time #=> Time
|
3232
3436
|
# resp.vocabulary.failure_reason #=> String
|
@@ -4589,7 +4793,7 @@ module Aws::Connect
|
|
4589
4793
|
#
|
4590
4794
|
#
|
4591
4795
|
#
|
4592
|
-
# [1]: https://docs.aws.amazon.com/connect/latest/
|
4796
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html
|
4593
4797
|
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/concepts-contact-flows.html
|
4594
4798
|
#
|
4595
4799
|
# @option params [required, String] :instance_id
|
@@ -4745,7 +4949,7 @@ module Aws::Connect
|
|
4745
4949
|
#
|
4746
4950
|
# resp = client.list_default_vocabularies({
|
4747
4951
|
# instance_id: "InstanceId", # required
|
4748
|
-
# language_code: "ar-AE", # accepts ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN
|
4952
|
+
# language_code: "ar-AE", # accepts ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN, en-NZ, en-ZA
|
4749
4953
|
# max_results: 1,
|
4750
4954
|
# next_token: "VocabularyNextToken",
|
4751
4955
|
# })
|
@@ -4754,7 +4958,7 @@ module Aws::Connect
|
|
4754
4958
|
#
|
4755
4959
|
# resp.default_vocabulary_list #=> Array
|
4756
4960
|
# resp.default_vocabulary_list[0].instance_id #=> String
|
4757
|
-
# resp.default_vocabulary_list[0].language_code #=> String, one of "ar-AE", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fr-CA", "fr-FR", "hi-IN", "it-IT", "ja-JP", "ko-KR", "pt-BR", "pt-PT", "zh-CN"
|
4961
|
+
# resp.default_vocabulary_list[0].language_code #=> String, one of "ar-AE", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fr-CA", "fr-FR", "hi-IN", "it-IT", "ja-JP", "ko-KR", "pt-BR", "pt-PT", "zh-CN", "en-NZ", "en-ZA"
|
4758
4962
|
# resp.default_vocabulary_list[0].vocabulary_id #=> String
|
4759
4963
|
# resp.default_vocabulary_list[0].vocabulary_name #=> String
|
4760
4964
|
# resp.next_token #=> String
|
@@ -5631,6 +5835,66 @@ module Aws::Connect
|
|
5631
5835
|
req.send_request(options)
|
5632
5836
|
end
|
5633
5837
|
|
5838
|
+
# List all rules for the specified Amazon Connect instance.
|
5839
|
+
#
|
5840
|
+
# @option params [required, String] :instance_id
|
5841
|
+
# The identifier of the Amazon Connect instance. You can find the
|
5842
|
+
# instanceId in the ARN of the instance.
|
5843
|
+
#
|
5844
|
+
# @option params [String] :publish_status
|
5845
|
+
# The publish status of the rule.
|
5846
|
+
#
|
5847
|
+
# @option params [String] :event_source_name
|
5848
|
+
# The name of the event source.
|
5849
|
+
#
|
5850
|
+
# @option params [Integer] :max_results
|
5851
|
+
# The maximum number of results to return per page.
|
5852
|
+
#
|
5853
|
+
# @option params [String] :next_token
|
5854
|
+
# The token for the next set of results. Use the value returned in the
|
5855
|
+
# previous response in the next request to retrieve the next set of
|
5856
|
+
# results.
|
5857
|
+
#
|
5858
|
+
# @return [Types::ListRulesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5859
|
+
#
|
5860
|
+
# * {Types::ListRulesResponse#rule_summary_list #rule_summary_list} => Array<Types::RuleSummary>
|
5861
|
+
# * {Types::ListRulesResponse#next_token #next_token} => String
|
5862
|
+
#
|
5863
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5864
|
+
#
|
5865
|
+
# @example Request syntax with placeholder values
|
5866
|
+
#
|
5867
|
+
# resp = client.list_rules({
|
5868
|
+
# instance_id: "InstanceId", # required
|
5869
|
+
# publish_status: "DRAFT", # accepts DRAFT, PUBLISHED
|
5870
|
+
# event_source_name: "OnPostCallAnalysisAvailable", # accepts OnPostCallAnalysisAvailable, OnRealTimeCallAnalysisAvailable, OnPostChatAnalysisAvailable, OnZendeskTicketCreate, OnZendeskTicketStatusUpdate, OnSalesforceCaseCreate
|
5871
|
+
# max_results: 1,
|
5872
|
+
# next_token: "NextToken",
|
5873
|
+
# })
|
5874
|
+
#
|
5875
|
+
# @example Response structure
|
5876
|
+
#
|
5877
|
+
# resp.rule_summary_list #=> Array
|
5878
|
+
# resp.rule_summary_list[0].name #=> String
|
5879
|
+
# resp.rule_summary_list[0].rule_id #=> String
|
5880
|
+
# resp.rule_summary_list[0].rule_arn #=> String
|
5881
|
+
# resp.rule_summary_list[0].event_source_name #=> String, one of "OnPostCallAnalysisAvailable", "OnRealTimeCallAnalysisAvailable", "OnPostChatAnalysisAvailable", "OnZendeskTicketCreate", "OnZendeskTicketStatusUpdate", "OnSalesforceCaseCreate"
|
5882
|
+
# resp.rule_summary_list[0].publish_status #=> String, one of "DRAFT", "PUBLISHED"
|
5883
|
+
# resp.rule_summary_list[0].action_summaries #=> Array
|
5884
|
+
# resp.rule_summary_list[0].action_summaries[0].action_type #=> String, one of "CREATE_TASK", "ASSIGN_CONTACT_CATEGORY", "GENERATE_EVENTBRIDGE_EVENT", "SEND_NOTIFICATION"
|
5885
|
+
# resp.rule_summary_list[0].created_time #=> Time
|
5886
|
+
# resp.rule_summary_list[0].last_updated_time #=> Time
|
5887
|
+
# resp.next_token #=> String
|
5888
|
+
#
|
5889
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRules AWS API Documentation
|
5890
|
+
#
|
5891
|
+
# @overload list_rules(params = {})
|
5892
|
+
# @param [Hash] params ({})
|
5893
|
+
def list_rules(params = {}, options = {})
|
5894
|
+
req = build_request(:list_rules, params)
|
5895
|
+
req.send_request(options)
|
5896
|
+
end
|
5897
|
+
|
5634
5898
|
# This API is in preview release for Amazon Connect and is subject to
|
5635
5899
|
# change.
|
5636
5900
|
#
|
@@ -6906,7 +7170,7 @@ module Aws::Connect
|
|
6906
7170
|
# next_token: "VocabularyNextToken",
|
6907
7171
|
# state: "CREATION_IN_PROGRESS", # accepts CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED, DELETE_IN_PROGRESS
|
6908
7172
|
# name_starts_with: "VocabularyName",
|
6909
|
-
# language_code: "ar-AE", # accepts ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN
|
7173
|
+
# language_code: "ar-AE", # accepts ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN, en-NZ, en-ZA
|
6910
7174
|
# })
|
6911
7175
|
#
|
6912
7176
|
# @example Response structure
|
@@ -6915,7 +7179,7 @@ module Aws::Connect
|
|
6915
7179
|
# resp.vocabulary_summary_list[0].name #=> String
|
6916
7180
|
# resp.vocabulary_summary_list[0].id #=> String
|
6917
7181
|
# resp.vocabulary_summary_list[0].arn #=> String
|
6918
|
-
# resp.vocabulary_summary_list[0].language_code #=> String, one of "ar-AE", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fr-CA", "fr-FR", "hi-IN", "it-IT", "ja-JP", "ko-KR", "pt-BR", "pt-PT", "zh-CN"
|
7182
|
+
# resp.vocabulary_summary_list[0].language_code #=> String, one of "ar-AE", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fr-CA", "fr-FR", "hi-IN", "it-IT", "ja-JP", "ko-KR", "pt-BR", "pt-PT", "zh-CN", "en-NZ", "en-ZA"
|
6919
7183
|
# resp.vocabulary_summary_list[0].state #=> String, one of "CREATION_IN_PROGRESS", "ACTIVE", "CREATION_FAILED", "DELETE_IN_PROGRESS"
|
6920
7184
|
# resp.vocabulary_summary_list[0].last_modified_time #=> Time
|
6921
7185
|
# resp.vocabulary_summary_list[0].failure_reason #=> String
|
@@ -7885,7 +8149,7 @@ module Aws::Connect
|
|
7885
8149
|
#
|
7886
8150
|
#
|
7887
8151
|
#
|
7888
|
-
# [1]: https://docs.aws.amazon.com/connect/latest/
|
8152
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html
|
7889
8153
|
#
|
7890
8154
|
# @option params [required, String] :instance_id
|
7891
8155
|
# The identifier of the Amazon Connect instance.
|
@@ -7895,12 +8159,11 @@ module Aws::Connect
|
|
7895
8159
|
#
|
7896
8160
|
# @option params [required, String] :content
|
7897
8161
|
# The JSON string that represents flow's content. For an example, see
|
7898
|
-
# [Example contact flow in Amazon Connect Flow language][1]
|
7899
|
-
# *Amazon Connect Administrator Guide*.
|
8162
|
+
# [Example contact flow in Amazon Connect Flow language][1].
|
7900
8163
|
#
|
7901
8164
|
#
|
7902
8165
|
#
|
7903
|
-
# [1]: https://docs.aws.amazon.com/connect/latest/
|
8166
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html
|
7904
8167
|
#
|
7905
8168
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
7906
8169
|
#
|
@@ -8038,7 +8301,7 @@ module Aws::Connect
|
|
8038
8301
|
#
|
8039
8302
|
#
|
8040
8303
|
#
|
8041
|
-
# [1]: https://docs.aws.amazon.com/connect/latest/
|
8304
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html
|
8042
8305
|
#
|
8043
8306
|
# @option params [required, String] :instance_id
|
8044
8307
|
# The identifier of the Amazon Connect instance.
|
@@ -8758,6 +9021,90 @@ module Aws::Connect
|
|
8758
9021
|
req.send_request(options)
|
8759
9022
|
end
|
8760
9023
|
|
9024
|
+
# Updates a rule for the specified Amazon Connect instance.
|
9025
|
+
#
|
9026
|
+
# Use the [Rules Function language][1] to code conditions for the rule.
|
9027
|
+
#
|
9028
|
+
#
|
9029
|
+
#
|
9030
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/connect-rules-language.html
|
9031
|
+
#
|
9032
|
+
# @option params [required, String] :rule_id
|
9033
|
+
# A unique identifier for the rule.
|
9034
|
+
#
|
9035
|
+
# @option params [required, String] :instance_id
|
9036
|
+
# The identifier of the Amazon Connect instance. You can find the
|
9037
|
+
# instanceId in the ARN of the instance.
|
9038
|
+
#
|
9039
|
+
# @option params [required, String] :name
|
9040
|
+
# The name of the rule. You can change the name only if
|
9041
|
+
# `TriggerEventSource` is one of the following values:
|
9042
|
+
# `OnZendeskTicketCreate` \| `OnZendeskTicketStatusUpdate` \|
|
9043
|
+
# `OnSalesforceCaseCreate`
|
9044
|
+
#
|
9045
|
+
# @option params [required, String] :function
|
9046
|
+
# The conditions of the rule.
|
9047
|
+
#
|
9048
|
+
# @option params [required, Array<Types::RuleAction>] :actions
|
9049
|
+
# A list of actions to be run when the rule is triggered.
|
9050
|
+
#
|
9051
|
+
# @option params [required, String] :publish_status
|
9052
|
+
# The publish status of the rule.
|
9053
|
+
#
|
9054
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
9055
|
+
#
|
9056
|
+
# @example Request syntax with placeholder values
|
9057
|
+
#
|
9058
|
+
# resp = client.update_rule({
|
9059
|
+
# rule_id: "RuleId", # required
|
9060
|
+
# instance_id: "InstanceId", # required
|
9061
|
+
# name: "RuleName", # required
|
9062
|
+
# function: "RuleFunction", # required
|
9063
|
+
# actions: [ # required
|
9064
|
+
# {
|
9065
|
+
# action_type: "CREATE_TASK", # required, accepts CREATE_TASK, ASSIGN_CONTACT_CATEGORY, GENERATE_EVENTBRIDGE_EVENT, SEND_NOTIFICATION
|
9066
|
+
# task_action: {
|
9067
|
+
# name: "TaskNameExpression", # required
|
9068
|
+
# description: "TaskDescriptionExpression",
|
9069
|
+
# contact_flow_id: "ContactFlowId", # required
|
9070
|
+
# references: {
|
9071
|
+
# "ReferenceKey" => {
|
9072
|
+
# value: "ReferenceValue", # required
|
9073
|
+
# type: "URL", # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
|
9074
|
+
# },
|
9075
|
+
# },
|
9076
|
+
# },
|
9077
|
+
# event_bridge_action: {
|
9078
|
+
# name: "EventBridgeActionName", # required
|
9079
|
+
# },
|
9080
|
+
# assign_contact_category_action: {
|
9081
|
+
# },
|
9082
|
+
# send_notification_action: {
|
9083
|
+
# delivery_method: "EMAIL", # required, accepts EMAIL
|
9084
|
+
# subject: "Subject",
|
9085
|
+
# content: "Content", # required
|
9086
|
+
# content_type: "PLAIN_TEXT", # required, accepts PLAIN_TEXT
|
9087
|
+
# recipient: { # required
|
9088
|
+
# user_tags: {
|
9089
|
+
# "String" => "String",
|
9090
|
+
# },
|
9091
|
+
# user_ids: ["UserId"],
|
9092
|
+
# },
|
9093
|
+
# },
|
9094
|
+
# },
|
9095
|
+
# ],
|
9096
|
+
# publish_status: "DRAFT", # required, accepts DRAFT, PUBLISHED
|
9097
|
+
# })
|
9098
|
+
#
|
9099
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateRule AWS API Documentation
|
9100
|
+
#
|
9101
|
+
# @overload update_rule(params = {})
|
9102
|
+
# @param [Hash] params ({})
|
9103
|
+
def update_rule(params = {}, options = {})
|
9104
|
+
req = build_request(:update_rule, params)
|
9105
|
+
req.send_request(options)
|
9106
|
+
end
|
9107
|
+
|
8761
9108
|
# This API is in preview release for Amazon Connect and is subject to
|
8762
9109
|
# change.
|
8763
9110
|
#
|
@@ -9266,7 +9613,7 @@ module Aws::Connect
|
|
9266
9613
|
params: params,
|
9267
9614
|
config: config)
|
9268
9615
|
context[:gem_name] = 'aws-sdk-connect'
|
9269
|
-
context[:gem_version] = '1.
|
9616
|
+
context[:gem_version] = '1.87.0'
|
9270
9617
|
Seahorse::Client::Request.new(handlers, context)
|
9271
9618
|
end
|
9272
9619
|
|