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.

</note>

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'
        }
    },
    domainId='string',
    performedBy={
        'userArn': 'string'
    },
    type='Contact'|'Comment'|'File'
)

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.

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

• 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