Amazon Connect Service

2026/11/19 - Amazon Connect Service - 15 updated api methods

Changes  Amazon Connect adds voicemail support, with new reference types, file use case types, contact details, and a voicemail task contact subtype for managing voicemail recordings and transcripts.

BatchGetAttachedFileMetadata (updated) Link ¶
Changes (response)
{'Files': {'FileUseCaseType': {'VOICEMAIL_ANALYSIS',
                               'VOICEMAIL_ANALYSIS_REDACTED',
                               'VOICEMAIL_RECORDING',
                               'VOICEMAIL_RECORDING_REDACTED'}}}

Allows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with the input AssociatedResourceArn.

See also: AWS API Documentation

Request Syntax

client.batch_get_attached_file_metadata(
    FileIds=[
        'string',
    ],
    InstanceId='string',
    AssociatedResourceArn='string'
)
type FileIds:

list

param FileIds:

[REQUIRED]

The unique identifiers of the attached file resource.

  • (string) --

type InstanceId:

string

param InstanceId:

[REQUIRED]

The unique identifier of the Connect instance.

type AssociatedResourceArn:

string

param AssociatedResourceArn:

[REQUIRED]

The resource to which the attached file is (being) uploaded to. The supported resources are Cases, Email, and Task.

rtype:

dict

returns:

Response Syntax

{
    'Files': [
        {
            'CreationTime': 'string',
            'FileArn': 'string',
            'FileId': 'string',
            'FileName': 'string',
            'FileSizeInBytes': 123,
            'FileStatus': 'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED'|'DRAFTING',
            'CreatedBy': {
                'ConnectUserArn': 'string',
                'AWSIdentityArn': 'string'
            },
            'FileUseCaseType': 'CONTACT_ANALYSIS'|'EMAIL_MESSAGE'|'EMAIL_MESSAGE_PLAIN_TEXT'|'EMAIL_MESSAGE_REDACTED'|'EMAIL_MESSAGE_PLAIN_TEXT_REDACTED'|'ATTACHMENT'|'VOICE_RECORDING'|'VOICEMAIL_RECORDING'|'VOICEMAIL_RECORDING_REDACTED'|'VOICEMAIL_ANALYSIS'|'VOICEMAIL_ANALYSIS_REDACTED',
            'AssociatedResourceArn': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'Errors': [
        {
            'ErrorCode': 'string',
            'ErrorMessage': 'string',
            'FileId': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • Files (list) --

      List of attached files that were successfully retrieved.

      • (dict) --

        Information about the attached file.

        • CreationTime (string) --

          The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2024-05-03T02:41:28.172Z.

        • FileArn (string) --

          The unique identifier of the attached file resource (ARN).

        • FileId (string) --

          The unique identifier of the attached file resource.

        • FileName (string) --

          A case-sensitive name of the attached file being uploaded.

        • FileSizeInBytes (integer) --

          The size of the attached file in bytes.

        • FileStatus (string) --

          The current status of the attached file.

        • CreatedBy (dict) --

          Represents the identity that created the file.

          • ConnectUserArn (string) --

            An agent ARN representing a connect user.

          • AWSIdentityArn (string) --

            STS or IAM ARN representing the identity of API Caller. SDK users cannot populate this and this value is calculated automatically if ConnectUserArn is not provided.

        • FileUseCaseType (string) --

          The use case for the file.

        • AssociatedResourceArn (string) --

          The resource to which the attached file is (being) uploaded to. The supported resources are Cases, Email, and Task.

        • Tags (dict) --

          The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

          • (string) --

            • (string) --

    • Errors (list) --

      List of errors of attached files that could not be retrieved.

      • (dict) --

        Error describing a failure to retrieve attached file metadata through BatchGetAttachedFileMetadata action.

        • ErrorCode (string) --

          Status code describing the failure.

        • ErrorMessage (string) --

          Why the attached file couldn't be retrieved.

        • FileId (string) --

          The unique identifier of the attached file resource.

CreateAttachedFile (updated) Link ¶
Changes (request)
{'FileUseCaseType': {'VOICEMAIL_ANALYSIS',
                     'VOICEMAIL_ANALYSIS_REDACTED',
                     'VOICEMAIL_RECORDING',
                     'VOICEMAIL_RECORDING_REDACTED'}}

Creates an attached file for a completed voice contact by copying a recording from a source S3 URI into Connect Customer managed storage. Use this API to attach voice recordings to contacts for downstream processing such as conversational analytics.

See also: AWS API Documentation

Request Syntax

client.create_attached_file(
    ClientToken='string',
    InstanceId='string',
    FileUseCaseType='CONTACT_ANALYSIS'|'EMAIL_MESSAGE'|'EMAIL_MESSAGE_PLAIN_TEXT'|'EMAIL_MESSAGE_REDACTED'|'EMAIL_MESSAGE_PLAIN_TEXT_REDACTED'|'ATTACHMENT'|'VOICE_RECORDING'|'VOICEMAIL_RECORDING'|'VOICEMAIL_RECORDING_REDACTED'|'VOICEMAIL_ANALYSIS'|'VOICEMAIL_ANALYSIS_REDACTED',
    FileSourceUri='string',
    AssociatedResourceArn='string',
    Tags={
        'string': 'string'
    }
)
type ClientToken:

string

param ClientToken:

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.

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type FileUseCaseType:

string

param FileUseCaseType:

[REQUIRED]

The use case for the file.

type FileSourceUri:

string

param FileSourceUri:

[REQUIRED]

The S3 URI of the file to be attached. Only S3 source URIs are supported.

type AssociatedResourceArn:

string

param AssociatedResourceArn:

[REQUIRED]

The ARN of the completed voice contact to attach the file to. Only voice contacts with Telephony subtype are supported.

type Tags:

dict

param Tags:

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

  • (string) --

    • (string) --

rtype:

dict

returns:

Response Syntax

{
    'FileArn': 'string',
    'FileId': 'string',
    'CreationTime': 'string',
    'FileStatus': 'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED'|'DRAFTING'
}

Response Structure

  • (dict) -- Response from CreateAttachedFile API.

    • FileArn (string) --

      The unique identifier of the attached file resource (ARN).

    • FileId (string) --

      The unique identifier of the attached file resource.

    • CreationTime (string) --

      The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2024-05-03T02:41:28.172Z.

    • FileStatus (string) --

      The current status of the attached file. Valid values: PROCESSING | APPROVED | REJECTED | FAILED.

CreateContact (updated) Link ¶
Changes (request)
{'References': {'Type': {'VOICEMAIL_ANALYSIS',
                         'VOICEMAIL_ANALYSIS_REDACTED',
                         'VOICEMAIL_RECORDING',
                         'VOICEMAIL_RECORDING_REDACTED'}}}

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'|'VOICEMAIL_RECORDING'|'VOICEMAIL_RECORDING_REDACTED'|'VOICEMAIL_ANALYSIS'|'VOICEMAIL_ANALYSIS_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'
)
type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type ClientToken:

string

param ClientToken:

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.

type RelatedContactId:

string

param RelatedContactId:

The identifier of the contact in this instance of Connect Customer.

type Attributes:

dict

param Attributes:

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) --

type References:

dict

param References:

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.

type Channel:

string

param Channel:

[REQUIRED]

The channel for the contact.

type InitiationMethod:

string

param InitiationMethod:

[REQUIRED]

Indicates how the contact was initiated.

type ExpiryDurationInMinutes:

integer

param ExpiryDurationInMinutes:

Number of minutes the contact will be active for before expiring

type UserInfo:

dict

param UserInfo:

User details for the contact

  • UserId (string) --

    The user identifier for the contact.

type InitiateAs:

string

param InitiateAs:

Initial state of the contact when it's created. Only TASK channel contacts can be initiated with COMPLETED state.

type Name:

string

param Name:

The name of a the contact.

type Description:

string

param Description:

A description of the contact.

type SegmentAttributes:

dict

param SegmentAttributes:

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.

type PreviousContactId:

string

param PreviousContactId:

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.

rtype:

dict

returns:

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.

CreateRule (updated) Link ¶
Changes (request)
{'Actions': {'TaskAction': {'References': {'Type': {'VOICEMAIL_ANALYSIS',
                                                    'VOICEMAIL_ANALYSIS_REDACTED',
                                                    'VOICEMAIL_RECORDING',
                                                    'VOICEMAIL_RECORDING_REDACTED'}}}}}

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'|'END_ASSOCIATED_EMAILS'|'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'|'VOICEMAIL_RECORDING'|'VOICEMAIL_RECORDING_REDACTED'|'VOICEMAIL_ANALYSIS'|'VOICEMAIL_ANALYSIS_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': {}
            ,
            'EndAssociatedEmailsAction': {}
            ,
            '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'|'CONTACT_EVALUATION',
                'FilterType': 'TAG',
                'FilterKey': 'string',
                'FilterValue': 'string',
                'Operator': 'EQUALS'
            },
        ]
    },
    ClientToken='string',
    Tags={
        'string': 'string'
    }
)
type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type Name:

