Updates an existing agent¶

Description¶

Updates an existing agent.

Usage¶

quicksight_update_agent(AgentId, AwsAccountId, Name, Description,
  IconId, StarterPrompts, WelcomeMessage, CustomPromptInput, SpacesToAdd,
  SpacesToRemove, ActionConnectorsToAdd, ActionConnectorsToRemove)

Arguments¶

AgentId

[required] The unique identifier for the agent to update.
AwsAccountId

[required] The ID of the Amazon Web Services account that contains 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.
CustomPromptInput

The custom prompt configuration for the agent.
SpacesToAdd

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

The Amazon Resource Names (ARNs) of the spaces to detach from the agent.
ActionConnectorsToAdd

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

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

Value¶

A list with the following syntax:

list(
  Arn = "string",
  AgentId = "string",
  AgentStatus = "ACTIVE"|"UPDATING"|"FAILED"|"CREATING",
  FailedToAddSpaces = list(
    list(
      Arn = "string",
      ErrorMessage = "string",
      ErrorCode = "string"
    )
  ),
  FailedToRemoveSpaces = list(
    list(
      Arn = "string",
      ErrorMessage = "string",
      ErrorCode = "string"
    )
  ),
  FailedToAddActionConnectors = list(
    list(
      Arn = "string",
      ErrorMessage = "string",
      ErrorCode = "string"
    )
  ),
  FailedToRemoveActionConnectors = list(
    list(
      Arn = "string",
      ErrorMessage = "string",
      ErrorCode = "string"
    )
  ),
  RequestId = "string"
)

Request syntax¶

svc$update_agent(
  AgentId = "string",
  AwsAccountId = "string",
  Name = "string",
  Description = "string",
  IconId = "string",
  StarterPrompts = list(
    "string"
  ),
  WelcomeMessage = "string",
  CustomPromptInput = list(
    ExistingPrompt = list(
      ModelProfileId = "string",
      SubscriptionId = "string",
      QbsAwsAccountId = "string"
    ),
    NewPrompt = list(
      ResponseLength = "string",
      OutputStyle = "string",
      Identity = "string",
      Tone = "string",
      CustomInstructions = "string"
    )
  ),
  SpacesToAdd = list(
    "string"
  ),
  SpacesToRemove = list(
    "string"
  ),
  ActionConnectorsToAdd = list(
    "string"
  ),
  ActionConnectorsToRemove = list(
    "string"
  )
)