Amazon Connect Cases

2026/11/19 - Amazon Connect Cases - 1 updated api methods

Changes  This release adds support for SLAs that track any single-select field, including custom fields, and for updating the target duration of an SLA with the UpdateRelatedItem API.

UpdateRelatedItem (updated) Link ΒΆ
Changes (request)
{'content': {'sla': {'slaUpdateConfiguration': {'targetSlaMinutes': 'long'}}}}

Updates the content of a related item associated with a case. The following related item types are supported:

  • Comment - Update the text content of an existing comment

  • Custom - Update the fields of a custom related item. You can add, modify, and remove fields from a custom related item. There's a quota for the number of fields allowed in a Custom type related item. See Connect Customer Cases quotas.

  • Sla - Update the target duration ( targetSlaMinutes) of an SLA. The new deadline is counted from when the SLA was created. The SLA status is recalculated against the new deadline: an open SLA becomes Active or Overdue, and a completed SLA becomes Met or NotMet.

Important things to know

  • When updating a Custom related item, all existing and new fields, and their associated values should be included in the request. Fields not included as part of this request will be removed.

  • If you provide a value for performedBy.userArn, you must also have DescribeUser permission on the ARN of the user that you provide.

  • System case fields cannot be used in a custom related item.

  • If the case is the secondary case of a merge that is running, the request fails with a ConflictException. For more information, see StartMergeCases.

Endpoints: See Connect Customer endpoints and quotas.

See also: AWS API Documentation

Request Syntax

client.update_related_item(
    domainId='string',
    caseId='string',
    relatedItemId='string',
    content={
        'comment': {
            'body': 'string',
            'contentType': 'Text/Plain'
        },
        'custom': {
            'fields': [
                {
                    'id': 'string',
                    'value': {
                        'stringValue': 'string',
                        'doubleValue': 123.0,
                        'booleanValue': True|False,
                        'emptyValue': {}
                        ,
                        'userArnValue': 'string'
                    }
                },
            ]
        },
        'sla': {
            'slaUpdateConfiguration': {
                'targetSlaMinutes': 123
            }
        }
    },
    performedBy={
        'userArn': 'string',
        'customEntity': 'string'
    }
)
type domainId:

string

param domainId:

[REQUIRED]

The unique identifier of the Cases domain.

type caseId:

string

param caseId:

[REQUIRED]

A unique identifier of the case.

type relatedItemId:

string

param relatedItemId:

[REQUIRED]

Unique identifier of a related item.

type content:

dict

param content:

[REQUIRED]

The content of a related item to be updated.

  • comment (dict) --

    Represents the updated content of a Comment related item.

    • body (string) -- [REQUIRED]

      Updated text in the body of a Comment on a case.

    • contentType (string) -- [REQUIRED]

      Type of the text in the box of a Comment on a case.

  • custom (dict) --

    Represents the updated content of a Custom related item.

    • fields (list) -- [REQUIRED]

      List of updated field values for the Custom related item. All existing and new fields, and their associated values should be included. Fields not included as part of this request will be removed.

      • (dict) --

        Object for case field values.

        • id (string) -- [REQUIRED]

          Unique identifier of a field.

        • value (dict) -- [REQUIRED]

          Union of potential field value types.

          • stringValue (string) --

            String value type.

          • doubleValue (float) --

            Can be either null, or have a Double number value type. Only one value can be provided.

          • booleanValue (boolean) --

            Can be either null, or have a Boolean value type. Only one value can be provided.

          • emptyValue (dict) --

            An empty value.

          • userArnValue (string) --

            Represents the user that performed the audit.

  • sla (dict) --

    Represents the content of an SLA to be updated.

    • slaUpdateConfiguration (dict) --

      Represents the SLA configuration to update.

      • targetSlaMinutes (integer) -- [REQUIRED]

        New target duration in minutes within which an SLA should be completed. The new deadline is counted from when the SLA was created.

type performedBy:

dict

param performedBy:

Represents the user who performed the update of the related item.

  • userArn (string) --

    Represents the Connect Customer ARN of the user.

  • customEntity (string) --

    Any provided entity.

rtype:

dict

returns:

Response Syntax

