aws-sdk-connect 1.263.0 → 1.265.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 +268 -47
- data/lib/aws-sdk-connect/client_api.rb +114 -0
- data/lib/aws-sdk-connect/errors.rb +16 -0
- data/lib/aws-sdk-connect/types.rb +346 -46
- data/lib/aws-sdk-connect.rb +1 -1
- data/sig/client.rbs +52 -0
- data/sig/errors.rbs +3 -0
- data/sig/params.rbs +30 -0
- data/sig/types.rbs +72 -0
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 7c0e3818ce59b7be10b7bdc9d508b8fa988a80984236226942e970ae26ad4459
|
|
4
|
+
data.tar.gz: fa277af88112a25ee4802e94bdbbec955bee25c0de74782dbb3f7e999488d1b9
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 5b7aaaddb3d9c5d76ff143a09566787913a77fcd186718a16bc499b99a973d0c87bcaa23d5927b6647376abe223a26576d6e32db238f0351ad77120b0d099fc6
|
|
7
|
+
data.tar.gz: d2d0e89e8ca48459392a817e9dcabe97e7ecf8cf37db2222f3652651170c39188f6a22d6d32e717afd2d6f988a64661e8280c402e0fc3d4de987e99b1ee6c183
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,16 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.265.0 (2026-07-14)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - This release adds SearchRules API which can be used to search for rules within an Amazon Connect instance.
|
|
8
|
+
|
|
9
|
+
1.264.0 (2026-07-09)
|
|
10
|
+
------------------
|
|
11
|
+
|
|
12
|
+
* Feature - Amazon Connect - Added DeleteContactData API to support PII deletion of customer endpoint, additional email recipients and email subject.
|
|
13
|
+
|
|
4
14
|
1.263.0 (2026-07-07)
|
|
5
15
|
------------------
|
|
6
16
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.265.0
|
|
@@ -973,8 +973,9 @@ module Aws::Connect
|
|
|
973
973
|
end
|
|
974
974
|
|
|
975
975
|
# Associates a set of hours of operations with another hours of
|
|
976
|
-
# operation.
|
|
977
|
-
#
|
|
976
|
+
# operation. For more information about inheriting overrides from parent
|
|
977
|
+
# hours of operation, see [Hours of operation overrides][1] in the
|
|
978
|
+
# Administrator Guide.
|
|
978
979
|
#
|
|
979
980
|
#
|
|
980
981
|
#
|
|
@@ -3765,7 +3766,7 @@ module Aws::Connect
|
|
|
3765
3766
|
#
|
|
3766
3767
|
#
|
|
3767
3768
|
#
|
|
3768
|
-
# [1]: https://docs.aws.amazon.com/
|
|
3769
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/hours-of-operation-overrides.html
|
|
3769
3770
|
#
|
|
3770
3771
|
# @option params [Hash<String,String>] :tags
|
|
3771
3772
|
# The tags used to organize, track, or control access for this resource.
|
|
@@ -3858,7 +3859,7 @@ module Aws::Connect
|
|
|
3858
3859
|
#
|
|
3859
3860
|
#
|
|
3860
3861
|
#
|
|
3861
|
-
# [1]: https://docs.aws.amazon.com/
|
|
3862
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/hours-of-operation-overrides.html
|
|
3862
3863
|
#
|
|
3863
3864
|
# @return [Types::CreateHoursOfOperationOverrideResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3864
3865
|
#
|
|
@@ -6317,6 +6318,57 @@ module Aws::Connect
|
|
|
6317
6318
|
req.send_request(options)
|
|
6318
6319
|
end
|
|
6319
6320
|
|
|
6321
|
+
# Deletes the specified fields containing personally identifiable
|
|
6322
|
+
# information (PII) from a contact in the specified Connect Customer
|
|
6323
|
+
# instance. This operation redacts PII (such as customer endpoints,
|
|
6324
|
+
# additional email recipients, and the email subject) from the contact
|
|
6325
|
+
# and its associated contact trace record (CTR). The contact must be in
|
|
6326
|
+
# a terminated state.
|
|
6327
|
+
#
|
|
6328
|
+
# This operation performs a hard deletion of the specified PII and
|
|
6329
|
+
# cannot be undone. There is no retention period; after the data is
|
|
6330
|
+
# deleted, it cannot be recovered. Only fields that Connect Customer
|
|
6331
|
+
# identifies and stores as PII are removed. Any PII that you place in
|
|
6332
|
+
# fields outside the scope of this operation remains your responsibility
|
|
6333
|
+
# to remove.
|
|
6334
|
+
#
|
|
6335
|
+
# @option params [required, String] :instance_id
|
|
6336
|
+
# The identifier of the Connect Customer instance. You can [find the
|
|
6337
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
6338
|
+
#
|
|
6339
|
+
#
|
|
6340
|
+
#
|
|
6341
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
6342
|
+
#
|
|
6343
|
+
# @option params [required, String] :contact_id
|
|
6344
|
+
# The identifier of the contact. PII can be deleted only from a contact
|
|
6345
|
+
# that has been disconnected (is in a terminated state).
|
|
6346
|
+
#
|
|
6347
|
+
# @option params [required, Array<String>] :contact_fields
|
|
6348
|
+
# The categories of PII to redact from the contact. Valid values are
|
|
6349
|
+
# `CUSTOMER_ENDPOINT`, `ADDITIONAL_EMAIL_RECIPIENTS`, and
|
|
6350
|
+
# `EMAIL_SUBJECT`. `ADDITIONAL_EMAIL_RECIPIENTS` and `EMAIL_SUBJECT` are
|
|
6351
|
+
# supported only for contacts in the email channel.
|
|
6352
|
+
#
|
|
6353
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
6354
|
+
#
|
|
6355
|
+
# @example Request syntax with placeholder values
|
|
6356
|
+
#
|
|
6357
|
+
# resp = client.delete_contact_data({
|
|
6358
|
+
# instance_id: "InstanceId", # required
|
|
6359
|
+
# contact_id: "ContactId", # required
|
|
6360
|
+
# contact_fields: ["CUSTOMER_ENDPOINT"], # required, accepts CUSTOMER_ENDPOINT, ADDITIONAL_EMAIL_RECIPIENTS, EMAIL_SUBJECT
|
|
6361
|
+
# })
|
|
6362
|
+
#
|
|
6363
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteContactData AWS API Documentation
|
|
6364
|
+
#
|
|
6365
|
+
# @overload delete_contact_data(params = {})
|
|
6366
|
+
# @param [Hash] params ({})
|
|
6367
|
+
def delete_contact_data(params = {}, options = {})
|
|
6368
|
+
req = build_request(:delete_contact_data, params)
|
|
6369
|
+
req.send_request(options)
|
|
6370
|
+
end
|
|
6371
|
+
|
|
6320
6372
|
# Deletes a contact evaluation in the specified Connect Customer
|
|
6321
6373
|
# instance.
|
|
6322
6374
|
#
|
|
@@ -9367,6 +9419,8 @@ module Aws::Connect
|
|
|
9367
9419
|
# resp.rule.rule_arn #=> String
|
|
9368
9420
|
# 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"
|
|
9369
9421
|
# resp.rule.trigger_event_source.integration_association_id #=> String
|
|
9422
|
+
# resp.rule.rule_capability_tiers #=> Array
|
|
9423
|
+
# resp.rule.rule_capability_tiers[0] #=> String, one of "GenerativeAI"
|
|
9370
9424
|
# resp.rule.function #=> String
|
|
9371
9425
|
# resp.rule.actions #=> Array
|
|
9372
9426
|
# 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"
|
|
@@ -10311,8 +10365,9 @@ module Aws::Connect
|
|
|
10311
10365
|
end
|
|
10312
10366
|
|
|
10313
10367
|
# Disassociates a set of hours of operations with another hours of
|
|
10314
|
-
# operation.
|
|
10315
|
-
#
|
|
10368
|
+
# operation. For more information about inheriting overrides from parent
|
|
10369
|
+
# hours of operation, see [Hours of operation overrides][1] in the
|
|
10370
|
+
# Administrator Guide.
|
|
10316
10371
|
#
|
|
10317
10372
|
#
|
|
10318
10373
|
#
|
|
@@ -12452,24 +12507,25 @@ module Aws::Connect
|
|
|
12452
12507
|
# `AGENT_HIERARCHY_LEVEL_TWO` \| `AGENT_HIERARCHY_LEVEL_THREE` \|
|
|
12453
12508
|
# `AGENT_HIERARCHY_LEVEL_FOUR` \| `AGENT_HIERARCHY_LEVEL_FIVE` \|
|
|
12454
12509
|
# `ANSWERING_MACHINE_DETECTION_STATUS` \| `BOT_ALIAS` \| `BOT_ID` \|
|
|
12455
|
-
# `BOT_INTENT_NAME` \| `BOT_LOCALE` \| `BOT_VERSION` \| `
|
|
12456
|
-
# `
|
|
12457
|
-
# `
|
|
12458
|
-
# `contact/segmentAttributes/connect:Subtype` \|
|
|
12510
|
+
# `BOT_INTENT_NAME` \| `BOT_LOCALE` \| `BOT_VERSION` \| `BROWSER_NAME`
|
|
12511
|
+
# \| `CAMPAIGN` \| `CAMPAIGN_DELIVERY_EVENT_TYPE` \|
|
|
12512
|
+
# `CAMPAIGN_EXCLUDED_EVENT_TYPE` \| `CASE_STATUS` \| `CASE_TEMPLATE_ARN`
|
|
12513
|
+
# \| `CHANNEL` \| `contact/segmentAttributes/connect:Subtype` \|
|
|
12459
12514
|
# `contact/segmentAttributes/connect:ValidationTestType` \|
|
|
12460
|
-
# `
|
|
12461
|
-
# `
|
|
12462
|
-
# `
|
|
12463
|
-
# `
|
|
12464
|
-
# `
|
|
12465
|
-
# `
|
|
12466
|
-
# `
|
|
12467
|
-
# `
|
|
12468
|
-
# `
|
|
12469
|
-
# `
|
|
12470
|
-
# `
|
|
12471
|
-
# `
|
|
12472
|
-
# \| `TEST_CASE_EXECUTION_STATE`
|
|
12515
|
+
# `DEVICE_MODEL` \| `DEVICE_TYPE` \| `DISCONNECT_REASON` \|
|
|
12516
|
+
# `EVALUATION_FORM` \| `EVALUATION_QUESTION` \| `EVALUATION_SECTION` \|
|
|
12517
|
+
# `EVALUATION_SOURCE` \| `EVALUATOR_ID` \| `FEATURE` \| `FLOW_ACTION_ID`
|
|
12518
|
+
# \| `FLOW_TYPE` \| `FLOWS_MODULE_RESOURCE_ID` \|
|
|
12519
|
+
# `FLOWS_NEXT_RESOURCE_ID` \| `FLOWS_NEXT_RESOURCE_QUEUE_ID` \|
|
|
12520
|
+
# `FLOWS_OUTCOME_TYPE` \| `FLOWS_RESOURCE_ID` \| `FORM_VERSION` \|
|
|
12521
|
+
# `INITIATING_FLOW` \| `INITIATION_METHOD` \|
|
|
12522
|
+
# `INVOKING_RESOURCE_PUBLISHED_TIMESTAMP` \| `INVOKING_RESOURCE_TYPE` \|
|
|
12523
|
+
# `KNOWLEDGE_BASE_NAME` \| `PARENT_FLOWS_RESOURCE_ID` \|
|
|
12524
|
+
# `Q_CONNECT_ENABLED` \| `QUEUE` \| `RESOURCE_PUBLISHED_TIMESTAMP` \|
|
|
12525
|
+
# `ROUTING_PROFILE` \| `ROUTING_STEP_EXPRESSION` \| `SESSION_ID` \|
|
|
12526
|
+
# `TEST_CASE` \| `TEST_CASE_EXECUTION_FAILURE_REASON` \|
|
|
12527
|
+
# `TEST_CASE_EXECUTION_RESULT` \| `TEST_CASE_EXECUTION_STATE` \|
|
|
12528
|
+
# `WEB_NOTIFICATION_TYPE`
|
|
12473
12529
|
#
|
|
12474
12530
|
# <note markdown="1"> The following filter keys correspond to Connect Customer resources and
|
|
12475
12531
|
# are used for authorizing requests. A `GetMetricDataV2` request
|
|
@@ -12547,10 +12603,11 @@ module Aws::Connect
|
|
|
12547
12603
|
# `AGENT_HIERARCHY_LEVEL_THREE` \| `AGENT_HIERARCHY_LEVEL_FOUR` \|
|
|
12548
12604
|
# `AGENT_HIERARCHY_LEVEL_FIVE` \| `ANSWERING_MACHINE_DETECTION_STATUS`
|
|
12549
12605
|
# \| `BOT_ID` \| `BOT_ALIAS` \| `BOT_VERSION` \| `BOT_LOCALE` \|
|
|
12550
|
-
# `BOT_INTENT_NAME` \| `
|
|
12551
|
-
# `
|
|
12552
|
-
# `
|
|
12553
|
-
# `contact/segmentAttributes/connect:Subtype` \|
|
|
12606
|
+
# `BOT_INTENT_NAME` \| `BROWSER_NAME` \| `CAMPAIGN` \|
|
|
12607
|
+
# `CAMPAIGN_DELIVERY_EVENT_TYPE` \| `CAMPAIGN_EXCLUDED_EVENT_TYPE` \|
|
|
12608
|
+
# `CAMPAIGN_EXECUTION_TIMESTAMP` \| `CASE_TEMPLATE_ARN` \| `CASE_STATUS`
|
|
12609
|
+
# \| `CHANNEL` \| `contact/segmentAttributes/connect:Subtype` \|
|
|
12610
|
+
# `DEVICE_MODEL` \| `DEVICE_TYPE` \| `DISCONNECT_REASON` \|
|
|
12554
12611
|
# `EVALUATION_FORM` \| `EVALUATION_SECTION` \| `EVALUATION_QUESTION` \|
|
|
12555
12612
|
# `EVALUATION_SOURCE` \| `EVALUATOR_ID` \| `FLOWS_RESOURCE_ID` \|
|
|
12556
12613
|
# `FLOWS_MODULE_RESOURCE_ID` \| `FLOW_ACTION_ID` \| `FLOW_TYPE` \|
|
|
@@ -12561,6 +12618,7 @@ module Aws::Connect
|
|
|
12561
12618
|
# `RESOURCE_PUBLISHED_TIMESTAMP` \| `ROUTING_PROFILE` \|
|
|
12562
12619
|
# `ROUTING_STEP_EXPRESSION` \| `SESSION_ID` \| `TEST_CASE` \|
|
|
12563
12620
|
# `TEST_CASE_EXECUTION_FAILURE_REASON` \| `TEST_CASE_INVOCATION_METHOD`
|
|
12621
|
+
# \| `WEB_NOTIFICATION_TYPE`
|
|
12564
12622
|
#
|
|
12565
12623
|
# <note markdown="1"> `AI_AGENT_NAME_VERSION`, `AI_PROMPT_NAME_VERSION`, and
|
|
12566
12624
|
# `KNOWLEDGE_ARTICLE_NAME` are valid groupings but not valid filters.
|
|
@@ -13641,14 +13699,16 @@ module Aws::Connect
|
|
|
13641
13699
|
#
|
|
13642
13700
|
# CAMPAIGN\_INTERACTIONS
|
|
13643
13701
|
#
|
|
13644
|
-
# : This metric is available only for outbound campaigns using the
|
|
13645
|
-
# delivery
|
|
13702
|
+
# : This metric is available only for outbound campaigns using the
|
|
13703
|
+
# email, WhatsApp, and web notification delivery modes.
|
|
13646
13704
|
#
|
|
13647
13705
|
# Unit: Count
|
|
13648
13706
|
#
|
|
13649
13707
|
# Valid metric filter key: CAMPAIGN\_INTERACTION\_EVENT\_TYPE
|
|
13650
13708
|
#
|
|
13651
|
-
# Valid groupings and filters: Campaign
|
|
13709
|
+
# Valid groupings and filters: Browser Name, Campaign, Channel,
|
|
13710
|
+
# contact/segmentAttributes/connect:Subtype, Device Model, Device
|
|
13711
|
+
# Type, Web Notification Type
|
|
13652
13712
|
#
|
|
13653
13713
|
# UI name: [Campaign interactions][93]
|
|
13654
13714
|
#
|
|
@@ -13905,17 +13965,18 @@ module Aws::Connect
|
|
|
13905
13965
|
# `CAMPAIGN_DELIVERY_EVENT_TYPE`, `DISCONNECT_REASON`
|
|
13906
13966
|
#
|
|
13907
13967
|
# Valid groupings and filters: Agent, Answering Machine Detection
|
|
13908
|
-
# Status, Campaign, Campaign Delivery EventType,
|
|
13909
|
-
# contact/segmentAttributes/connect:Subtype,
|
|
13910
|
-
# Routing Profile
|
|
13968
|
+
# Status, Browser Name, Campaign, Campaign Delivery EventType,
|
|
13969
|
+
# Channel, contact/segmentAttributes/connect:Subtype, Device Model,
|
|
13970
|
+
# Device Type, Disconnect Reason, Queue, Routing Profile, Web
|
|
13971
|
+
# Notification Type
|
|
13911
13972
|
#
|
|
13912
13973
|
# UI name: [Delivery attempts][116]
|
|
13913
13974
|
#
|
|
13914
13975
|
# <note markdown="1"> Campaign Delivery EventType filter and grouping are only available
|
|
13915
|
-
# for SMS
|
|
13916
|
-
# Profile, Answering Machine Detection
|
|
13917
|
-
# are only available for agent assisted
|
|
13918
|
-
# delivery modes.
|
|
13976
|
+
# for SMS, Email, WhatsApp, and web notification campaign delivery
|
|
13977
|
+
# modes. Agent, Queue, Routing Profile, Answering Machine Detection
|
|
13978
|
+
# Status and Disconnect Reason are only available for agent assisted
|
|
13979
|
+
# voice and automated voice delivery modes.
|
|
13919
13980
|
#
|
|
13920
13981
|
# </note>
|
|
13921
13982
|
#
|
|
@@ -13931,17 +13992,18 @@ module Aws::Connect
|
|
|
13931
13992
|
# `CAMPAIGN_DELIVERY_EVENT_TYPE`, `DISCONNECT_REASON`
|
|
13932
13993
|
#
|
|
13933
13994
|
# Valid groupings and filters: Agent, Answering Machine Detection
|
|
13934
|
-
# Status, Campaign, Channel,
|
|
13935
|
-
# contact/segmentAttributes/connect:Subtype,
|
|
13936
|
-
# Routing Profile
|
|
13995
|
+
# Status, Browser Name, Campaign, Channel,
|
|
13996
|
+
# contact/segmentAttributes/connect:Subtype, Device Model, Device
|
|
13997
|
+
# Type, Disconnect Reason, Queue, Routing Profile, Web Notification
|
|
13998
|
+
# Type
|
|
13937
13999
|
#
|
|
13938
14000
|
# UI name: [Delivery attempt disposition rate][117]
|
|
13939
14001
|
#
|
|
13940
14002
|
# <note markdown="1"> Campaign Delivery Event Type filter and grouping are only available
|
|
13941
|
-
# for SMS
|
|
13942
|
-
# Profile, Answering Machine Detection
|
|
13943
|
-
# are only available for agent assisted
|
|
13944
|
-
# delivery modes.
|
|
14003
|
+
# for SMS, Email, WhatsApp, and web notification campaign delivery
|
|
14004
|
+
# modes. Agent, Queue, Routing Profile, Answering Machine Detection
|
|
14005
|
+
# Status and Disconnect Reason are only available for agent assisted
|
|
14006
|
+
# voice and automated voice delivery modes.
|
|
13945
14007
|
#
|
|
13946
14008
|
# </note>
|
|
13947
14009
|
#
|
|
@@ -15473,7 +15535,7 @@ module Aws::Connect
|
|
|
15473
15535
|
#
|
|
15474
15536
|
#
|
|
15475
15537
|
#
|
|
15476
|
-
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
15538
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/hours-of-operation-overrides.html
|
|
15477
15539
|
#
|
|
15478
15540
|
# @option params [required, String] :instance_id
|
|
15479
15541
|
# The identifier of the Amazon Connect instance. You can [find the
|
|
@@ -18049,6 +18111,8 @@ module Aws::Connect
|
|
|
18049
18111
|
# resp.rule_summary_list[0].rule_arn #=> String
|
|
18050
18112
|
# 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"
|
|
18051
18113
|
# resp.rule_summary_list[0].publish_status #=> String, one of "DRAFT", "PUBLISHED"
|
|
18114
|
+
# resp.rule_summary_list[0].rule_capability_tiers #=> Array
|
|
18115
|
+
# resp.rule_summary_list[0].rule_capability_tiers[0] #=> String, one of "GenerativeAI"
|
|
18052
18116
|
# resp.rule_summary_list[0].action_summaries #=> Array
|
|
18053
18117
|
# 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"
|
|
18054
18118
|
# resp.rule_summary_list[0].created_time #=> Time
|
|
@@ -21907,6 +21971,163 @@ module Aws::Connect
|
|
|
21907
21971
|
req.send_request(options)
|
|
21908
21972
|
end
|
|
21909
21973
|
|
|
21974
|
+
# Searches rules in an Connect Customer instance, with optional
|
|
21975
|
+
# filtering.
|
|
21976
|
+
#
|
|
21977
|
+
# @option params [required, String] :instance_id
|
|
21978
|
+
# The identifier of the Connect Customer instance. You can [find the
|
|
21979
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
21980
|
+
#
|
|
21981
|
+
#
|
|
21982
|
+
#
|
|
21983
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
21984
|
+
#
|
|
21985
|
+
# @option params [Integer] :max_results
|
|
21986
|
+
# The maximum number of results to return per page.
|
|
21987
|
+
#
|
|
21988
|
+
# @option params [String] :next_token
|
|
21989
|
+
# The token for the next set of results. Use the value returned in the
|
|
21990
|
+
# previous response in the next request to retrieve the next set of
|
|
21991
|
+
# results.
|
|
21992
|
+
#
|
|
21993
|
+
# @option params [Types::RulesSearchCriteria] :search_criteria
|
|
21994
|
+
# The search criteria to be used to return rules.
|
|
21995
|
+
#
|
|
21996
|
+
# @option params [Types::RulesSearchFilter] :search_filter
|
|
21997
|
+
# Filters to be applied to search results, such as tag-based filters.
|
|
21998
|
+
#
|
|
21999
|
+
# @return [Types::SearchRulesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
22000
|
+
#
|
|
22001
|
+
# * {Types::SearchRulesResponse#rules #rules} => Array<Types::RuleSearchSummary>
|
|
22002
|
+
# * {Types::SearchRulesResponse#approximate_total_count #approximate_total_count} => Integer
|
|
22003
|
+
# * {Types::SearchRulesResponse#next_token #next_token} => String
|
|
22004
|
+
#
|
|
22005
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
22006
|
+
#
|
|
22007
|
+
#
|
|
22008
|
+
# @example Example: SearchRules
|
|
22009
|
+
#
|
|
22010
|
+
# # Searches for published rules in an Amazon Connect instance.
|
|
22011
|
+
#
|
|
22012
|
+
# resp = client.search_rules({
|
|
22013
|
+
# instance_id: "12345678-1234-1234-1234-123456789012",
|
|
22014
|
+
# max_results: 10,
|
|
22015
|
+
# search_criteria: {
|
|
22016
|
+
# string_condition: {
|
|
22017
|
+
# comparison_type: "EXACT",
|
|
22018
|
+
# field_name: "PublishStatus",
|
|
22019
|
+
# value: "PUBLISHED",
|
|
22020
|
+
# },
|
|
22021
|
+
# },
|
|
22022
|
+
# })
|
|
22023
|
+
#
|
|
22024
|
+
# resp.to_h outputs the following:
|
|
22025
|
+
# {
|
|
22026
|
+
# approximate_total_count: 1,
|
|
22027
|
+
# rules: [
|
|
22028
|
+
# {
|
|
22029
|
+
# action_summaries: [
|
|
22030
|
+
# {
|
|
22031
|
+
# action_type: "CREATE_TASK",
|
|
22032
|
+
# },
|
|
22033
|
+
# ],
|
|
22034
|
+
# created_time: Time.parse("2026-01-15T10:00:00Z"),
|
|
22035
|
+
# last_updated_by: "arn:aws:connect:us-west-2:123456789012:instance/12345678-1234-1234-1234-123456789012/agent/agent-id",
|
|
22036
|
+
# last_updated_time: Time.parse("2026-03-20T14:30:00Z"),
|
|
22037
|
+
# name: "MyRule",
|
|
22038
|
+
# publish_status: "PUBLISHED",
|
|
22039
|
+
# rule_arn: "arn:aws:connect:us-west-2:123456789012:instance/12345678-1234-1234-1234-123456789012/rule/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
|
|
22040
|
+
# rule_capability_tiers: [
|
|
22041
|
+
# ],
|
|
22042
|
+
# rule_id: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
|
|
22043
|
+
# trigger_event_source: {
|
|
22044
|
+
# event_source_name: "OnPostCallAnalysisAvailable",
|
|
22045
|
+
# },
|
|
22046
|
+
# },
|
|
22047
|
+
# ],
|
|
22048
|
+
# }
|
|
22049
|
+
#
|
|
22050
|
+
# @example Request syntax with placeholder values
|
|
22051
|
+
#
|
|
22052
|
+
# resp = client.search_rules({
|
|
22053
|
+
# instance_id: "InstanceId", # required
|
|
22054
|
+
# max_results: 1,
|
|
22055
|
+
# next_token: "NextToken2500",
|
|
22056
|
+
# search_criteria: {
|
|
22057
|
+
# or_conditions: [
|
|
22058
|
+
# {
|
|
22059
|
+
# # recursive RulesSearchCriteria
|
|
22060
|
+
# },
|
|
22061
|
+
# ],
|
|
22062
|
+
# and_conditions: [
|
|
22063
|
+
# {
|
|
22064
|
+
# # recursive RulesSearchCriteria
|
|
22065
|
+
# },
|
|
22066
|
+
# ],
|
|
22067
|
+
# string_condition: {
|
|
22068
|
+
# field_name: "String",
|
|
22069
|
+
# value: "String",
|
|
22070
|
+
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
|
22071
|
+
# },
|
|
22072
|
+
# },
|
|
22073
|
+
# search_filter: {
|
|
22074
|
+
# attribute_filter: {
|
|
22075
|
+
# or_conditions: [
|
|
22076
|
+
# {
|
|
22077
|
+
# tag_conditions: [
|
|
22078
|
+
# {
|
|
22079
|
+
# tag_key: "String",
|
|
22080
|
+
# tag_value: "String",
|
|
22081
|
+
# },
|
|
22082
|
+
# ],
|
|
22083
|
+
# },
|
|
22084
|
+
# ],
|
|
22085
|
+
# and_condition: {
|
|
22086
|
+
# tag_conditions: [
|
|
22087
|
+
# {
|
|
22088
|
+
# tag_key: "String",
|
|
22089
|
+
# tag_value: "String",
|
|
22090
|
+
# },
|
|
22091
|
+
# ],
|
|
22092
|
+
# },
|
|
22093
|
+
# tag_condition: {
|
|
22094
|
+
# tag_key: "String",
|
|
22095
|
+
# tag_value: "String",
|
|
22096
|
+
# },
|
|
22097
|
+
# },
|
|
22098
|
+
# },
|
|
22099
|
+
# })
|
|
22100
|
+
#
|
|
22101
|
+
# @example Response structure
|
|
22102
|
+
#
|
|
22103
|
+
# resp.rules #=> Array
|
|
22104
|
+
# resp.rules[0].name #=> String
|
|
22105
|
+
# resp.rules[0].rule_id #=> String
|
|
22106
|
+
# resp.rules[0].rule_arn #=> String
|
|
22107
|
+
# 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"
|
|
22108
|
+
# resp.rules[0].trigger_event_source.integration_association_id #=> String
|
|
22109
|
+
# resp.rules[0].action_summaries #=> Array
|
|
22110
|
+
# 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"
|
|
22111
|
+
# resp.rules[0].rule_capability_tiers #=> Array
|
|
22112
|
+
# resp.rules[0].rule_capability_tiers[0] #=> String, one of "GenerativeAI"
|
|
22113
|
+
# resp.rules[0].publish_status #=> String, one of "DRAFT", "PUBLISHED"
|
|
22114
|
+
# resp.rules[0].created_time #=> Time
|
|
22115
|
+
# resp.rules[0].last_updated_time #=> Time
|
|
22116
|
+
# resp.rules[0].last_updated_by #=> String
|
|
22117
|
+
# resp.rules[0].tags #=> Hash
|
|
22118
|
+
# resp.rules[0].tags["TagKey"] #=> String
|
|
22119
|
+
# resp.approximate_total_count #=> Integer
|
|
22120
|
+
# resp.next_token #=> String
|
|
22121
|
+
#
|
|
22122
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchRules AWS API Documentation
|
|
22123
|
+
#
|
|
22124
|
+
# @overload search_rules(params = {})
|
|
22125
|
+
# @param [Hash] params ({})
|
|
22126
|
+
def search_rules(params = {}, options = {})
|
|
22127
|
+
req = build_request(:search_rules, params)
|
|
22128
|
+
req.send_request(options)
|
|
22129
|
+
end
|
|
22130
|
+
|
|
21910
22131
|
# Searches security profiles in an Connect Customer instance, with
|
|
21911
22132
|
# optional filtering.
|
|
21912
22133
|
#
|
|
@@ -27325,7 +27546,7 @@ module Aws::Connect
|
|
|
27325
27546
|
#
|
|
27326
27547
|
#
|
|
27327
27548
|
#
|
|
27328
|
-
# [1]: https://docs.aws.amazon.com/
|
|
27549
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/hours-of-operation-overrides.html
|
|
27329
27550
|
#
|
|
27330
27551
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
27331
27552
|
#
|
|
@@ -29940,7 +30161,7 @@ module Aws::Connect
|
|
|
29940
30161
|
tracer: tracer
|
|
29941
30162
|
)
|
|
29942
30163
|
context[:gem_name] = 'aws-sdk-connect'
|
|
29943
|
-
context[:gem_version] = '1.
|
|
30164
|
+
context[:gem_version] = '1.265.0'
|
|
29944
30165
|
Seahorse::Client::Request.new(handlers, context)
|
|
29945
30166
|
end
|
|
29946
30167
|
|