2026/10/26 - Amazon Connect Service - 1 new 10 updated api methods
Changes Amazon Connect now automatically saves agents' in-progress email drafts preserving the message, recipients, and subject during browser or network interruptions so agents can return to the mail and continue instead of starting over.
Updates the draft outbound email message for a contact. Use this operation to save changes to an in-progress outbound email reply before you send it. This operation applies only to contacts with an OUTBOUND or AGENT_REPLY initiation method; it isn't supported for flow-initiated emails.
See also: AWS API Documentation
Request Syntax
client.update_outbound_email_contact_message(
InstanceId='string',
ContactId='string',
EmailMessage={
'MessageSourceType': 'RAW',
'RawMessage': {
'Body': 'string',
'ContentType': '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 contact in this instance of Connect Customer.
dict
[REQUIRED]
The email message body to update on the outbound email draft.
MessageSourceType (string) -- [REQUIRED]
The message source type. The only supported value is RAW.
RawMessage (dict) -- [REQUIRED]
The raw email body content.
Body (string) -- [REQUIRED]
The email message body.
ContentType (string) -- [REQUIRED]
The content type of the email body. Valid values:
text/plain – Plain text content.
text/html – HTML-formatted content.
dict
Response Syntax
{
'ContactId': 'string'
}
Response Structure
(dict) --
ContactId (string) --
The identifier of the contact in this instance of Connect Customer.
{'References': {'Status': {'DRAFTING'}}}
Creates a new VOICE, EMAIL, or TASK contact.
After a contact is created, you can move it to the desired state by using the InitiateAs parameter. While you can use API to create task contacts that are in the COMPLETED state, you must contact Amazon Web Services Support before using it for bulk import use cases. Bulk import causes your requests to be throttled or fail if your CreateContact limits aren't high enough.
See also: AWS API Documentation
Request Syntax
client.create_contact(
InstanceId='string',
ClientToken='string',
RelatedContactId='string',
Attributes={
'string': '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'|'DRAFTING',
'Arn': 'string',
'StatusReason': 'string'
}
},
Channel='VOICE'|'CHAT'|'TASK'|'EMAIL',
InitiationMethod='INBOUND'|'OUTBOUND'|'TRANSFER'|'QUEUE_TRANSFER'|'CALLBACK'|'API'|'DISCONNECT'|'MONITOR'|'EXTERNAL_OUTBOUND'|'WEBRTC_API'|'AGENT_REPLY'|'FLOW',
ExpiryDurationInMinutes=123,
UserInfo={
'UserId': 'string'
},
InitiateAs='CONNECTED_TO_USER'|'COMPLETED',
Name='string',
Description='string',
SegmentAttributes={
'string': {
'ValueString': 'string',
'ValueMap': {
'string': {'... recursive ...'}
},
'ValueInteger': 123,
'ValueList': [
{'... recursive ...'},
],
'ValueArn': 'string'
}
},
PreviousContactId='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
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.
string
The identifier of the contact in this instance of Connect Customer.
dict
A custom key-value pair using an attribute map. The attributes are standard Connect Customer attributes, and can be accessed in flows just like any other contact attributes.
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
(string) --
(string) --
dict
A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL | ATTACHMENT.
(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.
string
[REQUIRED]
The channel for the contact.
string
[REQUIRED]
Indicates how the contact was initiated.
integer
Number of minutes the contact will be active for before expiring
dict
User details for the contact
UserId (string) --
The user identifier for the contact.
string
Initial state of the contact when it's created. Only TASK channel contacts can be initiated with COMPLETED state.
string
The name of a the contact.
string
A description of the contact.
dict
A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Connect Customer attributes. They can be accessed in flows.
Attribute keys can include only alphanumeric, -, and _.
This field can be used to set Segment Contact Expiry as a duration in minutes.
(string) --
(dict) --
A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
ValueString (string) --
The value of a segment attribute.
ValueMap (dict) --
The value of a segment attribute.
(string) --
(dict) --
A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
ValueInteger (integer) --
The value of a segment attribute.
ValueList (list) --
The value of a segment attribute. This is only supported for system-defined attributes, not for user-defined attributes.
(dict) --
A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
ValueArn (string) --
The value of a segment attribute that has to be a valid ARN. This is only supported for system-defined attributes, not for user-defined attributes.
string
The ID of the previous contact when creating a transfer contact. This value can be provided only for external audio contacts. For more information, see Integrate Connect Customer Contact Lens with external voice systems in the Connect Customer Administrator Guide.
dict
Response Syntax
{
'ContactId': 'string',
'ContactArn': 'string'
}
Response Structure
(dict) --
ContactId (string) --
The identifier of the contact in this instance of Connect Customer.
ContactArn (string) --
The Amazon Resource Name (ARN) of the created contact.
{'Actions': {'TaskAction': {'References': {'Status': {'DRAFTING'}}}}}
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'|'SEND_IN_APP_NOTIFICATION',
'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'|'DRAFTING',
'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'
},
]
},
'SendInAppNotificationAction': {
'Content': {
'string': 'string'
},
'Recipient': {
'UserTags': {
'string': 'string'
},
'UserIds': [
'string',
]
},
'Exclusion': {
'UserTags': {
'string': 'string'
},
'UserIds': [
'string',
]
},
'Priority': 'HIGH'|'LOW'
}
},
],
PublishStatus='DRAFT'|'PUBLISHED',
PreEvaluationFilters={
'AndConditions': [
{
'ResourceType': 'CONTACT',
'FilterType': 'TAG',
'FilterKey': 'string',
'FilterValue': 'string',
'Operator': 'EQUALS'
},
]
},
ClientToken='string',
Tags={
'string': '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.
SendInAppNotificationAction (dict) --
Information about the send in-app notification action.
Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnAfterCallWorkAvailable | OnAfterChatWorkAvailable | OnEmailAnalysisAvailable | OnContactEvaluationSubmit | OnCaseCreate | OnCaseUpdate | OnSlaBreach | OnSchedulePublish | OnScheduleUpdate | OnScheduleTimeOffRequestActivity
Content (dict) -- [REQUIRED]
Notification content. Supports variable injection. For more information, see JSONPath reference in the Connect Customer Administrators Guide.
(string) --
The locale code for localized content. Supported values include en_US, de_DE, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, and zh_TW.
(string) --
A localized string value. Maximum length is 500 visible characters. In a markdown link of the form [label](url), only the label counts toward the limit.
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) --
Priority (string) --
Notification priority.
string
[REQUIRED]
The publish status of the rule.
dict
The pre-evaluation filters for the rule, that restrict the rule to be applied to only certain resources based on the resource's attributes, such as tags assigned to a contact. The pre-evaluation filters are applied even before rule conditions are evaluated and are used to enforce tag-based-access-control while applying rules.
AndConditions (list) --
A list of conditions that the rule evaluates together using AND logic. All conditions must be met for the event to be evaluated by the rule.
(dict) --
A single pre-evaluation filter condition. Specifies a resource type, filter type, key, value, and operator to match against a resource attribute.
ResourceType (string) -- [REQUIRED]
The type of resource to filter on. Valid values: CONTACT.
FilterType (string) -- [REQUIRED]
The type of filter to apply. Valid values: TAG.
FilterKey (string) -- [REQUIRED]
The key of the attribute to filter on. For tag filters, this is the tag key.
FilterValue (string) -- [REQUIRED]
The value to match against. For tag filters, this is the tag value.
Operator (string) -- [REQUIRED]
The comparison operator for the filter condition. Valid values: EQUALS.
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
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
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': {'TaskAction': {'References': {'Status': {'DRAFTING'}}}}}}
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'|'SEND_IN_APP_NOTIFICATION',
'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'|'DRAFTING',
'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'
},
]
},
'SendInAppNotificationAction': {
'Content': {
'string': 'string'
},
'Recipient': {
'UserTags': {
'string': 'string'
},
'UserIds': [
'string',
]
},
'Exclusion': {
'UserTags': {
'string': 'string'
},
'UserIds': [
'string',
]
},
'Priority': 'HIGH'|'LOW'
}
},
],
'PublishStatus': 'DRAFT'|'PUBLISHED',
'PreEvaluationFilters': {
'AndConditions': [
{
'ResourceType': 'CONTACT',
'FilterType': 'TAG',
'FilterKey': 'string',
'FilterValue': 'string',
'Operator': 'EQUALS'
},
]
},
'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.
SendInAppNotificationAction (dict) --
Information about the send in-app notification action.
Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnAfterCallWorkAvailable | OnAfterChatWorkAvailable | OnEmailAnalysisAvailable | OnContactEvaluationSubmit | OnCaseCreate | OnCaseUpdate | OnSlaBreach | OnSchedulePublish | OnScheduleUpdate | OnScheduleTimeOffRequestActivity
Content (dict) --
Notification content. Supports variable injection. For more information, see JSONPath reference in the Connect Customer Administrators Guide.
(string) --
The locale code for localized content. Supported values include en_US, de_DE, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, and zh_TW.
(string) --
A localized string value. Maximum length is 500 visible characters. In a markdown link of the form [label](url), only the label counts toward the limit.
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) --
Priority (string) --
Notification priority.
PublishStatus (string) --
The publish status of the rule.
PreEvaluationFilters (dict) --
The pre-evaluation filters for the rule, that restrict the rule to be applied to only certain resources based on the resource's attributes, such as tags assigned to a contact. The pre-evaluation filters are applied even before rule conditions are evaluated and are used to enforce tag-based-access-control while applying rules.
AndConditions (list) --
A list of conditions that the rule evaluates together using AND logic. All conditions must be met for the event to be evaluated by the rule.
(dict) --
A single pre-evaluation filter condition. Specifies a resource type, filter type, key, value, and operator to match against a resource attribute.
ResourceType (string) --
The type of resource to filter on. Valid values: CONTACT.
FilterType (string) --
The type of filter to apply. Valid values: TAG.
FilterKey (string) --
The key of the attribute to filter on. For tag filters, this is the tag key.
FilterValue (string) --
The value to match against. For tag filters, this is the tag value.
Operator (string) --
The comparison operator for the filter condition. Valid values: EQUALS.
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) --
{'ReferenceSummaryList': {'Attachment': {'Status': {'DRAFTING'}},
'ContactAnalysis': {'Status': {'DRAFTING'}}}}
This API is in preview release for Connect Customer and is subject to change.
For the specified referenceTypes, returns a list of references associated with the contact. References are links to documents that are related to a contact, such as emails, attachments, or URLs.
See also: AWS API Documentation
Request Syntax
client.list_contact_references(
InstanceId='string',
ContactId='string',
ReferenceTypes=[
'URL'|'ATTACHMENT'|'CONTACT_ANALYSIS'|'NUMBER'|'STRING'|'DATE'|'EMAIL'|'EMAIL_MESSAGE'|'EMAIL_MESSAGE_PLAIN_TEXT'|'EMAIL_MESSAGE_PLAIN_TEXT_REDACTED'|'EMAIL_MESSAGE_REDACTED',
],
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
[REQUIRED]
The identifier of the initial contact.
list
[REQUIRED]
The type of reference.
(string) --
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
{
'ReferenceSummaryList': [
{
'Url': {
'Name': 'string',
'Value': 'string'
},
'Attachment': {
'Name': 'string',
'Value': 'string',
'Status': 'AVAILABLE'|'DELETED'|'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED'|'DRAFTING',
'Arn': 'string'
},
'EmailMessage': {
'Name': 'string',
'Arn': 'string'
},
'EmailMessageRedacted': {
'Name': 'string',
'Arn': 'string'
},
'EmailMessagePlainText': {
'Name': 'string',
'Arn': 'string'
},
'EmailMessagePlainTextRedacted': {
'Name': 'string',
'Arn': 'string'
},
'String': {
'Name': 'string',
'Value': 'string'
},
'Number': {
'Name': 'string',
'Value': 'string'
},
'Date': {
'Name': 'string',
'Value': 'string'
},
'Email': {
'Name': 'string',
'Value': 'string'
},
'ContactAnalysis': {
'Name': 'string',
'Value': 'string',
'Status': 'AVAILABLE'|'DELETED'|'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED'|'DRAFTING',
'Arn': 'string',
'AnalyticsMode': 'PostContact'|'RealTime'|'ContactLens'|'AutomatedInteraction',
'IsRedacted': True|False
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ReferenceSummaryList (list) --
Information about the flows.
(dict) --
Contains summary information about a reference. ReferenceSummary contains only one non null field between the URL and attachment based on the reference type.
Url (dict) --
Information about the reference when the referenceType is URL. Otherwise, null.
Name (string) --
Identifier of the URL reference.
Value (string) --
A valid URL.
Attachment (dict) --
Information about the reference when the referenceType is ATTACHMENT. Otherwise, null.
Name (string) --
Identifier of the attachment reference.
Value (string) --
The location path of the attachment reference.
Status (string) --
Status of the attachment reference type.
Arn (string) --
The Amazon Resource Name (ARN) of the attachment reference.
EmailMessage (dict) --
Information about the reference when the referenceType is EMAIL_MESSAGE. Otherwise, null.
Name (string) --
The name of the email message reference
Arn (string) --
The Amazon Resource Name (ARN) of the email message reference
EmailMessageRedacted (dict) --
Information about the reference when the referenceType is EMAIL_MESSAGE. Otherwise, null.
Name (string) --
The name of the email message reference
Arn (string) --
The Amazon Resource Name (ARN) of the email message reference
EmailMessagePlainText (dict) --
Information about the reference when the referenceType is EMAIL_MESSAGE. Otherwise, null.
Name (string) --
The name of the email message reference
Arn (string) --
The Amazon Resource Name (ARN) of the email message reference
EmailMessagePlainTextRedacted (dict) --
Information about the reference when the referenceType is EMAIL_MESSAGE. Otherwise, null.
Name (string) --
The name of the email message reference
Arn (string) --
The Amazon Resource Name (ARN) of the email message reference
String (dict) --
Information about a reference when the referenceType is STRING. Otherwise, null.
Name (string) --
Identifier of the string reference.
Value (string) --
A valid string.
Number (dict) --
Information about a reference when the referenceType is NUMBER. Otherwise, null.
Name (string) --
Identifier of the number reference.
Value (string) --
A valid number.
Date (dict) --
Information about a reference when the referenceType is DATE. Otherwise, null.
Name (string) --
Identifier of the date reference.
Value (string) --
A valid date.
Email (dict) --
Information about a reference when the referenceType is EMAIL. Otherwise, null.
Name (string) --
Identifier of the email reference.
Value (string) --
A valid email address.
ContactAnalysis (dict) --
Information about a reference when the referenceType is CONTACT_ANALYSIS. Otherwise, null.
Name (string) --
Identifier of the contact analysis reference.
Value (string) --
The location path of the contact analysis reference.
Status (string) --
Status of the contact analysis reference type.
Arn (string) --
The Amazon Resource Name (ARN) of the contact analysis reference.
AnalyticsMode (string) --
The analytics mode of the contact analysis.
IsRedacted (boolean) --
Indicates whether sensitive data has been redacted from the contact analysis.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
{'References': {'Status': {'DRAFTING'}}}
Creates an inbound email contact and initiates a flow to start the email contact for the customer. Response of this API provides the ContactId of the email contact created.
See also: AWS API Documentation
Request Syntax
client.start_email_contact(
InstanceId='string',
FromEmailAddress={
'EmailAddress': 'string',
'DisplayName': 'string'
},
DestinationEmailAddress='string',
Description='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'|'DRAFTING',
'Arn': 'string',
'StatusReason': 'string'
}
},
Name='string',
EmailMessage={
'MessageSourceType': 'RAW',
'RawMessage': {
'Subject': 'string',
'Body': 'string',
'ContentType': 'string',
'Headers': {
'string': 'string'
}
}
},
AdditionalRecipients={
'ToAddresses': [
{
'EmailAddress': 'string',
'DisplayName': 'string'
},
],
'CcAddresses': [
{
'EmailAddress': 'string',
'DisplayName': 'string'
},
]
},
Attachments=[
{
'FileName': 'string',
'S3Url': 'string'
},
],
ContactFlowId='string',
RelatedContactId='string',
Attributes={
'string': 'string'
},
SegmentAttributes={
'string': {
'ValueString': 'string',
'ValueMap': {
'string': {'... recursive ...'}
},
'ValueInteger': 123,
'ValueList': [
{'... recursive ...'},
],
'ValueArn': 'string'
}
},
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.
dict
[REQUIRED]
The email address of the customer.
EmailAddress (string) -- [REQUIRED]
The email address, including the domain.
DisplayName (string) --
The display name of email address.
string
[REQUIRED]
The email address associated with the Connect Customer instance.
string
A description of the email contact.
dict
A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Emails can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE. EMAIL | EMAIL_MESSAGE | ATTACHMENT are not a supported reference type during email creation.
(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.
string
The name of a email that is shown to an agent in the Contact Control Panel (CCP).
dict
[REQUIRED]
The email message body to be sent to the newly created email.
MessageSourceType (string) -- [REQUIRED]
The message source type, that is, RAW.
RawMessage (dict) --
The raw email body content.
Subject (string) -- [REQUIRED]
The email subject.
Body (string) -- [REQUIRED]
The email message body.
ContentType (string) -- [REQUIRED]
Type of content, that is, text/plain or text/html.
Headers (dict) --
Headers present in inbound email.
(string) --
(string) --
dict
The additional recipients address of the email.
ToAddresses (list) --
The additional recipients information present in to list. You must have 1 required recipient ( DestinationEmailAddress). You can then specify up to 49 additional recipients (across ToAddresses and CcAddresses), for a total of 50 recipients.
(dict) --
Contains information about a source or destination email address.
EmailAddress (string) -- [REQUIRED]
The email address, including the domain.
DisplayName (string) --
The display name of email address.
CcAddresses (list) --
The additional recipients information present in cc list. You must have 1 required recipient ( DestinationEmailAddress). You can then specify up to 49 additional recipients (across ToAddresses and CcAddresses), for a total of 50 recipients.
(dict) --
Contains information about a source or destination email address.
EmailAddress (string) -- [REQUIRED]
The email address, including the domain.
DisplayName (string) --
The display name of email address.
list
List of S3 presigned URLs of email attachments and their file name.
(dict) --
Information about the email attachment files.
FileName (string) -- [REQUIRED]
A case-sensitive name of the attached file being uploaded.
S3Url (string) -- [REQUIRED]
The pre-signed URLs for the S3 bucket where the email attachment is stored.
string
The identifier of the flow for initiating the emails. To see the ContactFlowId in the Connect Customer admin website, on the navigation menu go to Routing, Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
string
The contactId that is related to this contact. Linking emails together by using RelatedContactID copies over contact attributes from the related email contact to the new email contact. All updates to user-defined attributes in the new email contact are limited to the individual contact ID. There are no limits to the number of contacts that can be linked by using RelatedContactId.
dict
A custom key-value pair using an attribute map. The attributes are standard Connect Customer attributes, and can be accessed in flows just like any other contact attributes.
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
(string) --
(string) --
dict
A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Connect Customer attributes. They can be accessed in flows.
Attribute keys can include only alphanumeric, -, and _.
This field can be used to show channel subtype, such as connect:Guide.
(string) --
(dict) --
A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
ValueString (string) --
The value of a segment attribute.
ValueMap (dict) --
The value of a segment attribute.
(string) --
(dict) --
A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
ValueInteger (integer) --
The value of a segment attribute.
ValueList (list) --
The value of a segment attribute. This is only supported for system-defined attributes, not for user-defined attributes.
(dict) --
A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
ValueArn (string) --
The value of a segment attribute that has to be a valid ARN. This is only supported for system-defined attributes, not for user-defined attributes.
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
{
'ContactId': 'string'
}
Response Structure
(dict) --
ContactId (string) --
The identifier of this contact within the Connect Customer instance.
{'References': {'Status': {'DRAFTING'}}}
Places an outbound call to a contact, and then initiates the flow. It performs the actions in the flow that's specified (in ContactFlowId).
Agents do not initiate the outbound API, which means that they do not dial the contact. If the flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case.
Dialing timeout for this operation can be configured with the “RingTimeoutInSeconds” parameter. If not specified, the default dialing timeout will be 60 seconds which means if the call is not connected within 60 seconds, it fails.
See also: AWS API Documentation
Request Syntax
client.start_outbound_voice_contact(
Name='string',
Description='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'|'DRAFTING',
'Arn': 'string',
'StatusReason': 'string'
}
},
RelatedContactId='string',
DestinationPhoneNumber='string',
ContactFlowId='string',
InstanceId='string',
ClientToken='string',
SourcePhoneNumber='string',
QueueId='string',
Attributes={
'string': 'string'
},
AnswerMachineDetectionConfig={
'EnableAnswerMachineDetection': True|False,
'AwaitAnswerMachinePrompt': True|False
},
CampaignId='string',
TrafficType='GENERAL'|'CAMPAIGN',
OutboundStrategy={
'Type': 'AGENT_FIRST',
'Config': {
'AgentFirst': {
'Preview': {
'PostAcceptTimeoutConfig': {
'DurationInSeconds': 123
},
'AllowedUserActions': [
'CALL'|'DISCARD',
]
}
}
}
},
RingTimeoutInSeconds=123
)
string
The name of a voice contact that is shown to an agent in the Contact Control Panel (CCP).
string
A description of the voice contact that appears in the agent's snapshot in the CCP logs. For more information about CCP logs, see Download and review CCP logs in the Connect Customer Administrator Guide.
dict
A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Contacts can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL. ATTACHMENT is not a supported reference type during voice contact creation.
(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.
string
The contactId that is related to this contact. Linking voice, task, or chat by using RelatedContactID copies over contact attributes from the related contact to the new contact. All updates to user-defined attributes in the new contact are limited to the individual contact ID. There are no limits to the number of contacts that can be linked by using RelatedContactId.
string
[REQUIRED]
The phone number of the customer, in E.164 format.
string
[REQUIRED]
The identifier of the flow for the outbound call. To see the ContactFlowId in the Connect Customer admin website, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
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
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. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.
This field is autopopulated if not provided.
string
The phone number associated with the Connect Customer instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.
string
The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the flow is used. If you do not specify a queue, you must specify a source phone number.
dict
A custom key-value pair using an attribute map. The attributes are standard Connect Customer attributes, and can be accessed in flows just like any other contact attributes.
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
(string) --
(string) --
dict
Configuration of the answering machine detection for this outbound call.
EnableAnswerMachineDetection (boolean) --
The flag to indicate if answer machine detection analysis needs to be performed for a voice call. If set to true, TrafficType must be set as CAMPAIGN.
AwaitAnswerMachinePrompt (boolean) --
Wait for the answering machine prompt.
string
The campaign identifier of the outbound communication.
string
Denotes the class of traffic. Calls with different traffic types are handled differently by Connect Customer. The default value is GENERAL. Use CAMPAIGN if EnableAnswerMachineDetection is set to true. For all other cases, use GENERAL.
dict
Information about the outbound strategy.
Type (string) -- [REQUIRED]
Type of the outbound strategy.
Config (dict) --
Config of the outbound strategy.
AgentFirst (dict) --
The config of agent first outbound strategy.
Preview (dict) --
Information about preview configuration of agent first outbound strategy
PostAcceptTimeoutConfig (dict) -- [REQUIRED]
Countdown timer configuration after the agent accepted the preview outbound contact.
DurationInSeconds (integer) -- [REQUIRED]
Duration in seconds for the countdown timer after the agent accepted the contact.
AllowedUserActions (list) -- [REQUIRED]
The actions the agent can perform after accepting the preview outbound contact.
(string) --
integer
The maximum time the outbound call will wait for the destination to answer the call, in seconds
dict
Response Syntax
{
'ContactId': 'string'
}
Response Structure
(dict) --
ContactId (string) --
The identifier of this contact within the Connect Customer instance.
{'References': {'Status': {'DRAFTING'}}}
Initiates a flow to start a new task contact. For more information about task contacts, see Concepts: Tasks in Connect Customer in the Connect Customer Administrator Guide.
When using PreviousContactId and RelatedContactId input parameters, note the following:
PreviousContactId
Any updates to user-defined task contact attributes on any contact linked through the same PreviousContactId will affect every contact in the chain.
There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts can be created that share the same PreviousContactId.
RelatedContactId
Copies contact attributes from the related task contact to the new contact.
Any update on attributes in a new task contact does not update attributes on previous contact.
There’s no limit on the number of task contacts that can be created that use the same RelatedContactId.
In addition, when calling StartTaskContact include only one of these parameters: ContactFlowID, QuickConnectID, or TaskTemplateID. Only one parameter is required as long as the task template has a flow configured to run it. If more than one parameter is specified, or only the TaskTemplateID is specified but it does not have a flow configured, the request returns an error because Connect Customer cannot identify the unique flow to run when the task is created.
A ServiceQuotaExceededException occurs when the number of open tasks exceeds the active tasks quota or there are already 12 tasks referencing the same PreviousContactId. For more information about service quotas for task contacts, see Connect Customer service quotas in the Connect Customer Administrator Guide.
See also: AWS API Documentation
Request Syntax
client.start_task_contact(
InstanceId='string',
PreviousContactId='string',
ContactFlowId='string',
Attributes={
'string': 'string'
},
Name='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'|'DRAFTING',
'Arn': 'string',
'StatusReason': 'string'
}
},
Description='string',
ClientToken='string',
ScheduledTime=datetime(2015, 1, 1),
TaskTemplateId='string',
QuickConnectId='string',
RelatedContactId='string',
SegmentAttributes={
'string': {
'ValueString': 'string',
'ValueMap': {
'string': {'... recursive ...'}
},
'ValueInteger': 123,
'ValueList': [
{'... recursive ...'},
],
'ValueArn': 'string'
}
},
Attachments=[
{
'FileName': 'string',
'S3Url': '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 identifier of the previous chat, voice, or task contact. Any updates to user-defined attributes to task contacts linked using the same PreviousContactID will affect every contact in the chain. There can be a maximum of 12 linked task contacts in a chain.
string
The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Connect Customer admin website, on the navigation menu go to Routing, Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
dict
A custom key-value pair using an attribute map. The attributes are standard Connect Customer attributes, and can be accessed in flows just like any other contact attributes.
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
(string) --
(string) --
string
[REQUIRED]
The name of a task that is shown to an agent in the Contact Control Panel (CCP).
dict
A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL. ATTACHMENT is not a supported reference type during task creation.
(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.
string
A description of the task that is shown to an agent in the Contact Control Panel (CCP).
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.
datetime
The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.
string
A unique identifier for the task template. For more information about task templates, see Create task templates in the Connect Customer Administrator Guide.
string
The identifier for the quick connect. Tasks that are created by using QuickConnectId will use the flow that is defined on agent or queue quick connect. For more information about quick connects, see Create quick connects.
string
The contactId that is related to this contact. Linking tasks together by using RelatedContactID copies over contact attributes from the related task contact to the new task contact. All updates to user-defined attributes in the new task contact are limited to the individual contact ID, unlike what happens when tasks are linked by using PreviousContactID. There are no limits to the number of contacts that can be linked by using RelatedContactId.
dict
A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Connect Customer attributes. They can be accessed in flows.
Attribute keys can include only alphanumeric, -, and _.
This field can be used to set Contact Expiry as a duration in minutes and set a UserId for the User who created a task.
(string) --
(dict) --
A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
ValueString (string) --
The value of a segment attribute.
ValueMap (dict) --
The value of a segment attribute.
(string) --
(dict) --
A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
ValueInteger (integer) --
The value of a segment attribute.
ValueList (list) --
The value of a segment attribute. This is only supported for system-defined attributes, not for user-defined attributes.
(dict) --
A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
ValueArn (string) --
The value of a segment attribute that has to be a valid ARN. This is only supported for system-defined attributes, not for user-defined attributes.
list
List of S3 presigned URLs of task attachments and their file name. You can have a maximum of 5 attachments per task.
(dict) --
Information about the task attachment files.
FileName (string) -- [REQUIRED]
A case-sensitive name of the attached file being uploaded.
S3Url (string) -- [REQUIRED]
The pre-signed URLs for the S3 bucket where the task attachment is stored.
dict
Response Syntax
{
'ContactId': 'string'
}
Response Structure
(dict) --
ContactId (string) --
The identifier of this contact within the Connect Customer instance.
{'References': {'Status': {'DRAFTING'}}}
Places an inbound in-app, web, or video call to a contact, and then initiates the flow. It performs the actions in the flow that are specified (in ContactFlowId) and present in the Connect Customer instance (specified as InstanceId).
See also: AWS API Documentation
Request Syntax
client.start_web_rtc_contact(
Attributes={
'string': 'string'
},
ClientToken='string',
ContactFlowId='string',
InstanceId='string',
AllowedCapabilities={
'Customer': {
'Video': 'SEND',
'ScreenShare': 'SEND'
},
'Agent': {
'Video': 'SEND',
'ScreenShare': 'SEND'
}
},
ParticipantDetails={
'DisplayName': 'string'
},
RelatedContactId='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'|'DRAFTING',
'Arn': 'string',
'StatusReason': 'string'
}
},
Description='string',
SegmentAttributes={
'string': {
'ValueString': 'string',
'ValueMap': {
'string': {'... recursive ...'}
},
'ValueInteger': 123,
'ValueList': [
{'... recursive ...'},
],
'ValueArn': 'string'
}
}
)
dict
A custom key-value pair using an attribute map. The attributes are standard Connect Customer attributes, and can be accessed in flows just like any other contact attributes.
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, -, and _ characters.
(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. For more information about idempotency, see Making retries safe with idempotent APIs.
The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.
This field is autopopulated if not provided.
string
[REQUIRED]
The identifier of the flow for the call. To see the ContactFlowId in the Connect Customer admin website, on the navigation menu go to Routing, Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
string
[REQUIRED]
The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
dict
Information about the video sharing capabilities of the participants (customer, agent).
Customer (dict) --
Information about the customer's video sharing capabilities.
Video (string) --
The configuration having the video and screen sharing capabilities for participants over the call.
ScreenShare (string) --
The screen sharing capability that is enabled for the participant. SEND indicates the participant can share their screen.
Agent (dict) --
Information about the agent's video sharing capabilities.
Video (string) --
The configuration having the video and screen sharing capabilities for participants over the call.
ScreenShare (string) --
The screen sharing capability that is enabled for the participant. SEND indicates the participant can share their screen.
dict
[REQUIRED]
The details of the participant, including their display name.
DisplayName (string) -- [REQUIRED]
Display name of the participant.
string
The unique identifier for an Connect Customer contact. This identifier is related to the contact starting.
dict
A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL. ATTACHMENT is not a supported reference type during task creation.
(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.
string
A description of the task that is shown to an agent in the Contact Control Panel (CCP).
dict
A map of system-defined attributes for the WebRTC contact segment. Use the connect:Subtype attribute to specify the channel subtype, such as connect:WebRTC.
(string) --
(dict) --
A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
ValueString (string) --
The value of a segment attribute.
ValueMap (dict) --
The value of a segment attribute.
(string) --
(dict) --
A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
ValueInteger (integer) --
The value of a segment attribute.
ValueList (list) --
The value of a segment attribute. This is only supported for system-defined attributes, not for user-defined attributes.
(dict) --
A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
ValueArn (string) --
The value of a segment attribute that has to be a valid ARN. This is only supported for system-defined attributes, not for user-defined attributes.
dict
Response Syntax
{
'ConnectionData': {
'Attendee': {
'AttendeeId': 'string',
'JoinToken': 'string'
},
'Meeting': {
'MediaRegion': 'string',
'MediaPlacement': {
'AudioHostUrl': 'string',
'AudioFallbackUrl': 'string',
'SignalingUrl': 'string',
'TurnControlUrl': 'string',
'EventIngestionUrl': 'string'
},
'MeetingFeatures': {
'Audio': {
'EchoReduction': 'AVAILABLE'|'UNAVAILABLE'
}
},
'MeetingId': 'string'
}
},
'ContactId': 'string',
'ParticipantId': 'string',
'ParticipantToken': 'string'
}
Response Structure
(dict) --
ConnectionData (dict) --
Information required for the client application (mobile application or website) to connect to the call.
Attendee (dict) --
The attendee information, including attendee ID and join token.
AttendeeId (string) --
The Amazon Chime SDK attendee ID.
JoinToken (string) --
The join token used by the Amazon Chime SDK attendee.
Meeting (dict) --
A meeting created using the Amazon Chime SDK.
MediaRegion (string) --
The Amazon Web Services Region in which you create the meeting.
MediaPlacement (dict) --
The media placement for the meeting.
AudioHostUrl (string) --
The audio host URL.
AudioFallbackUrl (string) --
The audio fallback URL.
SignalingUrl (string) --
The signaling URL.
TurnControlUrl (string) --
The turn control URL.
EventIngestionUrl (string) --
The event ingestion URL to which you send client meeting events.
MeetingFeatures (dict) --
The configuration settings of the features available to a meeting.
Audio (dict) --
The configuration settings for the audio features available to a meeting.
EchoReduction (string) --
Makes echo reduction available to clients who connect to the meeting.
MeetingId (string) --
The Amazon Chime SDK meeting ID.
ContactId (string) --
The identifier of the contact in this instance of Connect Customer.
ParticipantId (string) --
The identifier for a contact participant. The ParticipantId for a contact participant is the same throughout the contact lifecycle.
ParticipantToken (string) --
The token used by the contact participant to call the CreateParticipantConnection API. The participant token is valid for the lifetime of a contact participant.
{'AdditionalRecipients': {'CcEmailAddresses': [{'DisplayName': 'string',
'EmailAddress': 'string'}]},
'References': {'Status': {'DRAFTING'}}}
This API is in preview release for Connect Customer and is subject to change.
Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request.
See also: AWS API Documentation
Request Syntax
client.update_contact(
InstanceId='string',
ContactId='string',
Name='string',
Description='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'|'DRAFTING',
'Arn': 'string',
'StatusReason': 'string'
}
},
SegmentAttributes={
'string': {
'ValueString': 'string',
'ValueMap': {
'string': {'... recursive ...'}
},
'ValueInteger': 123,
'ValueList': [
{'... recursive ...'},
],
'ValueArn': 'string'
}
},
QueueInfo={
'Id': 'string'
},
UserInfo={
'UserId': 'string'
},
CustomerEndpoint={
'Type': 'TELEPHONE_NUMBER'|'VOIP'|'CONTACT_FLOW'|'CONNECT_PHONENUMBER_ARN'|'EMAIL_ADDRESS',
'Address': 'string'
},
SystemEndpoint={
'Type': 'TELEPHONE_NUMBER'|'VOIP'|'CONTACT_FLOW'|'CONNECT_PHONENUMBER_ARN'|'EMAIL_ADDRESS',
'Address': 'string'
},
AdditionalRecipients={
'CcEmailAddresses': [
{
'EmailAddress': 'string',
'DisplayName': '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 contact. This is the identifier of the contact associated with the first interaction with your contact center.
string
The name of the contact.
string
The description of the contact.
dict
Well-formed data on contact, shown to agents on Contact Control Panel (CCP).
(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.
dict
A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Connect Customer attributes. They can be accessed in flows.
Attribute keys can include only alphanumeric, -, and _.
This field can be used to show channel subtype, such as connect:Guide.
Contact Expiry, and user-defined attributes (String - String) that are defined in predefined attributes, can be updated by using the UpdateContact API.
(string) --
(dict) --
A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
ValueString (string) --
The value of a segment attribute.
ValueMap (dict) --
The value of a segment attribute.
(string) --
(dict) --
A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
ValueInteger (integer) --
The value of a segment attribute.
ValueList (list) --
The value of a segment attribute. This is only supported for system-defined attributes, not for user-defined attributes.
(dict) --
A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
ValueArn (string) --
The value of a segment attribute that has to be a valid ARN. This is only supported for system-defined attributes, not for user-defined attributes.
dict
Information about the queue associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see Connect Customer Contact Lens integration in the Connect Customer Administrator Guide.
Id (string) --
The identifier of the queue.
dict
Information about the agent associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see Connect Customer Contact Lens integration in the Connect Customer Administrator Guide.
UserId (string) --
The user identifier for the contact.
dict
The endpoint of the customer for which the contact was initiated. For external audio contacts, this is usually the end customer's phone number. This value can only be updated for external audio contacts. For more information, see Connect Customer Contact Lens integration in the Connect Customer Administrator Guide. For email contacts with an OUTBOUND or AGENT_REPLY initiation method, this value can be updated while the outbound email is still a draft, before you send it.
Type (string) --
Type of the endpoint.
Address (string) --
Address of the endpoint.
dict
External system endpoint for the contact was initiated. For external audio contacts, this is the phone number of the external system such as the contact center. This value can only be updated for external audio contacts. For more information, see Connect Customer Contact Lens integration in the Connect Customer Administrator Guide. For email contacts with an OUTBOUND or AGENT_REPLY initiation method, this value can be updated while the outbound email is still a draft, before you send it.
Type (string) --
Type of the endpoint.
Address (string) --
Address of the endpoint.
dict
The additional recipients of an outbound email. Use this field to update the CC email address recipients of a contact. An empty list clears the existing CC recipients.
CcEmailAddresses (list) --
The additional CC email address recipients. You can specify up to 50 addresses. Provide an empty list to clear the existing CC recipients.
(dict) --
Contains information about a source or destination email address.
EmailAddress (string) -- [REQUIRED]
The email address, including the domain.
DisplayName (string) --
The display name of email address.
dict
Response Syntax
{}
Response Structure
(dict) --
{'Actions': {'TaskAction': {'References': {'Status': {'DRAFTING'}}}}}
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'|'SEND_IN_APP_NOTIFICATION',
'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'|'DRAFTING',
'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'
},
]
},
'SendInAppNotificationAction': {
'Content': {
'string': 'string'
},
'Recipient': {
'UserTags': {
'string': 'string'
},
'UserIds': [
'string',
]
},
'Exclusion': {
'UserTags': {
'string': 'string'
},
'UserIds': [
'string',
]
},
'Priority': 'HIGH'|'LOW'
}
},
],
PublishStatus='DRAFT'|'PUBLISHED',
PreEvaluationFilters={
'AndConditions': [
{
'ResourceType': 'CONTACT',
'FilterType': 'TAG',
'FilterKey': 'string',
'FilterValue': 'string',
'Operator': 'EQUALS'
},
]
}
)
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.
SendInAppNotificationAction (dict) --
Information about the send in-app notification action.
Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnAfterCallWorkAvailable | OnAfterChatWorkAvailable | OnEmailAnalysisAvailable | OnContactEvaluationSubmit | OnCaseCreate | OnCaseUpdate | OnSlaBreach | OnSchedulePublish | OnScheduleUpdate | OnScheduleTimeOffRequestActivity
Content (dict) -- [REQUIRED]
Notification content. Supports variable injection. For more information, see JSONPath reference in the Connect Customer Administrators Guide.
(string) --
The locale code for localized content. Supported values include en_US, de_DE, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, and zh_TW.
(string) --
A localized string value. Maximum length is 500 visible characters. In a markdown link of the form [label](url), only the label counts toward the limit.
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) --
Priority (string) --
Notification priority.
string
[REQUIRED]
The publish status of the rule.
dict
The pre-evaluation filters for the rule, that restrict the rule to be applied to only certain resources based on the resource's attributes, such as tags assigned to a contact. The pre-evaluation filters are applied even before rule conditions are evaluated and are used to enforce tag-based-access-control while applying rules.
AndConditions (list) --
A list of conditions that the rule evaluates together using AND logic. All conditions must be met for the event to be evaluated by the rule.
(dict) --
A single pre-evaluation filter condition. Specifies a resource type, filter type, key, value, and operator to match against a resource attribute.
ResourceType (string) -- [REQUIRED]
The type of resource to filter on. Valid values: CONTACT.
FilterType (string) -- [REQUIRED]
The type of filter to apply. Valid values: TAG.
FilterKey (string) -- [REQUIRED]
The key of the attribute to filter on. For tag filters, this is the tag key.
FilterValue (string) -- [REQUIRED]
The value to match against. For tag filters, this is the tag value.
Operator (string) -- [REQUIRED]
The comparison operator for the filter condition. Valid values: EQUALS.
None