Creates an agent in Amazon QuickSight¶

Description¶

Creates an agent in Amazon QuickSight.

Usage¶

quicksight_create_agent(Spaces, ActionConnectors, AwsAccountId, AgentId,
  Name, Description, IconId, StarterPrompts, WelcomeMessage,
  AgentLifecycle, CustomPromptInput)

Arguments¶

Spaces

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

ActionConnectors

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

AwsAccountId

[required] The ID of the Amazon Web Services account that contains the agent.

AgentId

[required] A unique identifier for the agent.

Name

[required] The name of the agent.

Description

A description of the agent.

IconId

The icon identifier for the agent.

StarterPrompts

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

WelcomeMessage

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

AgentLifecycle

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

CustomPromptInput

The custom prompt configuration for the agent.

Value¶

A list with the following syntax:

list(
  Arn = "string",
  AgentId = "string",
  AgentStatus = "ACTIVE"|"UPDATING"|"FAILED"|"CREATING",
  AgentName = "string",
  RequestId = "string"
)

Request syntax¶

svc$create_agent(
  Spaces = list(
    "string"
  ),
  ActionConnectors = list(
    "string"
  ),
  AwsAccountId = "string",
  AgentId = "string",
  Name = "string",
  Description = "string",
  IconId = "string",
  StarterPrompts = list(
    "string"
  ),
  WelcomeMessage = "string",
  AgentLifecycle = "PREVIEW"|"PUBLISHED",
  CustomPromptInput = list(
    ExistingPrompt = list(
      ModelProfileId = "string",
      SubscriptionId = "string",
      QbsAwsAccountId = "string"
    ),
    NewPrompt = list(
      ResponseLength = "string",
      OutputStyle = "string",
      Identity = "string",
      Tone = "string",
      CustomInstructions = "string"
    )
  )
)