AWS::QuickSight::Agent

QuickSight Agent

Resource Type definition for AWS::QuickSight::Agent

Properties

12 configurable properties. 3 required. Click a row to see details.

Filter:

Property	Type	Flags
`AgentId`	`string`	RequiredCreate-only
`AwsAccountId`	`string`	RequiredCreate-only
`Name`	`string`	Required
`ActionConnectors`	`Array<string>`
`AgentLifecycle`	`string`	Create-only
`CustomPromptInput`	`CustomPromptInput`	Write-only
`Description`	`string`
`IconId`	`string`
`Spaces`	`Array<string>`
`StarterPrompts`	`Array<string>`
`Tags`	`Array<AgentTag>`
`WelcomeMessage`	`string`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`AgentStatus`	`string`	The current status of the agent. One of ACTIVE, CREATING, UPDATING, or FAILED.
`Arn`	`string`	The Amazon Resource Name (ARN) of the agent.
`CreatedAt`	`string`	The date and time the agent was created.
`Creator`	`string`	The ARN of the user who created the agent.
`CustomPromptInterface`	`CustomPromptInterface`	-
`ErrorMessage`	`string`	The error message if the agent is in FAILED status.
`UpdatedAt`	`string`	The date and time the agent was last updated.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::QuickSight::Agent

Resources:
  MyResource:
    Type: AWS::QuickSight::Agent
    Properties:
      AwsAccountId: "my-awsaccountid"
      AgentId: "my-agentid"
      Name: "my-name"
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

quicksight:CreateAgentquicksight:DescribeAgentquicksight:TagResourcequicksight:ListTagsForResource

read

quicksight:DescribeAgentquicksight:DescribeAgentPermissionsquicksight:ListTagsForResource

update

quicksight:UpdateAgentquicksight:DescribeAgentquicksight:DescribeAgentPermissionsquicksight:UpdateAgentPermissionsquicksight:TagResourcequicksight:UntagResourcequicksight:ListTagsForResource

delete

quicksight:DeleteAgentquicksight:DescribeAgentquicksight:ListTagsForResourcequicksight:UntagResource

list

quicksight:ListAgents

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceQuickSight

Properties19

Required3

TaggingSupported

Primary IDAwsAccountId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

AwsAccountIdAgentIdAgentLifecycle

Related Resources

External Links

AWS Documentation