ConnectCases / Client / put_case_event_configuration

put_case_event_configuration#

ConnectCases.Client.put_case_event_configuration(**kwargs)#

Adds case event publishing configuration. For a complete list of fields you can add to the event message, see Create case fields in the Amazon Connect Administrator Guide

See also: AWS API Documentation

Request Syntax

response = client.put_case_event_configuration(
    domainId='string',
    eventBridge={
        'enabled': True|False,
        'includedData': {
            'caseData': {
                'fields': [
                    {
                        'id': 'string'
                    },
                ]
            },
            'relatedItemData': {
                'includeContent': True|False
            }
        }
    }
)
Parameters:

  • domainId (string) –

    [REQUIRED]

    The unique identifier of the Cases domain.

  • eventBridge (dict) –

    [REQUIRED]

    Configuration to enable EventBridge case event delivery and determine what data is delivered.

    • enabled (boolean) – [REQUIRED]

      Indicates whether the to broadcast case event data to the customer.

    • includedData (dict) –

      Details of what case and related item data is published through the case event stream.

      • caseData (dict) –

        Details of what case data is published through the case event stream.

        • fields (list) – [REQUIRED]

          List of field identifiers.

          • (dict) –

            Object for unique identifier of a field.

            • id (string) – [REQUIRED]

              Unique identifier of a field.

      • relatedItemData (dict) –

        Details of what related item data is published through the case event stream.

        • includeContent (boolean) – [REQUIRED]

          Details of what related item data is published through the case event stream.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions