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

Description

Note

If you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser permission on the User ARN resource that you provide

<p>Creates a case in the specified Cases domain. Case system and custom fields are taken as an array id/value pairs with a declared data types.</p> <p>The following fields are required when creating a case:</p> <ul> <li> <p> <code>customer_id</code> - You must provide the full customer profile ARN in this format: <code>arn:aws:profile:your_AWS_Region:your_AWS_account ID:domains/your_profiles_domain_name/profiles/profile_ID</code> </p> </li> <li> <p> <code>title</code> </p> </li> </ul>

See also: AWS API Documentation

Synopsis

  create-case
[--client-token <value>]
--domain-id <value>
--fields <value>
[--performed-by <value>]
--template-id <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

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs .

--domain-id (string)

The unique identifier of the Cases domain.

--fields (list)

An array of objects with field ID (matching ListFields/DescribeField) and value union data.

(structure)

Object for case field values.

id -> (string)

Unique identifier of a field.

value -> (tagged union structure)

Union of potential field value types.

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

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

emptyValue -> (structure)

An empty value.

stringValue -> (string)

String value type.

userArnValue -> (string)

Represents the user that performed the audit.

Shorthand Syntax:

id=string,value={booleanValue=boolean,doubleValue=double,emptyValue={},stringValue=string,userArnValue=string} ...

JSON Syntax:

[
  {
    "id": "string",
    "value": {
      "booleanValue": true|false,
      "doubleValue": double,
      "emptyValue": {

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

--performed-by (tagged union structure)

Represents the identity of the person who performed the action.

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"
}

--template-id (string)

A unique identifier of a template.

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

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

caseArn -> (string)

The Amazon Resource Name (ARN) of the case.

caseId -> (string)

A unique identifier of the case.