ConnectCases / Client / create_related_item

create_related_item

ConnectCases.Client.create_related_item(**kwargs)

Creates a related item (comments, tasks, and contacts) and associates it with a case.

Note

• A Related Item is a resource that is associated with a case. It may or may not have an external identifier linking it to an external resource (for example, a contactArn). All Related Items have their own internal identifier, the relatedItemArn. Examples of related items include comments and contacts.

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

• The type field is reserved for internal use only.

See also: AWS API Documentation

Request Syntax

response = client.create_related_item(
    caseId='string',
    content={
        'comment': {
            'body': 'string',
            'contentType': 'Text/Plain'
        },
        'contact': {
            'contactArn': 'string'
        },
        'file': {
            'fileArn': 'string'
        },
        'sla': {
            'slaInputConfiguration': {
                'fieldId': 'string',
                'name': 'string',
                'targetFieldValues': [
                    {
                        'booleanValue': True|False,
                        'doubleValue': 123.0,
                        'emptyValue': {}
                        ,
                        'stringValue': 'string',
                        'userArnValue': 'string'
                    },
                ],
                'targetSlaMinutes': 123,
                'type': 'CaseField'
            }
        }
    },
    domainId='string',
    performedBy={
        'userArn': 'string'
    },
    type='Contact'|'Comment'|'File'|'Sla'
)

Parameters:

• caseId (string) –

  [REQUIRED]

  A unique identifier of the case.

• content (dict) –

  [REQUIRED]

  The content of a related item to be created.

  Note

  This is a Tagged Union structure. Only one of the following top level keys can be set: comment, contact, file, sla.

  • comment (dict) –

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

    • body (string) – [REQUIRED]

      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.

  • contact (dict) –

    Object representing a contact in Amazon Connect as an API request field.

    • contactArn (string) – [REQUIRED]

      A unique identifier of a contact in Amazon Connect.

  • file (dict) –

    A file of related items.

    • fileArn (string) – [REQUIRED]

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

  • sla (dict) –

    Represents the content of an SLA to be created.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: slaInputConfiguration.

    • slaInputConfiguration (dict) –

      Represents an input SLA configuration.

      • fieldId (string) –

        Unique identifier of a field.

      • name (string) – [REQUIRED]

        Name of an SLA.

      • targetFieldValues (list) –

        Represents a list of target field values for the fieldId specified in SlaInputConfiguration. 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.

          Note

          The Summary system field accepts 3000 characters while all other fields accept 500 characters.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: booleanValue, doubleValue, emptyValue, stringValue, userArnValue.

          • booleanValue (boolean) –

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

          • doubleValue (float) –

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

          • emptyValue (dict) –

            An empty value.

          • stringValue (string) –

            String value type.

          • userArnValue (string) –

            Represents the user that performed the audit.

      • targetSlaMinutes (integer) – [REQUIRED]

        Target duration in minutes within which an SLA should be completed.

      • type (string) – [REQUIRED]

        Type of SLA.

• domainId (string) –

  [REQUIRED]

  The unique identifier of the Cases domain.

• performedBy (dict) –

  Represents the creator of the related item.

  Note

  This is a Tagged Union structure. Only one of the following top level keys can be set: userArn.

  • userArn (string) –

    Represents the Amazon Connect ARN of the user.

• type (string) –

  [REQUIRED]

  The type of a related item.

Return type:

dict

Returns:

Response Syntax

{
    'relatedItemArn': 'string',
    'relatedItemId': 'string'
}

Response Structure

• (dict) –

  • relatedItemArn (string) –

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

  • relatedItemId (string) –

    The unique identifier of the related item.

Exceptions

• ConnectCases.Client.exceptions.InternalServerException

• ConnectCases.Client.exceptions.ResourceNotFoundException

• ConnectCases.Client.exceptions.ValidationException

• ConnectCases.Client.exceptions.ThrottlingException

• ConnectCases.Client.exceptions.AccessDeniedException

• ConnectCases.Client.exceptions.ServiceQuotaExceededException