We recommend new projects start with resources from the AWS provider.
published on Monday, Aug 3, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Monday, Aug 3, 2026 by Pulumi
Resource Type definition for AWS::QuickSight::Agent
Create Agent Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Agent(name: string, args: AgentArgs, opts?: CustomResourceOptions);@overload
def Agent(resource_name: str,
args: AgentArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Agent(resource_name: str,
opts: Optional[ResourceOptions] = None,
agent_id: Optional[str] = None,
aws_account_id: Optional[str] = None,
action_connectors: Optional[Sequence[str]] = None,
agent_lifecycle: Optional[AgentLifecycle] = None,
custom_prompt_input: Optional[AgentCustomPromptInputArgs] = None,
description: Optional[str] = None,
icon_id: Optional[str] = None,
name: Optional[str] = None,
spaces: Optional[Sequence[str]] = None,
starter_prompts: Optional[Sequence[str]] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
welcome_message: Optional[str] = None)func NewAgent(ctx *Context, name string, args AgentArgs, opts ...ResourceOption) (*Agent, error)public Agent(string name, AgentArgs args, CustomResourceOptions? opts = null)type: aws-native:quicksight:Agent
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "aws-native_quicksight_agent" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args AgentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args AgentArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args AgentArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AgentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AgentArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Agent Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Agent resource accepts the following input properties:
- Agent
Id string - The unique identifier for the agent.
- Aws
Account stringId - The ID of the Amazon Web Services account where the agent is being created.
- Action
Connectors List<string> - A list of ActionConnector ARNs (max 10) attached to the agent.
- Agent
Lifecycle Pulumi.Aws Native. Quick Sight. Agent Lifecycle - The lifecycle stage of the agent. PREVIEW or PUBLISHED.
- Custom
Prompt Pulumi.Input Aws Native. Quick Sight. Inputs. Agent Custom Prompt Input - Description string
- A description of the agent.
- Icon
Id string - The icon identifier for the agent.
- Name string
- The display name of the agent.
- Spaces List<string>
- A list of Space ARNs (max 10) attached to the agent.
- Starter
Prompts List<string> - A list of up to 3 starter prompts displayed to users.
-
List<Pulumi.
Aws Native. Inputs. Tag> - A list of key-value pairs to associate with the agent resource.
- Welcome
Message string - The welcome message displayed when a user opens the agent.
- Agent
Id string - The unique identifier for the agent.
- Aws
Account stringId - The ID of the Amazon Web Services account where the agent is being created.
- Action
Connectors []string - A list of ActionConnector ARNs (max 10) attached to the agent.
- Agent
Lifecycle AgentLifecycle - The lifecycle stage of the agent. PREVIEW or PUBLISHED.
- Custom
Prompt AgentInput Custom Prompt Input Args - Description string
- A description of the agent.
- Icon
Id string - The icon identifier for the agent.
- Name string
- The display name of the agent.
- Spaces []string
- A list of Space ARNs (max 10) attached to the agent.
- Starter
Prompts []string - A list of up to 3 starter prompts displayed to users.
-
Tag
Args - A list of key-value pairs to associate with the agent resource.
- Welcome
Message string - The welcome message displayed when a user opens the agent.
- agent_
id string - The unique identifier for the agent.
- aws_
account_ stringid - The ID of the Amazon Web Services account where the agent is being created.
- action_
connectors list(string) - A list of ActionConnector ARNs (max 10) attached to the agent.
- agent_
lifecycle "PREVIEW" | "PUBLISHED" - The lifecycle stage of the agent. PREVIEW or PUBLISHED.
- custom_
prompt_ objectinput - description string
- A description of the agent.
- icon_
id string - The icon identifier for the agent.
- name string
- The display name of the agent.
- spaces list(string)
- A list of Space ARNs (max 10) attached to the agent.
- starter_
prompts list(string) - A list of up to 3 starter prompts displayed to users.
- list(object)
- A list of key-value pairs to associate with the agent resource.
- welcome_
message string - The welcome message displayed when a user opens the agent.
- agent
Id String - The unique identifier for the agent.
- aws
Account StringId - The ID of the Amazon Web Services account where the agent is being created.
- action
Connectors List<String> - A list of ActionConnector ARNs (max 10) attached to the agent.
- agent
Lifecycle AgentLifecycle - The lifecycle stage of the agent. PREVIEW or PUBLISHED.
- custom
Prompt AgentInput Custom Prompt Input - description String
- A description of the agent.
- icon
Id String - The icon identifier for the agent.
- name String
- The display name of the agent.
- spaces List<String>
- A list of Space ARNs (max 10) attached to the agent.
- starter
Prompts List<String> - A list of up to 3 starter prompts displayed to users.
- List<Tag>
- A list of key-value pairs to associate with the agent resource.
- welcome
Message String - The welcome message displayed when a user opens the agent.
- agent
Id string - The unique identifier for the agent.
- aws
Account stringId - The ID of the Amazon Web Services account where the agent is being created.
- action
Connectors string[] - A list of ActionConnector ARNs (max 10) attached to the agent.
- agent
Lifecycle AgentLifecycle - The lifecycle stage of the agent. PREVIEW or PUBLISHED.
- custom
Prompt AgentInput Custom Prompt Input - description string
- A description of the agent.
- icon
Id string - The icon identifier for the agent.
- name string
- The display name of the agent.
- spaces string[]
- A list of Space ARNs (max 10) attached to the agent.
- starter
Prompts string[] - A list of up to 3 starter prompts displayed to users.
- Tag[]
- A list of key-value pairs to associate with the agent resource.
- welcome
Message string - The welcome message displayed when a user opens the agent.
- agent_
id str - The unique identifier for the agent.
- aws_
account_ strid - The ID of the Amazon Web Services account where the agent is being created.
- action_
connectors Sequence[str] - A list of ActionConnector ARNs (max 10) attached to the agent.
- agent_
lifecycle AgentLifecycle - The lifecycle stage of the agent. PREVIEW or PUBLISHED.
- custom_
prompt_ Agentinput Custom Prompt Input Args - description str
- A description of the agent.
- icon_
id str - The icon identifier for the agent.
- name str
- The display name of the agent.
- spaces Sequence[str]
- A list of Space ARNs (max 10) attached to the agent.
- starter_
prompts Sequence[str] - A list of up to 3 starter prompts displayed to users.
-
Sequence[Tag
Args] - A list of key-value pairs to associate with the agent resource.
- welcome_
message str - The welcome message displayed when a user opens the agent.
- agent
Id String - The unique identifier for the agent.
- aws
Account StringId - The ID of the Amazon Web Services account where the agent is being created.
- action
Connectors List<String> - A list of ActionConnector ARNs (max 10) attached to the agent.
- agent
Lifecycle "PREVIEW" | "PUBLISHED" - The lifecycle stage of the agent. PREVIEW or PUBLISHED.
- custom
Prompt Property MapInput - description String
- A description of the agent.
- icon
Id String - The icon identifier for the agent.
- name String
- The display name of the agent.
- spaces List<String>
- A list of Space ARNs (max 10) attached to the agent.
- starter
Prompts List<String> - A list of up to 3 starter prompts displayed to users.
- List<Property Map>
- A list of key-value pairs to associate with the agent resource.
- welcome
Message String - The welcome message displayed when a user opens the agent.
Outputs
All input properties are implicitly available as output properties. Additionally, the Agent resource produces the following output properties:
- Agent
Status Pulumi.Aws Native. Quick Sight. Agent Status - The current status of the agent. One of ACTIVE, CREATING, UPDATING, or FAILED.
- Arn string
- The Amazon Resource Name (ARN) of the agent.
- Created
At string - The date and time the agent was created.
- Creator string
- The ARN of the user who created the agent.
- Custom
Prompt Pulumi.Interface Aws Native. Quick Sight. Outputs. Agent Custom Prompt Interface - Error
Message string - The error message if the agent is in FAILED status.
- Id string
- The provider-assigned unique ID for this managed resource.
- Updated
At string - The date and time the agent was last updated.
- Agent
Status AgentStatus - The current status of the agent. One of ACTIVE, CREATING, UPDATING, or FAILED.
- Arn string
- The Amazon Resource Name (ARN) of the agent.
- Created
At string - The date and time the agent was created.
- Creator string
- The ARN of the user who created the agent.
- Custom
Prompt AgentInterface Custom Prompt Interface - Error
Message string - The error message if the agent is in FAILED status.
- Id string
- The provider-assigned unique ID for this managed resource.
- Updated
At string - The date and time the agent was last updated.
- agent_
status "ACTIVE" | "CREATING" | "UPDATING" | "FAILED" - The current status of the agent. One of ACTIVE, CREATING, UPDATING, or FAILED.
- arn string
- The Amazon Resource Name (ARN) of the agent.
- created_
at string - The date and time the agent was created.
- creator string
- The ARN of the user who created the agent.
- custom_
prompt_ objectinterface - error_
message string - The error message if the agent is in FAILED status.
- id string
- The provider-assigned unique ID for this managed resource.
- updated_
at string - The date and time the agent was last updated.
- agent
Status AgentStatus - The current status of the agent. One of ACTIVE, CREATING, UPDATING, or FAILED.
- arn String
- The Amazon Resource Name (ARN) of the agent.
- created
At String - The date and time the agent was created.
- creator String
- The ARN of the user who created the agent.
- custom
Prompt AgentInterface Custom Prompt Interface - error
Message String - The error message if the agent is in FAILED status.
- id String
- The provider-assigned unique ID for this managed resource.
- updated
At String - The date and time the agent was last updated.
- agent
Status AgentStatus - The current status of the agent. One of ACTIVE, CREATING, UPDATING, or FAILED.
- arn string
- The Amazon Resource Name (ARN) of the agent.
- created
At string - The date and time the agent was created.
- creator string
- The ARN of the user who created the agent.
- custom
Prompt AgentInterface Custom Prompt Interface - error
Message string - The error message if the agent is in FAILED status.
- id string
- The provider-assigned unique ID for this managed resource.
- updated
At string - The date and time the agent was last updated.
- agent_
status AgentStatus - The current status of the agent. One of ACTIVE, CREATING, UPDATING, or FAILED.
- arn str
- The Amazon Resource Name (ARN) of the agent.
- created_
at str - The date and time the agent was created.
- creator str
- The ARN of the user who created the agent.
- custom_
prompt_ Agentinterface Custom Prompt Interface - error_
message str - The error message if the agent is in FAILED status.
- id str
- The provider-assigned unique ID for this managed resource.
- updated_
at str - The date and time the agent was last updated.
- agent
Status "ACTIVE" | "CREATING" | "UPDATING" | "FAILED" - The current status of the agent. One of ACTIVE, CREATING, UPDATING, or FAILED.
- arn String
- The Amazon Resource Name (ARN) of the agent.
- created
At String - The date and time the agent was created.
- creator String
- The ARN of the user who created the agent.
- custom
Prompt Property MapInterface - error
Message String - The error message if the agent is in FAILED status.
- id String
- The provider-assigned unique ID for this managed resource.
- updated
At String - The date and time the agent was last updated.
Supporting Types
AgentCustomPromptInput, AgentCustomPromptInputArgs
Custom prompt configuration. Specify either ExistingPrompt or NewPrompt.AgentCustomPromptInputParameters, AgentCustomPromptInputParametersArgs
Parameters for creating a new custom prompt configuration.- Custom
Instructions string - Custom instructions for the agent behavior.
- Identity string
- The identity or persona of the agent.
- Output
Style string - The output style for the agent responses.
- Response
Length string - The desired response length for the agent.
- Tone string
- The tone used in agent responses.
- Custom
Instructions string - Custom instructions for the agent behavior.
- Identity string
- The identity or persona of the agent.
- Output
Style string - The output style for the agent responses.
- Response
Length string - The desired response length for the agent.
- Tone string
- The tone used in agent responses.
- custom_
instructions string - Custom instructions for the agent behavior.
- identity string
- The identity or persona of the agent.
- output_
style string - The output style for the agent responses.
- response_
length string - The desired response length for the agent.
- tone string
- The tone used in agent responses.
- custom
Instructions String - Custom instructions for the agent behavior.
- identity String
- The identity or persona of the agent.
- output
Style String - The output style for the agent responses.
- response
Length String - The desired response length for the agent.
- tone String
- The tone used in agent responses.
- custom
Instructions string - Custom instructions for the agent behavior.
- identity string
- The identity or persona of the agent.
- output
Style string - The output style for the agent responses.
- response
Length string - The desired response length for the agent.
- tone string
- The tone used in agent responses.
- custom_
instructions str - Custom instructions for the agent behavior.
- identity str
- The identity or persona of the agent.
- output_
style str - The output style for the agent responses.
- response_
length str - The desired response length for the agent.
- tone str
- The tone used in agent responses.
- custom
Instructions String - Custom instructions for the agent behavior.
- identity String
- The identity or persona of the agent.
- output
Style String - The output style for the agent responses.
- response
Length String - The desired response length for the agent.
- tone String
- The tone used in agent responses.
AgentCustomPromptInterface, AgentCustomPromptInterfaceArgs
Read-only view of the resolved custom prompt interface for the agent.- Custom
Instructions string - Custom instructions for the agent behavior.
- Identity string
- The identity or persona of the agent.
- Model
Profile stringId - The identifier of the model profile.
- Output
Style string - The output style for the agent responses.
- Prompt
Summary string - A summary of the resolved prompt.
- Qbs
Aws stringAccount Id - The QBS AWS account identifier.
- Response
Length string - The desired response length for the agent.
- Subscription
Id string - The subscription identifier.
- Tone string
- The tone used in agent responses.
- Custom
Instructions string - Custom instructions for the agent behavior.
- Identity string
- The identity or persona of the agent.
- Model
Profile stringId - The identifier of the model profile.
- Output
Style string - The output style for the agent responses.
- Prompt
Summary string - A summary of the resolved prompt.
- Qbs
Aws stringAccount Id - The QBS AWS account identifier.
- Response
Length string - The desired response length for the agent.
- Subscription
Id string - The subscription identifier.
- Tone string
- The tone used in agent responses.
- custom_
instructions string - Custom instructions for the agent behavior.
- identity string
- The identity or persona of the agent.
- model_
profile_ stringid - The identifier of the model profile.
- output_
style string - The output style for the agent responses.
- prompt_
summary string - A summary of the resolved prompt.
- qbs_
aws_ stringaccount_ id - The QBS AWS account identifier.
- response_
length string - The desired response length for the agent.
- subscription_
id string - The subscription identifier.
- tone string
- The tone used in agent responses.
- custom
Instructions String - Custom instructions for the agent behavior.
- identity String
- The identity or persona of the agent.
- model
Profile StringId - The identifier of the model profile.
- output
Style String - The output style for the agent responses.
- prompt
Summary String - A summary of the resolved prompt.
- qbs
Aws StringAccount Id - The QBS AWS account identifier.
- response
Length String - The desired response length for the agent.
- subscription
Id String - The subscription identifier.
- tone String
- The tone used in agent responses.
- custom
Instructions string - Custom instructions for the agent behavior.
- identity string
- The identity or persona of the agent.
- model
Profile stringId - The identifier of the model profile.
- output
Style string - The output style for the agent responses.
- prompt
Summary string - A summary of the resolved prompt.
- qbs
Aws stringAccount Id - The QBS AWS account identifier.
- response
Length string - The desired response length for the agent.
- subscription
Id string - The subscription identifier.
- tone string
- The tone used in agent responses.
- custom_
instructions str - Custom instructions for the agent behavior.
- identity str
- The identity or persona of the agent.
- model_
profile_ strid - The identifier of the model profile.
- output_
style str - The output style for the agent responses.
- prompt_
summary str - A summary of the resolved prompt.
- qbs_
aws_ straccount_ id - The QBS AWS account identifier.
- response_
length str - The desired response length for the agent.
- subscription_
id str - The subscription identifier.
- tone str
- The tone used in agent responses.
- custom
Instructions String - Custom instructions for the agent behavior.
- identity String
- The identity or persona of the agent.
- model
Profile StringId - The identifier of the model profile.
- output
Style String - The output style for the agent responses.
- prompt
Summary String - A summary of the resolved prompt.
- qbs
Aws StringAccount Id - The QBS AWS account identifier.
- response
Length String - The desired response length for the agent.
- subscription
Id String - The subscription identifier.
- tone String
- The tone used in agent responses.
AgentCustomPromptProfile, AgentCustomPromptProfileArgs
Reference to an existing custom prompt profile.- Model
Profile stringId - The identifier of the model profile.
- Qbs
Aws stringAccount Id - The QBS AWS account identifier.
- Subscription
Id string - The subscription identifier.
- Model
Profile stringId - The identifier of the model profile.
- Qbs
Aws stringAccount Id - The QBS AWS account identifier.
- Subscription
Id string - The subscription identifier.
- model_
profile_ stringid - The identifier of the model profile.
- qbs_
aws_ stringaccount_ id - The QBS AWS account identifier.
- subscription_
id string - The subscription identifier.
- model
Profile StringId - The identifier of the model profile.
- qbs
Aws StringAccount Id - The QBS AWS account identifier.
- subscription
Id String - The subscription identifier.
- model
Profile stringId - The identifier of the model profile.
- qbs
Aws stringAccount Id - The QBS AWS account identifier.
- subscription
Id string - The subscription identifier.
- model_
profile_ strid - The identifier of the model profile.
- qbs_
aws_ straccount_ id - The QBS AWS account identifier.
- subscription_
id str - The subscription identifier.
- model
Profile StringId - The identifier of the model profile.
- qbs
Aws StringAccount Id - The QBS AWS account identifier.
- subscription
Id String - The subscription identifier.
AgentLifecycle, AgentLifecycleArgs
- Preview
PREVIEW- Published
PUBLISHED
- Agent
Lifecycle Preview PREVIEW- Agent
Lifecycle Published PUBLISHED
- "PREVIEW"
PREVIEW- "PUBLISHED"
PUBLISHED
- Preview
PREVIEW- Published
PUBLISHED
- Preview
PREVIEW- Published
PUBLISHED
- PREVIEW
PREVIEW- PUBLISHED
PUBLISHED
- "PREVIEW"
PREVIEW- "PUBLISHED"
PUBLISHED
AgentStatus, AgentStatusArgs
- Active
ACTIVE- Creating
CREATING- Updating
UPDATING- Failed
FAILED
- Agent
Status Active ACTIVE- Agent
Status Creating CREATING- Agent
Status Updating UPDATING- Agent
Status Failed FAILED
- "ACTIVE"
ACTIVE- "CREATING"
CREATING- "UPDATING"
UPDATING- "FAILED"
FAILED
- Active
ACTIVE- Creating
CREATING- Updating
UPDATING- Failed
FAILED
- Active
ACTIVE- Creating
CREATING- Updating
UPDATING- Failed
FAILED
- ACTIVE
ACTIVE- CREATING
CREATING- UPDATING
UPDATING- FAILED
FAILED
- "ACTIVE"
ACTIVE- "CREATING"
CREATING- "UPDATING"
UPDATING- "FAILED"
FAILED
Tag, TagArgs
A set of tags to apply to the resource.Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Monday, Aug 3, 2026 by Pulumi