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

create-session¶

Description¶

Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.

Synopsis¶

  create-session
[--ai-agent-configuration <value>]
--assistant-id <value>
[--client-token <value>]
[--description <value>]
--name <value>
[--tag-filter <value>]
[--tags <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¶

--ai-agent-configuration (map)

The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.

key -> (string)

value -> (structure)

A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant.

aiAgentId -> (string)

The ID of the AI Agent to be configured.

Shorthand Syntax:

  KeyName1=aiAgentId=string,KeyName2=aiAgentId=string

Where valid key names are:
  MANUAL_SEARCH
  ANSWER_RECOMMENDATION
  SELF_SERVICE

JSON Syntax:

{"MANUAL_SEARCH"|"ANSWER_RECOMMENDATION"|"SELF_SERVICE": {
      "aiAgentId": "string"
    }
  ...}

--assistant-id (string)

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

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

--description (string)

The description.

--name (string)

The name of the session.

--tag-filter (tagged union structure)

An object that can be used to specify Tag conditions.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: andConditions, orConditions, tagCondition.

andConditions -> (list)

A list of conditions which would be applied together with an AND condition.

(structure)

A leaf node condition which can be used to specify a tag condition.

key -> (string)

The tag key in the tag condition.

value -> (string)

The tag value in the tag condition.

orConditions -> (list)

A list of conditions which would be applied together with an OR condition.

(tagged union structure)

A list of conditions which would be applied together with an OR condition.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: andConditions, tagCondition.

andConditions -> (list)

A list of conditions which would be applied together with an AND condition.

(structure)

A leaf node condition which can be used to specify a tag condition.

key -> (string)

The tag key in the tag condition.

value -> (string)

The tag value in the tag condition.

tagCondition -> (structure)

A leaf node condition which can be used to specify a tag condition.

key -> (string)

The tag key in the tag condition.

value -> (string)

The tag value in the tag condition.

tagCondition -> (structure)

A leaf node condition which can be used to specify a tag condition.

key -> (string)

The tag key in the tag condition.

value -> (string)

The tag value in the tag condition.

JSON Syntax:

{
  "andConditions": [
    {
      "key": "string",
      "value": "string"
    }
    ...
  ],
  "orConditions": [
    {
      "andConditions": [
        {
          "key": "string",
          "value": "string"
        }
        ...
      ],
      "tagCondition": {
        "key": "string",
        "value": "string"
      }
    }
    ...
  ],
  "tagCondition": {
    "key": "string",
    "value": "string"
  }
}

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

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

session -> (structure)

The session.

aiAgentConfiguration -> (map)

The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.

key -> (string)

value -> (structure)

A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant.

aiAgentId -> (string)

The ID of the AI Agent to be configured.

description -> (string)

The description of the session.

integrationConfiguration -> (structure)

The configuration information for the session integration.

topicIntegrationArn -> (string)

The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.

name -> (string)

The name of the session.

sessionArn -> (string)

The Amazon Resource Name (ARN) of the session.

sessionId -> (string)

The identifier of the session.

tagFilter -> (tagged union structure)

An object that can be used to specify Tag conditions.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: andConditions, orConditions, tagCondition.

andConditions -> (list)

A list of conditions which would be applied together with an AND condition.

(structure)

A leaf node condition which can be used to specify a tag condition.

key -> (string)

The tag key in the tag condition.

value -> (string)

The tag value in the tag condition.

orConditions -> (list)

A list of conditions which would be applied together with an OR condition.

(tagged union structure)

A list of conditions which would be applied together with an OR condition.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: andConditions, tagCondition.

andConditions -> (list)

A list of conditions which would be applied together with an AND condition.

(structure)

A leaf node condition which can be used to specify a tag condition.

key -> (string)

The tag key in the tag condition.

value -> (string)

The tag value in the tag condition.

tagCondition -> (structure)

A leaf node condition which can be used to specify a tag condition.

key -> (string)

The tag key in the tag condition.

value -> (string)

The tag value in the tag condition.

tagCondition -> (structure)

A leaf node condition which can be used to specify a tag condition.

key -> (string)

The tag key in the tag condition.

value -> (string)

The tag value in the tag condition.

tags -> (map)

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

key -> (string)

value -> (string)

Table Of Contents

Feedback

User Guide

Note:

create-session¶

Description¶

Synopsis¶

Options¶

Note

Note

Global Options¶

Output¶

Note

Note