Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . connectcases ]

create-related-item

Description

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

Synopsis

  create-related-item
--case-id <value>
--content <value>
--domain-id <value>
[--performed-by <value>]
--type <value>
[--cli-input-json <value>]
[--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>]

Options

--case-id (string)

A unique identifier of the case.

--content (tagged union structure)

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

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.

contact -> (structure)

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

contactArn -> (string)

A unique identifier of a contact in Amazon Connect.

file -> (structure)

A file of related items.

fileArn -> (string)

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

Shorthand Syntax:

comment={body=string,contentType=string},contact={contactArn=string},file={fileArn=string}

JSON Syntax:

{
  "comment": {
    "body": "string",
    "contentType": "Text/Plain"
  },
  "contact": {
    "contactArn": "string"
  },
  "file": {
    "fileArn": "string"
  }
}

--domain-id (string)

The unique identifier of the Cases domain.

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

userArn -> (string)

Represents the Amazon Connect ARN of the user.

Shorthand Syntax:

userArn=string

JSON Syntax:

{
  "userArn": "string"
}

--type (string)

The type of a related item.

Possible values:

• Contact
• Comment
• File

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

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

Output

relatedItemArn -> (string)

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

relatedItemId -> (string)

The unique identifier of the related item.