CfnAgentPropsMixin

class aws_cdk.cfn_property_mixins.aws_quicksight.CfnAgentPropsMixin(props, *, strategy=None)

Bases: Mixin

Resource Type definition for AWS::QuickSight::Agent.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-agent.html
CloudformationResource:: AWS::QuickSight::Agent
Mixin:: true
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.cfn_property_mixins import aws_quicksight as quicksight
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_agent_props_mixin = quicksight.CfnAgentPropsMixin(quicksight.CfnAgentMixinProps(
    action_connectors=["actionConnectors"],
    agent_id="agentId",
    agent_lifecycle="agentLifecycle",
    aws_account_id="awsAccountId",
    custom_prompt_input=quicksight.CfnAgentPropsMixin.CustomPromptInputProperty(
        existing_prompt=quicksight.CfnAgentPropsMixin.CustomPromptProfileProperty(
            model_profile_id="modelProfileId",
            qbs_aws_account_id="qbsAwsAccountId",
            subscription_id="subscriptionId"
        ),
        new_prompt=quicksight.CfnAgentPropsMixin.CustomPromptInputParametersProperty(
            custom_instructions="customInstructions",
            identity="identity",
            output_style="outputStyle",
            response_length="responseLength",
            tone="tone"
        )
    ),
    description="description",
    icon_id="iconId",
    name="name",
    spaces=["spaces"],
    starter_prompts=["starterPrompts"],
    tags=[quicksight.CfnAgentPropsMixin.AgentTagProperty(
        key="key",
        value="value"
    )],
    welcome_message="welcomeMessage"
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::QuickSight::Agent.

Parameters:

props (Union[CfnAgentMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['actionConnectors', 'agentId', 'agentLifecycle', 'awsAccountId', 'customPromptInput', 'description', 'iconId', 'name', 'spaces', 'starterPrompts', 'tags', 'welcomeMessage']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

AgentTagProperty

class CfnAgentPropsMixin.AgentTagProperty(*, key=None, value=None)

Bases: object

A key-value pair to associate with the agent resource.

Parameters:

key (Optional[str]) – The key name of the tag.
value (Optional[str]) – The value for the tag.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-agent-agenttag.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.cfn_property_mixins import aws_quicksight as quicksight

agent_tag_property = quicksight.CfnAgentPropsMixin.AgentTagProperty(
    key="key",
    value="value"
)

Attributes

key

The key name of the tag.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-agent-agenttag.html#cfn-quicksight-agent-agenttag-key

value

The value for the tag.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-agent-agenttag.html#cfn-quicksight-agent-agenttag-value

CustomPromptInputParametersProperty

class CfnAgentPropsMixin.CustomPromptInputParametersProperty(*, custom_instructions=None, identity=None, output_style=None, response_length=None, tone=None)

Bases: object

Parameters for creating a new custom prompt configuration.

Parameters:

custom_instructions (Optional[str]) – Custom instructions for the agent behavior.
identity (Optional[str]) – The identity or persona of the agent.
output_style (Optional[str]) – The output style for the agent responses.
response_length (Optional[str]) – The desired response length for the agent.
tone (Optional[str]) – The tone used in agent responses.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-agent-custompromptinputparameters.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.cfn_property_mixins import aws_quicksight as quicksight

custom_prompt_input_parameters_property = quicksight.CfnAgentPropsMixin.CustomPromptInputParametersProperty(
    custom_instructions="customInstructions",
    identity="identity",
    output_style="outputStyle",
    response_length="responseLength",
    tone="tone"
)

Attributes

custom_instructions

Custom instructions for the agent behavior.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-agent-custompromptinputparameters.html#cfn-quicksight-agent-custompromptinputparameters-custominstructions

identity

The identity or persona of the agent.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-agent-custompromptinputparameters.html#cfn-quicksight-agent-custompromptinputparameters-identity

output_style

The output style for the agent responses.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-agent-custompromptinputparameters.html#cfn-quicksight-agent-custompromptinputparameters-outputstyle

response_length

The desired response length for the agent.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-agent-custompromptinputparameters.html#cfn-quicksight-agent-custompromptinputparameters-responselength

tone

The tone used in agent responses.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-agent-custompromptinputparameters.html#cfn-quicksight-agent-custompromptinputparameters-tone

CustomPromptInputProperty

class CfnAgentPropsMixin.CustomPromptInputProperty(*, existing_prompt=None, new_prompt=None)

Bases: object

Custom prompt configuration.

Specify either ExistingPrompt or NewPrompt.

Parameters:

existing_prompt (Union[IResolvable, CustomPromptProfileProperty, Dict[str, Any], None]) – Reference to an existing custom prompt profile.
new_prompt (Union[IResolvable, CustomPromptInputParametersProperty, Dict[str, Any], None]) – Parameters for creating a new custom prompt configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-agent-custompromptinput.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.cfn_property_mixins import aws_quicksight as quicksight

custom_prompt_input_property = quicksight.CfnAgentPropsMixin.CustomPromptInputProperty(
    existing_prompt=quicksight.CfnAgentPropsMixin.CustomPromptProfileProperty(
        model_profile_id="modelProfileId",
        qbs_aws_account_id="qbsAwsAccountId",
        subscription_id="subscriptionId"
    ),
    new_prompt=quicksight.CfnAgentPropsMixin.CustomPromptInputParametersProperty(
        custom_instructions="customInstructions",
        identity="identity",
        output_style="outputStyle",
        response_length="responseLength",
        tone="tone"
    )
)

Attributes

existing_prompt

Reference to an existing custom prompt profile.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-agent-custompromptinput.html#cfn-quicksight-agent-custompromptinput-existingprompt

new_prompt

Parameters for creating a new custom prompt configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-agent-custompromptinput.html#cfn-quicksight-agent-custompromptinput-newprompt

CustomPromptInterfaceProperty

class CfnAgentPropsMixin.CustomPromptInterfaceProperty(*, custom_instructions=None, identity=None, model_profile_id=None, output_style=None, prompt_summary=None, qbs_aws_account_id=None, response_length=None, subscription_id=None, tone=None)

Bases: object

Read-only view of the resolved custom prompt interface for the agent.

Parameters:

custom_instructions (Optional[str]) – Custom instructions for the agent behavior.
identity (Optional[str]) – The identity or persona of the agent.
model_profile_id (Optional[str]) – The identifier of the model profile.
output_style (Optional[str]) – The output style for the agent responses.
prompt_summary (Optional[str]) – A summary of the resolved prompt.
qbs_aws_account_id (Optional[str]) – The QBS AWS account identifier.
response_length (Optional[str]) – The desired response length for the agent.
subscription_id (Optional[str]) – The subscription identifier.
tone (Optional[str]) – The tone used in agent responses.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-agent-custompromptinterface.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.cfn_property_mixins import aws_quicksight as quicksight

custom_prompt_interface_property = quicksight.CfnAgentPropsMixin.CustomPromptInterfaceProperty(
    custom_instructions="customInstructions",
    identity="identity",
    model_profile_id="modelProfileId",
    output_style="outputStyle",
    prompt_summary="promptSummary",
    qbs_aws_account_id="qbsAwsAccountId",
    response_length="responseLength",
    subscription_id="subscriptionId",
    tone="tone"
)

Attributes

custom_instructions

Custom instructions for the agent behavior.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-agent-custompromptinterface.html#cfn-quicksight-agent-custompromptinterface-custominstructions

identity

The identity or persona of the agent.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-agent-custompromptinterface.html#cfn-quicksight-agent-custompromptinterface-identity

model_profile_id

The identifier of the model profile.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-agent-custompromptinterface.html#cfn-quicksight-agent-custompromptinterface-modelprofileid

output_style

The output style for the agent responses.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-agent-custompromptinterface.html#cfn-quicksight-agent-custompromptinterface-outputstyle

prompt_summary

A summary of the resolved prompt.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-agent-custompromptinterface.html#cfn-quicksight-agent-custompromptinterface-promptsummary

qbs_aws_account_id

The QBS AWS account identifier.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-agent-custompromptinterface.html#cfn-quicksight-agent-custompromptinterface-qbsawsaccountid

response_length

The desired response length for the agent.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-agent-custompromptinterface.html#cfn-quicksight-agent-custompromptinterface-responselength

subscription_id

The subscription identifier.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-agent-custompromptinterface.html#cfn-quicksight-agent-custompromptinterface-subscriptionid

tone

The tone used in agent responses.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-agent-custompromptinterface.html#cfn-quicksight-agent-custompromptinterface-tone

CustomPromptProfileProperty

class CfnAgentPropsMixin.CustomPromptProfileProperty(*, model_profile_id=None, qbs_aws_account_id=None, subscription_id=None)

Bases: object

Reference to an existing custom prompt profile.

Parameters:

model_profile_id (Optional[str]) – The identifier of the model profile.
qbs_aws_account_id (Optional[str]) – The QBS AWS account identifier.
subscription_id (Optional[str]) – The subscription identifier.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-agent-custompromptprofile.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.cfn_property_mixins import aws_quicksight as quicksight

custom_prompt_profile_property = quicksight.CfnAgentPropsMixin.CustomPromptProfileProperty(
    model_profile_id="modelProfileId",
    qbs_aws_account_id="qbsAwsAccountId",
    subscription_id="subscriptionId"
)

Attributes

model_profile_id

The identifier of the model profile.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-agent-custompromptprofile.html#cfn-quicksight-agent-custompromptprofile-modelprofileid

qbs_aws_account_id

The QBS AWS account identifier.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-agent-custompromptprofile.html#cfn-quicksight-agent-custompromptprofile-qbsawsaccountid

subscription_id

The subscription identifier.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-agent-custompromptprofile.html#cfn-quicksight-agent-custompromptprofile-subscriptionid