string

param Name:

[REQUIRED]

A unique name for the rule.

type TriggerEventSource:

dict

param TriggerEventSource:

[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.

type Function:

string

param Function:

[REQUIRED]

The conditions of the rule.

type Actions:

list

param Actions:

[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.

    • EndAssociatedEmailsAction (dict) --

      Information about the end associated emails 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.

type PublishStatus:

string

param PublishStatus:

[REQUIRED]

The publish status of the rule.

type PreEvaluationFilters:

dict

param PreEvaluationFilters:

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 - Filter on attributes of the contact, such as tags assigned to the contact.

        • CONTACT_EVALUATION - Filter on attributes of the contact evaluation, such as tags assigned to the contact evaluation, for rules triggered on the OnContactEvaluationSubmit event source.

      • 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.

type ClientToken:

string

param ClientToken:

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.

type Tags:

dict

param Tags:

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

  • (string) --

    • (string) --

rtype:

dict

returns:

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.

DescribeContact (updated) Link ¶
Changes (response)
{'Contact': {'VoicemailInfo': {'NumberOfVoicemails': 'integer'}}}

This API is in preview release for Connect Customer and is subject to change.

Describes the specified contact.

Use cases

Following are common uses cases for this API:

  • Retrieve contact information such as the caller's phone number and the specific number the caller dialed to integrate into custom monitoring or custom agent experience solutions.

  • Detect when a customer chat session disconnects due to a network issue on the agent's end. Use the DisconnectReason field in the ContactTraceRecord to detect this event and then re-queue the chat for followup.

  • Identify after contact work (ACW) duration and call recordings information when a COMPLETED event is received by using the contact event stream.

Important things to know

  • SystemEndpoint is not populated for contacts with initiation method of MONITOR, QUEUE_TRANSFER, or CALLBACK

  • Contact information remains available in Connect Customer for 24 months from the InitiationTimestamp, and then it is deleted. Only contact information that is available in Connect Customer is returned by this API.

Endpoints: See Connect Customer endpoints and quotas.

See also: AWS API Documentation

Request Syntax

client.describe_contact(
    InstanceId='string',
    ContactId='string'
)
type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type ContactId:

string

param ContactId:

[REQUIRED]

The identifier of the contact.

rtype:

dict

returns:

Response Syntax

{
    'Contact': {
        'Arn': 'string',
        'Id': 'string',
        'InitialContactId': 'string',
        'PreviousContactId': 'string',
        'ContactAssociationId': 'string',
        'InitiationMethod': 'INBOUND'|'OUTBOUND'|'TRANSFER'|'QUEUE_TRANSFER'|'CALLBACK'|'API'|'DISCONNECT'|'MONITOR'|'EXTERNAL_OUTBOUND'|'WEBRTC_API'|'AGENT_REPLY'|'FLOW',
        'Name': 'string',
        'Description': 'string',
        'Channel': 'VOICE'|'CHAT'|'TASK'|'EMAIL',
        'QueueInfo': {
            'Id': 'string',
            'EnqueueTimestamp': datetime(2015, 1, 1)
        },
        'AgentInfo': {
            'Id': 'string',
            'AcceptedByAgentTimestamp': datetime(2015, 1, 1),
            'PreviewEndTimestamp': datetime(2015, 1, 1),
            'ConnectedToAgentTimestamp': datetime(2015, 1, 1),
            'AgentPauseDurationInSeconds': 123,
            'HierarchyGroups': {
                'Level1': {
                    'Arn': 'string'
                },
                'Level2': {
                    'Arn': 'string'
                },
                'Level3': {
                    'Arn': 'string'
                },
                'Level4': {
                    'Arn': 'string'
                },
                'Level5': {
                    'Arn': 'string'
                }
            },
            'DeviceInfo': {
                'PlatformName': 'string',
                'PlatformVersion': 'string',
                'OperatingSystem': 'string'
            },
            'Capabilities': {
                'Video': 'SEND',
                'ScreenShare': 'SEND'
            },
            'AfterContactWorkDuration': 123,
            'AfterContactWorkStartTimestamp': datetime(2015, 1, 1),
            'AfterContactWorkEndTimestamp': datetime(2015, 1, 1),
            'AgentInitiatedHoldDuration': 123,
            'StateTransitions': [
                {
                    'State': 'INITIAL'|'CONNECTED'|'DISCONNECTED'|'MISSED',
                    'StateStartTimestamp': datetime(2015, 1, 1),
                    'StateEndTimestamp': datetime(2015, 1, 1)
                },
            ],
            'VoiceEnhancementMode': 'VOICE_ISOLATION'|'NOISE_SUPPRESSION'|'NONE',
            'ActiveRegion': 'string'
        },
        '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),
        'RingStartTimestamp': datetime(2015, 1, 1),
        'TotalPauseCount': 123,
        'TotalPauseDurationInSeconds': 123,
        'ScheduledTimestamp': datetime(2015, 1, 1),
        'RelatedContactId': 'string',
        'WisdomInfo': {
            'SessionArn': 'string',
            'AiAgents': [
                {
                    'AiUseCase': 'AgentAssistance'|'SelfService',
                    'AiAgentVersionId': 'string',
                    'AiAgentEscalated': True|False
                },
            ]
        },
        'CustomerId': 'string',
        'CustomerEndpoint': {
            'Type': 'TELEPHONE_NUMBER'|'VOIP'|'CONTACT_FLOW'|'CONNECT_PHONENUMBER_ARN'|'EMAIL_ADDRESS',
            'Address': 'string',
            'DisplayName': 'string'
        },
        'SystemEndpoint': {
            'Type': 'TELEPHONE_NUMBER'|'VOIP'|'CONTACT_FLOW'|'CONNECT_PHONENUMBER_ARN'|'EMAIL_ADDRESS',
            'Address': 'string',
            'DisplayName': 'string'
        },
        'QueueTimeAdjustmentSeconds': 123,
        'QueuePriority': 123,
        'Tags': {
            'string': 'string'
        },
        'ConnectedToSystemTimestamp': datetime(2015, 1, 1),
        'RoutingCriteria': {
            'Steps': [
                {
                    'Expiry': {
                        'DurationInSeconds': 123,
                        'ExpiryTimestamp': datetime(2015, 1, 1)
                    },
                    'Expression': {
                        'AttributeCondition': {
                            'Name': 'string',
                            'Value': 'string',
                            'ProficiencyLevel': ...,
                            'Range': {
                                'MinProficiencyLevel': ...,
                                'MaxProficiencyLevel': ...
                            },
                            'MatchCriteria': {
                                'AgentsCriteria': {
                                    'AgentIds': [
                                        'string',
                                    ]
                                }
                            },
                            'ComparisonOperator': 'string'
                        },
                        'AndExpression': [
                            {'... recursive ...'},
                        ],
                        'OrExpression': [
                            {'... recursive ...'},
                        ],
                        'NotAttributeCondition': {
                            'Name': 'string',
                            'Value': 'string',
                            'ProficiencyLevel': ...,
                            'Range': {
                                'MinProficiencyLevel': ...,
                                'MaxProficiencyLevel': ...
                            },
                            'MatchCriteria': {
                                'AgentsCriteria': {
                                    'AgentIds': [
                                        'string',
                                    ]
                                }
                            },
                            'ComparisonOperator': 'string'
                        }
                    },
                    'Status': 'ACTIVE'|'INACTIVE'|'JOINED'|'EXPIRED'
                },
            ],
            'ActivationTimestamp': datetime(2015, 1, 1),
            'Index': 123
        },
        'Customer': {
            'DeviceInfo': {
                'PlatformName': 'string',
                'PlatformVersion': 'string',
                'OperatingSystem': 'string'
            },
            'Capabilities': {
                'Video': 'SEND',
                'ScreenShare': 'SEND'
            }
        },
        'Campaign': {
            'CampaignId': 'string'
        },
        'AnsweringMachineDetectionStatus': 'ANSWERED'|'UNDETECTED'|'ERROR'|'HUMAN_ANSWERED'|'SIT_TONE_DETECTED'|'SIT_TONE_BUSY'|'SIT_TONE_INVALID_NUMBER'|'FAX_MACHINE_DETECTED'|'VOICEMAIL_BEEP'|'VOICEMAIL_NO_BEEP'|'AMD_UNRESOLVED'|'AMD_UNANSWERED'|'AMD_ERROR'|'AMD_NOT_APPLICABLE',
        'CustomerVoiceActivity': {
            'GreetingStartTimestamp': datetime(2015, 1, 1),
            'GreetingEndTimestamp': datetime(2015, 1, 1)
        },
        'QualityMetrics': {
            'Agent': {
                'Audio': {
                    'QualityScore': ...,
                    'PotentialQualityIssues': [
                        'string',
                    ]
                }
            },
            'Customer': {
                'Audio': {
                    'QualityScore': ...,
                    'PotentialQualityIssues': [
                        'string',
                    ]
                }
            }
        },
        'ChatMetrics': {
            'ChatContactMetrics': {
                'MultiParty': True|False,
                'TotalMessages': 123,
                'TotalBotMessages': 123,
                'TotalBotMessageLengthInChars': 123,
                'ConversationCloseTimeInMillis': 123,
                'ConversationTurnCount': 123,
                'AgentFirstResponseTimestamp': datetime(2015, 1, 1),
                'AgentFirstResponseTimeInMillis': 123
            },
            'AgentMetrics': {
                'ParticipantId': 'string',
                'ParticipantType': 'ALL'|'MANAGER'|'AGENT'|'CUSTOMER'|'THIRDPARTY',
                'ConversationAbandon': True|False,
                'MessagesSent': 123,
                'NumResponses': 123,
                'MessageLengthInChars': 123,
                'TotalResponseTimeInMillis': 123,
                'MaxResponseTimeInMillis': 123,
                'LastMessageTimestamp': datetime(2015, 1, 1)
            },
            'CustomerMetrics': {
                'ParticipantId': 'string',
                'ParticipantType': 'ALL'|'MANAGER'|'AGENT'|'CUSTOMER'|'THIRDPARTY',
                'ConversationAbandon': True|False,
                'MessagesSent': 123,
                'NumResponses': 123,
                'MessageLengthInChars': 123,
                'TotalResponseTimeInMillis': 123,
                'MaxResponseTimeInMillis': 123,
                'LastMessageTimestamp': datetime(2015, 1, 1)
            }
        },
        'DisconnectDetails': {
            'PotentialDisconnectIssue': 'string'
        },
        'AdditionalEmailRecipients': {
            'ToList': [
                {
                    'Address': 'string',
                    'DisplayName': 'string'
                },
            ],
            'CcList': [
                {
                    'Address': 'string',
                    'DisplayName': 'string'
                },
            ]
        },
        'SegmentAttributes': {
            'string': {
                'ValueString': 'string',
                'ValueMap': {
                    'string': {'... recursive ...'}
                },
                'ValueInteger': 123,
                'ValueList': [
                    {'... recursive ...'},
                ],
                'ValueArn': 'string'
            }
        },
        'Recordings': [
            {
                'StorageType': 'S3'|'KINESIS_VIDEO_STREAM'|'KINESIS_STREAM'|'KINESIS_FIREHOSE',
                'Location': 'string',
                'MediaStreamType': 'AUDIO'|'VIDEO',
                'ParticipantType': 'ALL'|'MANAGER'|'AGENT'|'CUSTOMER'|'THIRDPARTY',
                'FragmentStartNumber': 'string',
                'FragmentStopNumber': 'string',
                'StartTimestamp': datetime(2015, 1, 1),
                'StopTimestamp': datetime(2015, 1, 1),
                'Status': 'AVAILABLE'|'DELETED',
                'DeletionReason': 'string',
                'UnprocessedTranscriptLocation': 'string'
            },
        ],
        'DisconnectReason': 'string',
        'ContactEvaluations': {
            'string': {
                'FormId': 'string',
                'EvaluationArn': 'string',
                'Status': 'COMPLETE'|'IN_PROGRESS'|'DELETED',
                'StartTimestamp': datetime(2015, 1, 1),
                'EndTimestamp': datetime(2015, 1, 1),
                'DeleteTimestamp': datetime(2015, 1, 1),
                'ExportLocation': 'string'
            }
        },
        'TaskTemplateInfo': {
            'Arn': 'string',
            'Name': 'string'
        },
        'Cases': [
            {
                'CaseId': 'string',
                'CaseReferenceNumber': 'string'
            },
        ],
        'ContactDetails': {
            'Name': 'string',
            'Description': 'string'
        },
        'OutboundStrategy': {
            'Type': 'AGENT_FIRST',
            'Config': {
                'AgentFirst': {
                    'Preview': {
                        'PostAcceptTimeoutConfig': {
                            'DurationInSeconds': 123
                        },
                        'AllowedUserActions': [
                            'CALL'|'DISCARD',
                        ]
                    }
                }
            }
        },
        'Attributes': {
            'string': 'string'
        },
        'NextContacts': [
            {
                'Type': 'QUICK_CONNECT',
                'NextContactMetadata': {
                    'QuickConnectContactData': {
                        'ContactId': 'string',
                        'InitiationTimestamp': datetime(2015, 1, 1),
                        'QuickConnectId': 'string',
                        'QuickConnectName': 'string',
                        'QuickConnectType': 'USER'|'QUEUE'|'PHONE_NUMBER'|'FLOW'
                    }
                }
            },
        ],
        'GlobalResiliencyMetadata': {
            'ActiveRegion': 'string',
            'OriginRegion': 'string',
            'TrafficDistributionGroupId': 'string'
        },
        'ContactLens': {
            'ConversationalAnalytics': {
                'Configuration': {
                    'Enabled': True|False,
                    'LanguageLocale': 'string',
                    'LanguageLocales': [
                        'string',
                    ],
                    'ChannelConfiguration': {
                        'AnalyticsModes': [
                            'string',
                        ]
                    },
                    'RedactionConfiguration': {
                        'Behavior': 'string',
                        'Policy': 'string',
                        'Entities': [
                            'string',
                        ],
                        'MaskMode': 'string'
                    },
                    'SummaryConfiguration': {
                        'SummaryModes': [
                            'string',
                        ]
                    },
                    'SentimentConfiguration': {
                        'Behavior': 'string'
                    }
                },
                'ContactAnalysisReferenceState': {
                    'Status': 'string',
                    'StatusReason': 'string'
                }
            }
        },
        'VoicemailInfo': {
            'NumberOfVoicemails': 123
        }
    }
}

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.

      • ContactAssociationId (string) --

        This is the root contactId which is used as a unique identifier for all subsequent contacts in a contact tree.

      • 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.

        • AcceptedByAgentTimestamp (datetime) --

          The timestamp when the contact was accepted by the agent.

        • PreviewEndTimestamp (datetime) --

          The timestamp when the agent finished previewing the contact.

        • ConnectedToAgentTimestamp (datetime) --

          The timestamp when the contact was connected to the agent.

        • AgentPauseDurationInSeconds (integer) --

          Agent pause duration for a contact in seconds.

        • HierarchyGroups (dict) --

          The agent hierarchy groups for the agent.

          • Level1 (dict) --

            The group at level one of the agent hierarchy.

            • Arn (string) --

              The Amazon Resource Name (ARN) of the group.

          • Level2 (dict) --

            The group at level two of the agent hierarchy.

            • Arn (string) --

              The Amazon Resource Name (ARN) of the group.

          • Level3 (dict) --

            The group at level three of the agent hierarchy.

            • Arn (string) --

              The Amazon Resource Name (ARN) of the group.

          • Level4 (dict) --

            The group at level four of the agent hierarchy.

            • Arn (string) --

              The Amazon Resource Name (ARN) of the group.

          • Level5 (dict) --

            The group at level five of the agent hierarchy.

            • Arn (string) --

              The Amazon Resource Name (ARN) of the group.

        • DeviceInfo (dict) --

          Information regarding Agent’s device.

          • PlatformName (string) --

            Name of the platform that the participant used for the call.

          • PlatformVersion (string) --

            Version of the platform that the participant used for the call.

          • OperatingSystem (string) --

            Operating system that the participant used for the call.

        • Capabilities (dict) --

          The configuration for the allowed video and screen sharing capabilities for participants present over the call. For more information, see Set up in-app, web, video calling, and screen sharing capabilities in the Connect Customer Administrator Guide.

          • 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.

        • AfterContactWorkDuration (integer) --

          The difference in time, in whole seconds, between AfterContactWorkStartTimestamp and AfterContactWorkEndTimestamp.

        • AfterContactWorkStartTimestamp (datetime) --

          The date and time when the agent started doing After Contact Work for the contact, in UTC time.

        • AfterContactWorkEndTimestamp (datetime) --

          The date and time when the agent ended After Contact Work for the contact, in UTC time. In cases when agent finishes doing AfterContactWork for chat contacts and switches their activity status to offline or equivalent without clearing the contact in CCP, discrepancies may be noticed for AfterContactWorkEndTimestamp.

        • AgentInitiatedHoldDuration (integer) --

          The total hold duration in seconds initiated by the agent.

        • StateTransitions (list) --

          List of StateTransition for a supervisor.

          • (dict) --

            Information about the state transition of a supervisor.

            • State (string) --

              The state of the transition.

            • StateStartTimestamp (datetime) --

              The date and time when the state started in UTC time.

            • StateEndTimestamp (datetime) --

              The date and time when the state ended in UTC time.

        • VoiceEnhancementMode (string) --

          The voice enhancement mode used by the agent as the call is ending. Valid values: VOICE_ISOLATION | NOISE_SUPPRESSION | NONE. A value of null indicates this mode has not yet been set for this user.

        • ActiveRegion (string) --

          The Region where the agent was active when they handled the contact. For Amazon Connect Global Resiliency instances enabled for global routing, this indicates the Region in which the agent's session was established at the time of the contact.

      • 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 date and time that the customer endpoint disconnected from the current contact, in UTC time. In transfer scenarios, the DisconnectTimestamp of the previous contact indicates the date and time when that contact ended.

      • 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.

      • RingStartTimestamp (datetime) --

        The timestamp when ringing started for a campaign call.

      • 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 Connect Customer Wisdom.

        • SessionArn (string) --

          The Amazon Resource Name (ARN) of the Wisdom session.

        • AiAgents (list) --

          The array of AI agents involved in the contact.

          • (dict) --

            Information of the AI agent involved in the contact.

            • AiUseCase (string) --

              The use case or scenario for which the AI agent is involved in the contact

            • AiAgentVersionId (string) --

              The unique identifier that specifies both the AI agent ID and its version number that was involved in the contact

            • AiAgentEscalated (boolean) --

              A boolean flag indicating whether the contact initially handled by this AI agent was escalated to a human agent.

      • CustomerId (string) --

        The customer's identification number. For example, the CustomerId may be a customer number from your CRM. You can create a Lambda function to pull the unique customer ID of the caller from your CRM system. If you enable Connect Customer Voice ID capability, this attribute is populated with the CustomerSpeakerId of the caller.

      • CustomerEndpoint (dict) --

        The customer or external third party participant endpoint.

        • Type (string) --

          Type of endpoint.

        • Address (string) --

          Address of the endpoint.

        • DisplayName (string) --

          Display name of the endpoint.

      • SystemEndpoint (dict) --

        The system endpoint. For INBOUND, this is the phone number or email address that the customer dialed. For OUTBOUND and EXTERNAL_OUTBOUND, this is the outbound caller ID number assigned to the outbound queue that is used to dial the customer. For callback, this shows up as Softphone for calls handled by agents with softphone.

        • Type (string) --

          Type of endpoint.

        • Address (string) --

          Address of the endpoint.

        • DisplayName (string) --

          Display name of the endpoint.

      • QueueTimeAdjustmentSeconds (integer) --

        An integer that represents the queue time adjust to be applied to the contact, in seconds (longer / larger queue time are routed preferentially). Cannot be specified if the QueuePriority is specified. Must be statically defined and a valid integer value.

      • QueuePriority (integer) --

        An integer that represents the queue priority to be applied to the contact (lower priorities are routed preferentially). Cannot be specified if the QueueTimeAdjustmentSeconds is specified. Must be statically defined, must be larger than zero, and a valid integer value. Default Value is 5.

      • Tags (dict) --

        Tags associated with the contact. This contains both Amazon Web Services generated and user-defined tags.

        • (string) --

          • (string) --

      • ConnectedToSystemTimestamp (datetime) --

        The timestamp when customer endpoint connected to Connect Customer.

      • RoutingCriteria (dict) --

        Latest routing criteria on the contact.

        • Steps (list) --

          List of routing steps. When Connect Customer does not find an available agent meeting the requirements in a step for a given step duration, the routing criteria will move on to the next step sequentially until a join is completed with an agent. When all steps are exhausted, the contact will be offered to any agent in the queue.

          • (dict) --

            Step signifies the criteria to be used for routing to an agent

            • Expiry (dict) --

              An object to specify the expiration of a routing step.

              • DurationInSeconds (integer) --

                The number of seconds to wait before expiring the routing step.

              • ExpiryTimestamp (datetime) --

                The timestamp indicating when the routing step expires.

            • Expression (dict) --

              A tagged union to specify expression for a routing step.

              • AttributeCondition (dict) --

                An object to specify the predefined attribute condition.

                • Name (string) --

                  The name of predefined attribute.

                • Value (string) --

                  The value of predefined attribute.

                • ProficiencyLevel (float) --

                  The proficiency level of the condition.

                • Range (dict) --

                  An Object to define the minimum and maximum proficiency levels.

                  • MinProficiencyLevel (float) --

                    The minimum proficiency level of the range.

                  • MaxProficiencyLevel (float) --

                    The maximum proficiency level of the range.

                • MatchCriteria (dict) --

                  An object to define AgentsCriteria.

                  • AgentsCriteria (dict) --

                    An object to define agentIds.

                    • AgentIds (list) --

                      An object to specify a list of agents, by user ID.

                      • (string) --

                • ComparisonOperator (string) --

                  The operator of the condition.

              • AndExpression (list) --

                List of routing expressions which will be AND-ed together.

                • (dict) --

                  A tagged union to specify expression for a routing step.

              • OrExpression (list) --

                List of routing expressions which will be OR-ed together.

                • (dict) --

                  A tagged union to specify expression for a routing step.

              • NotAttributeCondition (dict) --

                An object to specify the predefined attribute condition.

                • Name (string) --

                  The name of predefined attribute.

                • Value (string) --

                  The value of predefined attribute.

                • ProficiencyLevel (float) --

                  The proficiency level of the condition.

                • Range (dict) --

                  An Object to define the minimum and maximum proficiency levels.

                  • MinProficiencyLevel (float) --

                    The minimum proficiency level of the range.

                  • MaxProficiencyLevel (float) --

                    The maximum proficiency level of the range.

                • MatchCriteria (dict) --

                  An object to define AgentsCriteria.

                  • AgentsCriteria (dict) --

                    An object to define agentIds.

                    • AgentIds (list) --

                      An object to specify a list of agents, by user ID.

                      • (string) --

                • ComparisonOperator (string) --

                  The operator of the condition.

            • Status (string) --

              Represents status of the Routing step.

        • ActivationTimestamp (datetime) --

          The timestamp indicating when the routing criteria is set to active. A routing criteria is activated when contact is transferred to a queue. ActivationTimestamp will be set on routing criteria for contacts in agent queue even though Routing criteria is never activated for contacts in agent queue.

        • Index (integer) --

          Information about the index of the routing criteria.

      • Customer (dict) --

        Information about the Customer on the contact.

        • DeviceInfo (dict) --

          Information regarding Customer’s device.

          • PlatformName (string) --

            Name of the platform that the participant used for the call.

          • PlatformVersion (string) --

            Version of the platform that the participant used for the call.

          • OperatingSystem (string) --

            Operating system that the participant used for the call.

        • Capabilities (dict) --

          The configuration for the allowed video and screen sharing capabilities for participants present over the call. For more information, see Set up in-app, web, video calling, and screen sharing capabilities in the Connect Customer Administrator Guide.

          • 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.

      • Campaign (dict) --

        Information associated with a campaign.

        • CampaignId (string) --

          A unique identifier for a campaign.

      • AnsweringMachineDetectionStatus (string) --

        Indicates how an outbound campaign call is actually disposed if the contact is connected to Connect Customer.

      • CustomerVoiceActivity (dict) --

        Information about customer’s voice activity.

        • GreetingStartTimestamp (datetime) --

          Timestamp that measures the beginning of the customer greeting from an outbound voice call.

        • GreetingEndTimestamp (datetime) --

          Timestamp that measures the end of the customer greeting from an outbound voice call.

      • QualityMetrics (dict) --

        Information about the quality of the participant's media connection.

        • Agent (dict) --

          Information about the quality of Agent media connection.

          • Audio (dict) --

            Information about the audio quality of the Agent

            • QualityScore (float) --

              Number measuring the estimated quality of the media connection.

            • PotentialQualityIssues (list) --

              List of potential issues causing degradation of quality on a media connection. If the service did not detect any potential quality issues the list is empty.

              Valid values: HighPacketLoss | HighRoundTripTime | HighJitterBuffer

              • (string) --

        • Customer (dict) --

          Information about the quality of Customer media connection.

          • Audio (dict) --

            Information about the audio quality of the Customer

            • QualityScore (float) --

              Number measuring the estimated quality of the media connection.

            • PotentialQualityIssues (list) --

              List of potential issues causing degradation of quality on a media connection. If the service did not detect any potential quality issues the list is empty.

              Valid values: HighPacketLoss | HighRoundTripTime | HighJitterBuffer

              • (string) --

      • ChatMetrics (dict) --

        Information about how agent, bot, and customer interact in a chat contact.

        • ChatContactMetrics (dict) --

          Information about the overall participant interactions at the contact level.

          • MultiParty (boolean) --

            A boolean flag indicating whether multiparty chat or supervisor barge were enabled on this contact.

          • TotalMessages (integer) --

            The number of chat messages on the contact.

          • TotalBotMessages (integer) --

            The total number of bot and automated messages on a chat contact.

          • TotalBotMessageLengthInChars (integer) --

            The total number of characters from bot and automated messages on a chat contact.

          • ConversationCloseTimeInMillis (integer) --

            The time it took for a contact to end after the last customer message.

          • ConversationTurnCount (integer) --

            The number of conversation turns in a chat contact, which represents the back-and-forth exchanges between customer and other participants.

          • AgentFirstResponseTimestamp (datetime) --

            The agent first response timestamp for a chat contact.

          • AgentFirstResponseTimeInMillis (integer) --

            The time for an agent to respond after obtaining a chat contact.

        • AgentMetrics (dict) --

          Information about agent interactions in a contact.

          • ParticipantId (string) --

            The Participant's ID.

          • ParticipantType (string) --

            Information about the conversation participant. Following are the participant types: [Agent, Customer, Supervisor].

          • ConversationAbandon (boolean) --

            A boolean flag indicating whether the chat conversation was abandoned by a Participant.

          • MessagesSent (integer) --

            Number of chat messages sent by Participant.

          • NumResponses (integer) --

            Number of chat messages sent by Participant.

          • MessageLengthInChars (integer) --

            Number of chat characters sent by Participant.

          • TotalResponseTimeInMillis (integer) --

            Total chat response time by Participant.

          • MaxResponseTimeInMillis (integer) --

            Maximum chat response time by Participant.

          • LastMessageTimestamp (datetime) --

            Timestamp of last chat message by Participant.

        • CustomerMetrics (dict) --

          Information about customer interactions in a contact.

          • ParticipantId (string) --

            The Participant's ID.

          • ParticipantType (string) --

            Information about the conversation participant. Following are the participant types: [Agent, Customer, Supervisor].

          • ConversationAbandon (boolean) --

            A boolean flag indicating whether the chat conversation was abandoned by a Participant.

          • MessagesSent (integer) --

            Number of chat messages sent by Participant.

          • NumResponses (integer) --

            Number of chat messages sent by Participant.

          • MessageLengthInChars (integer) --

            Number of chat characters sent by Participant.

          • TotalResponseTimeInMillis (integer) --

            Total chat response time by Participant.

          • MaxResponseTimeInMillis (integer) --

            Maximum chat response time by Participant.

          • LastMessageTimestamp (datetime) --

            Timestamp of last chat message by Participant.

      • DisconnectDetails (dict) --

        Information about the call disconnect experience.

        • PotentialDisconnectIssue (string) --

          Indicates the potential disconnection issues for a call. This field is not populated if the service does not detect potential issues.

      • AdditionalEmailRecipients (dict) --

        List of additional email addresses for an email contact.

        • ToList (list) --

          List of additional TO email recipients for an email contact.

          • (dict) --

            Information about the email recipient

            • Address (string) --

              Address of the email recipient.

            • DisplayName (string) --

              Display name of the email recipient.

        • CcList (list) --

          List of additional CC email recipients for an email contact.

          • (dict) --

            Information about the email recipient

            • Address (string) --

              Address of the email recipient.

            • DisplayName (string) --

              Display name of the email recipient.

      • SegmentAttributes (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 and can be accessed in flows. Attribute keys can include only alphanumeric, -, and _ characters. This field can be used to show channel subtype. For example, connect:Guide or connect:SMS.

        • (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.

      • Recordings (list) --

        If recording was enabled, this is information about the recordings.

        • (dict) --

          Information about a voice recording, chat transcript, or screen recording.

          • StorageType (string) --

            Where the recording/transcript is stored.

          • Location (string) --

            The location, in Amazon S3, for the recording/transcript.

          • MediaStreamType (string) --

            Information about the media stream used during the conversation.

          • ParticipantType (string) --

            Information about the conversation participant, whether they are an agent or contact. The participant types are as follows:

            • All

            • Manager

            • Agent

            • Customer

            • Thirdparty

            • Supervisor

          • FragmentStartNumber (string) --

            The number that identifies the Kinesis Video Streams fragment where the customer audio stream started.

          • FragmentStopNumber (string) --

            The number that identifies the Kinesis Video Streams fragment where the customer audio stream stopped.

          • StartTimestamp (datetime) --

            When the conversation of the last leg of the recording started in UTC time.

          • StopTimestamp (datetime) --

            When the conversation of the last leg of recording stopped in UTC time.

          • Status (string) --

            The status of the recording/transcript.

          • DeletionReason (string) --

            If the recording/transcript was deleted, this is the reason entered for the deletion.

          • UnprocessedTranscriptLocation (string) --

            The location, in Amazon S3, for the unprocessed transcript if any media processing was performed.

      • DisconnectReason (string) --

        The disconnect reason for the contact. For a list and description of all the possible disconnect reasons by channel, see DisconnectReason under ContactTraceRecord in the Connect Customer Administrator Guide.

      • ContactEvaluations (dict) --

        Information about the contact evaluations where the key is the FormId, which is a unique identifier for the form.

        • (string) --

          • (dict) --

            Information about the contact evaluations where the key is the FormId, which is a unique identifier for the form.

            • FormId (string) --

              The FormId of the contact evaluation.

            • EvaluationArn (string) --

              The Amazon Resource Name for the evaluation form. It is always present.

            • Status (string) --

              The status of the evaluation.

            • StartTimestamp (datetime) --

              The date and time when the evaluation was started, in UTC time.

            • EndTimestamp (datetime) --

              The date and time when the evaluation was submitted, in UTC time.

            • DeleteTimestamp (datetime) --

              The date and time when the evaluation was deleted, in UTC time.

            • ExportLocation (string) --

              The path where evaluation was exported.

      • TaskTemplateInfo (dict) --

        If this contact was created using a task template, this contains information about the task template.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the task template used to create this contact.

        • Name (string) --

          The name of the task template used to create this contact.

      • Cases (list) --

        A list of cases associated with the contact. This field is populated when one or more cases have been linked to the contact.

        • (dict) --

          Information about a case associated with a contact.

          • CaseId (string) --

            Unique identifier of the case in UUID format.

          • CaseReferenceNumber (string) --

            A friendly number for the case. Reference numbers are not guaranteed to be unique.

      • ContactDetails (dict) --

        A map of string key/value pairs that contain user-defined attributes which are lightly typed within the contact. This object is used only for task contacts.

        • Name (string) --

          The name of the contact details.

        • Description (string) --

          Teh description of the contact details.

      • OutboundStrategy (dict) --

        Information about the outbound strategy.

        • Type (string) --

          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) --

                Countdown timer configuration after the agent accepted the preview outbound contact.

                • DurationInSeconds (integer) --

                  Duration in seconds for the countdown timer after the agent accepted the contact.

              • AllowedUserActions (list) --

                The actions the agent can perform after accepting the preview outbound contact.

                • (string) --

      • Attributes (dict) --

        The attributes of the contact.

        • (string) --

          • (string) --

      • NextContacts (list) --

        List of next contact entries for the contact.

        • (dict) --

          Entry representing the next contact in a sequence.

          • Type (string) --

            The type of the next contact entry.

          • NextContactMetadata (dict) --

            Metadata for the next contact entry.

            • QuickConnectContactData (dict) --

              Quick connect contact data for the next contact metadata.

              • ContactId (string) --

                The contact ID for quick connect contact data.

              • InitiationTimestamp (datetime) --

                Timestamp when the quick connect contact was initiated.

              • QuickConnectId (string) --

                The quick connect ID.

              • QuickConnectName (string) --

                The name of the quick connect.

              • QuickConnectType (string) --

                The type of the quick connect.

      • GlobalResiliencyMetadata (dict) --

        Information about the global resiliency configuration for the contact, including traffic distribution details.

        • ActiveRegion (string) --

          The current AWS region in which the contact is active. This indicates where the contact is being processed in real-time.

        • OriginRegion (string) --

          The AWS region where the contact was originally created and initiated. This may differ from the ActiveRegion if the contact has been transferred across regions.

        • TrafficDistributionGroupId (string) --

          The identifier of the traffic distribution group.

      • ContactLens (dict) --

        Information about the conversational analytics configuration applied to the contact. This field is present only for contacts where conversational analytics is enabled in the contact flow.

        • ConversationalAnalytics (dict) --

          The conversational analytics configuration applied to the contact.

          • Configuration (dict) --

            The conversational analytics settings that apply to the contact.

            • Enabled (boolean) --

              Specifies whether conversational analytics is enabled for the contact.

            • LanguageLocale (string) --

              The language locale that conversational analytics uses to analyze the contact (for example, en-US).

            • LanguageLocales (list) --

              The language locales that conversational analytics uses to analyze the contact (for example, en-US and es-ES).

              • (string) --

            • ChannelConfiguration (dict) --

              The per-channel conversational analytics settings for the contact.

              • AnalyticsModes (list) --

                The conversational analytics modes enabled for the channel. Valid values:

                • RealTime – Real-time analysis is enabled during the contact. Voice channel only.

                • PostContact – Post-contact analysis is enabled after the contact ends. Voice channel only.

                • ContactLens – Conversational analytics is enabled for the contact. Chat channel only.

                • (string) --

            • RedactionConfiguration (dict) --

              The redaction configuration for the contact transcript.

              • Behavior (string) --

                Specifies whether redaction is enabled for sensitive data, such as personal information, in the conversational analytics output. Valid values:

                • Enable – Redaction is applied according to the other values in this object.

                • Disable – Redaction is not applied, and all other values in this object are ignored.

              • Policy (string) --

                The redaction policy that determines which versions of the transcript are stored. Valid values:

                • None – No redaction is applied.

                • RedactedOnly – Only the redacted transcript is stored.

                • RedactedAndOriginal – Both the redacted and the original transcript are stored.

              • Entities (list) --

                The entity types to redact from the transcript (for example, NAME, EMAIL, ADDRESS).

                • (string) --

              • MaskMode (string) --

                How sensitive information is masked in the transcript. Valid values:

                • PII – All redacted entities are replaced with the [PII] string.

                • EntityType – All redacted entities are replaced with the label of the entity. For example, when the EMAIL entity is configured for redaction, emails in the transcript are replaced with the [EMAIL] string.

            • SummaryConfiguration (dict) --

              The summary configuration for the contact.

              • SummaryModes (list) --

                The conversational analytics summary modes enabled for the contact. Valid values: PostContact | AutomatedInteraction | ContactChain.

                • (string) --

            • SentimentConfiguration (dict) --

              The sentiment analysis configuration for the contact.

              • Behavior (string) --

                Specifies whether sentiment analysis is enabled for the contact. The default value is Disable. Valid values:

                • Enable – Sentiment analysis is performed on the contact.

                • Disable – Sentiment analysis is not performed on the contact.

          • ContactAnalysisReferenceState (dict) --

            The current state of conversational analytics processing for the contact.

            • Status (string) --

              The status of conversational analytics processing for the contact. Valid values:

              • REQUESTED – Analysis has been requested for the contact and has not finished.

              • COMPLETED – Analysis finished successfully.

              • FAILED – Analysis did not finish successfully. See StatusReason for the cause.

            • StatusReason (string) --

              The reason for the current analysis status. This value is populated only when the status is FAILED.

      • VoicemailInfo (dict) --

        If one or more voicemails were recorded for the contact, this contains information about the voicemails.

        • NumberOfVoicemails (integer) --

          The number of voicemails recorded for the contact. Valid range is 1-3.

DescribeRule (updated) Link ¶
Changes (response)
{'Rule': {'Actions': {'TaskAction': {'References': {'Type': {'VOICEMAIL_ANALYSIS',
                                                             'VOICEMAIL_ANALYSIS_REDACTED',
                                                             'VOICEMAIL_RECORDING',
                                                             'VOICEMAIL_RECORDING_REDACTED'}}}}}}

Describes a rule for the specified Connect Customer instance.

See also: AWS API Documentation

Request Syntax

client.describe_rule(
    InstanceId='string',
    RuleId='string'
)
type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type RuleId:

string

param RuleId:

[REQUIRED]

A unique identifier for the rule.

rtype:

dict

returns:

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'|'END_ASSOCIATED_EMAILS'|'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'|'VOICEMAIL_RECORDING'|'VOICEMAIL_RECORDING_REDACTED'|'VOICEMAIL_ANALYSIS'|'VOICEMAIL_ANALYSIS_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': {},
                'EndAssociatedEmailsAction': {},
                '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'|'CONTACT_EVALUATION',
                    '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.

          • EndAssociatedEmailsAction (dict) --

            Information about the end associated emails 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 - Filter on attributes of the contact, such as tags assigned to the contact.

              • CONTACT_EVALUATION - Filter on attributes of the contact evaluation, such as tags assigned to the contact evaluation, for rules triggered on the OnContactEvaluationSubmit event source.

            • 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) --

GetAttachedFile (updated) Link ¶
Changes (response)
{'FileUseCaseType': {'VOICEMAIL_ANALYSIS',
                     'VOICEMAIL_ANALYSIS_REDACTED',
                     'VOICEMAIL_RECORDING',
                     'VOICEMAIL_RECORDING_REDACTED'}}

Provides a pre-signed URL for download of an approved attached file. This API also returns metadata about the attached file. It will only return a downloadURL if the status of the attached file is APPROVED.

See also: AWS API Documentation

Request Syntax

client.get_attached_file(
    InstanceId='string',
    FileId='string',
    UrlExpiryInSeconds=123,
    AssociatedResourceArn='string',
    UrlContentDisposition='INLINE'|'ATTACHMENT'
)
type InstanceId:

string

param InstanceId:

[REQUIRED]

The unique identifier of the Connect Customer instance.

type FileId:

string

param FileId:

[REQUIRED]

The unique identifier of the attached file resource.

type UrlExpiryInSeconds:

integer

param UrlExpiryInSeconds:

Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.

type AssociatedResourceArn:

string

param AssociatedResourceArn:

[REQUIRED]

The resource to which the attached file is (being) uploaded to. The supported resources are Cases, Email, and Task.

type UrlContentDisposition:

string

param UrlContentDisposition:

Specifies how a browser handles the file at the pre-signed URL. The valid values are the following:

INLINE

Displays the file in the browser.

ATTACHMENT

Downloads the file. This is the default.

rtype:

dict

returns:

Response Syntax

{
    'FileArn': 'string',
    'FileId': 'string',
    'CreationTime': 'string',
    'FileStatus': 'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED'|'DRAFTING',
    'FileName': 'string',
    'FileSizeInBytes': 123,
    'AssociatedResourceArn': 'string',
    'FileUseCaseType': 'CONTACT_ANALYSIS'|'EMAIL_MESSAGE'|'EMAIL_MESSAGE_PLAIN_TEXT'|'EMAIL_MESSAGE_REDACTED'|'EMAIL_MESSAGE_PLAIN_TEXT_REDACTED'|'ATTACHMENT'|'VOICE_RECORDING'|'VOICEMAIL_RECORDING'|'VOICEMAIL_RECORDING_REDACTED'|'VOICEMAIL_ANALYSIS'|'VOICEMAIL_ANALYSIS_REDACTED',
    'CreatedBy': {
        'ConnectUserArn': 'string',
        'AWSIdentityArn': 'string'
    },
    'DownloadUrlMetadata': {
        'Url': 'string',
        'UrlExpiry': 'string'
    },
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) -- Response from GetAttachedFile API.

    • FileArn (string) --

      The unique identifier of the attached file resource (ARN).

    • FileId (string) --

      The unique identifier of the attached file resource.

    • CreationTime (string) --

      The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2024-05-03T02:41:28.172Z.

    • FileStatus (string) --

      The current status of the attached file.

    • FileName (string) --

      A case-sensitive name of the attached file being uploaded.

    • FileSizeInBytes (integer) --

      The size of the attached file in bytes.

    • AssociatedResourceArn (string) --

      The resource to which the attached file is (being) uploaded to. The supported resources are Cases, Email, and Task.

    • FileUseCaseType (string) --

      The use case for the file.

    • CreatedBy (dict) --

      Represents the identity that created the file.

      • ConnectUserArn (string) --

        An agent ARN representing a connect user.

      • AWSIdentityArn (string) --

        STS or IAM ARN representing the identity of API Caller. SDK users cannot populate this and this value is calculated automatically if ConnectUserArn is not provided.

    • DownloadUrlMetadata (dict) --

      URL and expiry to be used when downloading the attached file.

      • Url (string) --

        A pre-signed URL that should be used to download the attached file.

      • UrlExpiry (string) --

        The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

    • Tags (dict) --

      The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

      • (string) --

        • (string) --

ListContactReferences (updated) Link ¶
Changes (request, response)
Request
{'ReferenceTypes': {'VOICEMAIL_ANALYSIS',
                    'VOICEMAIL_ANALYSIS_REDACTED',
                    'VOICEMAIL_RECORDING',
                    'VOICEMAIL_RECORDING_REDACTED'}}
Response
{'ReferenceSummaryList': {'VoicemailAnalysis': {'Arn': 'string',
                                                'Name': 'string',
                                                'Status': 'AVAILABLE | DELETED '
                                                          '| APPROVED | '
                                                          'REJECTED | '
                                                          'PROCESSING | FAILED '
                                                          '| DRAFTING',
                                                'Value': 'string'},
                          'VoicemailAnalysisRedacted': {'Arn': 'string',
                                                        'Name': 'string',
                                                        'Status': 'AVAILABLE | '
                                                                  'DELETED | '
                                                                  'APPROVED | '
                                                                  'REJECTED | '
                                                                  'PROCESSING '
                                                                  '| FAILED | '
                                                                  'DRAFTING',
                                                        'Value': 'string'},
                          'VoicemailRecording': {'Arn': 'string',
                                                 'Name': 'string',
                                                 'Status': 'AVAILABLE | '
                                                           'DELETED | APPROVED '
                                                           '| REJECTED | '
                                                           'PROCESSING | '
                                                           'FAILED | DRAFTING',
                                                 'Value': 'string'},
                          'VoicemailRecordingRedacted': {'Arn': 'string',
                                                         'Name': 'string',
                                                         'Status': 'AVAILABLE '
                                                                   '| DELETED '
                                                                   '| APPROVED '
                                                                   '| REJECTED '
                                                                   '| '
                                                                   'PROCESSING '
                                                                   '| FAILED | '
                                                                   'DRAFTING',
                                                         'Value': 'string'}}}

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'|'VOICEMAIL_RECORDING'|'VOICEMAIL_RECORDING_REDACTED'|'VOICEMAIL_ANALYSIS'|'VOICEMAIL_ANALYSIS_REDACTED',
    ],
    NextToken='string'
)
type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type ContactId:

