Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. quicksight
  6. getAgent

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
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.quicksight.getAgent

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
Schema (JSON)
pulumi/pulumi-aws-native

    Resource Type definition for AWS::QuickSight::Agent

    Using getAgent

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getAgent(args: GetAgentArgs, opts?: InvokeOptions): Promise<GetAgentResult>
function getAgentOutput(args: GetAgentOutputArgs, opts?: InvokeOptions): Output<GetAgentResult>
    def get_agent(agent_id: Optional[str] = None,
              aws_account_id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetAgentResult
def get_agent_output(agent_id: pulumi.Input[Optional[str]] = None,
              aws_account_id: pulumi.Input[Optional[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetAgentResult]
    func LookupAgent(ctx *Context, args *LookupAgentArgs, opts ...InvokeOption) (*LookupAgentResult, error)
func LookupAgentOutput(ctx *Context, args *LookupAgentOutputArgs, opts ...InvokeOption) LookupAgentResultOutput

    > Note: This function is named LookupAgent in the Go SDK.

    public static class GetAgent 
{
    public static Task<GetAgentResult> InvokeAsync(GetAgentArgs args, InvokeOptions? opts = null)
    public static Output<GetAgentResult> Invoke(GetAgentInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAgentResult> getAgent(GetAgentArgs args, InvokeOptions options)
public static Output<GetAgentResult> getAgent(GetAgentArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:quicksight:getAgent
  arguments:
    # arguments dictionary
    data "aws-native_quicksight_get_agent" "name" {
    # arguments
}

    The following arguments are supported:

    AgentId string
    The unique identifier for the agent.
    AwsAccountId string
    The ID of the Amazon Web Services account where the agent is being created.
    AgentId string
    The unique identifier for the agent.
    AwsAccountId string
    The ID of the Amazon Web Services account where the agent is being created.
    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.
    agentId String
    The unique identifier for the agent.
    awsAccountId String
    The ID of the Amazon Web Services account where the agent is being created.
    agentId string
    The unique identifier for the agent.
    awsAccountId string
    The ID of the Amazon Web Services account where the agent is being created.
    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.
    agentId String
    The unique identifier for the agent.
    awsAccountId String
    The ID of the Amazon Web Services account where the agent is being created.

    getAgent Result

    The following output properties are available:

    ActionConnectors List<string>
    A list of ActionConnector ARNs (max 10) attached to the agent.
    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
    Description string
    A description of the agent.
    ErrorMessage string
    The error message if the agent is in FAILED status.
    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.Outputs.Tag>
    A list of key-value pairs to associate with the agent resource.
    UpdatedAt string
    The date and time the agent was last updated.
    WelcomeMessage string
    The welcome message displayed when a user opens the agent.
    ActionConnectors []string
    A list of ActionConnector ARNs (max 10) attached to the agent.
    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
    Description string
    A description of the agent.
    ErrorMessage string
    The error message if the agent is in FAILED status.
    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.
    UpdatedAt string
    The date and time the agent was last updated.
    WelcomeMessage string
    The welcome message displayed when a user opens the agent.
    action_connectors list(string)
    A list of ActionConnector ARNs (max 10) attached to the agent.
    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
    description string
    A description of the agent.
    error_message string
    The error message if the agent is in FAILED status.
    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.
    updated_at string
    The date and time the agent was last updated.
    welcome_message string
    The welcome message displayed when a user opens the agent.
    actionConnectors List<String>
    A list of ActionConnector ARNs (max 10) attached to the agent.
    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
    description String
    A description of the agent.
    errorMessage String
    The error message if the agent is in FAILED status.
    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.
    updatedAt String
    The date and time the agent was last updated.
    welcomeMessage String
    The welcome message displayed when a user opens the agent.
    actionConnectors string[]
    A list of ActionConnector ARNs (max 10) attached to the agent.
    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
    description string
    A description of the agent.
    errorMessage string
    The error message if the agent is in FAILED status.
    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.
    updatedAt string
    The date and time the agent was last updated.
    welcomeMessage string
    The welcome message displayed when a user opens the agent.
    action_connectors Sequence[str]
    A list of ActionConnector ARNs (max 10) attached to the agent.
    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
    description str
    A description of the agent.
    error_message str
    The error message if the agent is in FAILED status.
    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[root_Tag]
    A list of key-value pairs to associate with the agent resource.
    updated_at str
    The date and time the agent was last updated.
    welcome_message str
    The welcome message displayed when a user opens the agent.
    actionConnectors List<String>
    A list of ActionConnector ARNs (max 10) attached to the agent.
    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
    description String
    A description of the agent.
    errorMessage String
    The error message if the agent is in FAILED status.
    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.
    updatedAt String
    The date and time the agent was last updated.
    welcomeMessage String
    The welcome message displayed when a user opens the agent.

    Supporting Types

    AgentCustomPromptInterface

    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.

    AgentStatus

    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 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
    Schema (JSON)
    pulumi/pulumi-aws-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial