Agent

An agent resource in Amazon QuickSight that provides AI-powered conversational experiences.

Note

In the following list, the required parameters are described first.

AgentId

The unique identifier for the agent.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

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

Required: Yes

AgentLifecycle

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

Type: String

Valid Values: PREVIEW | PUBLISHED

Required: Yes

AgentStatus

The status of the agent.

Type: String

Valid Values: ACTIVE | UPDATING | FAILED | CREATING

Required: Yes

Arn

The Amazon Resource Name (ARN) of the agent.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1284.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Required: Yes

CreatedAt

The date and time that the agent was created.

Type: Timestamp

Required: Yes

Creator

The identity of the user who created the agent.

Type: String

Required: Yes

Name

The name of the agent.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50.

Pattern: (?!\s*$).+

Required: Yes

UpdatedAt

The date and time that the agent was last updated.

Type: Timestamp

Required: Yes

ActionConnectors

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

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Required: No

CustomPromptInterface

The custom prompt interface configuration for the agent.

Type: CustomPromptInterface object

Required: No

Description

A description of the agent.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000.

Pattern: \P{C}*

Required: No

ErrorMessage

An error message associated with the agent, if applicable.

Type: String

Required: No

IconId

The icon identifier for the agent.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Required: No

Spaces

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

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Required: No

StarterPrompts

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

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 3 items.

Length Constraints: Minimum length of 0. Maximum length of 100.

Required: No

WelcomeMessage

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 300.

Required: No

Agent

Contents

Note

See Also