string

param ContactId:

[REQUIRED]

The identifier of the initial contact.

type ReferenceTypes:

list

param ReferenceTypes:

[REQUIRED]

The type of reference.

  • (string) --

type NextToken:

string

param NextToken:

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.

rtype:

dict

returns:

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
            },
            'VoicemailRecording': {
                'Name': 'string',
                'Value': 'string',
                'Status': 'AVAILABLE'|'DELETED'|'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED'|'DRAFTING',
                'Arn': 'string'
            },
            'VoicemailRecordingRedacted': {
                'Name': 'string',
                'Value': 'string',
                'Status': 'AVAILABLE'|'DELETED'|'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED'|'DRAFTING',
                'Arn': 'string'
            },
            'VoicemailAnalysis': {
                'Name': 'string',
                'Value': 'string',
                'Status': 'AVAILABLE'|'DELETED'|'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED'|'DRAFTING',
                'Arn': 'string'
            },
            'VoicemailAnalysisRedacted': {
                'Name': 'string',
                'Value': 'string',
                'Status': 'AVAILABLE'|'DELETED'|'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED'|'DRAFTING',
                'Arn': 'string'
            }
        },
    ],
    '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.

        • VoicemailRecording (dict) --

          Information about the reference when the referenceType is VOICEMAIL_RECORDING. Otherwise, null.

          • Name (string) --

            Identifier of the voicemail recording reference.

          • Value (string) --

            The location path of the voicemail recording reference.

          • Status (string) --

            Status of the voicemail recording reference type.

          • Arn (string) --

            The Amazon Resource Name (ARN) of the voicemail recording reference.

        • VoicemailRecordingRedacted (dict) --

          Information about the reference when the referenceType is VOICEMAIL_RECORDING_REDACTED. Otherwise, null.

          • Name (string) --

            Identifier of the voicemail recording reference.

          • Value (string) --

            The location path of the voicemail recording reference.

          • Status (string) --

            Status of the voicemail recording reference type.

          • Arn (string) --

            The Amazon Resource Name (ARN) of the voicemail recording reference.

        • VoicemailAnalysis (dict) --

          Information about the reference when the referenceType is VOICEMAIL_ANALYSIS. Otherwise, null.

          • Name (string) --

            Identifier of the voicemail analysis reference.

          • Value (string) --

            The location path of the voicemail analysis reference.

          • Status (string) --

            Status of the voicemail analysis reference type.

          • Arn (string) --

            The Amazon Resource Name (ARN) of the voicemail analysis reference.

        • VoicemailAnalysisRedacted (dict) --

          Information about the reference when the referenceType is VOICEMAIL_ANALYSIS_REDACTED. Otherwise, null.

          • Name (string) --

            Identifier of the voicemail analysis reference.

          • Value (string) --

            The location path of the voicemail analysis reference.

          • Status (string) --

            Status of the voicemail analysis reference type.

          • Arn (string) --

            The Amazon Resource Name (ARN) of the voicemail analysis reference.

    • NextToken (string) --

      If there are additional results, this is the token for the next set of results.

