AWS CLI Command Reference

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

submit-contact-evaluation

Description

Submits a contact evaluation in the specified Amazon Connect instance. Answers included in the request are merged with existing answers for the given evaluation. If no answers or notes are passed, the evaluation is submitted with the existing answers and notes. You can delete an answer or note by passing an empty object ({} ) to the question identifier.

If a contact evaluation is already in submitted state, this operation will trigger a resubmission.

See also: AWS API Documentation

Synopsis

  submit-contact-evaluation
--instance-id <value>
--evaluation-id <value>
[--answers <value>]
[--notes <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

--instance-id (string)

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

--evaluation-id (string)

A unique identifier for the contact evaluation.

--answers (map)

A map of question identifiers to answer value.

key -> (string)

value -> (structure)

Information about input answers for a contact evaluation.

Value -> (tagged union structure)

The value for an answer in a contact evaluation.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: StringValue, NumericValue, NotApplicable.

StringValue -> (string)

The string value for an answer in a contact evaluation.

NumericValue -> (double)

The numeric value for an answer in a contact evaluation.

NotApplicable -> (boolean)

The flag to mark the question as not applicable.

Shorthand Syntax:

KeyName1=Value={StringValue=string,NumericValue=double,NotApplicable=boolean},KeyName2=Value={StringValue=string,NumericValue=double,NotApplicable=boolean}

JSON Syntax:

{"string": {
      "Value": {
        "StringValue": "string",
        "NumericValue": double,
        "NotApplicable": true|false
      }
    }
  ...}

--notes (map)

A map of question identifiers to note value.

key -> (string)

value -> (structure)

Information about notes for a contact evaluation.

Value -> (string)

The note for an item (section or question) in a contact evaluation.

Note

Even though a note in an evaluation can have up to 3072 chars, there is also a limit on the total number of chars for all the notes in the evaluation combined. Assuming there are N questions in the evaluation being submitted, then the max char limit for all notes combined is N x 1024.

Shorthand Syntax:

KeyName1=Value=string,KeyName2=Value=string

JSON Syntax:

{"string": {
      "Value": "string"
    }
  ...}

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

EvaluationId -> (string)

A unique identifier for the contact evaluation.

EvaluationArn -> (string)

The Amazon Resource Name (ARN) for the contact evaluation resource.