<a id="cli-aws-connectcases-create-related-item"></a>

# create-related-item

## Description

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](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#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](https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeContact.html) 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](https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html) permission on the ARN of the user that you provide.
* If the case is the secondary case of a merge that is running, the request fails with a `ConflictException` . For more information, see [StartMergeCases](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_StartMergeCases.html) .

> **Endpoints** : See [Connect Customer endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/connect_region.html) .

See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/connectcases-2022-10-03/CreateRelatedItem)

## Synopsis

```
  create-related-item
--domain-id <value>
--case-id <value>
--type <value>
--content <value>
[--performed-by <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]
```

## Options

`--domain-id` (string) [required]

> The unique identifier of the Cases domain.

> Constraints:

> * min: `1`
> * max: `500`

`--case-id` (string) [required]

> A unique identifier of the case.

> Constraints:

> * min: `1`
> * max: `500`
> * pattern: `[A-Za-z0-9\-._/:#=+-]*`

`--type` (string) [required]

> The type of a related item.

> Possible values:

> * `Contact`
> * `Comment`
> * `File`
> * `Sla`
> * `ConnectCase`
> * `Custom`

`--content` (tagged union structure) [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: `contact`, `comment`, `file`, `sla`, `connectCase`, `custom`.

> contact -> (structure)

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

> > contactArn -> (string) [required]

> > > A unique identifier of a contact in Connect Customer.

> > > Constraints:

> > > * min: `1`
> > > * max: `500`

> comment -> (structure)

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

> > body -> (string) [required]

> > > Text in the body of a `Comment` on a case.

> > > Constraints:

> > > * min: `1`
> > > * max: `15000`

> > contentType -> (string) [required]

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

> > > Possible values:

> > > * `Text/Plain`

> file -> (structure)

> > A file of related items.

> > fileArn -> (string) [required]

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

> > > Constraints:

> > > * min: `1`
> > > * max: `500`

> sla -> (tagged union structure)

> > 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 -> (structure)

> > > Represents an input SLA configuration.

> > > name -> (string) [required]

> > > > Name of an SLA.

> > > > Constraints:

> > > > * min: `1`
> > > > * max: `500`
> > > > * pattern: `.*[\S]`

> > > type -> (string) [required]

> > > > Type of SLA.

> > > > Possible values:

> > > > * `CaseField`

> > > fieldId -> (string)

> > > > Unique identifier of a field.

> > > > Constraints:

> > > > * min: `1`
> > > > * max: `500`

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

> > > > Constraints:

> > > > * min: `1`
> > > > * max: `1`

> > > > (tagged union structure)

> > > > > Object to store union of Field values.

> > > > > #### NOTE
> > > > > The `Summary` system field accepts up to 3000 characters, while all other fields accept up to 4100 characters. If you use multi-byte characters, the effective character limit may be lower.

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

> > > > > stringValue -> (string)

> > > > > > String value type.

> > > > > > Constraints:

> > > > > > * min: `0`
> > > > > > * max: `4100`

> > > > > doubleValue -> (double)

> > > > > > 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 -> (structure)

> > > > > > An empty value.

> > > > > userArnValue -> (string)

> > > > > > Represents the user that performed the audit.

> > > targetSlaMinutes -> (long) [required]

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

> > > > Constraints:

> > > > * min: `1`
> > > > * max: `1051200`

> connectCase -> (structure)

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

> > caseId -> (string) [required]

> > > A unique identifier of the case.

> > > Constraints:

> > > * min: `1`
> > > * max: `500`
> > > * pattern: `[A-Za-z0-9\-._/:#=+-]*`

> custom -> (structure)

> > Represents the content of a `Custom` type related item.

> > fields -> (list) [required]

> > > List of field values for the `Custom` related item.

> > > Constraints:

> > > * min: `1`
> > > * max: `50`

> > > (structure)

> > > > Object for case field values.

> > > > id -> (string) [required]

> > > > > Unique identifier of a field.

> > > > > Constraints:

> > > > > * min: `1`
> > > > > * max: `500`

> > > > value -> (tagged union structure) [required]

> > > > > Union of potential field value types.

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

> > > > > stringValue -> (string)

> > > > > > String value type.

> > > > > > Constraints:

> > > > > > * min: `0`
> > > > > > * max: `4100`

> > > > > doubleValue -> (double)

> > > > > > 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 -> (structure)

> > > > > > An empty value.

> > > > > userArnValue -> (string)

> > > > > > Represents the user that performed the audit.

JSON Syntax:

```json
{
  "contact": {
    "contactArn": "string"
  },
  "comment": {
    "body": "string",
    "contentType": "Text/Plain"
  },
  "file": {
    "fileArn": "string"
  },
  "sla": {
    "slaInputConfiguration": {
      "name": "string",
      "type": "CaseField",
      "fieldId": "string",
      "targetFieldValues": [
        {
          "stringValue": "string",
          "doubleValue": double,
          "booleanValue": true|false,
          "emptyValue": {

          },
          "userArnValue": "string"
        }
        ...
      ],
      "targetSlaMinutes": long
    }
  },
  "connectCase": {
    "caseId": "string"
  },
  "custom": {
    "fields": [
      {
        "id": "string",
        "value": {
          "stringValue": "string",
          "doubleValue": double,
          "booleanValue": true|false,
          "emptyValue": {

          },
          "userArnValue": "string"
        }
      }
      ...
    ]
  }
}
```

`--performed-by` (tagged union structure)

> 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`, `customEntity`.

> userArn -> (string)

> > Represents the Connect Customer ARN of the user.

> > Constraints:

> > * min: `1`
> > * max: `500`

> customEntity -> (string)

> > Any provided entity.

> > Constraints:

> > * min: `1`
> > * max: `500`
> > * pattern: `[a-zA-Z0-9_\-\.@:/ ]*[a-zA-Z0-9_\-\.@:/]`

Shorthand Syntax:

```
userArn=string,customEntity=string
```

JSON Syntax:

```json
{
  "userArn": "string",
  "customEntity": "string"
}
```

`--cli-input-json` | `--cli-input-yaml` (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by `--generate-cli-skeleton`. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with `--cli-input-yaml`.

`--generate-cli-skeleton` (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value `input`, prints a sample input JSON that can be used as an argument for `--cli-input-json`. Similarly, if provided `yaml-input` it will print a sample input YAML that can be used with `--cli-input-yaml`. If provided with the value `output`, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

## Global Options

`--debug` (boolean)

Turn on debug logging.

`--endpoint-url` (string)

Override command’s default URL with the given URL.

`--no-verify-ssl` (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

`--no-paginate` (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

`--output` (string)

The formatting style for command output.

* json
* text
* table
* yaml
* yaml-stream
* off

`--query` (string)

A JMESPath query to use in filtering the response data.

`--profile` (string)

Use a specific profile from your credential file.

`--region` (string)

The region to use. Overrides config/env settings.

`--version` (string)

Display the version of this tool.

`--color` (string)

Turn on/off color output.

* on
* off
* auto

`--no-sign-request` (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

`--ca-bundle` (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

`--cli-read-timeout` (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

`--cli-connect-timeout` (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

`--cli-binary-format` (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob `fileb://` will always be treated as binary and use the file contents directly regardless of the `cli-binary-format` setting. When using `file://` the file contents will need to properly formatted for the configured `cli-binary-format`.

* base64
* raw-in-base64-out

`--no-cli-pager` (boolean)

Disable cli pager for output.

`--cli-auto-prompt` (boolean)

Automatically prompt for CLI input parameters.

`--no-cli-auto-prompt` (boolean)

Disable automatically prompt for CLI input parameters.

`--cli-error-format` (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

* legacy
* json
* yaml
* text
* table
* enhanced

`--help` (boolean)

Display help for the command/subcommand.

## Output

relatedItemId -> (string)

> The unique identifier of the related item.

> Constraints:

> * min: `1`
> * max: `500`

relatedItemArn -> (string)

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

> Constraints:

> * min: `1`
> * max: `500`