View a markdown version of this page

AWS::QuickSight::Agent - AWS CloudFormation
SyntaxPropertiesReturn values

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

AWS::QuickSight::Agent

The AWS::QuickSight::Agent resource Property description not available. for QuickSight.

Syntax

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

JSON

{
  "Type" : "AWS::QuickSight::Agent",
  "Properties" : {
      "ActionConnectors" : [ String, ... ],
      "AgentId" : String,
      "AgentLifecycle" : String,
      "AwsAccountId" : String,
      "CustomPromptInput" : CustomPromptInput,
      "Description" : String,
      "IconId" : String,
      "Name" : String,
      "Spaces" : [ String, ... ],
      "StarterPrompts" : [ String, ... ],
      "Tags" : [ AgentTag, ... ],
      "WelcomeMessage" : String
    }
}

YAML

Type: AWS::QuickSight::Agent
Properties:
  ActionConnectors: 
    - String
  AgentId: String
  AgentLifecycle: String
  AwsAccountId: String
  CustomPromptInput: 
    CustomPromptInput
  Description: String
  IconId: String
  Name: String
  Spaces: 
    - String
  StarterPrompts: 
    - String
  Tags: 
    - AgentTag
  WelcomeMessage: String

Properties

ActionConnectors

The Amazon Resource Names (ARNs) of the action connectors attached to the agent.

Required: No

Type: Array of String

Maximum: 10

Update requires: No interruption

AgentId

The unique identifier for the agent.

Required: Yes

Type: String

Pattern: ^[0-9a-zA-Z-_.+]+$

Minimum: 1

Maximum: 256

Update requires: Replacement

AgentLifecycle

The lifecycle state of the agent. Valid values are PREVIEW and PUBLISHED.

Required: No

Type: String

Allowed values: PREVIEW | PUBLISHED

Update requires: Replacement

AwsAccountId

Property description not available.

Required: Yes

Type: String

Pattern: ^[0-9]{12}$

Minimum: 12

Maximum: 12

Update requires: Replacement

CustomPromptInput

Property description not available.

Required: No

Type: CustomPromptInput

Update requires: No interruption

Description

A description of the agent.

Required: No

Type: String

Minimum: 0

Maximum: 1000

Update requires: No interruption

IconId

The icon identifier for the agent.

Required: No

Type: String

Minimum: 1

Maximum: 200

Update requires: No interruption

Name

The name of the agent.

Required: Yes

Type: String

Minimum: 1

Maximum: 50

Update requires: No interruption

Spaces

The Amazon Resource Names (ARNs) of the spaces attached to the agent.

Required: No

Type: Array of String

Maximum: 10

Update requires: No interruption

StarterPrompts

A list of starter prompts that are displayed to users when they begin interacting with the agent.

Required: No

Type: Array of String

Maximum: 3

Update requires: No interruption

Tags

Property description not available.

Required: No

Type: Array of AgentTag

Maximum: 200

Update requires: No interruption

WelcomeMessage

The welcome message that is displayed when a user starts a conversation with the agent.

Required: No

Type: String

Maximum: 300

Update requires: No interruption

Return values

Ref

Fn::GetAtt

AgentStatus

The status of the agent.

Arn

The Amazon Resource Name (ARN) of the agent.

CreatedAt

The date and time that the agent was created.

Creator

The identity of the user who created the agent.

ErrorMessage

An error message associated with the agent, if applicable.

UpdatedAt

The date and time that the agent was last updated.