Describes an agent¶

Description¶

Describes an agent.

Usage¶

quicksight_describe_agent(AgentId, AwsAccountId)

Arguments¶

AgentId

[required] The unique identifier for the agent.

AwsAccountId

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

Value¶

A list with the following syntax:

list(
  Agent = list(
    Spaces = list(
      "string"
    ),
    ActionConnectors = list(
      "string"
    ),
    Description = "string",
    IconId = "string",
    Name = "string",
    StarterPrompts = list(
      "string"
    ),
    WelcomeMessage = "string",
    Arn = "string",
    AgentId = "string",
    AgentLifecycle = "PREVIEW"|"PUBLISHED",
    AgentStatus = "ACTIVE"|"UPDATING"|"FAILED"|"CREATING",
    CreatedAt = as.POSIXct(
      "2015-01-01"
    ),
    Creator = "string",
    CustomPromptInterface = list(
      ModelProfileId = "string",
      SubscriptionId = "string",
      QbsAwsAccountId = "string",
      ResponseLength = "string",
      OutputStyle = "string",
      Identity = "string",
      Tone = "string",
      CustomInstructions = "string",
      promptSummary = "string"
    ),
    ErrorMessage = "string",
    UpdatedAt = as.POSIXct(
      "2015-01-01"
    )
  ),
  RequestId = "string"
)

Request syntax¶

svc$describe_agent(
  AgentId = "string",
  AwsAccountId = "string"
)