{
    'relatedItemId': 'string',
    'relatedItemArn': 'string',
    'type': 'Contact'|'Comment'|'File'|'Sla'|'ConnectCase'|'Custom',
    'content': {
        'contact': {
            'contactArn': 'string',
            'channel': 'string',
            'connectedToSystemTime': datetime(2015, 1, 1)
        },
        'comment': {
            'body': 'string',
            'contentType': 'Text/Plain'
        },
        'file': {
            'fileArn': 'string'
        },
        'sla': {
            'slaConfiguration': {
                'name': 'string',
                'type': 'CaseField',
                'status': 'Active'|'Overdue'|'Met'|'NotMet',
                'fieldId': 'string',
                'targetFieldValues': [
                    {
                        'stringValue': 'string',
                        'doubleValue': 123.0,
                        'booleanValue': True|False,
                        'emptyValue': {},
                        'userArnValue': 'string'
                    },
                ],
                'targetTime': datetime(2015, 1, 1),
                'completionTime': datetime(2015, 1, 1)
            }
        },
        'connectCase': {
            'caseId': 'string'
        },
        'custom': {
            'fields': [
                {
                    'id': 'string',
                    'value': {
                        'stringValue': 'string',
                        'doubleValue': 123.0,
                        'booleanValue': True|False,
                        'emptyValue': {},
                        'userArnValue': 'string'
                    }
                },
            ]
        }
    },
    'associationTime': datetime(2015, 1, 1),
    'tags': {
        'string': 'string'
    },
    'lastUpdatedUser': {
        'userArn': 'string',
        'customEntity': 'string'
    },
    'createdBy': {
        'userArn': 'string',
        'customEntity': 'string'
    }
}

Response Structure

  • (dict) --

    • relatedItemId (string) --

      The unique identifier of the updated related item.

    • relatedItemArn (string) --

      The Amazon Resource Name (ARN) of the updated related item.

    • type (string) --

      Type of the updated related item.

    • content (dict) --

      Represents the content of the updated related item.

      • contact (dict) --

        Represents the content of a contact to be returned to agents.

        • contactArn (string) --

          A unique identifier of a contact in Connect Customer.

        • channel (string) --

          A list of channels to filter on for related items of type Contact.

        • connectedToSystemTime (datetime) --

          The difference between the InitiationTimestamp and the DisconnectTimestamp of the contact.

      • comment (dict) --

        Represents the content of a comment to be returned to agents.

        • body (string) --

          Text in the body of a Comment on a case.

        • contentType (string) --

          Type of the text in the box of a Comment on a case.

      • file (dict) --

        Represents the content of a File to be returned to agents.

        • fileArn (string) --

          The Amazon Resource Name (ARN) of a File in Connect Customer.

      • sla (dict) --

        Represents the content of an SLA to be returned to agents.

        • slaConfiguration (dict) --

          Represents an SLA configuration.

          • name (string) --

            Name of an SLA.

          • type (string) --

            Type of SLA.

          • status (string) --

            Status of an SLA.

          • fieldId (string) --

            Unique identifier of a field.

          • targetFieldValues (list) --

            Represents a list of target field values for the fieldId specified in SlaConfiguration.

            • (dict) --

              Object to store union of Field values.

              • stringValue (string) --

                String value type.

              • doubleValue (float) --

                Can be either null, or have a Double number value type. Only one value can be provided.

              • booleanValue (boolean) --

                Can be either null, or have a Boolean value type. Only one value can be provided.

              • emptyValue (dict) --

                An empty value.

              • userArnValue (string) --

                Represents the user that performed the audit.

          • targetTime (datetime) --

            Target time by which an SLA should be completed.

          • completionTime (datetime) --

            Time at which an SLA was completed.

      • connectCase (dict) --

        Represents the Connect Customer case to be created as a related item.

        • caseId (string) --

          A unique identifier of the case.

      • custom (dict) --

        Represents the content of a Custom type related item.

        • fields (list) --

          List of field values for the Custom related item.

          • (dict) --

            Object for case field values.

            • id (string) --

              Unique identifier of a field.

            • value (dict) --

              Union of potential field value types.

              • stringValue (string) --

                String value type.

              • doubleValue (float) --

                Can be either null, or have a Double number value type. Only one value can be provided.

              • booleanValue (boolean) --

                Can be either null, or have a Boolean value type. Only one value can be provided.

              • emptyValue (dict) --

                An empty value.

              • userArnValue (string) --

                Represents the user that performed the audit.

    • associationTime (datetime) --

      Time at which the related item was associated with the case.

    • tags (dict) --

      A map of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

      • (string) --

        • (string) --

    • lastUpdatedUser (dict) --

      Represents the last user that updated the related item.

      • userArn (string) --

        Represents the Connect Customer ARN of the user.

      • customEntity (string) --

        Any provided entity.

    • createdBy (dict) --

      Represents the creator of the related item.

      • userArn (string) --

        Represents the Connect Customer ARN of the user.

      • customEntity (string) --

        Any provided entity.