StartAttachedFileUpload (updated) Link ¶
Changes (request)
{'FileUseCaseType': {'VOICEMAIL_ANALYSIS',
                     'VOICEMAIL_ANALYSIS_REDACTED',
                     'VOICEMAIL_RECORDING',
                     'VOICEMAIL_RECORDING_REDACTED'}}

Provides a pre-signed Amazon S3 URL in response for uploading your content.

See also: AWS API Documentation

Request Syntax

client.start_attached_file_upload(
    ClientToken='string',
    InstanceId='string',
    FileName='string',
    FileSizeInBytes=123,
    UrlExpiryInSeconds=123,
    FileUseCaseType='CONTACT_ANALYSIS'|'EMAIL_MESSAGE'|'EMAIL_MESSAGE_PLAIN_TEXT'|'EMAIL_MESSAGE_REDACTED'|'EMAIL_MESSAGE_PLAIN_TEXT_REDACTED'|'ATTACHMENT'|'VOICE_RECORDING'|'VOICEMAIL_RECORDING'|'VOICEMAIL_RECORDING_REDACTED'|'VOICEMAIL_ANALYSIS'|'VOICEMAIL_ANALYSIS_REDACTED',
    AssociatedResourceArn='string',
    CreatedBy={
        'ConnectUserArn': 'string',
        'AWSIdentityArn': 'string'
    },
    Tags={
        'string': 'string'
    }
)
type ClientToken:

string

param ClientToken:

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.

type InstanceId:

string

param InstanceId:

[REQUIRED]

The unique identifier of the Connect Customer instance.

type FileName:

string

param FileName:

[REQUIRED]

A case-sensitive name of the attached file being uploaded.

type FileSizeInBytes:

integer

param FileSizeInBytes:

[REQUIRED]

The size of the attached file in bytes.

type UrlExpiryInSeconds:

integer

param UrlExpiryInSeconds:

Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.

type FileUseCaseType:

string

param FileUseCaseType:

[REQUIRED]

The use case for the file.

type AssociatedResourceArn:

string

param AssociatedResourceArn:

[REQUIRED]

The resource to which the attached file is (being) uploaded to. The supported resources are Cases, Email, and Task.

type CreatedBy:

dict

param CreatedBy:

Represents the identity that created the file.

  • ConnectUserArn (string) --

    An agent ARN representing a connect user.

  • AWSIdentityArn (string) --

    STS or IAM ARN representing the identity of API Caller. SDK users cannot populate this and this value is calculated automatically if ConnectUserArn is not provided.

type Tags:

dict

param Tags:

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

  • (string) --

    • (string) --

rtype:

dict

returns:

Response Syntax

{
    'FileArn': 'string',
    'FileId': 'string',
    'CreationTime': 'string',
    'FileStatus': 'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED'|'DRAFTING',
    'CreatedBy': {
        'ConnectUserArn': 'string',
        'AWSIdentityArn': 'string'
    },
    'UploadUrlMetadata': {
        'Url': 'string',
        'UrlExpiry': 'string',
        'HeadersToInclude': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) -- Response from StartAttachedFileUpload API.

    • FileArn (string) --

      The unique identifier of the attached file resource (ARN).

    • FileId (string) --

      The unique identifier of the attached file resource.

    • CreationTime (string) --

      The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2024-05-03T02:41:28.172Z.

    • FileStatus (string) --

      The current status of the attached file.

    • CreatedBy (dict) --

      Represents the identity that created the file.

      • ConnectUserArn (string) --

        An agent ARN representing a connect user.

      • AWSIdentityArn (string) --

        STS or IAM ARN representing the identity of API Caller. SDK users cannot populate this and this value is calculated automatically if ConnectUserArn is not provided.

    • UploadUrlMetadata (dict) --

      The headers to be provided while uploading the file to the URL.

      • Url (string) --

        A pre-signed S3 URL that should be used for uploading the attached file.

      • UrlExpiry (string) --

        The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

      • HeadersToInclude (dict) --

        A map of headers that should be provided when uploading the attached file.

        • (string) --

          • (string) --

StartEmailContact (updated) Link ¶
Changes (request)
{'References': {'Type': {'VOICEMAIL_ANALYSIS',
                         'VOICEMAIL_ANALYSIS_REDACTED',
                         'VOICEMAIL_RECORDING',
                         'VOICEMAIL_RECORDING_REDACTED'}}}

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'|'VOICEMAIL_RECORDING'|'VOICEMAIL_RECORDING_REDACTED'|'VOICEMAIL_ANALYSIS'|'VOICEMAIL_ANALYSIS_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'
)
type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type FromEmailAddress:

dict

param FromEmailAddress:

[REQUIRED]

The email address of the customer.

  • EmailAddress (string) -- [REQUIRED]

    The email address, including the domain.

  • DisplayName (string) --

    The display name of email address.

type DestinationEmailAddress:

string

param DestinationEmailAddress:

[REQUIRED]

The email address associated with the Connect Customer instance.

type Description:

string

param Description:

A description of the email contact.

type References:

dict

param References:

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.

type Name:

string

param Name:

The name of a email that is shown to an agent in the Contact Control Panel (CCP).

type EmailMessage:

dict

param EmailMessage:

[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) --

type AdditionalRecipients:

dict

param AdditionalRecipients:

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.

type Attachments:

list

param Attachments:

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.

type ContactFlowId:

string

param ContactFlowId:

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

type RelatedContactId:

string

param RelatedContactId:

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.

type Attributes:

dict

param Attributes:

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) --

type SegmentAttributes:

dict

param SegmentAttributes:

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.

type ClientToken:

string

param ClientToken:

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.

rtype:

dict

returns:

Response Syntax

{
    'ContactId': 'string'
}

Response Structure

  • (dict) --

    • ContactId (string) --

      The identifier of this contact within the Connect Customer instance.

StartOutboundVoiceContact (updated) Link ¶
Changes (request)
{'References': {'Type': {'VOICEMAIL_ANALYSIS',
                         'VOICEMAIL_ANALYSIS_REDACTED',
                         'VOICEMAIL_RECORDING',
                         'VOICEMAIL_RECORDING_REDACTED'}}}

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'|'VOICEMAIL_RECORDING'|'VOICEMAIL_RECORDING_REDACTED'|'VOICEMAIL_ANALYSIS'|'VOICEMAIL_ANALYSIS_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
)
type Name:

