View a markdown version of this page

AWS::Wisdom::Session - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::Wisdom::Session

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

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Wisdom::Session",
  "Properties" : {
      "AssistantId" : String,
      "Description" : String,
      "Name" : String,
      "Tags" : [ TagsItems, ... ]
    }
}

YAML

Type: AWS::Wisdom::Session
Properties:
  AssistantId: String
  Description: String
  Name: String
  Tags: 
    - TagsItems

Properties

AssistantId

The identifier of the Amazon Q in Connect assistant.

Required: Yes

Type: String

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

Update requires: Replacement

Description

The description of the session.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9\s_.,-]+

Minimum: 1

Maximum: 255

Update requires: Replacement

Name

The name of the session.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9\s_.,-]+

Minimum: 1

Maximum: 255

Update requires: Replacement

Tags

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

Required: No

Type: Array of TagsItems

Maximum: 200

Update requires: Replacement

Return values

Ref

Fn::GetAtt

SessionArn

The Amazon Resource Name (ARN) of the session.

SessionId

The identifier of the session.