View a markdown version of this page

AWS::Cases::RelatedItem - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Cases::RelatedItem

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

There's a quota for the number of fields allowed in a Custom type related item. See Connect Customer Cases quotas.

Use cases

Following are examples of related items that you may want to associate with a case:

  • Related contacts, such as calls, chats, emails tasks

  • Comments, for agent notes

  • SLAs, to capture target resolution goals

  • Cases, to capture related Connect Customer Cases

  • Files, such as policy documentation or customer-provided attachments

  • Custom related items, which provide flexibility for you to define related items that such as bookings, orders, products, notices, and more

Important things to know

  • If you are associating a contact to a case by passing in Contact for a type, you must have DescribeContact permission on the ARN of the contact that you provide in content.contact.contactArn.

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

Endpoints: See Connect Customer endpoints and quotas.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Cases::RelatedItem",
  "Properties" : {
      "CaseId" : String,
      "Content" : RelatedItemContent,
      "DomainId" : String,
      "Tags" : [ Tag, ... ],
      "Type" : String
    }
}

YAML

Type: AWS::Cases::RelatedItem
Properties:
  CaseId: String
  Content: 
    RelatedItemContent
  DomainId: String
  Tags: 
    - Tag
  Type: String

Properties

CaseId

A unique identifier of the case.

Required: Yes

Type: String

Minimum: 1

Maximum: 500

Update requires: Replacement

Content

Represents the content of a particular type of related item.

Required: Yes

Type: RelatedItemContent

Update requires: Replacement

DomainId

Property description not available.

Required: Yes

Type: String

Minimum: 1

Maximum: 500

Update requires: Replacement

Tags

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

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Type

Type of a related item.

Required: Yes

Type: String

Allowed values: Contact | Comment | File | Sla | ConnectCase | Custom

Update requires: Replacement

Return values

Ref

Fn::GetAtt

RelatedItemArn

Property description not available.

RelatedItemId

Unique identifier of a related item.