Amazon Connect Cases

2026/11/17 - Amazon Connect Cases - 2 updated api methods

Changes  PutCaseEventConfiguration now supports an optional autoIncludeFields attribute on case event included data. Set it to All, System, or Custom to automatically include a category of case fields in case event data, combined as a union with any fields you list explicitly.

GetCaseEventConfiguration (updated) Link ¶
Changes (response)
{'eventBridge': {'includedData': {'caseData': {'autoIncludeFields': 'All | '
                                                                    'System | '
                                                                    'Custom'}}}}

Returns the case event publishing configuration.

See also: AWS API Documentation

Request Syntax

client.get_case_event_configuration(
    domainId='string'
)
type domainId:

string

param domainId:

[REQUIRED]

The unique identifier of the Cases domain.

rtype:

dict

returns:

Response Syntax

{
    'eventBridge': {
        'enabled': True|False,
        'includedData': {
            'caseData': {
                'fields': [
                    {
                        'id': 'string'
                    },
                ],
                'autoIncludeFields': 'All'|'System'|'Custom'
            },
            '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 to include in case event data.

            • (dict) --

              Object for unique identifier of a field.

              • id (string) --

                Unique identifier of a field.

          • autoIncludeFields (string) --

            Automatically include a category of fields in case event data, combined as a union with any fields specified in fields. Valid values are All (include all fields on the case), System (include all system fields), and Custom (include all custom fields). When this attribute is set, new fields added to the domain are picked up automatically without another call to PutCaseEventConfiguration. For the full behavior matrix and IAM requirements, see Case event streams in Connect Customer Cases in the Connect Customer Administrator Guide.

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

PutCaseEventConfiguration (updated) Link ¶
Changes (request)
{'eventBridge': {'includedData': {'caseData': {'autoIncludeFields': 'All | '
                                                                    'System | '
                                                                    'Custom'}}}}

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

See also: AWS API Documentation

Request Syntax

client.put_case_event_configuration(
    domainId='string',
    eventBridge={
        'enabled': True|False,
        'includedData': {
            'caseData': {
                'fields': [
                    {
                        'id': 'string'
                    },
                ],
                'autoIncludeFields': 'All'|'System'|'Custom'
            },
            'relatedItemData': {
                'includeContent': True|False
            }
        }
    }
)
type domainId:

string

param domainId:

[REQUIRED]

The unique identifier of the Cases domain.

type eventBridge:

dict

param eventBridge:

[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 to include in case event data.

        • (dict) --

          Object for unique identifier of a field.

          • id (string) -- [REQUIRED]

            Unique identifier of a field.

      • autoIncludeFields (string) --

        Automatically include a category of fields in case event data, combined as a union with any fields specified in fields. Valid values are All (include all fields on the case), System (include all system fields), and Custom (include all custom fields). When this attribute is set, new fields added to the domain are picked up automatically without another call to PutCaseEventConfiguration. For the full behavior matrix and IAM requirements, see Case event streams in Connect Customer Cases in the Connect Customer Administrator Guide.

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

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --