CfnAgentProps

class aws_cdk.aws_quicksight.CfnAgentProps(*, agent_id, aws_account_id, name, action_connectors=None, agent_lifecycle=None, custom_prompt_input=None, description=None, icon_id=None, spaces=None, starter_prompts=None, tags=None, welcome_message=None)

Bases: object

Properties for defining a CfnAgent.

Parameters:

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.
name (str) – The display name of the agent.
action_connectors (Optional[Sequence[str]]) – A list of ActionConnector ARNs (max 10) attached to the agent.
agent_lifecycle (Optional[str]) – The lifecycle stage of the agent. PREVIEW or PUBLISHED.
custom_prompt_input (Union[IResolvable, CustomPromptInputProperty, Dict[str, Any], None]) – Custom prompt configuration. Specify either ExistingPrompt or NewPrompt.
description (Optional[str]) – A description of the agent.
icon_id (Optional[str]) – The icon identifier for the agent.
spaces (Optional[Sequence[str]]) – A list of Space ARNs (max 10) attached to the agent.
starter_prompts (Optional[Sequence[str]]) – A list of up to 3 starter prompts displayed to users.
tags (Optional[Sequence[Union[AgentTagProperty, Dict[str, Any]]]]) – A list of key-value pairs to associate with the agent resource.
welcome_message (Optional[str]) – The welcome message displayed when a user opens the agent.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-agent.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

cfn_agent_props = quicksight.CfnAgentProps(
    agent_id="agentId",
    aws_account_id="awsAccountId",
    name="name",

    # the properties below are optional
    action_connectors=["actionConnectors"],
    agent_lifecycle="agentLifecycle",
    custom_prompt_input=quicksight.CfnAgent.CustomPromptInputProperty(
        existing_prompt=quicksight.CfnAgent.CustomPromptProfileProperty(
            model_profile_id="modelProfileId",
            qbs_aws_account_id="qbsAwsAccountId",
            subscription_id="subscriptionId"
        ),
        new_prompt=quicksight.CfnAgent.CustomPromptInputParametersProperty(
            custom_instructions="customInstructions",
            identity="identity",
            output_style="outputStyle",
            response_length="responseLength",
            tone="tone"
        )
    ),
    description="description",
    icon_id="iconId",
    spaces=["spaces"],
    starter_prompts=["starterPrompts"],
    tags=[quicksight.CfnAgent.AgentTagProperty(
        key="key",
        value="value"
    )],
    welcome_message="welcomeMessage"
)