string

param Name:

The name of a voice contact that is shown to an agent in the Contact Control Panel (CCP).

type Description:

string

param Description:

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.

type References:

dict

param References:

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.

type RelatedContactId:

string

param RelatedContactId:

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.

type DestinationPhoneNumber:

string

param DestinationPhoneNumber:

[REQUIRED]

The phone number of the customer, in E.164 format.

type ContactFlowId:

string

param ContactFlowId:

[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

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type ClientToken:

string

param ClientToken:

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.

type SourcePhoneNumber:

string

param SourcePhoneNumber:

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.

type QueueId:

string

param QueueId:

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.

type Attributes:

dict

param Attributes:

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) --

type AnswerMachineDetectionConfig:

dict

param AnswerMachineDetectionConfig:

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.

type CampaignId:

string

param CampaignId:

The campaign identifier of the outbound communication.

type TrafficType:

string

param TrafficType:

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.

type OutboundStrategy:

dict

param OutboundStrategy:

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) --

type RingTimeoutInSeconds:

integer

param RingTimeoutInSeconds:

The maximum time the outbound call will wait for the destination to answer the call, in seconds

rtype:

dict

returns:

Response Syntax

{
    'ContactId': 'string'
}

Response Structure

  • (dict) --

    • ContactId (string) --

      The identifier of this contact within the Connect Customer instance.

