AWS CLI Command Reference

[ aws . qconnect ]

update-session

Description

Updates a session. A session is a contextual container used for generating recommendations. Amazon Connect updates the existing Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.

See also: AWS API Documentation

Synopsis

  update-session
[--ai-agent-configuration <value>]
--assistant-id <value>
[--description <value>]
--session-id <value>
[--tag-filter <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

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

JSON Syntax:

{"MANUAL_SEARCH"|"ANSWER_RECOMMENDATION": {
      "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.

--description (string)

The description.

--session-id (string)

The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
  • yaml
  • yaml-stream

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

session -> (structure)

Information about 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)

© Copyright 2018, Amazon Web Services. Created using Sphinx.