aws-sdk-connect 1.264.0 → 1.266.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 +257 -55
- data/lib/aws-sdk-connect/client_api.rb +83 -0
- data/lib/aws-sdk-connect/types.rb +347 -54
- data/lib/aws-sdk-connect.rb +1 -1
- data/sig/client.rbs +41 -0
- data/sig/params.rbs +30 -0
- data/sig/types.rbs +57 -0
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 960031458f592a8498e4f581fc0516b5a21bf9b73637216b266d8e32df81931c
|
|
4
|
+
data.tar.gz: e3ed4bb5244f9adeb8128a9b0b358179592535bcf5a65028d22dc2f0b2f9b9bd
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 294670ff8beeaec582d46a73c72997bf70c0ef47deb0f000bad372899cd7bfeab2d495e9125a12181b8b8362938527a66d2a30c946badc332cf3e2d0450e041f
|
|
7
|
+
data.tar.gz: 45a764f421f824c8d09b4cce59db5bfc48021b3211b9954f5253873112f0d1e46ee0c235178ad93c4b121d71e1cedfca1b8af2d434cfdfab00c3b6a510a32335
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,16 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.266.0 (2026-07-28)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - Documentation updates for SearchRules, AssociateRoutingProfileQueues, CreateRoutingProfile, AssociateContactWithUser CreateTaskTemplate, and UpdateTaskTemplate
|
|
8
|
+
|
|
9
|
+
1.265.0 (2026-07-14)
|
|
10
|
+
------------------
|
|
11
|
+
|
|
12
|
+
* Feature - This release adds SearchRules API which can be used to search for rules within an Amazon Connect instance.
|
|
13
|
+
|
|
4
14
|
1.264.0 (2026-07-09)
|
|
5
15
|
------------------
|
|
6
16
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.266.0
|
|
@@ -694,8 +694,11 @@ module Aws::Connect
|
|
|
694
694
|
#
|
|
695
695
|
# **Important things to know**
|
|
696
696
|
#
|
|
697
|
-
# * Use this API with chat, email, and
|
|
698
|
-
# support
|
|
697
|
+
# * Use this API with chat, email, task, and voice contacts. For voice
|
|
698
|
+
# callbacks, this API does not support customer-first mode.
|
|
699
|
+
#
|
|
700
|
+
# * This API can be used to offer a contact to an agent even if the
|
|
701
|
+
# agent is currently at maximum concurrency for the channel.
|
|
699
702
|
#
|
|
700
703
|
# * Use it to associate contacts with users regardless of their current
|
|
701
704
|
# state, including custom states. Ensure your application logic
|
|
@@ -973,8 +976,9 @@ module Aws::Connect
|
|
|
973
976
|
end
|
|
974
977
|
|
|
975
978
|
# Associates a set of hours of operations with another hours of
|
|
976
|
-
# operation.
|
|
977
|
-
#
|
|
979
|
+
# operation. For more information about inheriting overrides from parent
|
|
980
|
+
# hours of operation, see [Hours of operation overrides][1] in the
|
|
981
|
+
# Administrator Guide.
|
|
978
982
|
#
|
|
979
983
|
#
|
|
980
984
|
#
|
|
@@ -1410,8 +1414,10 @@ module Aws::Connect
|
|
|
1410
1414
|
# @option params [Array<Types::RoutingProfileManualAssignmentQueueConfig>] :manual_assignment_queue_configs
|
|
1411
1415
|
# The manual assignment queues to associate with this routing profile.
|
|
1412
1416
|
#
|
|
1413
|
-
#
|
|
1414
|
-
#
|
|
1417
|
+
# <note markdown="1"> For voice contacts, manual assignment supports only agent-first
|
|
1418
|
+
# callback contacts. Chat, email, and task contacts are fully supported.
|
|
1419
|
+
#
|
|
1420
|
+
# </note>
|
|
1415
1421
|
#
|
|
1416
1422
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1417
1423
|
#
|
|
@@ -3765,7 +3771,7 @@ module Aws::Connect
|
|
|
3765
3771
|
#
|
|
3766
3772
|
#
|
|
3767
3773
|
#
|
|
3768
|
-
# [1]: https://docs.aws.amazon.com/
|
|
3774
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/hours-of-operation-overrides.html
|
|
3769
3775
|
#
|
|
3770
3776
|
# @option params [Hash<String,String>] :tags
|
|
3771
3777
|
# The tags used to organize, track, or control access for this resource.
|
|
@@ -3858,7 +3864,7 @@ module Aws::Connect
|
|
|
3858
3864
|
#
|
|
3859
3865
|
#
|
|
3860
3866
|
#
|
|
3861
|
-
# [1]: https://docs.aws.amazon.com/
|
|
3867
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/hours-of-operation-overrides.html
|
|
3862
3868
|
#
|
|
3863
3869
|
# @return [Types::CreateHoursOfOperationOverrideResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3864
3870
|
#
|
|
@@ -4803,8 +4809,10 @@ module Aws::Connect
|
|
|
4803
4809
|
# quota of 50 queues per routing profile per instance that is listed in
|
|
4804
4810
|
# Connect Customer service quotas.
|
|
4805
4811
|
#
|
|
4806
|
-
#
|
|
4807
|
-
#
|
|
4812
|
+
# <note markdown="1"> For voice contacts, manual assignment supports only agent-first
|
|
4813
|
+
# callback contacts. Chat, email, and task contacts are fully supported.
|
|
4814
|
+
#
|
|
4815
|
+
# </note>
|
|
4808
4816
|
#
|
|
4809
4817
|
# @option params [required, Array<Types::MediaConcurrency>] :media_concurrencies
|
|
4810
4818
|
# The channels that agents can handle in the Contact Control Panel (CCP)
|
|
@@ -5207,12 +5215,19 @@ module Aws::Connect
|
|
|
5207
5215
|
# The identifier of the flow that runs by default when a task is created
|
|
5208
5216
|
# by referencing this template.
|
|
5209
5217
|
#
|
|
5218
|
+
# Although this parameter is marked as optional, the request must
|
|
5219
|
+
# contain either a `ContactFlowId` or a field of type `QUICK_CONNECT`.
|
|
5220
|
+
#
|
|
5210
5221
|
# @option params [String] :self_assign_flow_id
|
|
5211
5222
|
# The ContactFlowId for the flow that will be run if this template is
|
|
5212
5223
|
# used to create a self-assigned task.
|
|
5213
5224
|
#
|
|
5214
5225
|
# @option params [Types::TaskTemplateConstraints] :constraints
|
|
5215
|
-
# Constraints that are applicable to the fields listed.
|
|
5226
|
+
# Constraints that are applicable to the fields listed. Although this
|
|
5227
|
+
# parameter is marked as optional in the API model, the service requires
|
|
5228
|
+
# it when calling `CreateTaskTemplate` or `UpdateTaskTemplate`. The
|
|
5229
|
+
# `RequiredFields` array must contain at least one element, and the
|
|
5230
|
+
# field of type `NAME` must be included in `RequiredFields`.
|
|
5216
5231
|
#
|
|
5217
5232
|
# @option params [Types::TaskTemplateDefaults] :defaults
|
|
5218
5233
|
# The default values for fields when a task is created by referencing
|
|
@@ -5227,6 +5242,10 @@ module Aws::Connect
|
|
|
5227
5242
|
# @option params [required, Array<Types::TaskTemplateField>] :fields
|
|
5228
5243
|
# Fields that are part of the template.
|
|
5229
5244
|
#
|
|
5245
|
+
# The request must contain exactly one field of type `NAME`. This field
|
|
5246
|
+
# must also be listed in the `RequiredFields` array within the
|
|
5247
|
+
# `Constraints` parameter.
|
|
5248
|
+
#
|
|
5230
5249
|
# @option params [String] :client_token
|
|
5231
5250
|
# A unique, case-sensitive identifier that you provide to ensure the
|
|
5232
5251
|
# idempotency of the request. If not provided, the Amazon Web Services
|
|
@@ -9418,6 +9437,8 @@ module Aws::Connect
|
|
|
9418
9437
|
# resp.rule.rule_arn #=> String
|
|
9419
9438
|
# resp.rule.trigger_event_source.event_source_name #=> String, one of "OnPostCallAnalysisAvailable", "OnRealTimeCallAnalysisAvailable", "OnRealTimeChatAnalysisAvailable", "OnPostChatAnalysisAvailable", "OnEmailAnalysisAvailable", "OnZendeskTicketCreate", "OnZendeskTicketStatusUpdate", "OnSalesforceCaseCreate", "OnContactEvaluationSubmit", "OnMetricDataUpdate", "OnCaseCreate", "OnCaseUpdate", "OnSlaBreach", "OnAlertUpdate", "OnSchedulePublish", "OnScheduleUpdate", "OnScheduleTimeOffRequestActivity"
|
|
9420
9439
|
# resp.rule.trigger_event_source.integration_association_id #=> String
|
|
9440
|
+
# resp.rule.rule_capability_tiers #=> Array
|
|
9441
|
+
# resp.rule.rule_capability_tiers[0] #=> String, one of "GenerativeAI"
|
|
9421
9442
|
# resp.rule.function #=> String
|
|
9422
9443
|
# resp.rule.actions #=> Array
|
|
9423
9444
|
# resp.rule.actions[0].action_type #=> String, one of "CREATE_TASK", "ASSIGN_CONTACT_CATEGORY", "GENERATE_EVENTBRIDGE_EVENT", "SEND_NOTIFICATION", "CREATE_CASE", "UPDATE_CASE", "ASSIGN_SLA", "END_ASSOCIATED_TASKS", "SUBMIT_AUTO_EVALUATION"
|
|
@@ -10362,8 +10383,9 @@ module Aws::Connect
|
|
|
10362
10383
|
end
|
|
10363
10384
|
|
|
10364
10385
|
# Disassociates a set of hours of operations with another hours of
|
|
10365
|
-
# operation.
|
|
10366
|
-
#
|
|
10386
|
+
# operation. For more information about inheriting overrides from parent
|
|
10387
|
+
# hours of operation, see [Hours of operation overrides][1] in the
|
|
10388
|
+
# Administrator Guide.
|
|
10367
10389
|
#
|
|
10368
10390
|
#
|
|
10369
10391
|
#
|
|
@@ -12503,24 +12525,25 @@ module Aws::Connect
|
|
|
12503
12525
|
# `AGENT_HIERARCHY_LEVEL_TWO` \| `AGENT_HIERARCHY_LEVEL_THREE` \|
|
|
12504
12526
|
# `AGENT_HIERARCHY_LEVEL_FOUR` \| `AGENT_HIERARCHY_LEVEL_FIVE` \|
|
|
12505
12527
|
# `ANSWERING_MACHINE_DETECTION_STATUS` \| `BOT_ALIAS` \| `BOT_ID` \|
|
|
12506
|
-
# `BOT_INTENT_NAME` \| `BOT_LOCALE` \| `BOT_VERSION` \| `
|
|
12507
|
-
# `
|
|
12508
|
-
# `
|
|
12509
|
-
# `contact/segmentAttributes/connect:Subtype` \|
|
|
12528
|
+
# `BOT_INTENT_NAME` \| `BOT_LOCALE` \| `BOT_VERSION` \| `BROWSER_NAME`
|
|
12529
|
+
# \| `CAMPAIGN` \| `CAMPAIGN_DELIVERY_EVENT_TYPE` \|
|
|
12530
|
+
# `CAMPAIGN_EXCLUDED_EVENT_TYPE` \| `CASE_STATUS` \| `CASE_TEMPLATE_ARN`
|
|
12531
|
+
# \| `CHANNEL` \| `contact/segmentAttributes/connect:Subtype` \|
|
|
12510
12532
|
# `contact/segmentAttributes/connect:ValidationTestType` \|
|
|
12511
|
-
# `
|
|
12512
|
-
# `
|
|
12513
|
-
# `
|
|
12514
|
-
# `
|
|
12515
|
-
# `
|
|
12516
|
-
# `
|
|
12517
|
-
# `
|
|
12518
|
-
# `
|
|
12519
|
-
# `
|
|
12520
|
-
# `
|
|
12521
|
-
# `
|
|
12522
|
-
# `
|
|
12523
|
-
# \| `TEST_CASE_EXECUTION_STATE`
|
|
12533
|
+
# `DEVICE_MODEL` \| `DEVICE_TYPE` \| `DISCONNECT_REASON` \|
|
|
12534
|
+
# `EVALUATION_FORM` \| `EVALUATION_QUESTION` \| `EVALUATION_SECTION` \|
|
|
12535
|
+
# `EVALUATION_SOURCE` \| `EVALUATOR_ID` \| `FEATURE` \| `FLOW_ACTION_ID`
|
|
12536
|
+
# \| `FLOW_TYPE` \| `FLOWS_MODULE_RESOURCE_ID` \|
|
|
12537
|
+
# `FLOWS_NEXT_RESOURCE_ID` \| `FLOWS_NEXT_RESOURCE_QUEUE_ID` \|
|
|
12538
|
+
# `FLOWS_OUTCOME_TYPE` \| `FLOWS_RESOURCE_ID` \| `FORM_VERSION` \|
|
|
12539
|
+
# `INITIATING_FLOW` \| `INITIATION_METHOD` \|
|
|
12540
|
+
# `INVOKING_RESOURCE_PUBLISHED_TIMESTAMP` \| `INVOKING_RESOURCE_TYPE` \|
|
|
12541
|
+
# `KNOWLEDGE_BASE_NAME` \| `PARENT_FLOWS_RESOURCE_ID` \|
|
|
12542
|
+
# `Q_CONNECT_ENABLED` \| `QUEUE` \| `RESOURCE_PUBLISHED_TIMESTAMP` \|
|
|
12543
|
+
# `ROUTING_PROFILE` \| `ROUTING_STEP_EXPRESSION` \| `SESSION_ID` \|
|
|
12544
|
+
# `TEST_CASE` \| `TEST_CASE_EXECUTION_FAILURE_REASON` \|
|
|
12545
|
+
# `TEST_CASE_EXECUTION_RESULT` \| `TEST_CASE_EXECUTION_STATE` \|
|
|
12546
|
+
# `WEB_NOTIFICATION_TYPE`
|
|
12524
12547
|
#
|
|
12525
12548
|
# <note markdown="1"> The following filter keys correspond to Connect Customer resources and
|
|
12526
12549
|
# are used for authorizing requests. A `GetMetricDataV2` request
|
|
@@ -12598,10 +12621,11 @@ module Aws::Connect
|
|
|
12598
12621
|
# `AGENT_HIERARCHY_LEVEL_THREE` \| `AGENT_HIERARCHY_LEVEL_FOUR` \|
|
|
12599
12622
|
# `AGENT_HIERARCHY_LEVEL_FIVE` \| `ANSWERING_MACHINE_DETECTION_STATUS`
|
|
12600
12623
|
# \| `BOT_ID` \| `BOT_ALIAS` \| `BOT_VERSION` \| `BOT_LOCALE` \|
|
|
12601
|
-
# `BOT_INTENT_NAME` \| `
|
|
12602
|
-
# `
|
|
12603
|
-
# `
|
|
12604
|
-
# `contact/segmentAttributes/connect:Subtype` \|
|
|
12624
|
+
# `BOT_INTENT_NAME` \| `BROWSER_NAME` \| `CAMPAIGN` \|
|
|
12625
|
+
# `CAMPAIGN_DELIVERY_EVENT_TYPE` \| `CAMPAIGN_EXCLUDED_EVENT_TYPE` \|
|
|
12626
|
+
# `CAMPAIGN_EXECUTION_TIMESTAMP` \| `CASE_TEMPLATE_ARN` \| `CASE_STATUS`
|
|
12627
|
+
# \| `CHANNEL` \| `contact/segmentAttributes/connect:Subtype` \|
|
|
12628
|
+
# `DEVICE_MODEL` \| `DEVICE_TYPE` \| `DISCONNECT_REASON` \|
|
|
12605
12629
|
# `EVALUATION_FORM` \| `EVALUATION_SECTION` \| `EVALUATION_QUESTION` \|
|
|
12606
12630
|
# `EVALUATION_SOURCE` \| `EVALUATOR_ID` \| `FLOWS_RESOURCE_ID` \|
|
|
12607
12631
|
# `FLOWS_MODULE_RESOURCE_ID` \| `FLOW_ACTION_ID` \| `FLOW_TYPE` \|
|
|
@@ -12612,6 +12636,7 @@ module Aws::Connect
|
|
|
12612
12636
|
# `RESOURCE_PUBLISHED_TIMESTAMP` \| `ROUTING_PROFILE` \|
|
|
12613
12637
|
# `ROUTING_STEP_EXPRESSION` \| `SESSION_ID` \| `TEST_CASE` \|
|
|
12614
12638
|
# `TEST_CASE_EXECUTION_FAILURE_REASON` \| `TEST_CASE_INVOCATION_METHOD`
|
|
12639
|
+
# \| `WEB_NOTIFICATION_TYPE`
|
|
12615
12640
|
#
|
|
12616
12641
|
# <note markdown="1"> `AI_AGENT_NAME_VERSION`, `AI_PROMPT_NAME_VERSION`, and
|
|
12617
12642
|
# `KNOWLEDGE_ARTICLE_NAME` are valid groupings but not valid filters.
|
|
@@ -13692,14 +13717,16 @@ module Aws::Connect
|
|
|
13692
13717
|
#
|
|
13693
13718
|
# CAMPAIGN\_INTERACTIONS
|
|
13694
13719
|
#
|
|
13695
|
-
# : This metric is available only for outbound campaigns using the
|
|
13696
|
-
# delivery
|
|
13720
|
+
# : This metric is available only for outbound campaigns using the
|
|
13721
|
+
# email, WhatsApp, and web notification delivery modes.
|
|
13697
13722
|
#
|
|
13698
13723
|
# Unit: Count
|
|
13699
13724
|
#
|
|
13700
13725
|
# Valid metric filter key: CAMPAIGN\_INTERACTION\_EVENT\_TYPE
|
|
13701
13726
|
#
|
|
13702
|
-
# Valid groupings and filters: Campaign
|
|
13727
|
+
# Valid groupings and filters: Browser Name, Campaign, Channel,
|
|
13728
|
+
# contact/segmentAttributes/connect:Subtype, Device Model, Device
|
|
13729
|
+
# Type, Web Notification Type
|
|
13703
13730
|
#
|
|
13704
13731
|
# UI name: [Campaign interactions][93]
|
|
13705
13732
|
#
|
|
@@ -13956,17 +13983,18 @@ module Aws::Connect
|
|
|
13956
13983
|
# `CAMPAIGN_DELIVERY_EVENT_TYPE`, `DISCONNECT_REASON`
|
|
13957
13984
|
#
|
|
13958
13985
|
# Valid groupings and filters: Agent, Answering Machine Detection
|
|
13959
|
-
# Status, Campaign, Campaign Delivery EventType,
|
|
13960
|
-
# contact/segmentAttributes/connect:Subtype,
|
|
13961
|
-
# Routing Profile
|
|
13986
|
+
# Status, Browser Name, Campaign, Campaign Delivery EventType,
|
|
13987
|
+
# Channel, contact/segmentAttributes/connect:Subtype, Device Model,
|
|
13988
|
+
# Device Type, Disconnect Reason, Queue, Routing Profile, Web
|
|
13989
|
+
# Notification Type
|
|
13962
13990
|
#
|
|
13963
13991
|
# UI name: [Delivery attempts][116]
|
|
13964
13992
|
#
|
|
13965
13993
|
# <note markdown="1"> Campaign Delivery EventType filter and grouping are only available
|
|
13966
|
-
# for SMS
|
|
13967
|
-
# Profile, Answering Machine Detection
|
|
13968
|
-
# are only available for agent assisted
|
|
13969
|
-
# delivery modes.
|
|
13994
|
+
# for SMS, Email, WhatsApp, and web notification campaign delivery
|
|
13995
|
+
# modes. Agent, Queue, Routing Profile, Answering Machine Detection
|
|
13996
|
+
# Status and Disconnect Reason are only available for agent assisted
|
|
13997
|
+
# voice and automated voice delivery modes.
|
|
13970
13998
|
#
|
|
13971
13999
|
# </note>
|
|
13972
14000
|
#
|
|
@@ -13982,17 +14010,18 @@ module Aws::Connect
|
|
|
13982
14010
|
# `CAMPAIGN_DELIVERY_EVENT_TYPE`, `DISCONNECT_REASON`
|
|
13983
14011
|
#
|
|
13984
14012
|
# Valid groupings and filters: Agent, Answering Machine Detection
|
|
13985
|
-
# Status, Campaign, Channel,
|
|
13986
|
-
# contact/segmentAttributes/connect:Subtype,
|
|
13987
|
-
# Routing Profile
|
|
14013
|
+
# Status, Browser Name, Campaign, Channel,
|
|
14014
|
+
# contact/segmentAttributes/connect:Subtype, Device Model, Device
|
|
14015
|
+
# Type, Disconnect Reason, Queue, Routing Profile, Web Notification
|
|
14016
|
+
# Type
|
|
13988
14017
|
#
|
|
13989
14018
|
# UI name: [Delivery attempt disposition rate][117]
|
|
13990
14019
|
#
|
|
13991
14020
|
# <note markdown="1"> Campaign Delivery Event Type filter and grouping are only available
|
|
13992
|
-
# for SMS
|
|
13993
|
-
# Profile, Answering Machine Detection
|
|
13994
|
-
# are only available for agent assisted
|
|
13995
|
-
# delivery modes.
|
|
14021
|
+
# for SMS, Email, WhatsApp, and web notification campaign delivery
|
|
14022
|
+
# modes. Agent, Queue, Routing Profile, Answering Machine Detection
|
|
14023
|
+
# Status and Disconnect Reason are only available for agent assisted
|
|
14024
|
+
# voice and automated voice delivery modes.
|
|
13996
14025
|
#
|
|
13997
14026
|
# </note>
|
|
13998
14027
|
#
|
|
@@ -15524,7 +15553,7 @@ module Aws::Connect
|
|
|
15524
15553
|
#
|
|
15525
15554
|
#
|
|
15526
15555
|
#
|
|
15527
|
-
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
15556
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/hours-of-operation-overrides.html
|
|
15528
15557
|
#
|
|
15529
15558
|
# @option params [required, String] :instance_id
|
|
15530
15559
|
# The identifier of the Amazon Connect instance. You can [find the
|
|
@@ -18100,6 +18129,8 @@ module Aws::Connect
|
|
|
18100
18129
|
# resp.rule_summary_list[0].rule_arn #=> String
|
|
18101
18130
|
# resp.rule_summary_list[0].event_source_name #=> String, one of "OnPostCallAnalysisAvailable", "OnRealTimeCallAnalysisAvailable", "OnRealTimeChatAnalysisAvailable", "OnPostChatAnalysisAvailable", "OnEmailAnalysisAvailable", "OnZendeskTicketCreate", "OnZendeskTicketStatusUpdate", "OnSalesforceCaseCreate", "OnContactEvaluationSubmit", "OnMetricDataUpdate", "OnCaseCreate", "OnCaseUpdate", "OnSlaBreach", "OnAlertUpdate", "OnSchedulePublish", "OnScheduleUpdate", "OnScheduleTimeOffRequestActivity"
|
|
18102
18131
|
# resp.rule_summary_list[0].publish_status #=> String, one of "DRAFT", "PUBLISHED"
|
|
18132
|
+
# resp.rule_summary_list[0].rule_capability_tiers #=> Array
|
|
18133
|
+
# resp.rule_summary_list[0].rule_capability_tiers[0] #=> String, one of "GenerativeAI"
|
|
18103
18134
|
# resp.rule_summary_list[0].action_summaries #=> Array
|
|
18104
18135
|
# resp.rule_summary_list[0].action_summaries[0].action_type #=> String, one of "CREATE_TASK", "ASSIGN_CONTACT_CATEGORY", "GENERATE_EVENTBRIDGE_EVENT", "SEND_NOTIFICATION", "CREATE_CASE", "UPDATE_CASE", "ASSIGN_SLA", "END_ASSOCIATED_TASKS", "SUBMIT_AUTO_EVALUATION"
|
|
18105
18136
|
# resp.rule_summary_list[0].created_time #=> Time
|
|
@@ -21958,6 +21989,163 @@ module Aws::Connect
|
|
|
21958
21989
|
req.send_request(options)
|
|
21959
21990
|
end
|
|
21960
21991
|
|
|
21992
|
+
# Searches rules in an Connect Customer instance, with optional
|
|
21993
|
+
# filtering.
|
|
21994
|
+
#
|
|
21995
|
+
# @option params [required, String] :instance_id
|
|
21996
|
+
# The identifier of the Connect Customer instance. You can [find the
|
|
21997
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
21998
|
+
#
|
|
21999
|
+
#
|
|
22000
|
+
#
|
|
22001
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
22002
|
+
#
|
|
22003
|
+
# @option params [Integer] :max_results
|
|
22004
|
+
# The maximum number of results to return per page.
|
|
22005
|
+
#
|
|
22006
|
+
# @option params [String] :next_token
|
|
22007
|
+
# The token for the next set of results. Use the value returned in the
|
|
22008
|
+
# previous response in the next request to retrieve the next set of
|
|
22009
|
+
# results.
|
|
22010
|
+
#
|
|
22011
|
+
# @option params [Types::RulesSearchCriteria] :search_criteria
|
|
22012
|
+
# The search criteria to be used to return rules.
|
|
22013
|
+
#
|
|
22014
|
+
# @option params [Types::RulesSearchFilter] :search_filter
|
|
22015
|
+
# Filters to be applied to search results, such as tag-based filters.
|
|
22016
|
+
#
|
|
22017
|
+
# @return [Types::SearchRulesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
22018
|
+
#
|
|
22019
|
+
# * {Types::SearchRulesResponse#rules #rules} => Array<Types::RuleSearchSummary>
|
|
22020
|
+
# * {Types::SearchRulesResponse#approximate_total_count #approximate_total_count} => Integer
|
|
22021
|
+
# * {Types::SearchRulesResponse#next_token #next_token} => String
|
|
22022
|
+
#
|
|
22023
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
22024
|
+
#
|
|
22025
|
+
#
|
|
22026
|
+
# @example Example: SearchRules
|
|
22027
|
+
#
|
|
22028
|
+
# # Searches for published rules in an Amazon Connect instance.
|
|
22029
|
+
#
|
|
22030
|
+
# resp = client.search_rules({
|
|
22031
|
+
# instance_id: "12345678-1234-1234-1234-123456789012",
|
|
22032
|
+
# max_results: 10,
|
|
22033
|
+
# search_criteria: {
|
|
22034
|
+
# string_condition: {
|
|
22035
|
+
# comparison_type: "EXACT",
|
|
22036
|
+
# field_name: "PublishStatus",
|
|
22037
|
+
# value: "PUBLISHED",
|
|
22038
|
+
# },
|
|
22039
|
+
# },
|
|
22040
|
+
# })
|
|
22041
|
+
#
|
|
22042
|
+
# resp.to_h outputs the following:
|
|
22043
|
+
# {
|
|
22044
|
+
# approximate_total_count: 1,
|
|
22045
|
+
# rules: [
|
|
22046
|
+
# {
|
|
22047
|
+
# action_summaries: [
|
|
22048
|
+
# {
|
|
22049
|
+
# action_type: "CREATE_TASK",
|
|
22050
|
+
# },
|
|
22051
|
+
# ],
|
|
22052
|
+
# created_time: Time.parse("2026-01-15T10:00:00Z"),
|
|
22053
|
+
# last_updated_by: "arn:aws:connect:us-west-2:123456789012:instance/12345678-1234-1234-1234-123456789012/agent/agent-id",
|
|
22054
|
+
# last_updated_time: Time.parse("2026-03-20T14:30:00Z"),
|
|
22055
|
+
# name: "MyRule",
|
|
22056
|
+
# publish_status: "PUBLISHED",
|
|
22057
|
+
# rule_arn: "arn:aws:connect:us-west-2:123456789012:instance/12345678-1234-1234-1234-123456789012/rule/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
|
|
22058
|
+
# rule_capability_tiers: [
|
|
22059
|
+
# ],
|
|
22060
|
+
# rule_id: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
|
|
22061
|
+
# trigger_event_source: {
|
|
22062
|
+
# event_source_name: "OnPostCallAnalysisAvailable",
|
|
22063
|
+
# },
|
|
22064
|
+
# },
|
|
22065
|
+
# ],
|
|
22066
|
+
# }
|
|
22067
|
+
#
|
|
22068
|
+
# @example Request syntax with placeholder values
|
|
22069
|
+
#
|
|
22070
|
+
# resp = client.search_rules({
|
|
22071
|
+
# instance_id: "InstanceId", # required
|
|
22072
|
+
# max_results: 1,
|
|
22073
|
+
# next_token: "NextToken2500",
|
|
22074
|
+
# search_criteria: {
|
|
22075
|
+
# or_conditions: [
|
|
22076
|
+
# {
|
|
22077
|
+
# # recursive RulesSearchCriteria
|
|
22078
|
+
# },
|
|
22079
|
+
# ],
|
|
22080
|
+
# and_conditions: [
|
|
22081
|
+
# {
|
|
22082
|
+
# # recursive RulesSearchCriteria
|
|
22083
|
+
# },
|
|
22084
|
+
# ],
|
|
22085
|
+
# string_condition: {
|
|
22086
|
+
# field_name: "String",
|
|
22087
|
+
# value: "String",
|
|
22088
|
+
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
|
22089
|
+
# },
|
|
22090
|
+
# },
|
|
22091
|
+
# search_filter: {
|
|
22092
|
+
# attribute_filter: {
|
|
22093
|
+
# or_conditions: [
|
|
22094
|
+
# {
|
|
22095
|
+
# tag_conditions: [
|
|
22096
|
+
# {
|
|
22097
|
+
# tag_key: "String",
|
|
22098
|
+
# tag_value: "String",
|
|
22099
|
+
# },
|
|
22100
|
+
# ],
|
|
22101
|
+
# },
|
|
22102
|
+
# ],
|
|
22103
|
+
# and_condition: {
|
|
22104
|
+
# tag_conditions: [
|
|
22105
|
+
# {
|
|
22106
|
+
# tag_key: "String",
|
|
22107
|
+
# tag_value: "String",
|
|
22108
|
+
# },
|
|
22109
|
+
# ],
|
|
22110
|
+
# },
|
|
22111
|
+
# tag_condition: {
|
|
22112
|
+
# tag_key: "String",
|
|
22113
|
+
# tag_value: "String",
|
|
22114
|
+
# },
|
|
22115
|
+
# },
|
|
22116
|
+
# },
|
|
22117
|
+
# })
|
|
22118
|
+
#
|
|
22119
|
+
# @example Response structure
|
|
22120
|
+
#
|
|
22121
|
+
# resp.rules #=> Array
|
|
22122
|
+
# resp.rules[0].name #=> String
|
|
22123
|
+
# resp.rules[0].rule_id #=> String
|
|
22124
|
+
# resp.rules[0].rule_arn #=> String
|
|
22125
|
+
# resp.rules[0].trigger_event_source.event_source_name #=> String, one of "OnPostCallAnalysisAvailable", "OnRealTimeCallAnalysisAvailable", "OnRealTimeChatAnalysisAvailable", "OnPostChatAnalysisAvailable", "OnEmailAnalysisAvailable", "OnZendeskTicketCreate", "OnZendeskTicketStatusUpdate", "OnSalesforceCaseCreate", "OnContactEvaluationSubmit", "OnMetricDataUpdate", "OnCaseCreate", "OnCaseUpdate", "OnSlaBreach", "OnAlertUpdate", "OnSchedulePublish", "OnScheduleUpdate", "OnScheduleTimeOffRequestActivity"
|
|
22126
|
+
# resp.rules[0].trigger_event_source.integration_association_id #=> String
|
|
22127
|
+
# resp.rules[0].action_summaries #=> Array
|
|
22128
|
+
# resp.rules[0].action_summaries[0].action_type #=> String, one of "CREATE_TASK", "ASSIGN_CONTACT_CATEGORY", "GENERATE_EVENTBRIDGE_EVENT", "SEND_NOTIFICATION", "CREATE_CASE", "UPDATE_CASE", "ASSIGN_SLA", "END_ASSOCIATED_TASKS", "SUBMIT_AUTO_EVALUATION"
|
|
22129
|
+
# resp.rules[0].rule_capability_tiers #=> Array
|
|
22130
|
+
# resp.rules[0].rule_capability_tiers[0] #=> String, one of "GenerativeAI"
|
|
22131
|
+
# resp.rules[0].publish_status #=> String, one of "DRAFT", "PUBLISHED"
|
|
22132
|
+
# resp.rules[0].created_time #=> Time
|
|
22133
|
+
# resp.rules[0].last_updated_time #=> Time
|
|
22134
|
+
# resp.rules[0].last_updated_by #=> String
|
|
22135
|
+
# resp.rules[0].tags #=> Hash
|
|
22136
|
+
# resp.rules[0].tags["TagKey"] #=> String
|
|
22137
|
+
# resp.approximate_total_count #=> Integer
|
|
22138
|
+
# resp.next_token #=> String
|
|
22139
|
+
#
|
|
22140
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchRules AWS API Documentation
|
|
22141
|
+
#
|
|
22142
|
+
# @overload search_rules(params = {})
|
|
22143
|
+
# @param [Hash] params ({})
|
|
22144
|
+
def search_rules(params = {}, options = {})
|
|
22145
|
+
req = build_request(:search_rules, params)
|
|
22146
|
+
req.send_request(options)
|
|
22147
|
+
end
|
|
22148
|
+
|
|
21961
22149
|
# Searches security profiles in an Connect Customer instance, with
|
|
21962
22150
|
# optional filtering.
|
|
21963
22151
|
#
|
|
@@ -27376,7 +27564,7 @@ module Aws::Connect
|
|
|
27376
27564
|
#
|
|
27377
27565
|
#
|
|
27378
27566
|
#
|
|
27379
|
-
# [1]: https://docs.aws.amazon.com/
|
|
27567
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/hours-of-operation-overrides.html
|
|
27380
27568
|
#
|
|
27381
27569
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
27382
27570
|
#
|
|
@@ -28835,12 +29023,19 @@ module Aws::Connect
|
|
|
28835
29023
|
# The identifier of the flow that runs by default when a task is created
|
|
28836
29024
|
# by referencing this template.
|
|
28837
29025
|
#
|
|
29026
|
+
# Although this parameter is marked as optional, the request must
|
|
29027
|
+
# contain either a `ContactFlowId` or a field of type `QUICK_CONNECT`.
|
|
29028
|
+
#
|
|
28838
29029
|
# @option params [String] :self_assign_flow_id
|
|
28839
29030
|
# The ContactFlowId for the flow that will be run if this template is
|
|
28840
29031
|
# used to create a self-assigned task.
|
|
28841
29032
|
#
|
|
28842
29033
|
# @option params [Types::TaskTemplateConstraints] :constraints
|
|
28843
|
-
# Constraints that are applicable to the fields listed.
|
|
29034
|
+
# Constraints that are applicable to the fields listed. Although this
|
|
29035
|
+
# parameter is marked as optional in the API model, the service requires
|
|
29036
|
+
# it when calling `CreateTaskTemplate` or `UpdateTaskTemplate`. The
|
|
29037
|
+
# `RequiredFields` array must contain at least one element, and the
|
|
29038
|
+
# field of type `NAME` must be included in `RequiredFields`.
|
|
28844
29039
|
#
|
|
28845
29040
|
# @option params [Types::TaskTemplateDefaults] :defaults
|
|
28846
29041
|
# The default values for fields when a task is created by referencing
|
|
@@ -28852,9 +29047,16 @@ module Aws::Connect
|
|
|
28852
29047
|
# marked as `INACTIVE`, then a task that refers to this template cannot
|
|
28853
29048
|
# be created.
|
|
28854
29049
|
#
|
|
29050
|
+
# Although this parameter is marked as optional, the service requires it
|
|
29051
|
+
# when calling `UpdateTaskTemplate`.
|
|
29052
|
+
#
|
|
28855
29053
|
# @option params [Array<Types::TaskTemplateField>] :fields
|
|
28856
29054
|
# Fields that are part of the template.
|
|
28857
29055
|
#
|
|
29056
|
+
# The request must contain exactly one field of type `NAME`. This field
|
|
29057
|
+
# must also be listed in the `RequiredFields` array within the
|
|
29058
|
+
# `Constraints` parameter.
|
|
29059
|
+
#
|
|
28858
29060
|
# @return [Types::UpdateTaskTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
28859
29061
|
#
|
|
28860
29062
|
# * {Types::UpdateTaskTemplateResponse#instance_id #instance_id} => String
|
|
@@ -29991,7 +30193,7 @@ module Aws::Connect
|
|
|
29991
30193
|
tracer: tracer
|
|
29992
30194
|
)
|
|
29993
30195
|
context[:gem_name] = 'aws-sdk-connect'
|
|
29994
|
-
context[:gem_version] = '1.
|
|
30196
|
+
context[:gem_version] = '1.266.0'
|
|
29995
30197
|
Seahorse::Client::Request.new(handlers, context)
|
|
29996
30198
|
end
|
|
29997
30199
|
|