StartTaskContact (updated) Link ¶
Changes (request)
{'References': {'Type': {'VOICEMAIL_ANALYSIS',
                         'VOICEMAIL_ANALYSIS_REDACTED',
                         'VOICEMAIL_RECORDING',
                         'VOICEMAIL_RECORDING_REDACTED'}}}

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'|'VOICEMAIL_RECORDING'|'VOICEMAIL_RECORDING_REDACTED'|'VOICEMAIL_ANALYSIS'|'VOICEMAIL_ANALYSIS_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'
        },
    ]
)
type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type PreviousContactId:

string

param PreviousContactId:

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.

type ContactFlowId:

string

param ContactFlowId:

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

type Attributes:

dict

param Attributes:

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) --

type Name:

string

param Name:

[REQUIRED]

The name of a task that is shown to an agent in the Contact Control Panel (CCP).

type References:

dict

param References:

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.

type Description:

string

param Description:

A description of the task that is shown to an agent in the Contact Control Panel (CCP).

type ClientToken:

string

param ClientToken:

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.

type ScheduledTime:

datetime

param ScheduledTime:

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.

type TaskTemplateId:

string

param TaskTemplateId:

A unique identifier for the task template. For more information about task templates, see Create task templates in the Connect Customer Administrator Guide.

type QuickConnectId:

string

param QuickConnectId:

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.

type RelatedContactId:

string

param RelatedContactId:

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.

type SegmentAttributes:

dict

param SegmentAttributes:

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.

type Attachments:

list

param Attachments:

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.

rtype:

dict

returns:

Response Syntax

{
    'ContactId': 'string'
}

Response Structure

  • (dict) --

    • ContactId (string) --

      The identifier of this contact within the Connect Customer instance.

StartWebRTCContact (updated) Link ¶
Changes (request)
{'References': {'Type': {'VOICEMAIL_ANALYSIS',
                         'VOICEMAIL_ANALYSIS_REDACTED',
                         'VOICEMAIL_RECORDING',
                         'VOICEMAIL_RECORDING_REDACTED'}}}

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'|'VOICEMAIL_RECORDING'|'VOICEMAIL_RECORDING_REDACTED'|'VOICEMAIL_ANALYSIS'|'VOICEMAIL_ANALYSIS_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'
        }
    }
)
type Attributes:

dict

param Attributes:

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) --

type ClientToken:

string

param ClientToken:

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.

type ContactFlowId:

string

param ContactFlowId:

[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

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type AllowedCapabilities:

dict

param AllowedCapabilities:

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.

type ParticipantDetails:

dict

param ParticipantDetails:

[REQUIRED]

The details of the participant, including their display name.

  • DisplayName (string) -- [REQUIRED]

    Display name of the participant.

type RelatedContactId:

string

param RelatedContactId:

The unique identifier for an Connect Customer contact. This identifier is related to the contact starting.

type References:

dict

param References:

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.

type Description:

string

param Description:

A description of the task that is shown to an agent in the Contact Control Panel (CCP).

type SegmentAttributes:

dict

param SegmentAttributes:

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.

rtype:

dict

returns:

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.

UpdateContact (updated) Link ¶
Changes (request)
{'References': {'Type': {'VOICEMAIL_ANALYSIS',
                         'VOICEMAIL_ANALYSIS_REDACTED',
                         'VOICEMAIL_RECORDING',
                         'VOICEMAIL_RECORDING_REDACTED'}}}

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'|'VOICEMAIL_RECORDING'|'VOICEMAIL_RECORDING_REDACTED'|'VOICEMAIL_ANALYSIS'|'VOICEMAIL_ANALYSIS_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'
            },
        ]
    }
)
type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type ContactId:

string

param ContactId:

[REQUIRED]

The identifier of the contact. This is the identifier of the contact associated with the first interaction with your contact center.

type Name:

string

param Name:

The name of the contact.

type Description:

string

param Description:

The description of the contact.

type References:

dict

param References:

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.

type SegmentAttributes:

dict

param SegmentAttributes:

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.

type QueueInfo:

dict

param QueueInfo:

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.

type UserInfo:

dict

param UserInfo:

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.

type CustomerEndpoint:

dict

param CustomerEndpoint:

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.

type SystemEndpoint:

dict

param SystemEndpoint:

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.

type AdditionalRecipients:

dict

param AdditionalRecipients:

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.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

UpdateRule (updated) Link ¶
Changes (request)
{'Actions': {'TaskAction': {'References': {'Type': {'VOICEMAIL_ANALYSIS',
                                                    'VOICEMAIL_ANALYSIS_REDACTED',
                                                    'VOICEMAIL_RECORDING',
                                                    'VOICEMAIL_RECORDING_REDACTED'}}}}}

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'|'END_ASSOCIATED_EMAILS'|'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'|'VOICEMAIL_RECORDING'|'VOICEMAIL_RECORDING_REDACTED'|'VOICEMAIL_ANALYSIS'|'VOICEMAIL_ANALYSIS_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': {}
            ,
            'EndAssociatedEmailsAction': {}
            ,
            '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'|'CONTACT_EVALUATION',
                'FilterType': 'TAG',
                'FilterKey': 'string',
                'FilterValue': 'string',
                'Operator': 'EQUALS'
            },
        ]
    }
)
type RuleId:

string

param RuleId:

[REQUIRED]

A unique identifier for the rule.

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type Name:

string

param Name:

[REQUIRED]

The name of the rule. You can change the name only if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate

type Function:

string

param Function:

[REQUIRED]

The conditions of the rule.

type Actions:

list

param Actions:

[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.

    • EndAssociatedEmailsAction (dict) --

      Information about the end associated emails 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.

type PublishStatus:

string

param PublishStatus:

[REQUIRED]

The publish status of the rule.

type PreEvaluationFilters:

dict

param PreEvaluationFilters:

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 - Filter on attributes of the contact, such as tags assigned to the contact.

        • CONTACT_EVALUATION - Filter on attributes of the contact evaluation, such as tags assigned to the contact evaluation, for rules triggered on the OnContactEvaluationSubmit event source.

      • 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.

returns:

None