AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . connect ]

create-test-case

Description

Creates a test case with its content and metadata for the specified Amazon Connect instance.

See also: AWS API Documentation

Synopsis

  create-test-case
--instance-id <value>
--name <value>
[--description <value>]
--content <value>
[--entry-point <value>]
[--initialization-data <value>]
[--status <value>]
[--test-case-id <value>]
[--tags <value>]
[--last-modified-time <value>]
[--last-modified-region <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>]
[--v2-debug]

Options

--instance-id (string)

The identifier of the Amazon Connect instance.

--name (string)

The name of the test.

--description (string)

The description of the test.

--content (string)

The JSON string that represents the content of the test.

--entry-point (structure)

Defines the starting point for your test.

Type -> (string)

The type of entry point.

VoiceCallEntryPointParameters -> (structure)

Parameters for voice call entry point.

SourcePhoneNumber -> (string)

The source phone number for the test.

DestinationPhoneNumber -> (string)

The destination phone number for the test.

FlowId -> (string)

The flow identifier for the test.

Shorthand Syntax:

Type=string,VoiceCallEntryPointParameters={SourcePhoneNumber=string,DestinationPhoneNumber=string,FlowId=string}

JSON Syntax:

{
  "Type": "VOICE_CALL",
  "VoiceCallEntryPointParameters": {
    "SourcePhoneNumber": "string",
    "DestinationPhoneNumber": "string",
    "FlowId": "string"
  }
}

--initialization-data (string)

Defines the initial custom attributes for your test.

--status (string)

Indicates the test status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. The SAVED status does not initiate validation of the content.

Possible values:

  • PUBLISHED
  • SAVED

--test-case-id (string)

Id of the test case if you want to create it in a replica region using Amazon Connect Global Resiliency

--tags (map)

The tags used to organize, track, or control access for this resource.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

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

--last-modified-time (timestamp)

The time at which the resource was last modified.

--last-modified-region (string)

The region in which the resource was last modified

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

TestCaseId -> (string)

The identifier of the test.

TestCaseArn -> (string)

The Amazon Resource Name (ARN) of the test.