ConnectCases / Client / get_case_event_configuration

get_case_event_configuration#

ConnectCases.Client.get_case_event_configuration(**kwargs)#

Returns the case event publishing configuration.

See also: AWS API Documentation

Request Syntax

response = client.get_case_event_configuration(
    domainId='string'
)
Parameters:

domainId (string) –

[REQUIRED]

The unique identifier of the Cases domain.

Return type:

dict

Returns:

Response Syntax

{
    'eventBridge': {
        'enabled': True|False,
        'includedData': {
            'caseData': {
                'fields': [
                    {
                        'id': 'string'
                    },
                ]
            },
            'relatedItemData': {
                'includeContent': True|False
            }
        }
    }
}

Response Structure

  • (dict) –

    • eventBridge (dict) –

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

      • enabled (boolean) –

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

            List of field identifiers.

            • (dict) –

              Object for unique identifier of a field.

              • id (string) –

                Unique identifier of a field.

        • relatedItemData (dict) –

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

          • includeContent (boolean) –

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

Exceptions