2026/08/17 - Amazon Connect Service - 5 new 5 updated api methods
Changes This release adds new APIs to create, describe, update, delete, and list extraction definitions, enabling customers to manage lifecycle of extraction definition resources. Additionally, this release adds new event sources for Rules related to ACW and new action to Extract Information.
Deletes an extraction definition from the specified Connect Customer instance.
See also: AWS API Documentation
Request Syntax
client.delete_extraction_definition(
InstanceId='string',
ExtractionDefinitionId='string'
)
string
[REQUIRED]
The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
The identifier of the extraction definition to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists extraction definitions in the specified Connect Customer instance.
See also: AWS API Documentation
Request Syntax
client.list_extraction_definitions(
InstanceId='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
integer
The maximum number of results to return per page. The default MaxResult size is 100.
string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
dict
Response Syntax
{
'ExtractionDefinitionSummaryList': [
{
'Name': 'string',
'ExtractionDefinitionId': 'string',
'ExtractionDefinitionArn': 'string',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'LastUpdatedBy': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ExtractionDefinitionSummaryList (list) --
Information about the extraction definitions.
(dict) --
Summary information about an extraction definition.
Name (string) --
The name of the extraction definition.
ExtractionDefinitionId (string) --
The identifier of the extraction definition.
ExtractionDefinitionArn (string) --
The Amazon Resource Name (ARN) of the extraction definition.
CreatedTime (datetime) --
The timestamp when the extraction definition was created.
LastUpdatedTime (datetime) --
The timestamp when the extraction definition was last updated.
LastUpdatedBy (string) --
The Amazon Resource Name (ARN) of the user who last updated the extraction definition.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Creates an extraction definition in the specified Connect Customer instance. An extraction definition specifies how structured data is extracted from customer interactions using generative AI, including the prompt hint that guides extraction and the behavior when a value cannot be found.
See also: AWS API Documentation
Request Syntax
client.create_extraction_definition(
ClientToken='string',
InstanceId='string',
Name='string',
ExtractionConfiguration={
'PromptHint': 'string',
'NotFoundBehavior': {
'Behavior': 'USE_DEFAULT_VALUE'|'OMIT',
'DefaultValue': 'string'
}
},
Display={
'Label': 'string'
},
Tags={
'string': 'string'
}
)
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field.
This field is autopopulated if not provided.
string
[REQUIRED]
The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
A unique name of the extraction definition.
dict
[REQUIRED]
The configuration that defines how data is extracted, including the prompt hint and not-found behavior.
PromptHint (string) -- [REQUIRED]
The prompt hint that guides the extraction. This text tells the generative AI model what data to look for in the customer interaction.
NotFoundBehavior (dict) --
The behavior when the extraction cannot find the specified data in the interaction.
Behavior (string) -- [REQUIRED]
The behavior type. USE_DEFAULT_VALUE returns the specified default value. OMIT excludes the field from the output.
DefaultValue (string) --
The default value to use when the behavior is USE_DEFAULT_VALUE.
dict
The display settings for the extraction definition, including the label shown in the agent workspace.
Label (string) --
The label displayed in the agent workspace for this extraction definition.
dict
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
dict
Response Syntax
{
'ExtractionDefinitionArn': 'string',
'ExtractionDefinitionId': 'string'
}
Response Structure
(dict) --
ExtractionDefinitionArn (string) --
The Amazon Resource Name (ARN) of the extraction definition.
ExtractionDefinitionId (string) --
The identifier of the extraction definition.
Describes an extraction definition in the specified Connect Customer instance.
See also: AWS API Documentation
Request Syntax
client.describe_extraction_definition(
InstanceId='string',
ExtractionDefinitionId='string'
)
string
[REQUIRED]
The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
The identifier of the extraction definition to describe.
dict
Response Syntax
{
'ExtractionDefinition': {
'Name': 'string',
'ExtractionDefinitionId': 'string',
'ExtractionDefinitionArn': 'string',
'ExtractionConfiguration': {
'PromptHint': 'string',
'NotFoundBehavior': {
'Behavior': 'USE_DEFAULT_VALUE'|'OMIT',
'DefaultValue': 'string'
}
},
'Display': {
'Label': 'string'
},
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'LastUpdatedBy': 'string',
'Tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
ExtractionDefinition (dict) --
The extraction definition.
Name (string) --
The name of the extraction definition.
ExtractionDefinitionId (string) --
The identifier of the extraction definition.
ExtractionDefinitionArn (string) --
The Amazon Resource Name (ARN) of the extraction definition.
ExtractionConfiguration (dict) --
The configuration that defines how data is extracted.
PromptHint (string) --
The prompt hint that guides the extraction. This text tells the generative AI model what data to look for in the customer interaction.
NotFoundBehavior (dict) --
The behavior when the extraction cannot find the specified data in the interaction.
Behavior (string) --
The behavior type. USE_DEFAULT_VALUE returns the specified default value. OMIT excludes the field from the output.
DefaultValue (string) --
The default value to use when the behavior is USE_DEFAULT_VALUE.
Display (dict) --
The display settings for the extraction definition.
Label (string) --
The label displayed in the agent workspace for this extraction definition.
CreatedTime (datetime) --
The timestamp when the extraction definition was created.
LastUpdatedTime (datetime) --
The timestamp when the extraction definition was last updated.
LastUpdatedBy (string) --
The Amazon Resource Name (ARN) of the user who last updated the extraction definition.
Tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
Updates an extraction definition in the specified Connect Customer instance.
See also: AWS API Documentation
Request Syntax
client.update_extraction_definition(
ClientToken='string',
ExtractionDefinitionId='string',
InstanceId='string',
Name='string',
ExtractionConfiguration={
'PromptHint': 'string',
'NotFoundBehavior': {
'Behavior': 'USE_DEFAULT_VALUE'|'OMIT',
'DefaultValue': 'string'
}
},
Display={
'Label': 'string'
}
)
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field.
This field is autopopulated if not provided.
string
[REQUIRED]
The identifier of the extraction definition to update.
string
[REQUIRED]
The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
The name of the extraction definition.
dict
[REQUIRED]
The configuration that defines how data is extracted, including the prompt hint and not-found behavior.
PromptHint (string) -- [REQUIRED]
The prompt hint that guides the extraction. This text tells the generative AI model what data to look for in the customer interaction.
NotFoundBehavior (dict) --
The behavior when the extraction cannot find the specified data in the interaction.
Behavior (string) -- [REQUIRED]
The behavior type. USE_DEFAULT_VALUE returns the specified default value. OMIT excludes the field from the output.
DefaultValue (string) --
The default value to use when the behavior is USE_DEFAULT_VALUE.
dict
The display settings for the extraction definition.
Label (string) --
The label displayed in the agent workspace for this extraction definition.
dict
Response Syntax
{}
Response Structure
(dict) --
{'Actions': {'ActionType': {'EXTRACT_INFORMATION'},
'ExtractInformationAction': {'RulesExtractionDefinitions': [{'Identifier': 'string'}]}},
'TriggerEventSource': {'EventSourceName': {'OnAfterCallWorkAvailable',
'OnAfterChatWorkAvailable'}}}
Creates a rule for the specified Connect Customer instance.
Use the Rules Function language to code conditions for the rule.
See also: AWS API Documentation
Request Syntax
client.create_rule(
InstanceId='string',
Name='string',
TriggerEventSource={
'EventSourceName': 'OnPostCallAnalysisAvailable'|'OnRealTimeCallAnalysisAvailable'|'OnRealTimeChatAnalysisAvailable'|'OnPostChatAnalysisAvailable'|'OnAfterCallWorkAvailable'|'OnAfterChatWorkAvailable'|'OnEmailAnalysisAvailable'|'OnZendeskTicketCreate'|'OnZendeskTicketStatusUpdate'|'OnSalesforceCaseCreate'|'OnContactEvaluationSubmit'|'OnMetricDataUpdate'|'OnCaseCreate'|'OnCaseUpdate'|'OnSlaBreach'|'OnAlertUpdate'|'OnSchedulePublish'|'OnScheduleUpdate'|'OnScheduleTimeOffRequestActivity',
'IntegrationAssociationId': 'string'
},
Function='string',
Actions=[
{
'ActionType': 'CREATE_TASK'|'ASSIGN_CONTACT_CATEGORY'|'GENERATE_EVENTBRIDGE_EVENT'|'SEND_NOTIFICATION'|'CREATE_CASE'|'UPDATE_CASE'|'ASSIGN_SLA'|'END_ASSOCIATED_TASKS'|'SUBMIT_AUTO_EVALUATION'|'EXTRACT_INFORMATION',
'TaskAction': {
'Name': 'string',
'Description': 'string',
'ContactFlowId': 'string',
'References': {
'string': {
'Value': 'string',
'Type': 'URL'|'ATTACHMENT'|'CONTACT_ANALYSIS'|'NUMBER'|'STRING'|'DATE'|'EMAIL'|'EMAIL_MESSAGE'|'EMAIL_MESSAGE_PLAIN_TEXT'|'EMAIL_MESSAGE_PLAIN_TEXT_REDACTED'|'EMAIL_MESSAGE_REDACTED',
'Status': 'AVAILABLE'|'DELETED'|'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED',
'Arn': 'string',
'StatusReason': 'string'
}
}
},
'EventBridgeAction': {
'Name': 'string'
},
'AssignContactCategoryAction': {}
,
'SendNotificationAction': {
'DeliveryMethod': 'EMAIL',
'Subject': 'string',
'Content': 'string',
'ContentType': 'PLAIN_TEXT',
'Recipient': {
'UserTags': {
'string': 'string'
},
'UserIds': [
'string',
]
},
'Exclusion': {
'UserTags': {
'string': 'string'
},
'UserIds': [
'string',
]
}
},
'CreateCaseAction': {
'Fields': [
{
'Id': 'string',
'Value': {
'BooleanValue': True|False,
'DoubleValue': 123.0,
'EmptyValue': {}
,
'StringValue': 'string'
}
},
],
'TemplateId': 'string'
},
'UpdateCaseAction': {
'Fields': [
{
'Id': 'string',
'Value': {
'BooleanValue': True|False,
'DoubleValue': 123.0,
'EmptyValue': {}
,
'StringValue': 'string'
}
},
]
},
'AssignSlaAction': {
'SlaAssignmentType': 'CASES',
'CaseSlaConfiguration': {
'Name': 'string',
'Type': 'CaseField',
'FieldId': 'string',
'TargetFieldValues': [
{
'BooleanValue': True|False,
'DoubleValue': 123.0,
'EmptyValue': {}
,
'StringValue': 'string'
},
],
'TargetSlaMinutes': 123
}
},
'EndAssociatedTasksAction': {}
,
'SubmitAutoEvaluationAction': {
'EvaluationFormId': 'string'
},
'ExtractInformationAction': {
'RulesExtractionDefinitions': [
{
'Identifier': 'string'
},
]
}
},
],
PublishStatus='DRAFT'|'PUBLISHED',
ClientToken='string'
)
string
[REQUIRED]
The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
A unique name for the rule.
dict
[REQUIRED]
The event source to trigger the rule.
EventSourceName (string) -- [REQUIRED]
The name of the event source.
IntegrationAssociationId (string) --
The identifier for the integration association.
string
[REQUIRED]
The conditions of the rule.
list
[REQUIRED]
A list of actions to be run when the rule is triggered.
(dict) --
Information about the action to be performed when a rule is triggered.
ActionType (string) -- [REQUIRED]
The type of action that creates a rule.
TaskAction (dict) --
Information about the task action. This field is required if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate
Name (string) -- [REQUIRED]
The name. Supports variable injection. For more information, see JSONPath reference in the Connect Customer Administrators Guide.
Description (string) --
The description. Supports variable injection. For more information, see JSONPath reference in the Connect Customer Administrators Guide.
ContactFlowId (string) -- [REQUIRED]
The identifier of the flow.
References (dict) --
Information about the reference when the referenceType is URL. Otherwise, null. (Supports variable injection in the Value field.)
(string) --
(dict) --
Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.
Value (string) --
A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).
Type (string) -- [REQUIRED]
The type of the reference. DATE must be of type Epoch timestamp.
Status (string) --
Status of the attachment reference type.
Arn (string) --
The Amazon Resource Name (ARN) of the reference
StatusReason (string) --
Relevant details why the reference was not successfully created.
EventBridgeAction (dict) --
Information about the EventBridge action.
Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate
Name (string) -- [REQUIRED]
The name.
AssignContactCategoryAction (dict) --
Information about the contact category action.
Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate
SendNotificationAction (dict) --
Information about the send notification action.
Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate
DeliveryMethod (string) -- [REQUIRED]
Notification delivery method.
Subject (string) --
The subject of the email if the delivery method is EMAIL. Supports variable injection. For more information, see JSONPath reference in the Connect Customer Administrators Guide.
Content (string) -- [REQUIRED]
Notification content. Supports variable injection. For more information, see JSONPath reference in the Connect Customer Administrators Guide.
ContentType (string) -- [REQUIRED]
Content type format.
Recipient (dict) -- [REQUIRED]
Notification recipient.
UserTags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. Connect Customer users with the specified tags will be notified.
(string) --
(string) --
UserIds (list) --
A list of user IDs. Supports variable injection of $.ContactLens.ContactEvaluation.Agent.AgentId for OnContactEvaluationSubmit event source.
(string) --
Exclusion (dict) --
Recipients to exclude from notification.
UserTags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. Connect Customer users with the specified tags will be notified.
(string) --
(string) --
UserIds (list) --
A list of user IDs. Supports variable injection of $.ContactLens.ContactEvaluation.Agent.AgentId for OnContactEvaluationSubmit event source.
(string) --
CreateCaseAction (dict) --
Information about the create case action.
Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnPostChatAnalysisAvailable.
Fields (list) -- [REQUIRED]
An array of objects with Field ID and Value data.
(dict) --
Object for case field values.
Id (string) -- [REQUIRED]
Unique identifier of a field.
Value (dict) -- [REQUIRED]
Union of potential field value types.
BooleanValue (boolean) --
A Boolean number value type.
DoubleValue (float) --
A Double number value type.
EmptyValue (dict) --
An empty value.
StringValue (string) --
String value type.
TemplateId (string) -- [REQUIRED]
A unique identifier of a template.
UpdateCaseAction (dict) --
Information about the update case action.
Supported only for TriggerEventSource values: OnCaseCreate | OnCaseUpdate.
Fields (list) -- [REQUIRED]
An array of objects with Field ID and Value data.
(dict) --
Object for case field values.
Id (string) -- [REQUIRED]
Unique identifier of a field.
Value (dict) -- [REQUIRED]
Union of potential field value types.
BooleanValue (boolean) --
A Boolean number value type.
DoubleValue (float) --
A Double number value type.
EmptyValue (dict) --
An empty value.
StringValue (string) --
String value type.
AssignSlaAction (dict) --
Information about the assign SLA action.
SlaAssignmentType (string) -- [REQUIRED]
Type of SLA assignment.
CaseSlaConfiguration (dict) --
The SLA configuration for Case SLA Assignment.
Name (string) -- [REQUIRED]
Name of an SLA.
Type (string) -- [REQUIRED]
Type of SLA for Case SlaAssignmentType.
FieldId (string) --
Unique identifier of a Case field.
TargetFieldValues (list) --
Represents a list of target field values for the fieldId specified in CaseSlaConfiguration. The SLA is considered met if any one of these target field values matches the actual field value.
(dict) --
Object to store union of Field values.
BooleanValue (boolean) --
A Boolean number value type.
DoubleValue (float) --
A Double number value type.
EmptyValue (dict) --
An empty value.
StringValue (string) --
String value type.
TargetSlaMinutes (integer) -- [REQUIRED]
Target duration in minutes within which an SLA should be completed.
EndAssociatedTasksAction (dict) --
Information about the end associated tasks action.
Supported only for TriggerEventSource values: OnCaseUpdate.
SubmitAutoEvaluationAction (dict) --
Information about the submit automated evaluation action.
EvaluationFormId (string) -- [REQUIRED]
The identifier of the auto-evaluation enabled form.
ExtractInformationAction (dict) --
Information about the extract information action.
RulesExtractionDefinitions (list) -- [REQUIRED]
The list of extraction definition identifiers that specify what data to extract.
(dict) --
An identifier that references an extraction definition resource.
Identifier (string) -- [REQUIRED]
The identifier of the extraction definition.
string
[REQUIRED]
The publish status of the rule.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
This field is autopopulated if not provided.
dict
Response Syntax
{
'RuleArn': 'string',
'RuleId': 'string'
}
Response Structure
(dict) --
RuleArn (string) --
The Amazon Resource Name (ARN) of the rule.
RuleId (string) --
A unique identifier for the rule.
{'Rule': {'Actions': {'ActionType': {'EXTRACT_INFORMATION'},
'ExtractInformationAction': {'RulesExtractionDefinitions': [{'Identifier': 'string'}]}},
'TriggerEventSource': {'EventSourceName': {'OnAfterCallWorkAvailable',
'OnAfterChatWorkAvailable'}}}}
Describes a rule for the specified Connect Customer instance.
See also: AWS API Documentation
Request Syntax
client.describe_rule(
InstanceId='string',
RuleId='string'
)
string
[REQUIRED]
The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
A unique identifier for the rule.
dict
Response Syntax
{
'Rule': {
'Name': 'string',
'RuleId': 'string',
'RuleArn': 'string',
'TriggerEventSource': {
'EventSourceName': 'OnPostCallAnalysisAvailable'|'OnRealTimeCallAnalysisAvailable'|'OnRealTimeChatAnalysisAvailable'|'OnPostChatAnalysisAvailable'|'OnAfterCallWorkAvailable'|'OnAfterChatWorkAvailable'|'OnEmailAnalysisAvailable'|'OnZendeskTicketCreate'|'OnZendeskTicketStatusUpdate'|'OnSalesforceCaseCreate'|'OnContactEvaluationSubmit'|'OnMetricDataUpdate'|'OnCaseCreate'|'OnCaseUpdate'|'OnSlaBreach'|'OnAlertUpdate'|'OnSchedulePublish'|'OnScheduleUpdate'|'OnScheduleTimeOffRequestActivity',
'IntegrationAssociationId': 'string'
},
'RuleCapabilityTiers': [
'GenerativeAI',
],
'Function': 'string',
'Actions': [
{
'ActionType': 'CREATE_TASK'|'ASSIGN_CONTACT_CATEGORY'|'GENERATE_EVENTBRIDGE_EVENT'|'SEND_NOTIFICATION'|'CREATE_CASE'|'UPDATE_CASE'|'ASSIGN_SLA'|'END_ASSOCIATED_TASKS'|'SUBMIT_AUTO_EVALUATION'|'EXTRACT_INFORMATION',
'TaskAction': {
'Name': 'string',
'Description': 'string',
'ContactFlowId': 'string',
'References': {
'string': {
'Value': 'string',
'Type': 'URL'|'ATTACHMENT'|'CONTACT_ANALYSIS'|'NUMBER'|'STRING'|'DATE'|'EMAIL'|'EMAIL_MESSAGE'|'EMAIL_MESSAGE_PLAIN_TEXT'|'EMAIL_MESSAGE_PLAIN_TEXT_REDACTED'|'EMAIL_MESSAGE_REDACTED',
'Status': 'AVAILABLE'|'DELETED'|'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED',
'Arn': 'string',
'StatusReason': 'string'
}
}
},
'EventBridgeAction': {
'Name': 'string'
},
'AssignContactCategoryAction': {},
'SendNotificationAction': {
'DeliveryMethod': 'EMAIL',
'Subject': 'string',
'Content': 'string',
'ContentType': 'PLAIN_TEXT',
'Recipient': {
'UserTags': {
'string': 'string'
},
'UserIds': [
'string',
]
},
'Exclusion': {
'UserTags': {
'string': 'string'
},
'UserIds': [
'string',
]
}
},
'CreateCaseAction': {
'Fields': [
{
'Id': 'string',
'Value': {
'BooleanValue': True|False,
'DoubleValue': 123.0,
'EmptyValue': {},
'StringValue': 'string'
}
},
],
'TemplateId': 'string'
},
'UpdateCaseAction': {
'Fields': [
{
'Id': 'string',
'Value': {
'BooleanValue': True|False,
'DoubleValue': 123.0,
'EmptyValue': {},
'StringValue': 'string'
}
},
]
},
'AssignSlaAction': {
'SlaAssignmentType': 'CASES',
'CaseSlaConfiguration': {
'Name': 'string',
'Type': 'CaseField',
'FieldId': 'string',
'TargetFieldValues': [
{
'BooleanValue': True|False,
'DoubleValue': 123.0,
'EmptyValue': {},
'StringValue': 'string'
},
],
'TargetSlaMinutes': 123
}
},
'EndAssociatedTasksAction': {},
'SubmitAutoEvaluationAction': {
'EvaluationFormId': 'string'
},
'ExtractInformationAction': {
'RulesExtractionDefinitions': [
{
'Identifier': 'string'
},
]
}
},
],
'PublishStatus': 'DRAFT'|'PUBLISHED',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'LastUpdatedBy': 'string',
'Tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
Rule (dict) --
Information about the rule.
Name (string) --
The name of the rule.
RuleId (string) --
A unique identifier for the rule.
RuleArn (string) --
The Amazon Resource Name (ARN) of the rule.
TriggerEventSource (dict) --
The event source to trigger the rule.
EventSourceName (string) --
The name of the event source.
IntegrationAssociationId (string) --
The identifier for the integration association.
RuleCapabilityTiers (list) --
The list of capability tiers associated with the rule. Used for categorizing rules by capability (for example, GenerativeAI).
(string) --
Function (string) --
The conditions of the rule.
Actions (list) --
A list of actions to be run when the rule is triggered.
(dict) --
Information about the action to be performed when a rule is triggered.
ActionType (string) --
The type of action that creates a rule.
TaskAction (dict) --
Information about the task action. This field is required if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate
Name (string) --
The name. Supports variable injection. For more information, see JSONPath reference in the Connect Customer Administrators Guide.
Description (string) --
The description. Supports variable injection. For more information, see JSONPath reference in the Connect Customer Administrators Guide.
ContactFlowId (string) --
The identifier of the flow.
References (dict) --
Information about the reference when the referenceType is URL. Otherwise, null. (Supports variable injection in the Value field.)
(string) --
(dict) --
Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.
Value (string) --
A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).
Type (string) --
The type of the reference. DATE must be of type Epoch timestamp.
Status (string) --
Status of the attachment reference type.
Arn (string) --
The Amazon Resource Name (ARN) of the reference
StatusReason (string) --
Relevant details why the reference was not successfully created.
EventBridgeAction (dict) --
Information about the EventBridge action.
Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate
Name (string) --
The name.
AssignContactCategoryAction (dict) --
Information about the contact category action.
Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate
SendNotificationAction (dict) --
Information about the send notification action.
Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate
DeliveryMethod (string) --
Notification delivery method.
Subject (string) --
The subject of the email if the delivery method is EMAIL. Supports variable injection. For more information, see JSONPath reference in the Connect Customer Administrators Guide.
Content (string) --
Notification content. Supports variable injection. For more information, see JSONPath reference in the Connect Customer Administrators Guide.
ContentType (string) --
Content type format.
Recipient (dict) --
Notification recipient.
UserTags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. Connect Customer users with the specified tags will be notified.
(string) --
(string) --
UserIds (list) --
A list of user IDs. Supports variable injection of $.ContactLens.ContactEvaluation.Agent.AgentId for OnContactEvaluationSubmit event source.
(string) --
Exclusion (dict) --
Recipients to exclude from notification.
UserTags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. Connect Customer users with the specified tags will be notified.
(string) --
(string) --
UserIds (list) --
A list of user IDs. Supports variable injection of $.ContactLens.ContactEvaluation.Agent.AgentId for OnContactEvaluationSubmit event source.
(string) --
CreateCaseAction (dict) --
Information about the create case action.
Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnPostChatAnalysisAvailable.
Fields (list) --
An array of objects with Field ID and Value data.
(dict) --
Object for case field values.
Id (string) --
Unique identifier of a field.
Value (dict) --
Union of potential field value types.
BooleanValue (boolean) --
A Boolean number value type.
DoubleValue (float) --
A Double number value type.
EmptyValue (dict) --
An empty value.
StringValue (string) --
String value type.
TemplateId (string) --
A unique identifier of a template.
UpdateCaseAction (dict) --
Information about the update case action.
Supported only for TriggerEventSource values: OnCaseCreate | OnCaseUpdate.
Fields (list) --
An array of objects with Field ID and Value data.
(dict) --
Object for case field values.
Id (string) --
Unique identifier of a field.
Value (dict) --
Union of potential field value types.
BooleanValue (boolean) --
A Boolean number value type.
DoubleValue (float) --
A Double number value type.
EmptyValue (dict) --
An empty value.
StringValue (string) --
String value type.
AssignSlaAction (dict) --
Information about the assign SLA action.
SlaAssignmentType (string) --
Type of SLA assignment.
CaseSlaConfiguration (dict) --
The SLA configuration for Case SLA Assignment.
Name (string) --
Name of an SLA.
Type (string) --
Type of SLA for Case SlaAssignmentType.
FieldId (string) --
Unique identifier of a Case field.
TargetFieldValues (list) --
Represents a list of target field values for the fieldId specified in CaseSlaConfiguration. The SLA is considered met if any one of these target field values matches the actual field value.
(dict) --
Object to store union of Field values.
BooleanValue (boolean) --
A Boolean number value type.
DoubleValue (float) --
A Double number value type.
EmptyValue (dict) --
An empty value.
StringValue (string) --
String value type.
TargetSlaMinutes (integer) --
Target duration in minutes within which an SLA should be completed.
EndAssociatedTasksAction (dict) --
Information about the end associated tasks action.
Supported only for TriggerEventSource values: OnCaseUpdate.
SubmitAutoEvaluationAction (dict) --
Information about the submit automated evaluation action.
EvaluationFormId (string) --
The identifier of the auto-evaluation enabled form.
ExtractInformationAction (dict) --
Information about the extract information action.
RulesExtractionDefinitions (list) --
The list of extraction definition identifiers that specify what data to extract.
(dict) --
An identifier that references an extraction definition resource.
Identifier (string) --
The identifier of the extraction definition.
PublishStatus (string) --
The publish status of the rule.
CreatedTime (datetime) --
The timestamp for when the rule was created.
LastUpdatedTime (datetime) --
The timestamp for the when the rule was last updated.
LastUpdatedBy (string) --
The Amazon Resource Name (ARN) of the user who last updated the rule.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
{'EventSourceName': {'OnAfterChatWorkAvailable', 'OnAfterCallWorkAvailable'}}
Response {'RuleSummaryList': {'ActionSummaries': {'ActionType': {'EXTRACT_INFORMATION'}},
'EventSourceName': {'OnAfterCallWorkAvailable',
'OnAfterChatWorkAvailable'}}}
List all rules for the specified Connect Customer instance.
See also: AWS API Documentation
Request Syntax
client.list_rules(
InstanceId='string',
PublishStatus='DRAFT'|'PUBLISHED',
EventSourceName='OnPostCallAnalysisAvailable'|'OnRealTimeCallAnalysisAvailable'|'OnRealTimeChatAnalysisAvailable'|'OnPostChatAnalysisAvailable'|'OnAfterCallWorkAvailable'|'OnAfterChatWorkAvailable'|'OnEmailAnalysisAvailable'|'OnZendeskTicketCreate'|'OnZendeskTicketStatusUpdate'|'OnSalesforceCaseCreate'|'OnContactEvaluationSubmit'|'OnMetricDataUpdate'|'OnCaseCreate'|'OnCaseUpdate'|'OnSlaBreach'|'OnAlertUpdate'|'OnSchedulePublish'|'OnScheduleUpdate'|'OnScheduleTimeOffRequestActivity',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
The publish status of the rule.
string
The name of the event source.
integer
The maximum number of results to return per page.
string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
dict
Response Syntax
{
'RuleSummaryList': [
{
'Name': 'string',
'RuleId': 'string',
'RuleArn': 'string',
'EventSourceName': 'OnPostCallAnalysisAvailable'|'OnRealTimeCallAnalysisAvailable'|'OnRealTimeChatAnalysisAvailable'|'OnPostChatAnalysisAvailable'|'OnAfterCallWorkAvailable'|'OnAfterChatWorkAvailable'|'OnEmailAnalysisAvailable'|'OnZendeskTicketCreate'|'OnZendeskTicketStatusUpdate'|'OnSalesforceCaseCreate'|'OnContactEvaluationSubmit'|'OnMetricDataUpdate'|'OnCaseCreate'|'OnCaseUpdate'|'OnSlaBreach'|'OnAlertUpdate'|'OnSchedulePublish'|'OnScheduleUpdate'|'OnScheduleTimeOffRequestActivity',
'PublishStatus': 'DRAFT'|'PUBLISHED',
'RuleCapabilityTiers': [
'GenerativeAI',
],
'ActionSummaries': [
{
'ActionType': 'CREATE_TASK'|'ASSIGN_CONTACT_CATEGORY'|'GENERATE_EVENTBRIDGE_EVENT'|'SEND_NOTIFICATION'|'CREATE_CASE'|'UPDATE_CASE'|'ASSIGN_SLA'|'END_ASSOCIATED_TASKS'|'SUBMIT_AUTO_EVALUATION'|'EXTRACT_INFORMATION'
},
],
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
RuleSummaryList (list) --
Summary information about a rule.
(dict) --
A list of ActionTypes associated with a rule.
Name (string) --
The name of the rule.
RuleId (string) --
A unique identifier for the rule.
RuleArn (string) --
The Amazon Resource Name (ARN) of the rule.
EventSourceName (string) --
The name of the event source.
PublishStatus (string) --
The publish status of the rule.
RuleCapabilityTiers (list) --
The list of capability tiers associated with the rule. Used for categorizing rules by capability (for example, GenerativeAI).
(string) --
ActionSummaries (list) --
A list of ActionTypes associated with a rule.
(dict) --
Information about an action.
ActionType (string) --
The action type.
CreatedTime (datetime) --
The timestamp for when the rule was created.
LastUpdatedTime (datetime) --
The timestamp for when the rule was last updated.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
{'Rules': {'ActionSummaries': {'ActionType': {'EXTRACT_INFORMATION'}},
'TriggerEventSource': {'EventSourceName': {'OnAfterCallWorkAvailable',
'OnAfterChatWorkAvailable'}}}}
Searches rules in an Connect Customer instance, with optional filtering.
See also: AWS API Documentation
Request Syntax
client.search_rules(
InstanceId='string',
MaxResults=123,
NextToken='string',
SearchCriteria={
'OrConditions': [
{'... recursive ...'},
],
'AndConditions': [
{'... recursive ...'},
],
'StringCondition': {
'FieldName': 'string',
'Value': 'string',
'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT'
}
},
SearchFilter={
'AttributeFilter': {
'OrConditions': [
{
'TagConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
]
},
],
'AndCondition': {
'TagConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
]
},
'TagCondition': {
'TagKey': 'string',
'TagValue': 'string'
}
}
}
)
string
[REQUIRED]
The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
integer
The maximum number of results to return per page.
string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
dict
The search criteria to be used to return rules.
OrConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
The search criteria to be used to return rules.
AndConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
The search criteria to be used to return rules.
StringCondition (dict) --
A leaf node condition which can be used to specify a string condition.
FieldName (string) --
The name of the field in the string condition.
Value (string) --
The value of the string.
ComparisonType (string) --
The type of comparison to be made when evaluating the string condition.
dict
Filters to be applied to search results, such as tag-based filters.
AttributeFilter (dict) --
An object that can be used to specify tag conditions inside the SearchFilter.
OrConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an AND condition.
TagConditions (list) --
A list of tag conditions that need to be applied with AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
AndCondition (dict) --
A list of conditions which would be applied together with an AND condition.
TagConditions (list) --
A list of tag conditions that need to be applied with AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
TagCondition (dict) --
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
dict
Response Syntax
{
'Rules': [
{
'Name': 'string',
'RuleId': 'string',
'RuleArn': 'string',
'TriggerEventSource': {
'EventSourceName': 'OnPostCallAnalysisAvailable'|'OnRealTimeCallAnalysisAvailable'|'OnRealTimeChatAnalysisAvailable'|'OnPostChatAnalysisAvailable'|'OnAfterCallWorkAvailable'|'OnAfterChatWorkAvailable'|'OnEmailAnalysisAvailable'|'OnZendeskTicketCreate'|'OnZendeskTicketStatusUpdate'|'OnSalesforceCaseCreate'|'OnContactEvaluationSubmit'|'OnMetricDataUpdate'|'OnCaseCreate'|'OnCaseUpdate'|'OnSlaBreach'|'OnAlertUpdate'|'OnSchedulePublish'|'OnScheduleUpdate'|'OnScheduleTimeOffRequestActivity',
'IntegrationAssociationId': 'string'
},
'ActionSummaries': [
{
'ActionType': 'CREATE_TASK'|'ASSIGN_CONTACT_CATEGORY'|'GENERATE_EVENTBRIDGE_EVENT'|'SEND_NOTIFICATION'|'CREATE_CASE'|'UPDATE_CASE'|'ASSIGN_SLA'|'END_ASSOCIATED_TASKS'|'SUBMIT_AUTO_EVALUATION'|'EXTRACT_INFORMATION'
},
],
'RuleCapabilityTiers': [
'GenerativeAI',
],
'PublishStatus': 'DRAFT'|'PUBLISHED',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'LastUpdatedBy': 'string',
'Tags': {
'string': 'string'
}
},
],
'ApproximateTotalCount': 123,
'NextToken': 'string'
}
Response Structure
(dict) --
Rules (list) --
Information about the rules.
(dict) --
A summary of information about a rule, returned as part of the response to a SearchRules operation.
Name (string) --
The name of the rule.
RuleId (string) --
A unique identifier for the rule.
RuleArn (string) --
The Amazon Resource Name (ARN) of the rule.
TriggerEventSource (dict) --
The event source to trigger the rule.
EventSourceName (string) --
The name of the event source.
IntegrationAssociationId (string) --
The identifier for the integration association.
ActionSummaries (list) --
A list of ActionTypes associated with a rule.
(dict) --
Information about an action.
ActionType (string) --
The action type.
RuleCapabilityTiers (list) --
The list of capability tiers associated with the rule. Used for categorizing rules by capability (for example, GenerativeAI).
(string) --
PublishStatus (string) --
The publish status of the rule.
CreatedTime (datetime) --
The timestamp for when the rule was created.
LastUpdatedTime (datetime) --
The timestamp for when the rule was last updated.
LastUpdatedBy (string) --
The Amazon Resource Name (ARN) of the user who last updated the rule.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
ApproximateTotalCount (integer) --
The total number of rules which matched your search query.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
{'Actions': {'ActionType': {'EXTRACT_INFORMATION'},
'ExtractInformationAction': {'RulesExtractionDefinitions': [{'Identifier': 'string'}]}}}
Updates a rule for the specified Connect Customer instance.
Use the Rules Function language to code conditions for the rule.
See also: AWS API Documentation
Request Syntax
client.update_rule(
RuleId='string',
InstanceId='string',
Name='string',
Function='string',
Actions=[
{
'ActionType': 'CREATE_TASK'|'ASSIGN_CONTACT_CATEGORY'|'GENERATE_EVENTBRIDGE_EVENT'|'SEND_NOTIFICATION'|'CREATE_CASE'|'UPDATE_CASE'|'ASSIGN_SLA'|'END_ASSOCIATED_TASKS'|'SUBMIT_AUTO_EVALUATION'|'EXTRACT_INFORMATION',
'TaskAction': {
'Name': 'string',
'Description': 'string',
'ContactFlowId': 'string',
'References': {
'string': {
'Value': 'string',
'Type': 'URL'|'ATTACHMENT'|'CONTACT_ANALYSIS'|'NUMBER'|'STRING'|'DATE'|'EMAIL'|'EMAIL_MESSAGE'|'EMAIL_MESSAGE_PLAIN_TEXT'|'EMAIL_MESSAGE_PLAIN_TEXT_REDACTED'|'EMAIL_MESSAGE_REDACTED',
'Status': 'AVAILABLE'|'DELETED'|'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED',
'Arn': 'string',
'StatusReason': 'string'
}
}
},
'EventBridgeAction': {
'Name': 'string'
},
'AssignContactCategoryAction': {}
,
'SendNotificationAction': {
'DeliveryMethod': 'EMAIL',
'Subject': 'string',
'Content': 'string',
'ContentType': 'PLAIN_TEXT',
'Recipient': {
'UserTags': {
'string': 'string'
},
'UserIds': [
'string',
]
},
'Exclusion': {
'UserTags': {
'string': 'string'
},
'UserIds': [
'string',
]
}
},
'CreateCaseAction': {
'Fields': [
{
'Id': 'string',
'Value': {
'BooleanValue': True|False,
'DoubleValue': 123.0,
'EmptyValue': {}
,
'StringValue': 'string'
}
},
],
'TemplateId': 'string'
},
'UpdateCaseAction': {
'Fields': [
{
'Id': 'string',
'Value': {
'BooleanValue': True|False,
'DoubleValue': 123.0,
'EmptyValue': {}
,
'StringValue': 'string'
}
},
]
},
'AssignSlaAction': {
'SlaAssignmentType': 'CASES',
'CaseSlaConfiguration': {
'Name': 'string',
'Type': 'CaseField',
'FieldId': 'string',
'TargetFieldValues': [
{
'BooleanValue': True|False,
'DoubleValue': 123.0,
'EmptyValue': {}
,
'StringValue': 'string'
},
],
'TargetSlaMinutes': 123
}
},
'EndAssociatedTasksAction': {}
,
'SubmitAutoEvaluationAction': {
'EvaluationFormId': 'string'
},
'ExtractInformationAction': {
'RulesExtractionDefinitions': [
{
'Identifier': 'string'
},
]
}
},
],
PublishStatus='DRAFT'|'PUBLISHED'
)
string
[REQUIRED]
A unique identifier for the rule.
string
[REQUIRED]
The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
The name of the rule. You can change the name only if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate
string
[REQUIRED]
The conditions of the rule.
list
[REQUIRED]
A list of actions to be run when the rule is triggered.
(dict) --
Information about the action to be performed when a rule is triggered.
ActionType (string) -- [REQUIRED]
The type of action that creates a rule.
TaskAction (dict) --
Information about the task action. This field is required if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate
Name (string) -- [REQUIRED]
The name. Supports variable injection. For more information, see JSONPath reference in the Connect Customer Administrators Guide.
Description (string) --
The description. Supports variable injection. For more information, see JSONPath reference in the Connect Customer Administrators Guide.
ContactFlowId (string) -- [REQUIRED]
The identifier of the flow.
References (dict) --
Information about the reference when the referenceType is URL. Otherwise, null. (Supports variable injection in the Value field.)
(string) --
(dict) --
Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.
Value (string) --
A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).
Type (string) -- [REQUIRED]
The type of the reference. DATE must be of type Epoch timestamp.
Status (string) --
Status of the attachment reference type.
Arn (string) --
The Amazon Resource Name (ARN) of the reference
StatusReason (string) --
Relevant details why the reference was not successfully created.
EventBridgeAction (dict) --
Information about the EventBridge action.
Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate
Name (string) -- [REQUIRED]
The name.
AssignContactCategoryAction (dict) --
Information about the contact category action.
Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate
SendNotificationAction (dict) --
Information about the send notification action.
Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate
DeliveryMethod (string) -- [REQUIRED]
Notification delivery method.
Subject (string) --
The subject of the email if the delivery method is EMAIL. Supports variable injection. For more information, see JSONPath reference in the Connect Customer Administrators Guide.
Content (string) -- [REQUIRED]
Notification content. Supports variable injection. For more information, see JSONPath reference in the Connect Customer Administrators Guide.
ContentType (string) -- [REQUIRED]
Content type format.
Recipient (dict) -- [REQUIRED]
Notification recipient.
UserTags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. Connect Customer users with the specified tags will be notified.
(string) --
(string) --
UserIds (list) --
A list of user IDs. Supports variable injection of $.ContactLens.ContactEvaluation.Agent.AgentId for OnContactEvaluationSubmit event source.
(string) --
Exclusion (dict) --
Recipients to exclude from notification.
UserTags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. Connect Customer users with the specified tags will be notified.
(string) --
(string) --
UserIds (list) --
A list of user IDs. Supports variable injection of $.ContactLens.ContactEvaluation.Agent.AgentId for OnContactEvaluationSubmit event source.
(string) --
CreateCaseAction (dict) --
Information about the create case action.
Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnPostChatAnalysisAvailable.
Fields (list) -- [REQUIRED]
An array of objects with Field ID and Value data.
(dict) --
Object for case field values.
Id (string) -- [REQUIRED]
Unique identifier of a field.
Value (dict) -- [REQUIRED]
Union of potential field value types.
BooleanValue (boolean) --
A Boolean number value type.
DoubleValue (float) --
A Double number value type.
EmptyValue (dict) --
An empty value.
StringValue (string) --
String value type.
TemplateId (string) -- [REQUIRED]
A unique identifier of a template.
UpdateCaseAction (dict) --
Information about the update case action.
Supported only for TriggerEventSource values: OnCaseCreate | OnCaseUpdate.
Fields (list) -- [REQUIRED]
An array of objects with Field ID and Value data.
(dict) --
Object for case field values.
Id (string) -- [REQUIRED]
Unique identifier of a field.
Value (dict) -- [REQUIRED]
Union of potential field value types.
BooleanValue (boolean) --
A Boolean number value type.
DoubleValue (float) --
A Double number value type.
EmptyValue (dict) --
An empty value.
StringValue (string) --
String value type.
AssignSlaAction (dict) --
Information about the assign SLA action.
SlaAssignmentType (string) -- [REQUIRED]
Type of SLA assignment.
CaseSlaConfiguration (dict) --
The SLA configuration for Case SLA Assignment.
Name (string) -- [REQUIRED]
Name of an SLA.
Type (string) -- [REQUIRED]
Type of SLA for Case SlaAssignmentType.
FieldId (string) --
Unique identifier of a Case field.
TargetFieldValues (list) --
Represents a list of target field values for the fieldId specified in CaseSlaConfiguration. The SLA is considered met if any one of these target field values matches the actual field value.
(dict) --
Object to store union of Field values.
BooleanValue (boolean) --
A Boolean number value type.
DoubleValue (float) --
A Double number value type.
EmptyValue (dict) --
An empty value.
StringValue (string) --
String value type.
TargetSlaMinutes (integer) -- [REQUIRED]
Target duration in minutes within which an SLA should be completed.
EndAssociatedTasksAction (dict) --
Information about the end associated tasks action.
Supported only for TriggerEventSource values: OnCaseUpdate.
SubmitAutoEvaluationAction (dict) --
Information about the submit automated evaluation action.
EvaluationFormId (string) -- [REQUIRED]
The identifier of the auto-evaluation enabled form.
ExtractInformationAction (dict) --
Information about the extract information action.
RulesExtractionDefinitions (list) -- [REQUIRED]
The list of extraction definition identifiers that specify what data to extract.
(dict) --
An identifier that references an extraction definition resource.
Identifier (string) -- [REQUIRED]
The identifier of the extraction definition.
string
[REQUIRED]
The publish status of the rule.
None