2023/12/15 - Amazon Connect Service - 2 new 8 updated api methods
Changes Adds relatedContactId field to StartOutboundVoiceContact API input. Introduces PauseContact API and ResumeContact API for Task contacts. Adds pause duration, number of pauses, timestamps for last paused and resumed events to DescribeContact API response. Adds new Rule type and new Rule action.
Allows resuming a task contact in a paused state.
See also: AWS API Documentation
Request Syntax
client.resume_contact(
ContactId='string',
InstanceId='string',
ContactFlowId='string'
)
string
[REQUIRED]
The identifier of the contact.
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
string
The identifier of the flow.
dict
Response Syntax
{}
Response Structure
(dict) --
Allows pausing an ongoing task contact.
See also: AWS API Documentation
Request Syntax
client.pause_contact(
ContactId='string',
InstanceId='string',
ContactFlowId='string'
)
string
[REQUIRED]
The identifier of the contact.
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
string
The identifier of the flow.
dict
Response Syntax
{}
Response Structure
(dict) --
{'SourceType': {'CASES'}}
Creates an Amazon Web Services resource association with an Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
client.create_integration_association(
InstanceId='string',
IntegrationType='EVENT'|'VOICE_ID'|'PINPOINT_APP'|'WISDOM_ASSISTANT'|'WISDOM_KNOWLEDGE_BASE'|'WISDOM_QUICK_RESPONSES'|'CASES_DOMAIN'|'APPLICATION'|'FILE_SCANNER',
IntegrationArn='string',
SourceApplicationUrl='string',
SourceApplicationName='string',
SourceType='SALESFORCE'|'ZENDESK'|'CASES',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
The type of information to be ingested.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the integration.
Note
When integrating with Amazon Pinpoint, the Amazon Connect and Amazon Pinpoint instances must be in the same account.
string
The URL for the external application. This field is only required for the EVENT integration type.
string
The name of the external application. This field is only required for the EVENT integration type.
string
The type of the data source. This field is only required for the EVENT integration type.
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
{
'IntegrationAssociationId': 'string',
'IntegrationAssociationArn': 'string'
}
Response Structure
(dict) --
IntegrationAssociationId (string) --
The identifier for the integration association.
IntegrationAssociationArn (string) --
The Amazon Resource Name (ARN) for the association.
{'Actions': {'ActionType': {'CREATE_CASE',
'END_ASSOCIATED_TASKS',
'UPDATE_CASE'},
'CreateCaseAction': {'Fields': [{'Id': 'string',
'Value': {'BooleanValue': 'boolean',
'DoubleValue': 'double',
'EmptyValue': {},
'StringValue': 'string'}}],
'TemplateId': 'string'},
'EndAssociatedTasksAction': {},
'UpdateCaseAction': {'Fields': [{'Id': 'string',
'Value': {'BooleanValue': 'boolean',
'DoubleValue': 'double',
'EmptyValue': {},
'StringValue': 'string'}}]}},
'TriggerEventSource': {'EventSourceName': {'OnCaseUpdate', 'OnCaseCreate'}}}
Creates a rule for the specified Amazon Connect 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'|'OnZendeskTicketCreate'|'OnZendeskTicketStatusUpdate'|'OnSalesforceCaseCreate'|'OnContactEvaluationSubmit'|'OnMetricDataUpdate'|'OnCaseCreate'|'OnCaseUpdate',
'IntegrationAssociationId': 'string'
},
Function='string',
Actions=[
{
'ActionType': 'CREATE_TASK'|'ASSIGN_CONTACT_CATEGORY'|'GENERATE_EVENTBRIDGE_EVENT'|'SEND_NOTIFICATION'|'CREATE_CASE'|'UPDATE_CASE'|'END_ASSOCIATED_TASKS',
'TaskAction': {
'Name': 'string',
'Description': 'string',
'ContactFlowId': 'string',
'References': {
'string': {
'Value': 'string',
'Type': 'URL'|'ATTACHMENT'|'NUMBER'|'STRING'|'DATE'|'EMAIL'
}
}
},
'EventBridgeAction': {
'Name': 'string'
},
'AssignContactCategoryAction': {}
,
'SendNotificationAction': {
'DeliveryMethod': 'EMAIL',
'Subject': 'string',
'Content': 'string',
'ContentType': 'PLAIN_TEXT',
'Recipient': {
'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'
}
},
]
},
'EndAssociatedTasksAction': {}
},
],
PublishStatus='DRAFT'|'PUBLISHED',
ClientToken='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect 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 Amazon Connect Administrators Guide .
Description (string) --
The description. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect 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) -- [REQUIRED]
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.
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 Amazon Connect Administrators Guide .
Content (string) -- [REQUIRED]
Notification content. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect 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"} }. Amazon Connect users with the specified tags will be notified.
(string) --
(string) --
UserIds (list) --
A list of user IDs.
(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.
EndAssociatedTasksAction (dict) --
Information about the end associated tasks action.
Supported only for TriggerEventSource values: OnCaseUpdate .
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.
{'Contact': {'AgentInfo': {'AgentPauseDurationInSeconds': 'integer'},
'LastPausedTimestamp': 'timestamp',
'LastResumedTimestamp': 'timestamp',
'TotalPauseCount': 'integer',
'TotalPauseDurationInSeconds': 'integer'}}
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified contact.
Warning
Contact information remains available in Amazon Connect for 24 months, and then it is deleted.
Only data from November 12, 2021, and later is returned by this API.
See also: AWS API Documentation
Request Syntax
client.describe_contact(
InstanceId='string',
ContactId='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
The identifier of the contact.
dict
Response Syntax
{
'Contact': {
'Arn': 'string',
'Id': 'string',
'InitialContactId': 'string',
'PreviousContactId': 'string',
'InitiationMethod': 'INBOUND'|'OUTBOUND'|'TRANSFER'|'QUEUE_TRANSFER'|'CALLBACK'|'API'|'DISCONNECT'|'MONITOR'|'EXTERNAL_OUTBOUND',
'Name': 'string',
'Description': 'string',
'Channel': 'VOICE'|'CHAT'|'TASK',
'QueueInfo': {
'Id': 'string',
'EnqueueTimestamp': datetime(2015, 1, 1)
},
'AgentInfo': {
'Id': 'string',
'ConnectedToAgentTimestamp': datetime(2015, 1, 1),
'AgentPauseDurationInSeconds': 123
},
'InitiationTimestamp': datetime(2015, 1, 1),
'DisconnectTimestamp': datetime(2015, 1, 1),
'LastUpdateTimestamp': datetime(2015, 1, 1),
'LastPausedTimestamp': datetime(2015, 1, 1),
'LastResumedTimestamp': datetime(2015, 1, 1),
'TotalPauseCount': 123,
'TotalPauseDurationInSeconds': 123,
'ScheduledTimestamp': datetime(2015, 1, 1),
'RelatedContactId': 'string',
'WisdomInfo': {
'SessionArn': 'string'
},
'Tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
Contact (dict) --
Information about the contact.
Arn (string) --
The Amazon Resource Name (ARN) for the contact.
Id (string) --
The identifier for the contact.
InitialContactId (string) --
If this contact is related to other contacts, this is the ID of the initial contact.
PreviousContactId (string) --
If this contact is not the first contact, this is the ID of the previous contact.
InitiationMethod (string) --
Indicates how the contact was initiated.
Name (string) --
The name of the contact.
Description (string) --
The description of the contact.
Channel (string) --
How the contact reached your contact center.
QueueInfo (dict) --
If this contact was queued, this contains information about the queue.
Id (string) --
The unique identifier for the queue.
EnqueueTimestamp (datetime) --
The timestamp when the contact was added to the queue.
AgentInfo (dict) --
Information about the agent who accepted the contact.
Id (string) --
The identifier of the agent who accepted the contact.
ConnectedToAgentTimestamp (datetime) --
The timestamp when the contact was connected to the agent.
AgentPauseDurationInSeconds (integer) --
Agent pause duration for a contact in seconds.
InitiationTimestamp (datetime) --
The date and time this contact was initiated, in UTC time. For INBOUND , this is when the contact arrived. For OUTBOUND , this is when the agent began dialing. For CALLBACK , this is when the callback contact was created. For TRANSFER and QUEUE_TRANSFER , this is when the transfer was initiated. For API , this is when the request arrived. For EXTERNAL_OUTBOUND , this is when the agent started dialing the external participant. For MONITOR , this is when the supervisor started listening to a contact.
DisconnectTimestamp (datetime) --
The timestamp when the customer endpoint disconnected from Amazon Connect.
LastUpdateTimestamp (datetime) --
The timestamp when contact was last updated.
LastPausedTimestamp (datetime) --
The timestamp when the contact was last paused.
LastResumedTimestamp (datetime) --
The timestamp when the contact was last resumed.
TotalPauseCount (integer) --
Total pause count for a contact.
TotalPauseDurationInSeconds (integer) --
Total pause duration for a contact in seconds.
ScheduledTimestamp (datetime) --
The timestamp, in Unix epoch time format, at which to start running the inbound flow.
RelatedContactId (string) --
The contactId that is related to this contact.
WisdomInfo (dict) --
Information about Amazon Connect Wisdom.
SessionArn (string) --
The Amazon Resource Name (ARN) of the Wisdom session.
Tags (dict) --
Tags associated with the contact. This contains both Amazon Web Services generated and user-defined tags.
(string) --
(string) --
{'Rule': {'Actions': {'ActionType': {'CREATE_CASE',
'END_ASSOCIATED_TASKS',
'UPDATE_CASE'},
'CreateCaseAction': {'Fields': [{'Id': 'string',
'Value': {'BooleanValue': 'boolean',
'DoubleValue': 'double',
'EmptyValue': {},
'StringValue': 'string'}}],
'TemplateId': 'string'},
'EndAssociatedTasksAction': {},
'UpdateCaseAction': {'Fields': [{'Id': 'string',
'Value': {'BooleanValue': 'boolean',
'DoubleValue': 'double',
'EmptyValue': {},
'StringValue': 'string'}}]}},
'TriggerEventSource': {'EventSourceName': {'OnCaseCreate',
'OnCaseUpdate'}}}}
Describes a rule for the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
client.describe_rule(
InstanceId='string',
RuleId='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect 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'|'OnZendeskTicketCreate'|'OnZendeskTicketStatusUpdate'|'OnSalesforceCaseCreate'|'OnContactEvaluationSubmit'|'OnMetricDataUpdate'|'OnCaseCreate'|'OnCaseUpdate',
'IntegrationAssociationId': 'string'
},
'Function': 'string',
'Actions': [
{
'ActionType': 'CREATE_TASK'|'ASSIGN_CONTACT_CATEGORY'|'GENERATE_EVENTBRIDGE_EVENT'|'SEND_NOTIFICATION'|'CREATE_CASE'|'UPDATE_CASE'|'END_ASSOCIATED_TASKS',
'TaskAction': {
'Name': 'string',
'Description': 'string',
'ContactFlowId': 'string',
'References': {
'string': {
'Value': 'string',
'Type': 'URL'|'ATTACHMENT'|'NUMBER'|'STRING'|'DATE'|'EMAIL'
}
}
},
'EventBridgeAction': {
'Name': 'string'
},
'AssignContactCategoryAction': {},
'SendNotificationAction': {
'DeliveryMethod': 'EMAIL',
'Subject': 'string',
'Content': 'string',
'ContentType': 'PLAIN_TEXT',
'Recipient': {
'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'
}
},
]
},
'EndAssociatedTasksAction': {}
},
],
'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.
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 Amazon Connect Administrators Guide .
Description (string) --
The description. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect 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.
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 Amazon Connect Administrators Guide .
Content (string) --
Notification content. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect 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"} }. Amazon Connect users with the specified tags will be notified.
(string) --
(string) --
UserIds (list) --
A list of user IDs.
(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.
EndAssociatedTasksAction (dict) --
Information about the end associated tasks action.
Supported only for TriggerEventSource values: OnCaseUpdate .
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) --
{'IntegrationAssociationSummaryList': {'SourceType': {'CASES'}}}
Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
client.list_integration_associations(
InstanceId='string',
IntegrationType='EVENT'|'VOICE_ID'|'PINPOINT_APP'|'WISDOM_ASSISTANT'|'WISDOM_KNOWLEDGE_BASE'|'WISDOM_QUICK_RESPONSES'|'CASES_DOMAIN'|'APPLICATION'|'FILE_SCANNER',
NextToken='string',
MaxResults=123,
IntegrationArn='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
The integration type.
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.
integer
The maximum number of results to return per page.
string
The Amazon Resource Name (ARN) of the integration.
dict
Response Syntax
{
'IntegrationAssociationSummaryList': [
{
'IntegrationAssociationId': 'string',
'IntegrationAssociationArn': 'string',
'InstanceId': 'string',
'IntegrationType': 'EVENT'|'VOICE_ID'|'PINPOINT_APP'|'WISDOM_ASSISTANT'|'WISDOM_KNOWLEDGE_BASE'|'WISDOM_QUICK_RESPONSES'|'CASES_DOMAIN'|'APPLICATION'|'FILE_SCANNER',
'IntegrationArn': 'string',
'SourceApplicationUrl': 'string',
'SourceApplicationName': 'string',
'SourceType': 'SALESFORCE'|'ZENDESK'|'CASES'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
IntegrationAssociationSummaryList (list) --
The associations.
(dict) --
Contains summary information about the associated AppIntegrations.
IntegrationAssociationId (string) --
The identifier for the AppIntegration association.
IntegrationAssociationArn (string) --
The Amazon Resource Name (ARN) for the AppIntegration association.
InstanceId (string) --
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
IntegrationType (string) --
The integration type.
IntegrationArn (string) --
The Amazon Resource Name (ARN) for the AppIntegration.
SourceApplicationUrl (string) --
The URL for the external application.
SourceApplicationName (string) --
The user-provided, friendly name for the external application.
SourceType (string) --
The name of the source.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
{'EventSourceName': {'OnCaseUpdate', 'OnCaseCreate'}}
Response {'RuleSummaryList': {'ActionSummaries': {'ActionType': {'CREATE_CASE',
'END_ASSOCIATED_TASKS',
'UPDATE_CASE'}},
'EventSourceName': {'OnCaseUpdate', 'OnCaseCreate'}}}
List all rules for the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
client.list_rules(
InstanceId='string',
PublishStatus='DRAFT'|'PUBLISHED',
EventSourceName='OnPostCallAnalysisAvailable'|'OnRealTimeCallAnalysisAvailable'|'OnRealTimeChatAnalysisAvailable'|'OnPostChatAnalysisAvailable'|'OnZendeskTicketCreate'|'OnZendeskTicketStatusUpdate'|'OnSalesforceCaseCreate'|'OnContactEvaluationSubmit'|'OnMetricDataUpdate'|'OnCaseCreate'|'OnCaseUpdate',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect 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'|'OnZendeskTicketCreate'|'OnZendeskTicketStatusUpdate'|'OnSalesforceCaseCreate'|'OnContactEvaluationSubmit'|'OnMetricDataUpdate'|'OnCaseCreate'|'OnCaseUpdate',
'PublishStatus': 'DRAFT'|'PUBLISHED',
'ActionSummaries': [
{
'ActionType': 'CREATE_TASK'|'ASSIGN_CONTACT_CATEGORY'|'GENERATE_EVENTBRIDGE_EVENT'|'SEND_NOTIFICATION'|'CREATE_CASE'|'UPDATE_CASE'|'END_ASSOCIATED_TASKS'
},
],
'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.
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.
{'Description': 'string',
'Name': 'string',
'References': {'string': {'Type': 'URL | ATTACHMENT | NUMBER | STRING | DATE '
'| EMAIL',
'Value': 'string'}},
'RelatedContactId': 'string'}
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.
There is a 60-second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.
Note
UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide .
Note
Campaign calls are not allowed by default. Before you can make a call with TrafficType = CAMPAIGN , you must submit a service quota increase request to the quota Amazon Connect campaigns.
See also: AWS API Documentation
Request Syntax
client.start_outbound_voice_contact(
Name='string',
Description='string',
References={
'string': {
'Value': 'string',
'Type': 'URL'|'ATTACHMENT'|'NUMBER'|'STRING'|'DATE'|'EMAIL'
}
},
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'
)
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 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). 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) -- [REQUIRED]
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.
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 Amazon Connect 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 Amazon Connect 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 Amazon Connect 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 Amazon Connect 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 Amazon Connect. The default value is GENERAL . Use CAMPAIGN if EnableAnswerMachineDetection is set to true . For all other cases, use GENERAL .
dict
Response Syntax
{
'ContactId': 'string'
}
Response Structure
(dict) --
ContactId (string) --
The identifier of this contact within the Amazon Connect instance.
{'Actions': {'ActionType': {'CREATE_CASE',
'END_ASSOCIATED_TASKS',
'UPDATE_CASE'},
'CreateCaseAction': {'Fields': [{'Id': 'string',
'Value': {'BooleanValue': 'boolean',
'DoubleValue': 'double',
'EmptyValue': {},
'StringValue': 'string'}}],
'TemplateId': 'string'},
'EndAssociatedTasksAction': {},
'UpdateCaseAction': {'Fields': [{'Id': 'string',
'Value': {'BooleanValue': 'boolean',
'DoubleValue': 'double',
'EmptyValue': {},
'StringValue': 'string'}}]}}}
Updates a rule for the specified Amazon Connect 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'|'END_ASSOCIATED_TASKS',
'TaskAction': {
'Name': 'string',
'Description': 'string',
'ContactFlowId': 'string',
'References': {
'string': {
'Value': 'string',
'Type': 'URL'|'ATTACHMENT'|'NUMBER'|'STRING'|'DATE'|'EMAIL'
}
}
},
'EventBridgeAction': {
'Name': 'string'
},
'AssignContactCategoryAction': {}
,
'SendNotificationAction': {
'DeliveryMethod': 'EMAIL',
'Subject': 'string',
'Content': 'string',
'ContentType': 'PLAIN_TEXT',
'Recipient': {
'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'
}
},
]
},
'EndAssociatedTasksAction': {}
},
],
PublishStatus='DRAFT'|'PUBLISHED'
)
string
[REQUIRED]
A unique identifier for the rule.
string
[REQUIRED]
The identifier of the Amazon Connect 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 Amazon Connect Administrators Guide .
Description (string) --
The description. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect 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) -- [REQUIRED]
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.
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 Amazon Connect Administrators Guide .
Content (string) -- [REQUIRED]
Notification content. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect 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"} }. Amazon Connect users with the specified tags will be notified.
(string) --
(string) --
UserIds (list) --
A list of user IDs.
(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.
EndAssociatedTasksAction (dict) --
Information about the end associated tasks action.
Supported only for TriggerEventSource values: OnCaseUpdate .
string
[REQUIRED]
The publish status of the rule.
None