1. Packages
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. quicksight
  6. Agent

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.74.1
published on Monday, Aug 3, 2026 by Pulumi
aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.74.1
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)
    public Agent(String name, AgentArgs args)
    public Agent(String name, AgentArgs args, CustomResourceOptions options)
    
    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:

    AgentId string
    The unique identifier for the agent.
    AwsAccountId string
    The ID of the Amazon Web Services account where the agent is being created.
    ActionConnectors List<string>
    A list of ActionConnector ARNs (max 10) attached to the agent.
    AgentLifecycle Pulumi.AwsNative.QuickSight.AgentLifecycle
    The lifecycle stage of the agent. PREVIEW or PUBLISHED.
    CustomPromptInput Pulumi.AwsNative.QuickSight.Inputs.AgentCustomPromptInput
    Description string
    A description of the agent.
    IconId 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.
    StarterPrompts List<string>
    A list of up to 3 starter prompts displayed to users.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    A list of key-value pairs to associate with the agent resource.
    WelcomeMessage string
    The welcome message displayed when a user opens the agent.
    AgentId string
    The unique identifier for the agent.
    AwsAccountId string
    The ID of the Amazon Web Services account where the agent is being created.
    ActionConnectors []string
    A list of ActionConnector ARNs (max 10) attached to the agent.
    AgentLifecycle AgentLifecycle
    The lifecycle stage of the agent. PREVIEW or PUBLISHED.
    CustomPromptInput AgentCustomPromptInputArgs
    Description string
    A description of the agent.
    IconId 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.
    StarterPrompts []string
    A list of up to 3 starter prompts displayed to users.
    Tags TagArgs
    A list of key-value pairs to associate with the agent resource.
    WelcomeMessage string
    The welcome message displayed when a user opens the agent.
    agent_id string
    The unique identifier for the agent.
    aws_account_id string
    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_input object
    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.
    tags 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.
    agentId String
    The unique identifier for the agent.
    awsAccountId String
    The ID of the Amazon Web Services account where the agent is being created.
    actionConnectors List<String>
    A list of ActionConnector ARNs (max 10) attached to the agent.
    agentLifecycle AgentLifecycle
    The lifecycle stage of the agent. PREVIEW or PUBLISHED.
    customPromptInput AgentCustomPromptInput
    description String
    A description of the agent.
    iconId 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.
    starterPrompts List<String>
    A list of up to 3 starter prompts displayed to users.
    tags List<Tag>
    A list of key-value pairs to associate with the agent resource.
    welcomeMessage String
    The welcome message displayed when a user opens the agent.
    agentId string
    The unique identifier for the agent.
    awsAccountId string
    The ID of the Amazon Web Services account where the agent is being created.
    actionConnectors string[]
    A list of ActionConnector ARNs (max 10) attached to the agent.
    agentLifecycle AgentLifecycle
    The lifecycle stage of the agent. PREVIEW or PUBLISHED.
    customPromptInput AgentCustomPromptInput
    description string
    A description of the agent.
    iconId 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.
    starterPrompts string[]
    A list of up to 3 starter prompts displayed to users.
    tags Tag[]
    A list of key-value pairs to associate with the agent resource.
    welcomeMessage string
    The welcome message displayed when a user opens the agent.
    agent_id str
    The unique identifier for the agent.
    aws_account_id str
    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_input AgentCustomPromptInputArgs
    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.
    tags Sequence[TagArgs]
    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.
    agentId String
    The unique identifier for the agent.
    awsAccountId String
    The ID of the Amazon Web Services account where the agent is being created.
    actionConnectors List<String>
    A list of ActionConnector ARNs (max 10) attached to the agent.
    agentLifecycle "PREVIEW" | "PUBLISHED"
    The lifecycle stage of the agent. PREVIEW or PUBLISHED.
    customPromptInput Property Map
    description String
    A description of the agent.
    iconId 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.
    starterPrompts List<String>
    A list of up to 3 starter prompts displayed to users.
    tags List<Property Map>
    A list of key-value pairs to associate with the agent resource.
    welcomeMessage 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:

    AgentStatus Pulumi.AwsNative.QuickSight.AgentStatus
    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 Pulumi.AwsNative.QuickSight.Outputs.AgentCustomPromptInterface
    ErrorMessage string
    The error message if the agent is in FAILED status.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    The date and time the agent was last updated.
    AgentStatus AgentStatus
    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 AgentCustomPromptInterface
    ErrorMessage string
    The error message if the agent is in FAILED status.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt 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_interface object
    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.
    agentStatus AgentStatus
    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 AgentCustomPromptInterface
    errorMessage String
    The error message if the agent is in FAILED status.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    The date and time the agent was last updated.
    agentStatus AgentStatus
    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 AgentCustomPromptInterface
    errorMessage string
    The error message if the agent is in FAILED status.
    id string
    The provider-assigned unique ID for this managed resource.
    updatedAt 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_interface AgentCustomPromptInterface
    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.
    agentStatus "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.
    createdAt String
    The date and time the agent was created.
    creator String
    The ARN of the user who created the agent.
    customPromptInterface Property Map
    errorMessage String
    The error message if the agent is in FAILED status.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt 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.
    CustomInstructions string
    Custom instructions for the agent behavior.
    Identity string
    The identity or persona of the agent.
    OutputStyle string
    The output style for the agent responses.
    ResponseLength string
    The desired response length for the agent.
    Tone string
    The tone used in agent responses.
    CustomInstructions string
    Custom instructions for the agent behavior.
    Identity string
    The identity or persona of the agent.
    OutputStyle string
    The output style for the agent responses.
    ResponseLength 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.
    customInstructions String
    Custom instructions for the agent behavior.
    identity String
    The identity or persona of the agent.
    outputStyle String
    The output style for the agent responses.
    responseLength String
    The desired response length for the agent.
    tone String
    The tone used in agent responses.
    customInstructions string
    Custom instructions for the agent behavior.
    identity string
    The identity or persona of the agent.
    outputStyle string
    The output style for the agent responses.
    responseLength 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.
    customInstructions String
    Custom instructions for the agent behavior.
    identity String
    The identity or persona of the agent.
    outputStyle String
    The output style for the agent responses.
    responseLength 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.
    CustomInstructions string
    Custom instructions for the agent behavior.
    Identity string
    The identity or persona of the agent.
    ModelProfileId string
    The identifier of the model profile.
    OutputStyle string
    The output style for the agent responses.
    PromptSummary string
    A summary of the resolved prompt.
    QbsAwsAccountId string
    The QBS AWS account identifier.
    ResponseLength string
    The desired response length for the agent.
    SubscriptionId string
    The subscription identifier.
    Tone string
    The tone used in agent responses.
    CustomInstructions string
    Custom instructions for the agent behavior.
    Identity string
    The identity or persona of the agent.
    ModelProfileId string
    The identifier of the model profile.
    OutputStyle string
    The output style for the agent responses.
    PromptSummary string
    A summary of the resolved prompt.
    QbsAwsAccountId string
    The QBS AWS account identifier.
    ResponseLength string
    The desired response length for the agent.
    SubscriptionId 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_id string
    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_account_id string
    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.
    customInstructions String
    Custom instructions for the agent behavior.
    identity String
    The identity or persona of the agent.
    modelProfileId String
    The identifier of the model profile.
    outputStyle String
    The output style for the agent responses.
    promptSummary String
    A summary of the resolved prompt.
    qbsAwsAccountId String
    The QBS AWS account identifier.
    responseLength String
    The desired response length for the agent.
    subscriptionId String
    The subscription identifier.
    tone String
    The tone used in agent responses.
    customInstructions string
    Custom instructions for the agent behavior.
    identity string
    The identity or persona of the agent.
    modelProfileId string
    The identifier of the model profile.
    outputStyle string
    The output style for the agent responses.
    promptSummary string
    A summary of the resolved prompt.
    qbsAwsAccountId string
    The QBS AWS account identifier.
    responseLength string
    The desired response length for the agent.
    subscriptionId 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_id str
    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_account_id str
    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.
    customInstructions String
    Custom instructions for the agent behavior.
    identity String
    The identity or persona of the agent.
    modelProfileId String
    The identifier of the model profile.
    outputStyle String
    The output style for the agent responses.
    promptSummary String
    A summary of the resolved prompt.
    qbsAwsAccountId String
    The QBS AWS account identifier.
    responseLength String
    The desired response length for the agent.
    subscriptionId String
    The subscription identifier.
    tone String
    The tone used in agent responses.

    AgentCustomPromptProfile, AgentCustomPromptProfileArgs

    Reference to an existing custom prompt profile.
    ModelProfileId string
    The identifier of the model profile.
    QbsAwsAccountId string
    The QBS AWS account identifier.
    SubscriptionId string
    The subscription identifier.
    ModelProfileId string
    The identifier of the model profile.
    QbsAwsAccountId string
    The QBS AWS account identifier.
    SubscriptionId string
    The subscription identifier.
    model_profile_id string
    The identifier of the model profile.
    qbs_aws_account_id string
    The QBS AWS account identifier.
    subscription_id string
    The subscription identifier.
    modelProfileId String
    The identifier of the model profile.
    qbsAwsAccountId String
    The QBS AWS account identifier.
    subscriptionId String
    The subscription identifier.
    modelProfileId string
    The identifier of the model profile.
    qbsAwsAccountId string
    The QBS AWS account identifier.
    subscriptionId string
    The subscription identifier.
    model_profile_id str
    The identifier of the model profile.
    qbs_aws_account_id str
    The QBS AWS account identifier.
    subscription_id str
    The subscription identifier.
    modelProfileId String
    The identifier of the model profile.
    qbsAwsAccountId String
    The QBS AWS account identifier.
    subscriptionId String
    The subscription identifier.

    AgentLifecycle, AgentLifecycleArgs

    Preview
    PREVIEW
    Published
    PUBLISHED
    AgentLifecyclePreview
    PREVIEW
    AgentLifecyclePublished
    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
    AgentStatusActive
    ACTIVE
    AgentStatusCreating
    CREATING
    AgentStatusUpdating
    UPDATING
    AgentStatusFailed
    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.
    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.74.1
    published on Monday, Aug 3, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial