CfnBotPropsMixin

class aws_cdk.mixins_preview.aws_lex.mixins.CfnBotPropsMixin(props, *, strategy=None)

Bases: Mixin

Amazon Lex V2 is the only supported version in CloudFormation .

Specifies an Amazon Lex conversational bot.

You must configure an intent based on the AMAZON.FallbackIntent built-in intent. If you don’t add one, creating the bot will fail.

see:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lex-bot.html

cloudformationResource:

AWS::Lex::Bot

mixin:

true

exampleMetadata:

fixture=_generated

Example:

Create a mixin to apply properties to AWS::Lex::Bot.

Parameters:

  • props (Union[CfnBotMixinProps, Dict[str, Any]]) – L1 properties to apply.

  • strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['autoBuildBotLocales', 'botFileS3Location', 'botLocales', 'botTags', 'dataPrivacy', 'description', 'errorLogSettings', 'idleSessionTtlInSeconds', 'name', 'replication', 'roleArn', 'testBotAliasSettings', 'testBotAliasTags']

Static Methods

classmethod is_mixin(x)

(experimental) 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.

Stability:

experimental

AdvancedRecognitionSettingProperty

class CfnBotPropsMixin.AdvancedRecognitionSettingProperty(*, audio_recognition_strategy=None)

Bases: object

Provides settings that enable advanced recognition settings for slot values.

Parameters:

audio_recognition_strategy (Optional[str]) – Enables using the slot values as a custom vocabulary for recognizing user utterances.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-advancedrecognitionsetting.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.mixins_preview.aws_lex import mixins as lex_mixins

advanced_recognition_setting_property = lex_mixins.CfnBotPropsMixin.AdvancedRecognitionSettingProperty(
    audio_recognition_strategy="audioRecognitionStrategy"
)

Attributes

audio_recognition_strategy

Enables using the slot values as a custom vocabulary for recognizing user utterances.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-advancedrecognitionsetting.html#cfn-lex-bot-advancedrecognitionsetting-audiorecognitionstrategy

AllowedInputTypesProperty

class CfnBotPropsMixin.AllowedInputTypesProperty(*, allow_audio_input=None, allow_dtmf_input=None)

Bases: object

Specifies the allowed input types.

Parameters:

  • allow_audio_input (Union[bool, IResolvable, None]) – Indicates whether audio input is allowed.

  • allow_dtmf_input (Union[bool, IResolvable, None]) – Indicates whether DTMF input is allowed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-allowedinputtypes.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.mixins_preview.aws_lex import mixins as lex_mixins

allowed_input_types_property = lex_mixins.CfnBotPropsMixin.AllowedInputTypesProperty(
    allow_audio_input=False,
    allow_dtmf_input=False
)

Attributes

allow_audio_input

Indicates whether audio input is allowed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-allowedinputtypes.html#cfn-lex-bot-allowedinputtypes-allowaudioinput

allow_dtmf_input

Indicates whether DTMF input is allowed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-allowedinputtypes.html#cfn-lex-bot-allowedinputtypes-allowdtmfinput

AudioAndDTMFInputSpecificationProperty

class CfnBotPropsMixin.AudioAndDTMFInputSpecificationProperty(*, audio_specification=None, dtmf_specification=None, start_timeout_ms=None)

Bases: object

Specifies the audio and DTMF input specification.

Parameters:

  • audio_specification (Union[IResolvable, AudioSpecificationProperty, Dict[str, Any], None]) – Specifies the settings on audio input.

  • dtmf_specification (Union[IResolvable, DTMFSpecificationProperty, Dict[str, Any], None]) – Specifies the settings on DTMF input.

  • start_timeout_ms (Union[int, float, None]) – Time for which a bot waits before assuming that the customer isn’t going to speak or press a key. This timeout is shared between Audio and DTMF inputs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-audioanddtmfinputspecification.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.mixins_preview.aws_lex import mixins as lex_mixins

audio_and_dTMFInput_specification_property = lex_mixins.CfnBotPropsMixin.AudioAndDTMFInputSpecificationProperty(
    audio_specification=lex_mixins.CfnBotPropsMixin.AudioSpecificationProperty(
        end_timeout_ms=123,
        max_length_ms=123
    ),
    dtmf_specification=lex_mixins.CfnBotPropsMixin.DTMFSpecificationProperty(
        deletion_character="deletionCharacter",
        end_character="endCharacter",
        end_timeout_ms=123,
        max_length=123
    ),
    start_timeout_ms=123
)

Attributes

audio_specification

Specifies the settings on audio input.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-audioanddtmfinputspecification.html#cfn-lex-bot-audioanddtmfinputspecification-audiospecification

dtmf_specification

Specifies the settings on DTMF input.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-audioanddtmfinputspecification.html#cfn-lex-bot-audioanddtmfinputspecification-dtmfspecification

start_timeout_ms

Time for which a bot waits before assuming that the customer isn’t going to speak or press a key.

This timeout is shared between Audio and DTMF inputs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-audioanddtmfinputspecification.html#cfn-lex-bot-audioanddtmfinputspecification-starttimeoutms

AudioLogDestinationProperty

class CfnBotPropsMixin.AudioLogDestinationProperty(*, s3_bucket=None)

Bases: object

The location of audio log files collected when conversation logging is enabled for a bot.

Parameters:

s3_bucket (Union[IResolvable, S3BucketLogDestinationProperty, Dict[str, Any], None]) – Specifies the Amazon S3 bucket where the audio files are stored.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-audiologdestination.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.mixins_preview.aws_lex import mixins as lex_mixins

audio_log_destination_property = lex_mixins.CfnBotPropsMixin.AudioLogDestinationProperty(
    s3_bucket=lex_mixins.CfnBotPropsMixin.S3BucketLogDestinationProperty(
        kms_key_arn="kmsKeyArn",
        log_prefix="logPrefix",
        s3_bucket_arn="s3BucketArn"
    )
)

Attributes

s3_bucket

Specifies the Amazon S3 bucket where the audio files are stored.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-audiologdestination.html#cfn-lex-bot-audiologdestination-s3bucket

AudioLogSettingProperty

class CfnBotPropsMixin.AudioLogSettingProperty(*, destination=None, enabled=None)

Bases: object

Settings for logging audio of conversations between Amazon Lex and a user.

You specify whether to log audio and the Amazon S3 bucket where the audio file is stored.

Parameters:

  • destination (Union[IResolvable, AudioLogDestinationProperty, Dict[str, Any], None]) – Specifies the location of the audio log files collected when conversation logging is enabled for a bot.

  • enabled (Union[bool, IResolvable, None]) – Determines whether audio logging in enabled for the bot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-audiologsetting.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.mixins_preview.aws_lex import mixins as lex_mixins

audio_log_setting_property = lex_mixins.CfnBotPropsMixin.AudioLogSettingProperty(
    destination=lex_mixins.CfnBotPropsMixin.AudioLogDestinationProperty(
        s3_bucket=lex_mixins.CfnBotPropsMixin.S3BucketLogDestinationProperty(
            kms_key_arn="kmsKeyArn",
            log_prefix="logPrefix",
            s3_bucket_arn="s3BucketArn"
        )
    ),
    enabled=False
)

Attributes

destination

Specifies the location of the audio log files collected when conversation logging is enabled for a bot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-audiologsetting.html#cfn-lex-bot-audiologsetting-destination

enabled

Determines whether audio logging in enabled for the bot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-audiologsetting.html#cfn-lex-bot-audiologsetting-enabled

AudioSpecificationProperty

class CfnBotPropsMixin.AudioSpecificationProperty(*, end_timeout_ms=None, max_length_ms=None)

Bases: object

Specifies the audio input specifications.

Parameters:

  • end_timeout_ms (Union[int, float, None]) – Time for which a bot waits after the customer stops speaking to assume the utterance is finished.

  • max_length_ms (Union[int, float, None]) – Time for how long Amazon Lex waits before speech input is truncated and the speech is returned to application.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-audiospecification.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.mixins_preview.aws_lex import mixins as lex_mixins

audio_specification_property = lex_mixins.CfnBotPropsMixin.AudioSpecificationProperty(
    end_timeout_ms=123,
    max_length_ms=123
)

Attributes

end_timeout_ms

Time for which a bot waits after the customer stops speaking to assume the utterance is finished.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-audiospecification.html#cfn-lex-bot-audiospecification-endtimeoutms

max_length_ms

Time for how long Amazon Lex waits before speech input is truncated and the speech is returned to application.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-audiospecification.html#cfn-lex-bot-audiospecification-maxlengthms

BKBExactResponseFieldsProperty

class CfnBotPropsMixin.BKBExactResponseFieldsProperty(*, answer_field=None)

Bases: object

Parameters:

answer_field (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-bkbexactresponsefields.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.mixins_preview.aws_lex import mixins as lex_mixins

b_kBExact_response_fields_property = lex_mixins.CfnBotPropsMixin.BKBExactResponseFieldsProperty(
    answer_field="answerField"
)

Attributes

answer_field

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-bkbexactresponsefields.html#cfn-lex-bot-bkbexactresponsefields-answerfield

Type:

see

BedrockAgentConfigurationProperty

class CfnBotPropsMixin.BedrockAgentConfigurationProperty(*, bedrock_agent_alias_id=None, bedrock_agent_id=None)

Bases: object

Parameters:

  • bedrock_agent_alias_id (Optional[str])

  • bedrock_agent_id (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-bedrockagentconfiguration.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.mixins_preview.aws_lex import mixins as lex_mixins

bedrock_agent_configuration_property = lex_mixins.CfnBotPropsMixin.BedrockAgentConfigurationProperty(
    bedrock_agent_alias_id="bedrockAgentAliasId",
    bedrock_agent_id="bedrockAgentId"
)

Attributes

bedrock_agent_alias_id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-bedrockagentconfiguration.html#cfn-lex-bot-bedrockagentconfiguration-bedrockagentaliasid

Type:

see

bedrock_agent_id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-bedrockagentconfiguration.html#cfn-lex-bot-bedrockagentconfiguration-bedrockagentid

Type:

see

BedrockAgentIntentConfigurationProperty

class CfnBotPropsMixin.BedrockAgentIntentConfigurationProperty(*, bedrock_agent_configuration=None, bedrock_agent_intent_knowledge_base_configuration=None)

Bases: object

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-bedrockagentintentconfiguration.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.mixins_preview.aws_lex import mixins as lex_mixins

bedrock_agent_intent_configuration_property = lex_mixins.CfnBotPropsMixin.BedrockAgentIntentConfigurationProperty(
    bedrock_agent_configuration=lex_mixins.CfnBotPropsMixin.BedrockAgentConfigurationProperty(
        bedrock_agent_alias_id="bedrockAgentAliasId",
        bedrock_agent_id="bedrockAgentId"
    ),
    bedrock_agent_intent_knowledge_base_configuration=lex_mixins.CfnBotPropsMixin.BedrockAgentIntentKnowledgeBaseConfigurationProperty(
        bedrock_knowledge_base_arn="bedrockKnowledgeBaseArn",
        bedrock_model_configuration=lex_mixins.CfnBotPropsMixin.BedrockModelSpecificationProperty(
            bedrock_guardrail_configuration=lex_mixins.CfnBotPropsMixin.BedrockGuardrailConfigurationProperty(
                bedrock_guardrail_identifier="bedrockGuardrailIdentifier",
                bedrock_guardrail_version="bedrockGuardrailVersion"
            ),
            bedrock_model_custom_prompt="bedrockModelCustomPrompt",
            bedrock_trace_status="bedrockTraceStatus",
            model_arn="modelArn"
        )
    )
)

Attributes

bedrock_agent_configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-bedrockagentintentconfiguration.html#cfn-lex-bot-bedrockagentintentconfiguration-bedrockagentconfiguration

Type:

see

bedrock_agent_intent_knowledge_base_configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-bedrockagentintentconfiguration.html#cfn-lex-bot-bedrockagentintentconfiguration-bedrockagentintentknowledgebaseconfiguration

Type:

see

BedrockAgentIntentKnowledgeBaseConfigurationProperty

class CfnBotPropsMixin.BedrockAgentIntentKnowledgeBaseConfigurationProperty(*, bedrock_knowledge_base_arn=None, bedrock_model_configuration=None)

Bases: object

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-bedrockagentintentknowledgebaseconfiguration.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.mixins_preview.aws_lex import mixins as lex_mixins

bedrock_agent_intent_knowledge_base_configuration_property = lex_mixins.CfnBotPropsMixin.BedrockAgentIntentKnowledgeBaseConfigurationProperty(
    bedrock_knowledge_base_arn="bedrockKnowledgeBaseArn",
    bedrock_model_configuration=lex_mixins.CfnBotPropsMixin.BedrockModelSpecificationProperty(
        bedrock_guardrail_configuration=lex_mixins.CfnBotPropsMixin.BedrockGuardrailConfigurationProperty(
            bedrock_guardrail_identifier="bedrockGuardrailIdentifier",
            bedrock_guardrail_version="bedrockGuardrailVersion"
        ),
        bedrock_model_custom_prompt="bedrockModelCustomPrompt",
        bedrock_trace_status="bedrockTraceStatus",
        model_arn="modelArn"
    )
)

Attributes

bedrock_knowledge_base_arn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-bedrockagentintentknowledgebaseconfiguration.html#cfn-lex-bot-bedrockagentintentknowledgebaseconfiguration-bedrockknowledgebasearn

Type:

see

bedrock_model_configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-bedrockagentintentknowledgebaseconfiguration.html#cfn-lex-bot-bedrockagentintentknowledgebaseconfiguration-bedrockmodelconfiguration

Type:

see

BedrockGuardrailConfigurationProperty

class CfnBotPropsMixin.BedrockGuardrailConfigurationProperty(*, bedrock_guardrail_identifier=None, bedrock_guardrail_version=None)

Bases: object

The details on the Bedrock guardrail configuration.

Parameters:

  • bedrock_guardrail_identifier (Optional[str])

  • bedrock_guardrail_version (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-bedrockguardrailconfiguration.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.mixins_preview.aws_lex import mixins as lex_mixins

bedrock_guardrail_configuration_property = lex_mixins.CfnBotPropsMixin.BedrockGuardrailConfigurationProperty(
    bedrock_guardrail_identifier="bedrockGuardrailIdentifier",
    bedrock_guardrail_version="bedrockGuardrailVersion"
)

Attributes

bedrock_guardrail_identifier

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-bedrockguardrailconfiguration.html#cfn-lex-bot-bedrockguardrailconfiguration-bedrockguardrailidentifier

Type:

see

bedrock_guardrail_version

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-bedrockguardrailconfiguration.html#cfn-lex-bot-bedrockguardrailconfiguration-bedrockguardrailversion

Type:

see

BedrockKnowledgeStoreConfigurationProperty

class CfnBotPropsMixin.BedrockKnowledgeStoreConfigurationProperty(*, bedrock_knowledge_base_arn=None, bkb_exact_response_fields=None, exact_response=None)

Bases: object

Contains details about the configuration of a Amazon Bedrock knowledge base.

Parameters:

  • bedrock_knowledge_base_arn (Optional[str]) – The base ARN of the knowledge base used.

  • bkb_exact_response_fields (Union[IResolvable, BKBExactResponseFieldsProperty, Dict[str, Any], None])

  • exact_response (Union[bool, IResolvable, None]) – Specifies whether to return an exact response, or to return an answer generated by the model, using the fields you specify from the database.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-bedrockknowledgestoreconfiguration.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.mixins_preview.aws_lex import mixins as lex_mixins

bedrock_knowledge_store_configuration_property = lex_mixins.CfnBotPropsMixin.BedrockKnowledgeStoreConfigurationProperty(
    bedrock_knowledge_base_arn="bedrockKnowledgeBaseArn",
    bkb_exact_response_fields=lex_mixins.CfnBotPropsMixin.BKBExactResponseFieldsProperty(
        answer_field="answerField"
    ),
    exact_response=False
)

Attributes

bedrock_knowledge_base_arn

The base ARN of the knowledge base used.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-bedrockknowledgestoreconfiguration.html#cfn-lex-bot-bedrockknowledgestoreconfiguration-bedrockknowledgebasearn

bkb_exact_response_fields

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-bedrockknowledgestoreconfiguration.html#cfn-lex-bot-bedrockknowledgestoreconfiguration-bkbexactresponsefields

Type:

see

exact_response

Specifies whether to return an exact response, or to return an answer generated by the model, using the fields you specify from the database.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-bedrockknowledgestoreconfiguration.html#cfn-lex-bot-bedrockknowledgestoreconfiguration-exactresponse

BedrockModelSpecificationProperty

class CfnBotPropsMixin.BedrockModelSpecificationProperty(*, bedrock_guardrail_configuration=None, bedrock_model_custom_prompt=None, bedrock_trace_status=None, model_arn=None)

Bases: object

Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.

Parameters:

  • bedrock_guardrail_configuration (Union[IResolvable, BedrockGuardrailConfigurationProperty, Dict[str, Any], None])

  • bedrock_model_custom_prompt (Optional[str])

  • bedrock_trace_status (Optional[str])

  • model_arn (Optional[str]) – The ARN of the foundation model used in descriptive bot building.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-bedrockmodelspecification.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.mixins_preview.aws_lex import mixins as lex_mixins

bedrock_model_specification_property = lex_mixins.CfnBotPropsMixin.BedrockModelSpecificationProperty(
    bedrock_guardrail_configuration=lex_mixins.CfnBotPropsMixin.BedrockGuardrailConfigurationProperty(
        bedrock_guardrail_identifier="bedrockGuardrailIdentifier",
        bedrock_guardrail_version="bedrockGuardrailVersion"
    ),
    bedrock_model_custom_prompt="bedrockModelCustomPrompt",
    bedrock_trace_status="bedrockTraceStatus",
    model_arn="modelArn"
)

Attributes

bedrock_guardrail_configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-bedrockmodelspecification.html#cfn-lex-bot-bedrockmodelspecification-bedrockguardrailconfiguration

Type:

see

bedrock_model_custom_prompt

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-bedrockmodelspecification.html#cfn-lex-bot-bedrockmodelspecification-bedrockmodelcustomprompt

Type:

see

bedrock_trace_status

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-bedrockmodelspecification.html#cfn-lex-bot-bedrockmodelspecification-bedrocktracestatus

Type:

see

model_arn

The ARN of the foundation model used in descriptive bot building.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-bedrockmodelspecification.html#cfn-lex-bot-bedrockmodelspecification-modelarn

BotAliasLocaleSettingsItemProperty

class CfnBotPropsMixin.BotAliasLocaleSettingsItemProperty(*, bot_alias_locale_setting=None, locale_id=None)

Bases: object

Specifies locale settings for a single locale.

Parameters:

  • bot_alias_locale_setting (Union[IResolvable, BotAliasLocaleSettingsProperty, Dict[str, Any], None]) – Specifies locale settings for a locale.

  • locale_id (Optional[str]) – Specifies the locale that the settings apply to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-botaliaslocalesettingsitem.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.mixins_preview.aws_lex import mixins as lex_mixins

bot_alias_locale_settings_item_property = lex_mixins.CfnBotPropsMixin.BotAliasLocaleSettingsItemProperty(
    bot_alias_locale_setting=lex_mixins.CfnBotPropsMixin.BotAliasLocaleSettingsProperty(
        code_hook_specification=lex_mixins.CfnBotPropsMixin.CodeHookSpecificationProperty(
            lambda_code_hook=lex_mixins.CfnBotPropsMixin.LambdaCodeHookProperty(
                code_hook_interface_version="codeHookInterfaceVersion",
                lambda_arn="lambdaArn"
            )
        ),
        enabled=False
    ),
    locale_id="localeId"
)

Attributes

bot_alias_locale_setting

Specifies locale settings for a locale.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-botaliaslocalesettingsitem.html#cfn-lex-bot-botaliaslocalesettingsitem-botaliaslocalesetting

locale_id

Specifies the locale that the settings apply to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-botaliaslocalesettingsitem.html#cfn-lex-bot-botaliaslocalesettingsitem-localeid

BotAliasLocaleSettingsProperty

class CfnBotPropsMixin.BotAliasLocaleSettingsProperty(*, code_hook_specification=None, enabled=None)

Bases: object

Specifies settings that are unique to a locale.

For example, you can use different Lambda function depending on the bot’s locale.

Parameters:

  • code_hook_specification (Union[IResolvable, CodeHookSpecificationProperty, Dict[str, Any], None]) – Specifies the Lambda function that should be used in the locale.

  • enabled (Union[bool, IResolvable, None]) – Determines whether the locale is enabled for the bot. If the value is false , the locale isn’t available for use.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-botaliaslocalesettings.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.mixins_preview.aws_lex import mixins as lex_mixins

bot_alias_locale_settings_property = lex_mixins.CfnBotPropsMixin.BotAliasLocaleSettingsProperty(
    code_hook_specification=lex_mixins.CfnBotPropsMixin.CodeHookSpecificationProperty(
        lambda_code_hook=lex_mixins.CfnBotPropsMixin.LambdaCodeHookProperty(
            code_hook_interface_version="codeHookInterfaceVersion",
            lambda_arn="lambdaArn"
        )
    ),
    enabled=False
)

Attributes

code_hook_specification

Specifies the Lambda function that should be used in the locale.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-botaliaslocalesettings.html#cfn-lex-bot-botaliaslocalesettings-codehookspecification

enabled

Determines whether the locale is enabled for the bot.

If the value is false , the locale isn’t available for use.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-botaliaslocalesettings.html#cfn-lex-bot-botaliaslocalesettings-enabled

BotLocaleProperty

class CfnBotPropsMixin.BotLocaleProperty(*, custom_vocabulary=None, description=None, generative_ai_settings=None, intents=None, locale_id=None, nlu_confidence_threshold=None, slot_types=None, voice_settings=None)

Bases: object

Provides configuration information for a locale.

Parameters:

  • custom_vocabulary (Union[IResolvable, CustomVocabularyProperty, Dict[str, Any], None]) – Specifies a custom vocabulary to use with a specific locale.

  • description (Optional[str]) – A description of the bot locale. Use this to help identify the bot locale in lists.

  • generative_ai_settings (Union[IResolvable, GenerativeAISettingsProperty, Dict[str, Any], None])

  • intents (Union[IResolvable, Sequence[Union[IResolvable, IntentProperty, Dict[str, Any]]], None]) – One or more intents defined for the locale.

  • locale_id (Optional[str]) – The identifier of the language and locale that the bot will be used in. The string must match one of the supported locales.

  • nlu_confidence_threshold (Union[int, float, None]) – Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent , AMAZON.KendraSearchIntent , or both when returning alternative intents. You must configure an AMAZON.FallbackIntent . AMAZON.KendraSearchIntent is only inserted if it is configured for the bot.

  • slot_types (Union[IResolvable, Sequence[Union[IResolvable, SlotTypeProperty, Dict[str, Any]]], None]) – One or more slot types defined for the locale.

  • voice_settings (Union[IResolvable, VoiceSettingsProperty, Dict[str, Any], None]) – Defines settings for using an Amazon Polly voice to communicate with a user. Valid values include: - standard - neural - long-form - generative

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-botlocale.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
custom_vocabulary

Specifies a custom vocabulary to use with a specific locale.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-botlocale.html#cfn-lex-bot-botlocale-customvocabulary

description

A description of the bot locale.

Use this to help identify the bot locale in lists.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-botlocale.html#cfn-lex-bot-botlocale-description

generative_ai_settings

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-botlocale.html#cfn-lex-bot-botlocale-generativeaisettings

Type:

see

intents

One or more intents defined for the locale.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-botlocale.html#cfn-lex-bot-botlocale-intents

locale_id

The identifier of the language and locale that the bot will be used in.

The string must match one of the supported locales.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-botlocale.html#cfn-lex-bot-botlocale-localeid

nlu_confidence_threshold

Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent , AMAZON.KendraSearchIntent , or both when returning alternative intents. You must configure an AMAZON.FallbackIntent . AMAZON.KendraSearchIntent is only inserted if it is configured for the bot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-botlocale.html#cfn-lex-bot-botlocale-nluconfidencethreshold

slot_types

One or more slot types defined for the locale.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-botlocale.html#cfn-lex-bot-botlocale-slottypes

voice_settings

Defines settings for using an Amazon Polly voice to communicate with a user.

Valid values include:

  • standard

  • neural

  • long-form

  • generative

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-botlocale.html#cfn-lex-bot-botlocale-voicesettings

BuildtimeSettingsProperty

class CfnBotPropsMixin.BuildtimeSettingsProperty(*, descriptive_bot_builder_specification=None, sample_utterance_generation_specification=None)

Bases: object

Contains specifications about the Amazon Lex build time generative AI capabilities from Amazon Bedrock that you can turn on for your bot.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-buildtimesettings.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.mixins_preview.aws_lex import mixins as lex_mixins

buildtime_settings_property = lex_mixins.CfnBotPropsMixin.BuildtimeSettingsProperty(
    descriptive_bot_builder_specification=lex_mixins.CfnBotPropsMixin.DescriptiveBotBuilderSpecificationProperty(
        bedrock_model_specification=lex_mixins.CfnBotPropsMixin.BedrockModelSpecificationProperty(
            bedrock_guardrail_configuration=lex_mixins.CfnBotPropsMixin.BedrockGuardrailConfigurationProperty(
                bedrock_guardrail_identifier="bedrockGuardrailIdentifier",
                bedrock_guardrail_version="bedrockGuardrailVersion"
            ),
            bedrock_model_custom_prompt="bedrockModelCustomPrompt",
            bedrock_trace_status="bedrockTraceStatus",
            model_arn="modelArn"
        ),
        enabled=False
    ),
    sample_utterance_generation_specification=lex_mixins.CfnBotPropsMixin.SampleUtteranceGenerationSpecificationProperty(
        bedrock_model_specification=lex_mixins.CfnBotPropsMixin.BedrockModelSpecificationProperty(
            bedrock_guardrail_configuration=lex_mixins.CfnBotPropsMixin.BedrockGuardrailConfigurationProperty(
                bedrock_guardrail_identifier="bedrockGuardrailIdentifier",
                bedrock_guardrail_version="bedrockGuardrailVersion"
            ),
            bedrock_model_custom_prompt="bedrockModelCustomPrompt",
            bedrock_trace_status="bedrockTraceStatus",
            model_arn="modelArn"
        ),
        enabled=False
    )
)

Attributes

descriptive_bot_builder_specification

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-buildtimesettings.html#cfn-lex-bot-buildtimesettings-descriptivebotbuilderspecification

Type:

see

sample_utterance_generation_specification

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-buildtimesettings.html#cfn-lex-bot-buildtimesettings-sampleutterancegenerationspecification

Type:

see

ButtonProperty

class CfnBotPropsMixin.ButtonProperty(*, text=None, value=None)

Bases: object

Describes a button to use on a response card used to gather slot values from a user.

Parameters:

  • text (Optional[str]) – The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

  • value (Optional[str]) – The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-button.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.mixins_preview.aws_lex import mixins as lex_mixins

button_property = lex_mixins.CfnBotPropsMixin.ButtonProperty(
    text="text",
    value="value"
)

Attributes

text

The text that appears on the button.

Use this to tell the user what value is returned when they choose this button.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-button.html#cfn-lex-bot-button-text

value

The value returned to Amazon Lex when the user chooses this button.

This must be one of the slot values configured for the slot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-button.html#cfn-lex-bot-button-value

CloudWatchLogGroupLogDestinationProperty

class CfnBotPropsMixin.CloudWatchLogGroupLogDestinationProperty(*, cloud_watch_log_group_arn=None, log_prefix=None)

Bases: object

The Amazon CloudWatch Logs log group where the text and metadata logs are delivered.

The log group must exist before you enable logging.

Parameters:

  • cloud_watch_log_group_arn (Optional[str]) – The Amazon Resource Name (ARN) of the log group where text and metadata logs are delivered.

  • log_prefix (Optional[str]) – The prefix of the log stream name within the log group that you specified.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-cloudwatchloggrouplogdestination.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.mixins_preview.aws_lex import mixins as lex_mixins

cloud_watch_log_group_log_destination_property = lex_mixins.CfnBotPropsMixin.CloudWatchLogGroupLogDestinationProperty(
    cloud_watch_log_group_arn="cloudWatchLogGroupArn",
    log_prefix="logPrefix"
)

Attributes

cloud_watch_log_group_arn

The Amazon Resource Name (ARN) of the log group where text and metadata logs are delivered.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-cloudwatchloggrouplogdestination.html#cfn-lex-bot-cloudwatchloggrouplogdestination-cloudwatchloggrouparn

log_prefix

The prefix of the log stream name within the log group that you specified.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-cloudwatchloggrouplogdestination.html#cfn-lex-bot-cloudwatchloggrouplogdestination-logprefix

CodeHookSpecificationProperty

class CfnBotPropsMixin.CodeHookSpecificationProperty(*, lambda_code_hook=None)

Bases: object

Contains information about code hooks that Amazon Lex calls during a conversation.

Parameters:

lambda_code_hook (Union[IResolvable, LambdaCodeHookProperty, Dict[str, Any], None]) – Specifies a Lambda function that verifies requests to a bot or fulfills the user’s request to a bot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-codehookspecification.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.mixins_preview.aws_lex import mixins as lex_mixins

code_hook_specification_property = lex_mixins.CfnBotPropsMixin.CodeHookSpecificationProperty(
    lambda_code_hook=lex_mixins.CfnBotPropsMixin.LambdaCodeHookProperty(
        code_hook_interface_version="codeHookInterfaceVersion",
        lambda_arn="lambdaArn"
    )
)

Attributes

lambda_code_hook

Specifies a Lambda function that verifies requests to a bot or fulfills the user’s request to a bot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-codehookspecification.html#cfn-lex-bot-codehookspecification-lambdacodehook

CompositeSlotTypeSettingProperty

class CfnBotPropsMixin.CompositeSlotTypeSettingProperty(*, sub_slots=None)

Bases: object

A composite slot is a combination of two or more slots that capture multiple pieces of information in a single user input.

Parameters:

sub_slots (Union[IResolvable, Sequence[Union[IResolvable, SubSlotTypeCompositionProperty, Dict[str, Any]]], None]) – Subslots in the composite slot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-compositeslottypesetting.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.mixins_preview.aws_lex import mixins as lex_mixins

composite_slot_type_setting_property = lex_mixins.CfnBotPropsMixin.CompositeSlotTypeSettingProperty(
    sub_slots=[lex_mixins.CfnBotPropsMixin.SubSlotTypeCompositionProperty(
        name="name",
        slot_type_id="slotTypeId"
    )]
)

Attributes

sub_slots

Subslots in the composite slot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-compositeslottypesetting.html#cfn-lex-bot-compositeslottypesetting-subslots

ConditionProperty

class CfnBotPropsMixin.ConditionProperty(*, expression_string=None)

Bases: object

Provides an expression that evaluates to true or false.

Parameters:

expression_string (Optional[str]) – The expression string that is evaluated.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-condition.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.mixins_preview.aws_lex import mixins as lex_mixins

condition_property = lex_mixins.CfnBotPropsMixin.ConditionProperty(
    expression_string="expressionString"
)

Attributes

expression_string

The expression string that is evaluated.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-condition.html#cfn-lex-bot-condition-expressionstring

ConditionalBranchProperty

class CfnBotPropsMixin.ConditionalBranchProperty(*, condition=None, name=None, next_step=None, response=None)

Bases: object

A set of actions that Amazon Lex should run if the condition is matched.

Parameters:

  • condition (Union[IResolvable, ConditionProperty, Dict[str, Any], None]) – Contains the expression to evaluate. If the condition is true, the branch’s actions are taken.

  • name (Optional[str]) – The name of the branch.

  • next_step (Union[IResolvable, DialogStateProperty, Dict[str, Any], None]) – The next step in the conversation.

  • response (Union[IResolvable, ResponseSpecificationProperty, Dict[str, Any], None]) – Specifies a list of message groups that Amazon Lex uses to respond the user input.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalbranch.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.mixins_preview.aws_lex import mixins as lex_mixins

# slot_value_override_property_: lex_mixins.CfnBotPropsMixin.SlotValueOverrideProperty

conditional_branch_property = lex_mixins.CfnBotPropsMixin.ConditionalBranchProperty(
    condition=lex_mixins.CfnBotPropsMixin.ConditionProperty(
        expression_string="expressionString"
    ),
    name="name",
    next_step=lex_mixins.CfnBotPropsMixin.DialogStateProperty(
        dialog_action=lex_mixins.CfnBotPropsMixin.DialogActionProperty(
            slot_to_elicit="slotToElicit",
            suppress_next_message=False,
            type="type"
        ),
        intent=lex_mixins.CfnBotPropsMixin.IntentOverrideProperty(
            name="name",
            slots=[lex_mixins.CfnBotPropsMixin.SlotValueOverrideMapProperty(
                slot_name="slotName",
                slot_value_override=lex_mixins.CfnBotPropsMixin.SlotValueOverrideProperty(
                    shape="shape",
                    value=lex_mixins.CfnBotPropsMixin.SlotValueProperty(
                        interpreted_value="interpretedValue"
                    ),
                    values=[slot_value_override_property_]
                )
            )]
        ),
        session_attributes=[lex_mixins.CfnBotPropsMixin.SessionAttributeProperty(
            key="key",
            value="value"
        )]
    ),
    response=lex_mixins.CfnBotPropsMixin.ResponseSpecificationProperty(
        allow_interrupt=False,
        message_groups_list=[lex_mixins.CfnBotPropsMixin.MessageGroupProperty(
            message=lex_mixins.CfnBotPropsMixin.MessageProperty(
                custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                    value="value"
                ),
                image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                    buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                        text="text",
                        value="value"
                    )],
                    image_url="imageUrl",
                    subtitle="subtitle",
                    title="title"
                ),
                plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                    value="value"
                ),
                ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                    value="value"
                )
            ),
            variations=[lex_mixins.CfnBotPropsMixin.MessageProperty(
                custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                    value="value"
                ),
                image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                    buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                        text="text",
                        value="value"
                    )],
                    image_url="imageUrl",
                    subtitle="subtitle",
                    title="title"
                ),
                plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                    value="value"
                ),
                ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                    value="value"
                )
            )]
        )]
    )
)

Attributes

condition

Contains the expression to evaluate.

If the condition is true, the branch’s actions are taken.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalbranch.html#cfn-lex-bot-conditionalbranch-condition

name

The name of the branch.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalbranch.html#cfn-lex-bot-conditionalbranch-name

next_step

The next step in the conversation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalbranch.html#cfn-lex-bot-conditionalbranch-nextstep

response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalbranch.html#cfn-lex-bot-conditionalbranch-response

ConditionalSpecificationProperty

class CfnBotPropsMixin.ConditionalSpecificationProperty(*, conditional_branches=None, default_branch=None, is_active=None)

Bases: object

Provides a list of conditional branches.

Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.

Parameters:

  • conditional_branches (Union[IResolvable, Sequence[Union[IResolvable, ConditionalBranchProperty, Dict[str, Any]]], None]) – A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.

  • default_branch (Union[IResolvable, DefaultConditionalBranchProperty, Dict[str, Any], None]) – The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.

  • is_active (Union[bool, IResolvable, None]) – Determines whether a conditional branch is active. When IsActive is false, the conditions are not evaluated.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.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.mixins_preview.aws_lex import mixins as lex_mixins

# slot_value_override_property_: lex_mixins.CfnBotPropsMixin.SlotValueOverrideProperty

conditional_specification_property = lex_mixins.CfnBotPropsMixin.ConditionalSpecificationProperty(
    conditional_branches=[lex_mixins.CfnBotPropsMixin.ConditionalBranchProperty(
        condition=lex_mixins.CfnBotPropsMixin.ConditionProperty(
            expression_string="expressionString"
        ),
        name="name",
        next_step=lex_mixins.CfnBotPropsMixin.DialogStateProperty(
            dialog_action=lex_mixins.CfnBotPropsMixin.DialogActionProperty(
                slot_to_elicit="slotToElicit",
                suppress_next_message=False,
                type="type"
            ),
            intent=lex_mixins.CfnBotPropsMixin.IntentOverrideProperty(
                name="name",
                slots=[lex_mixins.CfnBotPropsMixin.SlotValueOverrideMapProperty(
                    slot_name="slotName",
                    slot_value_override=lex_mixins.CfnBotPropsMixin.SlotValueOverrideProperty(
                        shape="shape",
                        value=lex_mixins.CfnBotPropsMixin.SlotValueProperty(
                            interpreted_value="interpretedValue"
                        ),
                        values=[slot_value_override_property_]
                    )
                )]
            ),
            session_attributes=[lex_mixins.CfnBotPropsMixin.SessionAttributeProperty(
                key="key",
                value="value"
            )]
        ),
        response=lex_mixins.CfnBotPropsMixin.ResponseSpecificationProperty(
            allow_interrupt=False,
            message_groups_list=[lex_mixins.CfnBotPropsMixin.MessageGroupProperty(
                message=lex_mixins.CfnBotPropsMixin.MessageProperty(
                    custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                        value="value"
                    ),
                    image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                        buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                            text="text",
                            value="value"
                        )],
                        image_url="imageUrl",
                        subtitle="subtitle",
                        title="title"
                    ),
                    plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                        value="value"
                    ),
                    ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                        value="value"
                    )
                ),
                variations=[lex_mixins.CfnBotPropsMixin.MessageProperty(
                    custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                        value="value"
                    ),
                    image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                        buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                            text="text",
                            value="value"
                        )],
                        image_url="imageUrl",
                        subtitle="subtitle",
                        title="title"
                    ),
                    plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                        value="value"
                    ),
                    ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                        value="value"
                    )
                )]
            )]
        )
    )],
    default_branch=lex_mixins.CfnBotPropsMixin.DefaultConditionalBranchProperty(
        next_step=lex_mixins.CfnBotPropsMixin.DialogStateProperty(
            dialog_action=lex_mixins.CfnBotPropsMixin.DialogActionProperty(
                slot_to_elicit="slotToElicit",
                suppress_next_message=False,
                type="type"
            ),
            intent=lex_mixins.CfnBotPropsMixin.IntentOverrideProperty(
                name="name",
                slots=[lex_mixins.CfnBotPropsMixin.SlotValueOverrideMapProperty(
                    slot_name="slotName",
                    slot_value_override=lex_mixins.CfnBotPropsMixin.SlotValueOverrideProperty(
                        shape="shape",
                        value=lex_mixins.CfnBotPropsMixin.SlotValueProperty(
                            interpreted_value="interpretedValue"
                        ),
                        values=[slot_value_override_property_]
                    )
                )]
            ),
            session_attributes=[lex_mixins.CfnBotPropsMixin.SessionAttributeProperty(
                key="key",
                value="value"
            )]
        ),
        response=lex_mixins.CfnBotPropsMixin.ResponseSpecificationProperty(
            allow_interrupt=False,
            message_groups_list=[lex_mixins.CfnBotPropsMixin.MessageGroupProperty(
                message=lex_mixins.CfnBotPropsMixin.MessageProperty(
                    custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                        value="value"
                    ),
                    image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                        buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                            text="text",
                            value="value"
                        )],
                        image_url="imageUrl",
                        subtitle="subtitle",
                        title="title"
                    ),
                    plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                        value="value"
                    ),
                    ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                        value="value"
                    )
                ),
                variations=[lex_mixins.CfnBotPropsMixin.MessageProperty(
                    custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                        value="value"
                    ),
                    image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                        buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                            text="text",
                            value="value"
                        )],
                        image_url="imageUrl",
                        subtitle="subtitle",
                        title="title"
                    ),
                    plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                        value="value"
                    ),
                    ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                        value="value"
                    )
                )]
            )]
        )
    ),
    is_active=False
)

Attributes

conditional_branches

A list of conditional branches.

A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html#cfn-lex-bot-conditionalspecification-conditionalbranches

default_branch

The conditional branch that should be followed when the conditions for other branches are not satisfied.

A conditional branch is made up of a condition, a response and a next step.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html#cfn-lex-bot-conditionalspecification-defaultbranch

is_active

Determines whether a conditional branch is active.

When IsActive is false, the conditions are not evaluated.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conditionalspecification.html#cfn-lex-bot-conditionalspecification-isactive

ConversationLogSettingsProperty

class CfnBotPropsMixin.ConversationLogSettingsProperty(*, audio_log_settings=None, text_log_settings=None)

Bases: object

Configures conversation logging that saves audio, text, and metadata for the conversations with your users.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conversationlogsettings.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.mixins_preview.aws_lex import mixins as lex_mixins

conversation_log_settings_property = lex_mixins.CfnBotPropsMixin.ConversationLogSettingsProperty(
    audio_log_settings=[lex_mixins.CfnBotPropsMixin.AudioLogSettingProperty(
        destination=lex_mixins.CfnBotPropsMixin.AudioLogDestinationProperty(
            s3_bucket=lex_mixins.CfnBotPropsMixin.S3BucketLogDestinationProperty(
                kms_key_arn="kmsKeyArn",
                log_prefix="logPrefix",
                s3_bucket_arn="s3BucketArn"
            )
        ),
        enabled=False
    )],
    text_log_settings=[lex_mixins.CfnBotPropsMixin.TextLogSettingProperty(
        destination=lex_mixins.CfnBotPropsMixin.TextLogDestinationProperty(
            cloud_watch=lex_mixins.CfnBotPropsMixin.CloudWatchLogGroupLogDestinationProperty(
                cloud_watch_log_group_arn="cloudWatchLogGroupArn",
                log_prefix="logPrefix"
            )
        ),
        enabled=False
    )]
)

Attributes

audio_log_settings

The Amazon S3 settings for logging audio to an S3 bucket.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conversationlogsettings.html#cfn-lex-bot-conversationlogsettings-audiologsettings

text_log_settings

The Amazon CloudWatch Logs settings for logging text and metadata.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-conversationlogsettings.html#cfn-lex-bot-conversationlogsettings-textlogsettings

CustomPayloadProperty

class CfnBotPropsMixin.CustomPayloadProperty(*, value=None)

Bases: object

A custom response string that Amazon Lex sends to your application.

You define the content and structure the string.

Parameters:

value (Optional[str]) – The string that is sent to your application.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-custompayload.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.mixins_preview.aws_lex import mixins as lex_mixins

custom_payload_property = lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
    value="value"
)

Attributes

value

The string that is sent to your application.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-custompayload.html#cfn-lex-bot-custompayload-value

CustomVocabularyItemProperty

class CfnBotPropsMixin.CustomVocabularyItemProperty(*, display_as=None, phrase=None, weight=None)

Bases: object

Specifies an entry in a custom vocabulary.

Parameters:

  • display_as (Optional[str]) – The DisplayAs value for the custom vocabulary item from the custom vocabulary list.

  • phrase (Optional[str]) – Specifies 1 - 4 words that should be recognized.

  • weight (Union[int, float, None]) – Specifies the degree to which the phrase recognition is boosted. The default value is 1.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-customvocabularyitem.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.mixins_preview.aws_lex import mixins as lex_mixins

custom_vocabulary_item_property = lex_mixins.CfnBotPropsMixin.CustomVocabularyItemProperty(
    display_as="displayAs",
    phrase="phrase",
    weight=123
)

Attributes

display_as

The DisplayAs value for the custom vocabulary item from the custom vocabulary list.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-customvocabularyitem.html#cfn-lex-bot-customvocabularyitem-displayas

phrase

Specifies 1 - 4 words that should be recognized.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-customvocabularyitem.html#cfn-lex-bot-customvocabularyitem-phrase

weight

Specifies the degree to which the phrase recognition is boosted.

The default value is 1.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-customvocabularyitem.html#cfn-lex-bot-customvocabularyitem-weight

CustomVocabularyProperty

class CfnBotPropsMixin.CustomVocabularyProperty(*, custom_vocabulary_items=None)

Bases: object

Specifies a custom vocabulary.

A custom vocabulary is a list of words that you expect to be used during a conversation with your bot.

Parameters:

custom_vocabulary_items (Union[IResolvable, Sequence[Union[IResolvable, CustomVocabularyItemProperty, Dict[str, Any]]], None]) – Specifies a list of words that you expect to be used during a conversation with your bot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-customvocabulary.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.mixins_preview.aws_lex import mixins as lex_mixins

custom_vocabulary_property = lex_mixins.CfnBotPropsMixin.CustomVocabularyProperty(
    custom_vocabulary_items=[lex_mixins.CfnBotPropsMixin.CustomVocabularyItemProperty(
        display_as="displayAs",
        phrase="phrase",
        weight=123
    )]
)

Attributes

custom_vocabulary_items

Specifies a list of words that you expect to be used during a conversation with your bot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-customvocabulary.html#cfn-lex-bot-customvocabulary-customvocabularyitems

DTMFSpecificationProperty

class CfnBotPropsMixin.DTMFSpecificationProperty(*, deletion_character=None, end_character=None, end_timeout_ms=None, max_length=None)

Bases: object

Specifies the DTMF input specifications.

Parameters:

  • deletion_character (Optional[str]) – The DTMF character that clears the accumulated DTMF digits and immediately ends the input.

  • end_character (Optional[str]) – The DTMF character that immediately ends input. If the user does not press this character, the input ends after the end timeout.

  • end_timeout_ms (Union[int, float, None]) – How long the bot should wait after the last DTMF character input before assuming that the input has concluded.

  • max_length (Union[int, float, None]) – The maximum number of DTMF digits allowed in an utterance.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dtmfspecification.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.mixins_preview.aws_lex import mixins as lex_mixins

d_tMFSpecification_property = lex_mixins.CfnBotPropsMixin.DTMFSpecificationProperty(
    deletion_character="deletionCharacter",
    end_character="endCharacter",
    end_timeout_ms=123,
    max_length=123
)

Attributes

deletion_character

The DTMF character that clears the accumulated DTMF digits and immediately ends the input.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dtmfspecification.html#cfn-lex-bot-dtmfspecification-deletioncharacter

end_character

The DTMF character that immediately ends input.

If the user does not press this character, the input ends after the end timeout.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dtmfspecification.html#cfn-lex-bot-dtmfspecification-endcharacter

end_timeout_ms

How long the bot should wait after the last DTMF character input before assuming that the input has concluded.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dtmfspecification.html#cfn-lex-bot-dtmfspecification-endtimeoutms

max_length

The maximum number of DTMF digits allowed in an utterance.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dtmfspecification.html#cfn-lex-bot-dtmfspecification-maxlength

DataPrivacyProperty

class CfnBotPropsMixin.DataPrivacyProperty(*, child_directed=None)

Bases: object

By default, data stored by Amazon Lex is encrypted.

The DataPrivacy structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.

Parameters:

child_directed (Union[bool, IResolvable, None]) – For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children’s Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dataprivacy.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.mixins_preview.aws_lex import mixins as lex_mixins

data_privacy_property = lex_mixins.CfnBotPropsMixin.DataPrivacyProperty(
    child_directed=False
)

Attributes

child_directed

For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children’s Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field.

By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dataprivacy.html#cfn-lex-bot-dataprivacy-childdirected

DataSourceConfigurationProperty

class CfnBotPropsMixin.DataSourceConfigurationProperty(*, bedrock_knowledge_store_configuration=None, kendra_configuration=None, opensearch_configuration=None)

Bases: object

Contains details about the configuration of the knowledge store used for the AMAZON.QnAIntent . You must have already created the knowledge store and indexed the documents within it.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-datasourceconfiguration.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.mixins_preview.aws_lex import mixins as lex_mixins

data_source_configuration_property = lex_mixins.CfnBotPropsMixin.DataSourceConfigurationProperty(
    bedrock_knowledge_store_configuration=lex_mixins.CfnBotPropsMixin.BedrockKnowledgeStoreConfigurationProperty(
        bedrock_knowledge_base_arn="bedrockKnowledgeBaseArn",
        bkb_exact_response_fields=lex_mixins.CfnBotPropsMixin.BKBExactResponseFieldsProperty(
            answer_field="answerField"
        ),
        exact_response=False
    ),
    kendra_configuration=lex_mixins.CfnBotPropsMixin.QnAKendraConfigurationProperty(
        exact_response=False,
        kendra_index="kendraIndex",
        query_filter_string="queryFilterString",
        query_filter_string_enabled=False
    ),
    opensearch_configuration=lex_mixins.CfnBotPropsMixin.OpensearchConfigurationProperty(
        domain_endpoint="domainEndpoint",
        exact_response=False,
        exact_response_fields=lex_mixins.CfnBotPropsMixin.ExactResponseFieldsProperty(
            answer_field="answerField",
            question_field="questionField"
        ),
        include_fields=["includeFields"],
        index_name="indexName"
    )
)

Attributes

bedrock_knowledge_store_configuration

Contains details about the configuration of the Amazon Bedrock knowledge base used for the AMAZON.QnAIntent . To set up a knowledge base, follow the steps at Building a knowledge base .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-datasourceconfiguration.html#cfn-lex-bot-datasourceconfiguration-bedrockknowledgestoreconfiguration

kendra_configuration

Contains details about the configuration of the Amazon Kendra index used for the AMAZON.QnAIntent . To create a Amazon Kendra index, follow the steps at Creating an index .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-datasourceconfiguration.html#cfn-lex-bot-datasourceconfiguration-kendraconfiguration

opensearch_configuration

Contains details about the configuration of the Amazon OpenSearch Service database used for the AMAZON.QnAIntent . To create a domain, follow the steps at Creating and managing Amazon OpenSearch Service domains .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-datasourceconfiguration.html#cfn-lex-bot-datasourceconfiguration-opensearchconfiguration

DefaultConditionalBranchProperty

class CfnBotPropsMixin.DefaultConditionalBranchProperty(*, next_step=None, response=None)

Bases: object

A set of actions that Amazon Lex should run if none of the other conditions are met.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-defaultconditionalbranch.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.mixins_preview.aws_lex import mixins as lex_mixins

# slot_value_override_property_: lex_mixins.CfnBotPropsMixin.SlotValueOverrideProperty

default_conditional_branch_property = lex_mixins.CfnBotPropsMixin.DefaultConditionalBranchProperty(
    next_step=lex_mixins.CfnBotPropsMixin.DialogStateProperty(
        dialog_action=lex_mixins.CfnBotPropsMixin.DialogActionProperty(
            slot_to_elicit="slotToElicit",
            suppress_next_message=False,
            type="type"
        ),
        intent=lex_mixins.CfnBotPropsMixin.IntentOverrideProperty(
            name="name",
            slots=[lex_mixins.CfnBotPropsMixin.SlotValueOverrideMapProperty(
                slot_name="slotName",
                slot_value_override=lex_mixins.CfnBotPropsMixin.SlotValueOverrideProperty(
                    shape="shape",
                    value=lex_mixins.CfnBotPropsMixin.SlotValueProperty(
                        interpreted_value="interpretedValue"
                    ),
                    values=[slot_value_override_property_]
                )
            )]
        ),
        session_attributes=[lex_mixins.CfnBotPropsMixin.SessionAttributeProperty(
            key="key",
            value="value"
        )]
    ),
    response=lex_mixins.CfnBotPropsMixin.ResponseSpecificationProperty(
        allow_interrupt=False,
        message_groups_list=[lex_mixins.CfnBotPropsMixin.MessageGroupProperty(
            message=lex_mixins.CfnBotPropsMixin.MessageProperty(
                custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                    value="value"
                ),
                image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                    buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                        text="text",
                        value="value"
                    )],
                    image_url="imageUrl",
                    subtitle="subtitle",
                    title="title"
                ),
                plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                    value="value"
                ),
                ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                    value="value"
                )
            ),
            variations=[lex_mixins.CfnBotPropsMixin.MessageProperty(
                custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                    value="value"
                ),
                image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                    buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                        text="text",
                        value="value"
                    )],
                    image_url="imageUrl",
                    subtitle="subtitle",
                    title="title"
                ),
                plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                    value="value"
                ),
                ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                    value="value"
                )
            )]
        )]
    )
)

Attributes

next_step

The next step in the conversation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-defaultconditionalbranch.html#cfn-lex-bot-defaultconditionalbranch-nextstep

response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-defaultconditionalbranch.html#cfn-lex-bot-defaultconditionalbranch-response

DescriptiveBotBuilderSpecificationProperty

class CfnBotPropsMixin.DescriptiveBotBuilderSpecificationProperty(*, bedrock_model_specification=None, enabled=None)

Bases: object

Contains specifications for the descriptive bot building feature.

Parameters:

  • bedrock_model_specification (Union[IResolvable, BedrockModelSpecificationProperty, Dict[str, Any], None]) – An object containing information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.

  • enabled (Union[bool, IResolvable, None]) – Specifies whether the descriptive bot building feature is activated or not.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-descriptivebotbuilderspecification.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.mixins_preview.aws_lex import mixins as lex_mixins

descriptive_bot_builder_specification_property = lex_mixins.CfnBotPropsMixin.DescriptiveBotBuilderSpecificationProperty(
    bedrock_model_specification=lex_mixins.CfnBotPropsMixin.BedrockModelSpecificationProperty(
        bedrock_guardrail_configuration=lex_mixins.CfnBotPropsMixin.BedrockGuardrailConfigurationProperty(
            bedrock_guardrail_identifier="bedrockGuardrailIdentifier",
            bedrock_guardrail_version="bedrockGuardrailVersion"
        ),
        bedrock_model_custom_prompt="bedrockModelCustomPrompt",
        bedrock_trace_status="bedrockTraceStatus",
        model_arn="modelArn"
    ),
    enabled=False
)

Attributes

bedrock_model_specification

An object containing information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-descriptivebotbuilderspecification.html#cfn-lex-bot-descriptivebotbuilderspecification-bedrockmodelspecification

enabled

Specifies whether the descriptive bot building feature is activated or not.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-descriptivebotbuilderspecification.html#cfn-lex-bot-descriptivebotbuilderspecification-enabled

DialogActionProperty

class CfnBotPropsMixin.DialogActionProperty(*, slot_to_elicit=None, suppress_next_message=None, type=None)

Bases: object

Defines the action that the bot executes at runtime when the conversation reaches this step.

Parameters:

  • slot_to_elicit (Optional[str]) – If the dialog action is ElicitSlot , defines the slot to elicit from the user.

  • suppress_next_message (Union[bool, IResolvable, None]) – When true the next message for the intent is not used.

  • type (Optional[str]) – The action that the bot should execute.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogaction.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.mixins_preview.aws_lex import mixins as lex_mixins

dialog_action_property = lex_mixins.CfnBotPropsMixin.DialogActionProperty(
    slot_to_elicit="slotToElicit",
    suppress_next_message=False,
    type="type"
)

Attributes

slot_to_elicit

If the dialog action is ElicitSlot , defines the slot to elicit from the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogaction.html#cfn-lex-bot-dialogaction-slottoelicit

suppress_next_message

When true the next message for the intent is not used.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogaction.html#cfn-lex-bot-dialogaction-suppressnextmessage

type

The action that the bot should execute.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogaction.html#cfn-lex-bot-dialogaction-type

DialogCodeHookInvocationSettingProperty

class CfnBotPropsMixin.DialogCodeHookInvocationSettingProperty(*, enable_code_hook_invocation=None, invocation_label=None, is_active=None, post_code_hook_specification=None)

Bases: object

Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation.

Parameters:

  • enable_code_hook_invocation (Union[bool, IResolvable, None]) – Indicates whether a Lambda function should be invoked for the dialog.

  • invocation_label (Optional[str]) – A label that indicates the dialog step from which the dialog code hook is happening.

  • is_active (Union[bool, IResolvable, None]) – Determines whether a dialog code hook is used when the intent is activated.

  • post_code_hook_specification (Union[IResolvable, PostDialogCodeHookInvocationSpecificationProperty, Dict[str, Any], None]) – Contains the responses and actions that Amazon Lex takes after the Lambda function is complete.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogcodehookinvocationsetting.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
enable_code_hook_invocation

Indicates whether a Lambda function should be invoked for the dialog.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogcodehookinvocationsetting.html#cfn-lex-bot-dialogcodehookinvocationsetting-enablecodehookinvocation

invocation_label

A label that indicates the dialog step from which the dialog code hook is happening.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogcodehookinvocationsetting.html#cfn-lex-bot-dialogcodehookinvocationsetting-invocationlabel

is_active

Determines whether a dialog code hook is used when the intent is activated.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogcodehookinvocationsetting.html#cfn-lex-bot-dialogcodehookinvocationsetting-isactive

post_code_hook_specification

Contains the responses and actions that Amazon Lex takes after the Lambda function is complete.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogcodehookinvocationsetting.html#cfn-lex-bot-dialogcodehookinvocationsetting-postcodehookspecification

DialogCodeHookSettingProperty

class CfnBotPropsMixin.DialogCodeHookSettingProperty(*, enabled=None)

Bases: object

Settings that determine the Lambda function that Amazon Lex uses for processing user responses.

Parameters:

enabled (Union[bool, IResolvable, None]) – Enables the dialog code hook so that it processes user requests.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogcodehooksetting.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.mixins_preview.aws_lex import mixins as lex_mixins

dialog_code_hook_setting_property = lex_mixins.CfnBotPropsMixin.DialogCodeHookSettingProperty(
    enabled=False
)

Attributes

enabled

Enables the dialog code hook so that it processes user requests.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogcodehooksetting.html#cfn-lex-bot-dialogcodehooksetting-enabled

DialogStateProperty

class CfnBotPropsMixin.DialogStateProperty(*, dialog_action=None, intent=None, session_attributes=None)

Bases: object

The current state of the conversation with the user.

Parameters:

  • dialog_action (Union[IResolvable, DialogActionProperty, Dict[str, Any], None]) – Defines the action that the bot executes at runtime when the conversation reaches this step.

  • intent (Union[IResolvable, IntentOverrideProperty, Dict[str, Any], None]) – Override settings to configure the intent state.

  • session_attributes (Union[IResolvable, Sequence[Union[IResolvable, SessionAttributeProperty, Dict[str, Any]]], None]) – Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.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.mixins_preview.aws_lex import mixins as lex_mixins

# slot_value_override_property_: lex_mixins.CfnBotPropsMixin.SlotValueOverrideProperty

dialog_state_property = lex_mixins.CfnBotPropsMixin.DialogStateProperty(
    dialog_action=lex_mixins.CfnBotPropsMixin.DialogActionProperty(
        slot_to_elicit="slotToElicit",
        suppress_next_message=False,
        type="type"
    ),
    intent=lex_mixins.CfnBotPropsMixin.IntentOverrideProperty(
        name="name",
        slots=[lex_mixins.CfnBotPropsMixin.SlotValueOverrideMapProperty(
            slot_name="slotName",
            slot_value_override=lex_mixins.CfnBotPropsMixin.SlotValueOverrideProperty(
                shape="shape",
                value=lex_mixins.CfnBotPropsMixin.SlotValueProperty(
                    interpreted_value="interpretedValue"
                ),
                values=[slot_value_override_property_]
            )
        )]
    ),
    session_attributes=[lex_mixins.CfnBotPropsMixin.SessionAttributeProperty(
        key="key",
        value="value"
    )]
)

Attributes

dialog_action

Defines the action that the bot executes at runtime when the conversation reaches this step.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html#cfn-lex-bot-dialogstate-dialogaction

intent

Override settings to configure the intent state.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html#cfn-lex-bot-dialogstate-intent

session_attributes

Map of key/value pairs representing session-specific context information.

It contains application information passed between Amazon Lex and a client application.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-dialogstate.html#cfn-lex-bot-dialogstate-sessionattributes

ElicitationCodeHookInvocationSettingProperty

class CfnBotPropsMixin.ElicitationCodeHookInvocationSettingProperty(*, enable_code_hook_invocation=None, invocation_label=None)

Bases: object

Settings that specify the dialog code hook that is called by Amazon Lex between eliciting slot values.

Parameters:

  • enable_code_hook_invocation (Union[bool, IResolvable, None]) – Indicates whether a Lambda function should be invoked for the dialog.

  • invocation_label (Optional[str]) – A label that indicates the dialog step from which the dialog code hook is happening.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-elicitationcodehookinvocationsetting.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.mixins_preview.aws_lex import mixins as lex_mixins

elicitation_code_hook_invocation_setting_property = lex_mixins.CfnBotPropsMixin.ElicitationCodeHookInvocationSettingProperty(
    enable_code_hook_invocation=False,
    invocation_label="invocationLabel"
)

Attributes

enable_code_hook_invocation

Indicates whether a Lambda function should be invoked for the dialog.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-elicitationcodehookinvocationsetting.html#cfn-lex-bot-elicitationcodehookinvocationsetting-enablecodehookinvocation

invocation_label

A label that indicates the dialog step from which the dialog code hook is happening.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-elicitationcodehookinvocationsetting.html#cfn-lex-bot-elicitationcodehookinvocationsetting-invocationlabel

ErrorLogSettingsProperty

class CfnBotPropsMixin.ErrorLogSettingsProperty(*, enabled=None)

Bases: object

Parameters:

enabled (Union[bool, IResolvable, None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-errorlogsettings.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.mixins_preview.aws_lex import mixins as lex_mixins

error_log_settings_property = lex_mixins.CfnBotPropsMixin.ErrorLogSettingsProperty(
    enabled=False
)

Attributes

enabled

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-errorlogsettings.html#cfn-lex-bot-errorlogsettings-enabled

Type:

see

ExactResponseFieldsProperty

class CfnBotPropsMixin.ExactResponseFieldsProperty(*, answer_field=None, question_field=None)

Bases: object

Contains the names of the fields used for an exact response to the user.

Parameters:

  • answer_field (Optional[str]) – The name of the field that contains the answer to the query made to the OpenSearch Service database.

  • question_field (Optional[str]) – The name of the field that contains the query made to the OpenSearch Service database.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-exactresponsefields.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.mixins_preview.aws_lex import mixins as lex_mixins

exact_response_fields_property = lex_mixins.CfnBotPropsMixin.ExactResponseFieldsProperty(
    answer_field="answerField",
    question_field="questionField"
)

Attributes

answer_field

The name of the field that contains the answer to the query made to the OpenSearch Service database.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-exactresponsefields.html#cfn-lex-bot-exactresponsefields-answerfield

question_field

The name of the field that contains the query made to the OpenSearch Service database.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-exactresponsefields.html#cfn-lex-bot-exactresponsefields-questionfield

ExternalSourceSettingProperty

class CfnBotPropsMixin.ExternalSourceSettingProperty(*, grammar_slot_type_setting=None)

Bases: object

Provides information about the external source of the slot type’s definition.

Parameters:

grammar_slot_type_setting (Union[IResolvable, GrammarSlotTypeSettingProperty, Dict[str, Any], None]) – Settings required for a slot type based on a grammar that you provide.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-externalsourcesetting.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.mixins_preview.aws_lex import mixins as lex_mixins

external_source_setting_property = lex_mixins.CfnBotPropsMixin.ExternalSourceSettingProperty(
    grammar_slot_type_setting=lex_mixins.CfnBotPropsMixin.GrammarSlotTypeSettingProperty(
        source=lex_mixins.CfnBotPropsMixin.GrammarSlotTypeSourceProperty(
            kms_key_arn="kmsKeyArn",
            s3_bucket_name="s3BucketName",
            s3_object_key="s3ObjectKey"
        )
    )
)

Attributes

grammar_slot_type_setting

Settings required for a slot type based on a grammar that you provide.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-externalsourcesetting.html#cfn-lex-bot-externalsourcesetting-grammarslottypesetting

FulfillmentCodeHookSettingProperty

class CfnBotPropsMixin.FulfillmentCodeHookSettingProperty(*, enabled=None, fulfillment_updates_specification=None, is_active=None, post_fulfillment_status_specification=None)

Bases: object

Determines if a Lambda function should be invoked for a specific intent.

Parameters:

  • enabled (Union[bool, IResolvable, None]) – Indicates whether a Lambda function should be invoked to fulfill a specific intent.

  • fulfillment_updates_specification (Union[IResolvable, FulfillmentUpdatesSpecificationProperty, Dict[str, Any], None]) – Provides settings for update messages sent to the user for long-running Lambda fulfillment functions. Fulfillment updates can be used only with streaming conversations.

  • is_active (Union[bool, IResolvable, None]) – Determines whether the fulfillment code hook is used. When active is false, the code hook doesn’t run.

  • post_fulfillment_status_specification (Union[IResolvable, PostFulfillmentStatusSpecificationProperty, Dict[str, Any], None]) – Provides settings for messages sent to the user for after the Lambda fulfillment function completes. Post-fulfillment messages can be sent for both streaming and non-streaming conversations.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-fulfillmentcodehooksetting.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
enabled

Indicates whether a Lambda function should be invoked to fulfill a specific intent.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-fulfillmentcodehooksetting.html#cfn-lex-bot-fulfillmentcodehooksetting-enabled

fulfillment_updates_specification

Provides settings for update messages sent to the user for long-running Lambda fulfillment functions.

Fulfillment updates can be used only with streaming conversations.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-fulfillmentcodehooksetting.html#cfn-lex-bot-fulfillmentcodehooksetting-fulfillmentupdatesspecification

is_active

Determines whether the fulfillment code hook is used.

When active is false, the code hook doesn’t run.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-fulfillmentcodehooksetting.html#cfn-lex-bot-fulfillmentcodehooksetting-isactive

post_fulfillment_status_specification

Provides settings for messages sent to the user for after the Lambda fulfillment function completes.

Post-fulfillment messages can be sent for both streaming and non-streaming conversations.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-fulfillmentcodehooksetting.html#cfn-lex-bot-fulfillmentcodehooksetting-postfulfillmentstatusspecification

FulfillmentStartResponseSpecificationProperty

class CfnBotPropsMixin.FulfillmentStartResponseSpecificationProperty(*, allow_interrupt=None, delay_in_seconds=None, message_groups=None)

Bases: object

Provides settings for a message that is sent to the user when a fulfillment Lambda function starts running.

Parameters:

  • allow_interrupt (Union[bool, IResolvable, None]) – Determines whether the user can interrupt the start message while it is playing.

  • delay_in_seconds (Union[int, float, None]) – The delay between when the Lambda fulfillment function starts running and the start message is played. If the Lambda function returns before the delay is over, the start message isn’t played.

  • message_groups (Union[IResolvable, Sequence[Union[IResolvable, MessageGroupProperty, Dict[str, Any]]], None]) – 1 - 5 message groups that contain start messages. Amazon Lex chooses one of the messages to play to the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-fulfillmentstartresponsespecification.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.mixins_preview.aws_lex import mixins as lex_mixins

fulfillment_start_response_specification_property = lex_mixins.CfnBotPropsMixin.FulfillmentStartResponseSpecificationProperty(
    allow_interrupt=False,
    delay_in_seconds=123,
    message_groups=[lex_mixins.CfnBotPropsMixin.MessageGroupProperty(
        message=lex_mixins.CfnBotPropsMixin.MessageProperty(
            custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                value="value"
            ),
            image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                    text="text",
                    value="value"
                )],
                image_url="imageUrl",
                subtitle="subtitle",
                title="title"
            ),
            plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                value="value"
            ),
            ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                value="value"
            )
        ),
        variations=[lex_mixins.CfnBotPropsMixin.MessageProperty(
            custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                value="value"
            ),
            image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                    text="text",
                    value="value"
                )],
                image_url="imageUrl",
                subtitle="subtitle",
                title="title"
            ),
            plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                value="value"
            ),
            ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                value="value"
            )
        )]
    )]
)

Attributes

allow_interrupt

Determines whether the user can interrupt the start message while it is playing.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-fulfillmentstartresponsespecification.html#cfn-lex-bot-fulfillmentstartresponsespecification-allowinterrupt

delay_in_seconds

The delay between when the Lambda fulfillment function starts running and the start message is played.

If the Lambda function returns before the delay is over, the start message isn’t played.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-fulfillmentstartresponsespecification.html#cfn-lex-bot-fulfillmentstartresponsespecification-delayinseconds

message_groups

1 - 5 message groups that contain start messages.

Amazon Lex chooses one of the messages to play to the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-fulfillmentstartresponsespecification.html#cfn-lex-bot-fulfillmentstartresponsespecification-messagegroups

FulfillmentUpdateResponseSpecificationProperty

class CfnBotPropsMixin.FulfillmentUpdateResponseSpecificationProperty(*, allow_interrupt=None, frequency_in_seconds=None, message_groups=None)

Bases: object

Provides settings for a message that is sent periodically to the user while a fulfillment Lambda function is running.

Parameters:

  • allow_interrupt (Union[bool, IResolvable, None]) – Determines whether the user can interrupt an update message while it is playing.

  • frequency_in_seconds (Union[int, float, None]) – The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user.

  • message_groups (Union[IResolvable, Sequence[Union[IResolvable, MessageGroupProperty, Dict[str, Any]]], None]) – 1 - 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-fulfillmentupdateresponsespecification.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.mixins_preview.aws_lex import mixins as lex_mixins

fulfillment_update_response_specification_property = lex_mixins.CfnBotPropsMixin.FulfillmentUpdateResponseSpecificationProperty(
    allow_interrupt=False,
    frequency_in_seconds=123,
    message_groups=[lex_mixins.CfnBotPropsMixin.MessageGroupProperty(
        message=lex_mixins.CfnBotPropsMixin.MessageProperty(
            custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                value="value"
            ),
            image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                    text="text",
                    value="value"
                )],
                image_url="imageUrl",
                subtitle="subtitle",
                title="title"
            ),
            plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                value="value"
            ),
            ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                value="value"
            )
        ),
        variations=[lex_mixins.CfnBotPropsMixin.MessageProperty(
            custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                value="value"
            ),
            image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                    text="text",
                    value="value"
                )],
                image_url="imageUrl",
                subtitle="subtitle",
                title="title"
            ),
            plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                value="value"
            ),
            ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                value="value"
            )
        )]
    )]
)

Attributes

allow_interrupt

Determines whether the user can interrupt an update message while it is playing.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-fulfillmentupdateresponsespecification.html#cfn-lex-bot-fulfillmentupdateresponsespecification-allowinterrupt

frequency_in_seconds

The frequency that a message is sent to the user.

When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-fulfillmentupdateresponsespecification.html#cfn-lex-bot-fulfillmentupdateresponsespecification-frequencyinseconds

message_groups

1 - 5 message groups that contain update messages.

Amazon Lex chooses one of the messages to play to the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-fulfillmentupdateresponsespecification.html#cfn-lex-bot-fulfillmentupdateresponsespecification-messagegroups

FulfillmentUpdatesSpecificationProperty

class CfnBotPropsMixin.FulfillmentUpdatesSpecificationProperty(*, active=None, start_response=None, timeout_in_seconds=None, update_response=None)

Bases: object

Provides information for updating the user on the progress of fulfilling an intent.

Parameters:

  • active (Union[bool, IResolvable, None]) – Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent. If the active field is set to true, the startResponse , updateResponse , and timeoutInSeconds fields are required.

  • start_response (Union[IResolvable, FulfillmentStartResponseSpecificationProperty, Dict[str, Any], None]) – Provides configuration information for the message sent to users when the fulfillment Lambda functions starts running.

  • timeout_in_seconds (Union[int, float, None]) – The length of time that the fulfillment Lambda function should run before it times out.

  • update_response (Union[IResolvable, FulfillmentUpdateResponseSpecificationProperty, Dict[str, Any], None]) – Provides configuration information for messages sent periodically to the user while the fulfillment Lambda function is running.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-fulfillmentupdatesspecification.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.mixins_preview.aws_lex import mixins as lex_mixins

fulfillment_updates_specification_property = lex_mixins.CfnBotPropsMixin.FulfillmentUpdatesSpecificationProperty(
    active=False,
    start_response=lex_mixins.CfnBotPropsMixin.FulfillmentStartResponseSpecificationProperty(
        allow_interrupt=False,
        delay_in_seconds=123,
        message_groups=[lex_mixins.CfnBotPropsMixin.MessageGroupProperty(
            message=lex_mixins.CfnBotPropsMixin.MessageProperty(
                custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                    value="value"
                ),
                image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                    buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                        text="text",
                        value="value"
                    )],
                    image_url="imageUrl",
                    subtitle="subtitle",
                    title="title"
                ),
                plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                    value="value"
                ),
                ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                    value="value"
                )
            ),
            variations=[lex_mixins.CfnBotPropsMixin.MessageProperty(
                custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                    value="value"
                ),
                image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                    buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                        text="text",
                        value="value"
                    )],
                    image_url="imageUrl",
                    subtitle="subtitle",
                    title="title"
                ),
                plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                    value="value"
                ),
                ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                    value="value"
                )
            )]
        )]
    ),
    timeout_in_seconds=123,
    update_response=lex_mixins.CfnBotPropsMixin.FulfillmentUpdateResponseSpecificationProperty(
        allow_interrupt=False,
        frequency_in_seconds=123,
        message_groups=[lex_mixins.CfnBotPropsMixin.MessageGroupProperty(
            message=lex_mixins.CfnBotPropsMixin.MessageProperty(
                custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                    value="value"
                ),
                image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                    buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                        text="text",
                        value="value"
                    )],
                    image_url="imageUrl",
                    subtitle="subtitle",
                    title="title"
                ),
                plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                    value="value"
                ),
                ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                    value="value"
                )
            ),
            variations=[lex_mixins.CfnBotPropsMixin.MessageProperty(
                custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                    value="value"
                ),
                image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                    buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                        text="text",
                        value="value"
                    )],
                    image_url="imageUrl",
                    subtitle="subtitle",
                    title="title"
                ),
                plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                    value="value"
                ),
                ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                    value="value"
                )
            )]
        )]
    )
)

Attributes

active

Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent.

If the active field is set to true, the startResponse , updateResponse , and timeoutInSeconds fields are required.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-fulfillmentupdatesspecification.html#cfn-lex-bot-fulfillmentupdatesspecification-active

start_response

Provides configuration information for the message sent to users when the fulfillment Lambda functions starts running.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-fulfillmentupdatesspecification.html#cfn-lex-bot-fulfillmentupdatesspecification-startresponse

timeout_in_seconds

The length of time that the fulfillment Lambda function should run before it times out.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-fulfillmentupdatesspecification.html#cfn-lex-bot-fulfillmentupdatesspecification-timeoutinseconds

update_response

Provides configuration information for messages sent periodically to the user while the fulfillment Lambda function is running.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-fulfillmentupdatesspecification.html#cfn-lex-bot-fulfillmentupdatesspecification-updateresponse

GenerativeAISettingsProperty

class CfnBotPropsMixin.GenerativeAISettingsProperty(*, buildtime_settings=None, runtime_settings=None)

Bases: object

Contains specifications about the generative AI capabilities from Amazon Bedrock that you can turn on for your bot.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-generativeaisettings.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.mixins_preview.aws_lex import mixins as lex_mixins

generative_aISettings_property = lex_mixins.CfnBotPropsMixin.GenerativeAISettingsProperty(
    buildtime_settings=lex_mixins.CfnBotPropsMixin.BuildtimeSettingsProperty(
        descriptive_bot_builder_specification=lex_mixins.CfnBotPropsMixin.DescriptiveBotBuilderSpecificationProperty(
            bedrock_model_specification=lex_mixins.CfnBotPropsMixin.BedrockModelSpecificationProperty(
                bedrock_guardrail_configuration=lex_mixins.CfnBotPropsMixin.BedrockGuardrailConfigurationProperty(
                    bedrock_guardrail_identifier="bedrockGuardrailIdentifier",
                    bedrock_guardrail_version="bedrockGuardrailVersion"
                ),
                bedrock_model_custom_prompt="bedrockModelCustomPrompt",
                bedrock_trace_status="bedrockTraceStatus",
                model_arn="modelArn"
            ),
            enabled=False
        ),
        sample_utterance_generation_specification=lex_mixins.CfnBotPropsMixin.SampleUtteranceGenerationSpecificationProperty(
            bedrock_model_specification=lex_mixins.CfnBotPropsMixin.BedrockModelSpecificationProperty(
                bedrock_guardrail_configuration=lex_mixins.CfnBotPropsMixin.BedrockGuardrailConfigurationProperty(
                    bedrock_guardrail_identifier="bedrockGuardrailIdentifier",
                    bedrock_guardrail_version="bedrockGuardrailVersion"
                ),
                bedrock_model_custom_prompt="bedrockModelCustomPrompt",
                bedrock_trace_status="bedrockTraceStatus",
                model_arn="modelArn"
            ),
            enabled=False
        )
    ),
    runtime_settings=lex_mixins.CfnBotPropsMixin.RuntimeSettingsProperty(
        nlu_improvement_specification=lex_mixins.CfnBotPropsMixin.NluImprovementSpecificationProperty(
            enabled=False
        ),
        slot_resolution_improvement_specification=lex_mixins.CfnBotPropsMixin.SlotResolutionImprovementSpecificationProperty(
            bedrock_model_specification=lex_mixins.CfnBotPropsMixin.BedrockModelSpecificationProperty(
                bedrock_guardrail_configuration=lex_mixins.CfnBotPropsMixin.BedrockGuardrailConfigurationProperty(
                    bedrock_guardrail_identifier="bedrockGuardrailIdentifier",
                    bedrock_guardrail_version="bedrockGuardrailVersion"
                ),
                bedrock_model_custom_prompt="bedrockModelCustomPrompt",
                bedrock_trace_status="bedrockTraceStatus",
                model_arn="modelArn"
            ),
            enabled=False
        )
    )
)

Attributes

buildtime_settings

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-generativeaisettings.html#cfn-lex-bot-generativeaisettings-buildtimesettings

Type:

see

runtime_settings

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-generativeaisettings.html#cfn-lex-bot-generativeaisettings-runtimesettings

Type:

see

GrammarSlotTypeSettingProperty

class CfnBotPropsMixin.GrammarSlotTypeSettingProperty(*, source=None)

Bases: object

Settings requried for a slot type based on a grammar that you provide.

Parameters:

source (Union[IResolvable, GrammarSlotTypeSourceProperty, Dict[str, Any], None]) – The source of the grammar used to create the slot type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-grammarslottypesetting.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.mixins_preview.aws_lex import mixins as lex_mixins

grammar_slot_type_setting_property = lex_mixins.CfnBotPropsMixin.GrammarSlotTypeSettingProperty(
    source=lex_mixins.CfnBotPropsMixin.GrammarSlotTypeSourceProperty(
        kms_key_arn="kmsKeyArn",
        s3_bucket_name="s3BucketName",
        s3_object_key="s3ObjectKey"
    )
)

Attributes

source

The source of the grammar used to create the slot type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-grammarslottypesetting.html#cfn-lex-bot-grammarslottypesetting-source

GrammarSlotTypeSourceProperty

class CfnBotPropsMixin.GrammarSlotTypeSourceProperty(*, kms_key_arn=None, s3_bucket_name=None, s3_object_key=None)

Bases: object

Describes the Amazon S3 bucket name and location for the grammar that is the source for the slot type.

Parameters:

  • kms_key_arn (Optional[str]) – The AWS key required to decrypt the contents of the grammar, if any.

  • s3_bucket_name (Optional[str]) – The name of the Amazon S3 bucket that contains the grammar source.

  • s3_object_key (Optional[str]) – The path to the grammar in the Amazon S3 bucket.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-grammarslottypesource.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.mixins_preview.aws_lex import mixins as lex_mixins

grammar_slot_type_source_property = lex_mixins.CfnBotPropsMixin.GrammarSlotTypeSourceProperty(
    kms_key_arn="kmsKeyArn",
    s3_bucket_name="s3BucketName",
    s3_object_key="s3ObjectKey"
)

Attributes

kms_key_arn

The AWS key required to decrypt the contents of the grammar, if any.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-grammarslottypesource.html#cfn-lex-bot-grammarslottypesource-kmskeyarn

s3_bucket_name

The name of the Amazon S3 bucket that contains the grammar source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-grammarslottypesource.html#cfn-lex-bot-grammarslottypesource-s3bucketname

s3_object_key

The path to the grammar in the Amazon S3 bucket.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-grammarslottypesource.html#cfn-lex-bot-grammarslottypesource-s3objectkey

ImageResponseCardProperty

class CfnBotPropsMixin.ImageResponseCardProperty(*, buttons=None, image_url=None, subtitle=None, title=None)

Bases: object

A card that is shown to the user by a messaging platform.

You define the contents of the card, the card is displayed by the platform.

When you use a response card, the response from the user is constrained to the text associated with a button on the card.

Parameters:

  • buttons (Union[IResolvable, Sequence[Union[IResolvable, ButtonProperty, Dict[str, Any]]], None]) – A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.

  • image_url (Optional[str]) – The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.

  • subtitle (Optional[str]) – The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.

  • title (Optional[str]) – The title to display on the response card. The format of the title is determined by the platform displaying the response card.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-imageresponsecard.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.mixins_preview.aws_lex import mixins as lex_mixins

image_response_card_property = lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
    buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
        text="text",
        value="value"
    )],
    image_url="imageUrl",
    subtitle="subtitle",
    title="title"
)

Attributes

buttons

A list of buttons that should be displayed on the response card.

The arrangement of the buttons is determined by the platform that displays the button.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-imageresponsecard.html#cfn-lex-bot-imageresponsecard-buttons

image_url

The URL of an image to display on the response card.

The image URL must be publicly available so that the platform displaying the response card has access to the image.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-imageresponsecard.html#cfn-lex-bot-imageresponsecard-imageurl

subtitle

The subtitle to display on the response card.

The format of the subtitle is determined by the platform displaying the response card.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-imageresponsecard.html#cfn-lex-bot-imageresponsecard-subtitle

title

The title to display on the response card.

The format of the title is determined by the platform displaying the response card.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-imageresponsecard.html#cfn-lex-bot-imageresponsecard-title

InitialResponseSettingProperty

class CfnBotPropsMixin.InitialResponseSettingProperty(*, code_hook=None, conditional=None, initial_response=None, next_step=None)

Bases: object

Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.

Parameters:

  • code_hook (Union[IResolvable, DialogCodeHookInvocationSettingProperty, Dict[str, Any], None]) – Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation.

  • conditional (Union[IResolvable, ConditionalSpecificationProperty, Dict[str, Any], None]) – Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.

  • initial_response (Union[IResolvable, ResponseSpecificationProperty, Dict[str, Any], None]) – Specifies a list of message groups that Amazon Lex uses to respond the user input.

  • next_step (Union[IResolvable, DialogStateProperty, Dict[str, Any], None]) – The next step in the conversation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-initialresponsesetting.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
code_hook

Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-initialresponsesetting.html#cfn-lex-bot-initialresponsesetting-codehook

conditional

Provides a list of conditional branches.

Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-initialresponsesetting.html#cfn-lex-bot-initialresponsesetting-conditional

initial_response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-initialresponsesetting.html#cfn-lex-bot-initialresponsesetting-initialresponse

next_step

The next step in the conversation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-initialresponsesetting.html#cfn-lex-bot-initialresponsesetting-nextstep

InputContextProperty

class CfnBotPropsMixin.InputContextProperty(*, name=None)

Bases: object

A context that must be active for an intent to be selected by Amazon Lex.

Parameters:

name (Optional[str]) – The name of the context.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-inputcontext.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.mixins_preview.aws_lex import mixins as lex_mixins

input_context_property = lex_mixins.CfnBotPropsMixin.InputContextProperty(
    name="name"
)

Attributes

name

The name of the context.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-inputcontext.html#cfn-lex-bot-inputcontext-name

IntentClosingSettingProperty

class CfnBotPropsMixin.IntentClosingSettingProperty(*, closing_response=None, conditional=None, is_active=None, next_step=None)

Bases: object

Provides a statement the Amazon Lex conveys to the user when the intent is successfully fulfilled.

Parameters:

  • closing_response (Union[IResolvable, ResponseSpecificationProperty, Dict[str, Any], None]) – The response that Amazon Lex sends to the user when the intent is complete.

  • conditional (Union[IResolvable, ConditionalSpecificationProperty, Dict[str, Any], None]) – A list of conditional branches associated with the intent’s closing response. These branches are executed when the nextStep attribute is set to EvalutateConditional .

  • is_active (Union[bool, IResolvable, None]) – Specifies whether an intent’s closing response is used. When this field is false, the closing response isn’t sent to the user. If the IsActive field isn’t specified, the default is true.

  • next_step (Union[IResolvable, DialogStateProperty, Dict[str, Any], None]) – Specifies the next step that the bot executes after playing the intent’s closing response.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentclosingsetting.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.mixins_preview.aws_lex import mixins as lex_mixins

# slot_value_override_property_: lex_mixins.CfnBotPropsMixin.SlotValueOverrideProperty

intent_closing_setting_property = lex_mixins.CfnBotPropsMixin.IntentClosingSettingProperty(
    closing_response=lex_mixins.CfnBotPropsMixin.ResponseSpecificationProperty(
        allow_interrupt=False,
        message_groups_list=[lex_mixins.CfnBotPropsMixin.MessageGroupProperty(
            message=lex_mixins.CfnBotPropsMixin.MessageProperty(
                custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                    value="value"
                ),
                image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                    buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                        text="text",
                        value="value"
                    )],
                    image_url="imageUrl",
                    subtitle="subtitle",
                    title="title"
                ),
                plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                    value="value"
                ),
                ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                    value="value"
                )
            ),
            variations=[lex_mixins.CfnBotPropsMixin.MessageProperty(
                custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                    value="value"
                ),
                image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                    buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                        text="text",
                        value="value"
                    )],
                    image_url="imageUrl",
                    subtitle="subtitle",
                    title="title"
                ),
                plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                    value="value"
                ),
                ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                    value="value"
                )
            )]
        )]
    ),
    conditional=lex_mixins.CfnBotPropsMixin.ConditionalSpecificationProperty(
        conditional_branches=[lex_mixins.CfnBotPropsMixin.ConditionalBranchProperty(
            condition=lex_mixins.CfnBotPropsMixin.ConditionProperty(
                expression_string="expressionString"
            ),
            name="name",
            next_step=lex_mixins.CfnBotPropsMixin.DialogStateProperty(
                dialog_action=lex_mixins.CfnBotPropsMixin.DialogActionProperty(
                    slot_to_elicit="slotToElicit",
                    suppress_next_message=False,
                    type="type"
                ),
                intent=lex_mixins.CfnBotPropsMixin.IntentOverrideProperty(
                    name="name",
                    slots=[lex_mixins.CfnBotPropsMixin.SlotValueOverrideMapProperty(
                        slot_name="slotName",
                        slot_value_override=lex_mixins.CfnBotPropsMixin.SlotValueOverrideProperty(
                            shape="shape",
                            value=lex_mixins.CfnBotPropsMixin.SlotValueProperty(
                                interpreted_value="interpretedValue"
                            ),
                            values=[slot_value_override_property_]
                        )
                    )]
                ),
                session_attributes=[lex_mixins.CfnBotPropsMixin.SessionAttributeProperty(
                    key="key",
                    value="value"
                )]
            ),
            response=lex_mixins.CfnBotPropsMixin.ResponseSpecificationProperty(
                allow_interrupt=False,
                message_groups_list=[lex_mixins.CfnBotPropsMixin.MessageGroupProperty(
                    message=lex_mixins.CfnBotPropsMixin.MessageProperty(
                        custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                            value="value"
                        ),
                        image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                            buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                                text="text",
                                value="value"
                            )],
                            image_url="imageUrl",
                            subtitle="subtitle",
                            title="title"
                        ),
                        plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                            value="value"
                        ),
                        ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                            value="value"
                        )
                    ),
                    variations=[lex_mixins.CfnBotPropsMixin.MessageProperty(
                        custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                            value="value"
                        ),
                        image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                            buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                                text="text",
                                value="value"
                            )],
                            image_url="imageUrl",
                            subtitle="subtitle",
                            title="title"
                        ),
                        plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                            value="value"
                        ),
                        ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                            value="value"
                        )
                    )]
                )]
            )
        )],
        default_branch=lex_mixins.CfnBotPropsMixin.DefaultConditionalBranchProperty(
            next_step=lex_mixins.CfnBotPropsMixin.DialogStateProperty(
                dialog_action=lex_mixins.CfnBotPropsMixin.DialogActionProperty(
                    slot_to_elicit="slotToElicit",
                    suppress_next_message=False,
                    type="type"
                ),
                intent=lex_mixins.CfnBotPropsMixin.IntentOverrideProperty(
                    name="name",
                    slots=[lex_mixins.CfnBotPropsMixin.SlotValueOverrideMapProperty(
                        slot_name="slotName",
                        slot_value_override=lex_mixins.CfnBotPropsMixin.SlotValueOverrideProperty(
                            shape="shape",
                            value=lex_mixins.CfnBotPropsMixin.SlotValueProperty(
                                interpreted_value="interpretedValue"
                            ),
                            values=[slot_value_override_property_]
                        )
                    )]
                ),
                session_attributes=[lex_mixins.CfnBotPropsMixin.SessionAttributeProperty(
                    key="key",
                    value="value"
                )]
            ),
            response=lex_mixins.CfnBotPropsMixin.ResponseSpecificationProperty(
                allow_interrupt=False,
                message_groups_list=[lex_mixins.CfnBotPropsMixin.MessageGroupProperty(
                    message=lex_mixins.CfnBotPropsMixin.MessageProperty(
                        custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                            value="value"
                        ),
                        image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                            buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                                text="text",
                                value="value"
                            )],
                            image_url="imageUrl",
                            subtitle="subtitle",
                            title="title"
                        ),
                        plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                            value="value"
                        ),
                        ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                            value="value"
                        )
                    ),
                    variations=[lex_mixins.CfnBotPropsMixin.MessageProperty(
                        custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                            value="value"
                        ),
                        image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                            buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                                text="text",
                                value="value"
                            )],
                            image_url="imageUrl",
                            subtitle="subtitle",
                            title="title"
                        ),
                        plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                            value="value"
                        ),
                        ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                            value="value"
                        )
                    )]
                )]
            )
        ),
        is_active=False
    ),
    is_active=False,
    next_step=lex_mixins.CfnBotPropsMixin.DialogStateProperty(
        dialog_action=lex_mixins.CfnBotPropsMixin.DialogActionProperty(
            slot_to_elicit="slotToElicit",
            suppress_next_message=False,
            type="type"
        ),
        intent=lex_mixins.CfnBotPropsMixin.IntentOverrideProperty(
            name="name",
            slots=[lex_mixins.CfnBotPropsMixin.SlotValueOverrideMapProperty(
                slot_name="slotName",
                slot_value_override=lex_mixins.CfnBotPropsMixin.SlotValueOverrideProperty(
                    shape="shape",
                    value=lex_mixins.CfnBotPropsMixin.SlotValueProperty(
                        interpreted_value="interpretedValue"
                    ),
                    values=[slot_value_override_property_]
                )
            )]
        ),
        session_attributes=[lex_mixins.CfnBotPropsMixin.SessionAttributeProperty(
            key="key",
            value="value"
        )]
    )
)

Attributes

closing_response

The response that Amazon Lex sends to the user when the intent is complete.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentclosingsetting.html#cfn-lex-bot-intentclosingsetting-closingresponse

conditional

A list of conditional branches associated with the intent’s closing response.

These branches are executed when the nextStep attribute is set to EvalutateConditional .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentclosingsetting.html#cfn-lex-bot-intentclosingsetting-conditional

is_active

Specifies whether an intent’s closing response is used.

When this field is false, the closing response isn’t sent to the user. If the IsActive field isn’t specified, the default is true.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentclosingsetting.html#cfn-lex-bot-intentclosingsetting-isactive

next_step

Specifies the next step that the bot executes after playing the intent’s closing response.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentclosingsetting.html#cfn-lex-bot-intentclosingsetting-nextstep

IntentConfirmationSettingProperty

class CfnBotPropsMixin.IntentConfirmationSettingProperty(*, code_hook=None, confirmation_conditional=None, confirmation_next_step=None, confirmation_response=None, declination_conditional=None, declination_next_step=None, declination_response=None, elicitation_code_hook=None, failure_conditional=None, failure_next_step=None, failure_response=None, is_active=None, prompt_specification=None)

Bases: object

Provides a prompt for making sure that the user is ready for the intent to be fulfilled.

Parameters:

  • code_hook (Union[IResolvable, DialogCodeHookInvocationSettingProperty, Dict[str, Any], None]) – The DialogCodeHookInvocationSetting object associated with intent’s confirmation step. The dialog code hook is triggered based on these invocation settings when the confirmation next step or declination next step or failure next step is InvokeDialogCodeHook .

  • confirmation_conditional (Union[IResolvable, ConditionalSpecificationProperty, Dict[str, Any], None]) – A list of conditional branches to evaluate after the intent is closed.

  • confirmation_next_step (Union[IResolvable, DialogStateProperty, Dict[str, Any], None]) – Specifies the next step that the bot executes when the customer confirms the intent.

  • confirmation_response (Union[IResolvable, ResponseSpecificationProperty, Dict[str, Any], None]) – Specifies a list of message groups that Amazon Lex uses to respond the user input.

  • declination_conditional (Union[IResolvable, ConditionalSpecificationProperty, Dict[str, Any], None]) – A list of conditional branches to evaluate after the intent is declined.

  • declination_next_step (Union[IResolvable, DialogStateProperty, Dict[str, Any], None]) – Specifies the next step that the bot executes when the customer declines the intent.

  • declination_response (Union[IResolvable, ResponseSpecificationProperty, Dict[str, Any], None]) – When the user answers “no” to the question defined in promptSpecification , Amazon Lex responds with this response to acknowledge that the intent was canceled.

  • elicitation_code_hook (Union[IResolvable, ElicitationCodeHookInvocationSettingProperty, Dict[str, Any], None]) – The DialogCodeHookInvocationSetting used when the code hook is invoked during confirmation prompt retries.

  • failure_conditional (Union[IResolvable, ConditionalSpecificationProperty, Dict[str, Any], None]) – Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.

  • failure_next_step (Union[IResolvable, DialogStateProperty, Dict[str, Any], None]) – The next step to take in the conversation if the confirmation step fails.

  • failure_response (Union[IResolvable, ResponseSpecificationProperty, Dict[str, Any], None]) – Specifies a list of message groups that Amazon Lex uses to respond the user input when the intent confirmation fails.

  • is_active (Union[bool, IResolvable, None]) – Specifies whether the intent’s confirmation is sent to the user. When this field is false, confirmation and declination responses aren’t sent. If the IsActive field isn’t specified, the default is true.

  • prompt_specification (Union[IResolvable, PromptSpecificationProperty, Dict[str, Any], None]) – Prompts the user to confirm the intent. This question should have a yes or no answer. Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentconfirmationsetting.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
code_hook

The DialogCodeHookInvocationSetting object associated with intent’s confirmation step.

The dialog code hook is triggered based on these invocation settings when the confirmation next step or declination next step or failure next step is InvokeDialogCodeHook .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentconfirmationsetting.html#cfn-lex-bot-intentconfirmationsetting-codehook

confirmation_conditional

A list of conditional branches to evaluate after the intent is closed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentconfirmationsetting.html#cfn-lex-bot-intentconfirmationsetting-confirmationconditional

confirmation_next_step

Specifies the next step that the bot executes when the customer confirms the intent.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentconfirmationsetting.html#cfn-lex-bot-intentconfirmationsetting-confirmationnextstep

confirmation_response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentconfirmationsetting.html#cfn-lex-bot-intentconfirmationsetting-confirmationresponse

declination_conditional

A list of conditional branches to evaluate after the intent is declined.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentconfirmationsetting.html#cfn-lex-bot-intentconfirmationsetting-declinationconditional

declination_next_step

Specifies the next step that the bot executes when the customer declines the intent.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentconfirmationsetting.html#cfn-lex-bot-intentconfirmationsetting-declinationnextstep

declination_response

When the user answers “no” to the question defined in promptSpecification , Amazon Lex responds with this response to acknowledge that the intent was canceled.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentconfirmationsetting.html#cfn-lex-bot-intentconfirmationsetting-declinationresponse

elicitation_code_hook

The DialogCodeHookInvocationSetting used when the code hook is invoked during confirmation prompt retries.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentconfirmationsetting.html#cfn-lex-bot-intentconfirmationsetting-elicitationcodehook

failure_conditional

Provides a list of conditional branches.

Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentconfirmationsetting.html#cfn-lex-bot-intentconfirmationsetting-failureconditional

failure_next_step

The next step to take in the conversation if the confirmation step fails.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentconfirmationsetting.html#cfn-lex-bot-intentconfirmationsetting-failurenextstep

failure_response

Specifies a list of message groups that Amazon Lex uses to respond the user input when the intent confirmation fails.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentconfirmationsetting.html#cfn-lex-bot-intentconfirmationsetting-failureresponse

is_active

Specifies whether the intent’s confirmation is sent to the user.

When this field is false, confirmation and declination responses aren’t sent. If the IsActive field isn’t specified, the default is true.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentconfirmationsetting.html#cfn-lex-bot-intentconfirmationsetting-isactive

prompt_specification

Prompts the user to confirm the intent. This question should have a yes or no answer.

Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentconfirmationsetting.html#cfn-lex-bot-intentconfirmationsetting-promptspecification

IntentOverrideProperty

class CfnBotPropsMixin.IntentOverrideProperty(*, name=None, slots=None)

Bases: object

Override settings to configure the intent state.

Parameters:

  • name (Optional[str]) – The name of the intent. Only required when you’re switching intents.

  • slots (Union[IResolvable, Sequence[Union[IResolvable, SlotValueOverrideMapProperty, Dict[str, Any]]], None]) – A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren’t overridden.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentoverride.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.mixins_preview.aws_lex import mixins as lex_mixins

# slot_value_override_property_: lex_mixins.CfnBotPropsMixin.SlotValueOverrideProperty

intent_override_property = lex_mixins.CfnBotPropsMixin.IntentOverrideProperty(
    name="name",
    slots=[lex_mixins.CfnBotPropsMixin.SlotValueOverrideMapProperty(
        slot_name="slotName",
        slot_value_override=lex_mixins.CfnBotPropsMixin.SlotValueOverrideProperty(
            shape="shape",
            value=lex_mixins.CfnBotPropsMixin.SlotValueProperty(
                interpreted_value="interpretedValue"
            ),
            values=[slot_value_override_property_]
        )
    )]
)

Attributes

name

The name of the intent.

Only required when you’re switching intents.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentoverride.html#cfn-lex-bot-intentoverride-name

slots

A map of all of the slot value overrides for the intent.

The name of the slot maps to the value of the slot. Slots that are not included in the map aren’t overridden.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentoverride.html#cfn-lex-bot-intentoverride-slots

IntentProperty

class CfnBotPropsMixin.IntentProperty(*, bedrock_agent_intent_configuration=None, description=None, dialog_code_hook=None, fulfillment_code_hook=None, initial_response_setting=None, input_contexts=None, intent_closing_setting=None, intent_confirmation_setting=None, kendra_configuration=None, name=None, output_contexts=None, parent_intent_signature=None, q_in_connect_intent_configuration=None, qn_a_intent_configuration=None, sample_utterances=None, slot_priorities=None, slots=None)

Bases: object

Represents an action that the user wants to perform.

Parameters:

  • bedrock_agent_intent_configuration (Union[IResolvable, BedrockAgentIntentConfigurationProperty, Dict[str, Any], None])

  • description (Optional[str]) – A description of the intent. Use the description to help identify the intent in lists.

  • dialog_code_hook (Union[IResolvable, DialogCodeHookSettingProperty, Dict[str, Any], None]) – Specifies that Amazon Lex invokes the alias Lambda function for each user input. You can invoke this Lambda function to personalize user interaction.

  • fulfillment_code_hook (Union[IResolvable, FulfillmentCodeHookSettingProperty, Dict[str, Any], None]) – Specifies that Amazon Lex invokes the alias Lambda function when the intent is ready for fulfillment. You can invoke this function to complete the bot’s transaction with the user.

  • initial_response_setting (Union[IResolvable, InitialResponseSettingProperty, Dict[str, Any], None]) – Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.

  • input_contexts (Union[IResolvable, Sequence[Union[IResolvable, InputContextProperty, Dict[str, Any]]], None]) – A list of contexts that must be active for this intent to be considered by Amazon Lex .

  • intent_closing_setting (Union[IResolvable, IntentClosingSettingProperty, Dict[str, Any], None]) – Sets the response that Amazon Lex sends to the user when the intent is closed.

  • intent_confirmation_setting (Union[IResolvable, IntentConfirmationSettingProperty, Dict[str, Any], None]) – Provides prompts that Amazon Lex sends to the user to confirm the completion of an intent. If the user answers “no,” the settings contain a statement that is sent to the user to end the intent.

  • kendra_configuration (Union[IResolvable, KendraConfigurationProperty, Dict[str, Any], None]) – Provides configuration information for the AMAZON.KendraSearchIntent intent. When you use this intent, Amazon Lex searches the specified Amazon Kendra index and returns documents from the index that match the user’s utterance.

  • name (Optional[str]) – The name of the intent. Intent names must be unique within the locale that contains the intent and can’t match the name of any built-in intent.

  • output_contexts (Union[IResolvable, Sequence[Union[IResolvable, OutputContextProperty, Dict[str, Any]]], None]) – A list of contexts that the intent activates when it is fulfilled.

  • parent_intent_signature (Optional[str]) – A unique identifier for the built-in intent to base this intent on.

  • q_in_connect_intent_configuration (Union[IResolvable, QInConnectIntentConfigurationProperty, Dict[str, Any], None])

  • qn_a_intent_configuration (Union[IResolvable, QnAIntentConfigurationProperty, Dict[str, Any], None])

  • sample_utterances (Union[IResolvable, Sequence[Union[IResolvable, SampleUtteranceProperty, Dict[str, Any]]], None]) – A list of utterances that a user might say to signal the intent.

  • slot_priorities (Union[IResolvable, Sequence[Union[IResolvable, SlotPriorityProperty, Dict[str, Any]]], None]) – Indicates the priority for slots. Amazon Lex prompts the user for slot values in priority order.

  • slots (Union[IResolvable, Sequence[Union[IResolvable, SlotProperty, Dict[str, Any]]], None]) – A list of slots that the intent requires for fulfillment.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intent.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
bedrock_agent_intent_configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intent.html#cfn-lex-bot-intent-bedrockagentintentconfiguration

Type:

see

description

A description of the intent.

Use the description to help identify the intent in lists.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intent.html#cfn-lex-bot-intent-description

dialog_code_hook

Specifies that Amazon Lex invokes the alias Lambda function for each user input.

You can invoke this Lambda function to personalize user interaction.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intent.html#cfn-lex-bot-intent-dialogcodehook

fulfillment_code_hook

Specifies that Amazon Lex invokes the alias Lambda function when the intent is ready for fulfillment.

You can invoke this function to complete the bot’s transaction with the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intent.html#cfn-lex-bot-intent-fulfillmentcodehook

initial_response_setting

Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intent.html#cfn-lex-bot-intent-initialresponsesetting

input_contexts

A list of contexts that must be active for this intent to be considered by Amazon Lex .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intent.html#cfn-lex-bot-intent-inputcontexts

intent_closing_setting

Sets the response that Amazon Lex sends to the user when the intent is closed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intent.html#cfn-lex-bot-intent-intentclosingsetting

intent_confirmation_setting

Provides prompts that Amazon Lex sends to the user to confirm the completion of an intent.

If the user answers “no,” the settings contain a statement that is sent to the user to end the intent.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intent.html#cfn-lex-bot-intent-intentconfirmationsetting

kendra_configuration

Provides configuration information for the AMAZON.KendraSearchIntent intent. When you use this intent, Amazon Lex searches the specified Amazon Kendra index and returns documents from the index that match the user’s utterance.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intent.html#cfn-lex-bot-intent-kendraconfiguration

name

The name of the intent.

Intent names must be unique within the locale that contains the intent and can’t match the name of any built-in intent.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intent.html#cfn-lex-bot-intent-name

output_contexts

A list of contexts that the intent activates when it is fulfilled.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intent.html#cfn-lex-bot-intent-outputcontexts

parent_intent_signature

A unique identifier for the built-in intent to base this intent on.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intent.html#cfn-lex-bot-intent-parentintentsignature

q_in_connect_intent_configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intent.html#cfn-lex-bot-intent-qinconnectintentconfiguration

Type:

see

qn_a_intent_configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intent.html#cfn-lex-bot-intent-qnaintentconfiguration

Type:

see

sample_utterances

A list of utterances that a user might say to signal the intent.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intent.html#cfn-lex-bot-intent-sampleutterances

slot_priorities

Indicates the priority for slots.

Amazon Lex prompts the user for slot values in priority order.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intent.html#cfn-lex-bot-intent-slotpriorities

slots

A list of slots that the intent requires for fulfillment.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intent.html#cfn-lex-bot-intent-slots

KendraConfigurationProperty

class CfnBotPropsMixin.KendraConfigurationProperty(*, kendra_index=None, query_filter_string=None, query_filter_string_enabled=None)

Bases: object

Provides configuration information for the AMAZON.KendraSearchIntent intent. When you use this intent, Amazon Lex searches the specified Amazon Kendra index and returns documents from the index that match the user’s utterance.

Parameters:

  • kendra_index (Optional[str]) – The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot.

  • query_filter_string (Optional[str]) – A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries .

  • query_filter_string_enabled (Union[bool, IResolvable, None]) – Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-kendraconfiguration.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.mixins_preview.aws_lex import mixins as lex_mixins

kendra_configuration_property = lex_mixins.CfnBotPropsMixin.KendraConfigurationProperty(
    kendra_index="kendraIndex",
    query_filter_string="queryFilterString",
    query_filter_string_enabled=False
)

Attributes

kendra_index

The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-kendraconfiguration.html#cfn-lex-bot-kendraconfiguration-kendraindex

query_filter_string

A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query.

The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-kendraconfiguration.html#cfn-lex-bot-kendraconfiguration-queryfilterstring

query_filter_string_enabled

Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-kendraconfiguration.html#cfn-lex-bot-kendraconfiguration-queryfilterstringenabled

LambdaCodeHookProperty

class CfnBotPropsMixin.LambdaCodeHookProperty(*, code_hook_interface_version=None, lambda_arn=None)

Bases: object

Specifies a Lambda function that verifies requests to a bot or fulfills the user’s request to a bot.

Parameters:

  • code_hook_interface_version (Optional[str]) – The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.

  • lambda_arn (Optional[str]) – The Amazon Resource Name (ARN) of the Lambda function.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-lambdacodehook.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.mixins_preview.aws_lex import mixins as lex_mixins

lambda_code_hook_property = lex_mixins.CfnBotPropsMixin.LambdaCodeHookProperty(
    code_hook_interface_version="codeHookInterfaceVersion",
    lambda_arn="lambdaArn"
)

Attributes

code_hook_interface_version

The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-lambdacodehook.html#cfn-lex-bot-lambdacodehook-codehookinterfaceversion

lambda_arn

The Amazon Resource Name (ARN) of the Lambda function.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-lambdacodehook.html#cfn-lex-bot-lambdacodehook-lambdaarn

MessageGroupProperty

class CfnBotPropsMixin.MessageGroupProperty(*, message=None, variations=None)

Bases: object

Provides one or more messages that Amazon Lex should send to the user.

Parameters:

  • message (Union[IResolvable, MessageProperty, Dict[str, Any], None]) – The primary message that Amazon Lex should send to the user.

  • variations (Union[IResolvable, Sequence[Union[IResolvable, MessageProperty, Dict[str, Any]]], None]) – Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-messagegroup.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.mixins_preview.aws_lex import mixins as lex_mixins

message_group_property = lex_mixins.CfnBotPropsMixin.MessageGroupProperty(
    message=lex_mixins.CfnBotPropsMixin.MessageProperty(
        custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
            value="value"
        ),
        image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
            buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                text="text",
                value="value"
            )],
            image_url="imageUrl",
            subtitle="subtitle",
            title="title"
        ),
        plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
            value="value"
        ),
        ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
            value="value"
        )
    ),
    variations=[lex_mixins.CfnBotPropsMixin.MessageProperty(
        custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
            value="value"
        ),
        image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
            buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                text="text",
                value="value"
            )],
            image_url="imageUrl",
            subtitle="subtitle",
            title="title"
        ),
        plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
            value="value"
        ),
        ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
            value="value"
        )
    )]
)

Attributes

message

The primary message that Amazon Lex should send to the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-messagegroup.html#cfn-lex-bot-messagegroup-message

variations

Message variations to send to the user.

When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-messagegroup.html#cfn-lex-bot-messagegroup-variations

MessageProperty

class CfnBotPropsMixin.MessageProperty(*, custom_payload=None, image_response_card=None, plain_text_message=None, ssml_message=None)

Bases: object

The object that provides message text and its type.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-message.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.mixins_preview.aws_lex import mixins as lex_mixins

message_property = lex_mixins.CfnBotPropsMixin.MessageProperty(
    custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
        value="value"
    ),
    image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
        buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
            text="text",
            value="value"
        )],
        image_url="imageUrl",
        subtitle="subtitle",
        title="title"
    ),
    plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
        value="value"
    ),
    ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
        value="value"
    )
)

Attributes

custom_payload

A message in a custom format defined by the client application.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-message.html#cfn-lex-bot-message-custompayload

image_response_card

A message that defines a response card that the client application can show to the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-message.html#cfn-lex-bot-message-imageresponsecard

plain_text_message

A message in plain text format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-message.html#cfn-lex-bot-message-plaintextmessage

ssml_message

A message in Speech Synthesis Markup Language (SSML).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-message.html#cfn-lex-bot-message-ssmlmessage

MultipleValuesSettingProperty

class CfnBotPropsMixin.MultipleValuesSettingProperty(*, allow_multiple_values=None)

Bases: object

Indicates whether a slot can return multiple values.

Parameters:

allow_multiple_values (Union[bool, IResolvable, None]) – Indicates whether a slot can return multiple values. When true , the slot may return more than one value in a response. When false , the slot returns only a single value. Multi-value slots are only available in the en-US locale. If you set this value to true in any other locale, Amazon Lex throws a ValidationException . If the allowMutlipleValues is not set, the default value is false .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-multiplevaluessetting.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.mixins_preview.aws_lex import mixins as lex_mixins

multiple_values_setting_property = lex_mixins.CfnBotPropsMixin.MultipleValuesSettingProperty(
    allow_multiple_values=False
)

Attributes

allow_multiple_values

Indicates whether a slot can return multiple values.

When true , the slot may return more than one value in a response. When false , the slot returns only a single value.

Multi-value slots are only available in the en-US locale. If you set this value to true in any other locale, Amazon Lex throws a ValidationException .

If the allowMutlipleValues is not set, the default value is false .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-multiplevaluessetting.html#cfn-lex-bot-multiplevaluessetting-allowmultiplevalues

NluImprovementSpecificationProperty

class CfnBotPropsMixin.NluImprovementSpecificationProperty(*, enabled=None)

Bases: object

Configures the Assisted Natural Language Understanding (NLU) feature for your bot.

This specification determines whether enhanced intent recognition and utterance understanding capabilities are active.

Parameters:

enabled (Union[bool, IResolvable, None]) – Determines whether the Assisted NLU feature is enabled for the bot. When set to true , Amazon Lex uses advanced models to improve intent recognition and slot resolution, with the default being false .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-nluimprovementspecification.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.mixins_preview.aws_lex import mixins as lex_mixins

nlu_improvement_specification_property = lex_mixins.CfnBotPropsMixin.NluImprovementSpecificationProperty(
    enabled=False
)

Attributes

enabled

Determines whether the Assisted NLU feature is enabled for the bot.

When set to true , Amazon Lex uses advanced models to improve intent recognition and slot resolution, with the default being false .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-nluimprovementspecification.html#cfn-lex-bot-nluimprovementspecification-enabled

ObfuscationSettingProperty

class CfnBotPropsMixin.ObfuscationSettingProperty(*, obfuscation_setting_type=None)

Bases: object

Determines whether Amazon Lex obscures slot values in conversation logs.

Parameters:

obfuscation_setting_type (Optional[str]) – Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-obfuscationsetting.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.mixins_preview.aws_lex import mixins as lex_mixins

obfuscation_setting_property = lex_mixins.CfnBotPropsMixin.ObfuscationSettingProperty(
    obfuscation_setting_type="obfuscationSettingType"
)

Attributes

obfuscation_setting_type

Value that determines whether Amazon Lex obscures slot values in conversation logs.

The default is to obscure the values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-obfuscationsetting.html#cfn-lex-bot-obfuscationsetting-obfuscationsettingtype

OpensearchConfigurationProperty

class CfnBotPropsMixin.OpensearchConfigurationProperty(*, domain_endpoint=None, exact_response=None, exact_response_fields=None, include_fields=None, index_name=None)

Bases: object

Contains details about the configuration of the Amazon OpenSearch Service database used for the AMAZON.QnAIntent .

Parameters:

  • domain_endpoint (Optional[str]) – The endpoint of the Amazon OpenSearch Service domain.

  • exact_response (Union[bool, IResolvable, None]) – Specifies whether to return an exact response or to return an answer generated by the model using the fields you specify from the database.

  • exact_response_fields (Union[IResolvable, ExactResponseFieldsProperty, Dict[str, Any], None]) – Contains the names of the fields used for an exact response to the user.

  • include_fields (Optional[Sequence[str]]) – Contains a list of fields from the Amazon OpenSearch Service that the model can use to generate the answer to the query.

  • index_name (Optional[str]) – The name of the Amazon OpenSearch Service index.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-opensearchconfiguration.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.mixins_preview.aws_lex import mixins as lex_mixins

opensearch_configuration_property = lex_mixins.CfnBotPropsMixin.OpensearchConfigurationProperty(
    domain_endpoint="domainEndpoint",
    exact_response=False,
    exact_response_fields=lex_mixins.CfnBotPropsMixin.ExactResponseFieldsProperty(
        answer_field="answerField",
        question_field="questionField"
    ),
    include_fields=["includeFields"],
    index_name="indexName"
)

Attributes

domain_endpoint

The endpoint of the Amazon OpenSearch Service domain.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-opensearchconfiguration.html#cfn-lex-bot-opensearchconfiguration-domainendpoint

exact_response

Specifies whether to return an exact response or to return an answer generated by the model using the fields you specify from the database.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-opensearchconfiguration.html#cfn-lex-bot-opensearchconfiguration-exactresponse

exact_response_fields

Contains the names of the fields used for an exact response to the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-opensearchconfiguration.html#cfn-lex-bot-opensearchconfiguration-exactresponsefields

include_fields

Contains a list of fields from the Amazon OpenSearch Service that the model can use to generate the answer to the query.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-opensearchconfiguration.html#cfn-lex-bot-opensearchconfiguration-includefields

index_name

The name of the Amazon OpenSearch Service index.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-opensearchconfiguration.html#cfn-lex-bot-opensearchconfiguration-indexname

OutputContextProperty

class CfnBotPropsMixin.OutputContextProperty(*, name=None, time_to_live_in_seconds=None, turns_to_live=None)

Bases: object

Describes a session context that is activated when an intent is fulfilled.

Parameters:

  • name (Optional[str]) – The name of the output context.

  • time_to_live_in_seconds (Union[int, float, None]) – The amount of time, in seconds, that the output context should remain active. The time is figured from the first time the context is sent to the user.

  • turns_to_live (Union[int, float, None]) – The number of conversation turns that the output context should remain active. The number of turns is counted from the first time that the context is sent to the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-outputcontext.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.mixins_preview.aws_lex import mixins as lex_mixins

output_context_property = lex_mixins.CfnBotPropsMixin.OutputContextProperty(
    name="name",
    time_to_live_in_seconds=123,
    turns_to_live=123
)

Attributes

name

The name of the output context.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-outputcontext.html#cfn-lex-bot-outputcontext-name

time_to_live_in_seconds

The amount of time, in seconds, that the output context should remain active.

The time is figured from the first time the context is sent to the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-outputcontext.html#cfn-lex-bot-outputcontext-timetoliveinseconds

turns_to_live

The number of conversation turns that the output context should remain active.

The number of turns is counted from the first time that the context is sent to the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-outputcontext.html#cfn-lex-bot-outputcontext-turnstolive

PlainTextMessageProperty

class CfnBotPropsMixin.PlainTextMessageProperty(*, value=None)

Bases: object

Defines an ASCII text message to send to the user.

Parameters:

value (Optional[str]) – The message to send to the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-plaintextmessage.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.mixins_preview.aws_lex import mixins as lex_mixins

plain_text_message_property = lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
    value="value"
)

Attributes

value

The message to send to the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-plaintextmessage.html#cfn-lex-bot-plaintextmessage-value

PostDialogCodeHookInvocationSpecificationProperty

class CfnBotPropsMixin.PostDialogCodeHookInvocationSpecificationProperty(*, failure_conditional=None, failure_next_step=None, failure_response=None, success_conditional=None, success_next_step=None, success_response=None, timeout_conditional=None, timeout_next_step=None, timeout_response=None)

Bases: object

Specifies next steps to run after the dialog code hook finishes.

Parameters:

  • failure_conditional (Union[IResolvable, ConditionalSpecificationProperty, Dict[str, Any], None]) – A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the State field of the Intent object set to Failed .

  • failure_next_step (Union[IResolvable, DialogStateProperty, Dict[str, Any], None]) – Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the State field of the Intent object set to Failed .

  • failure_response (Union[IResolvable, ResponseSpecificationProperty, Dict[str, Any], None]) – Specifies a list of message groups that Amazon Lex uses to respond the user input when the code hook fails.

  • success_conditional (Union[IResolvable, ConditionalSpecificationProperty, Dict[str, Any], None]) – A list of conditional branches to evaluate after the dialog code hook finishes successfully.

  • success_next_step (Union[IResolvable, DialogStateProperty, Dict[str, Any], None]) – Specifics the next step the bot runs after the dialog code hook finishes successfully.

  • success_response (Union[IResolvable, ResponseSpecificationProperty, Dict[str, Any], None]) – Specifies a list of message groups that Amazon Lex uses to respond when the code hook succeeds.

  • timeout_conditional (Union[IResolvable, ConditionalSpecificationProperty, Dict[str, Any], None]) – A list of conditional branches to evaluate if the code hook times out.

  • timeout_next_step (Union[IResolvable, DialogStateProperty, Dict[str, Any], None]) – Specifies the next step that the bot runs when the code hook times out.

  • timeout_response (Union[IResolvable, ResponseSpecificationProperty, Dict[str, Any], None]) – Specifies a list of message groups that Amazon Lex uses to respond to the user input when the code hook times out.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-postdialogcodehookinvocationspecification.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
failure_conditional

A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the State field of the Intent object set to Failed .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-postdialogcodehookinvocationspecification.html#cfn-lex-bot-postdialogcodehookinvocationspecification-failureconditional

failure_next_step

Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the State field of the Intent object set to Failed .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-postdialogcodehookinvocationspecification.html#cfn-lex-bot-postdialogcodehookinvocationspecification-failurenextstep

failure_response

Specifies a list of message groups that Amazon Lex uses to respond the user input when the code hook fails.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-postdialogcodehookinvocationspecification.html#cfn-lex-bot-postdialogcodehookinvocationspecification-failureresponse

success_conditional

A list of conditional branches to evaluate after the dialog code hook finishes successfully.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-postdialogcodehookinvocationspecification.html#cfn-lex-bot-postdialogcodehookinvocationspecification-successconditional

success_next_step

Specifics the next step the bot runs after the dialog code hook finishes successfully.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-postdialogcodehookinvocationspecification.html#cfn-lex-bot-postdialogcodehookinvocationspecification-successnextstep

success_response

Specifies a list of message groups that Amazon Lex uses to respond when the code hook succeeds.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-postdialogcodehookinvocationspecification.html#cfn-lex-bot-postdialogcodehookinvocationspecification-successresponse

timeout_conditional

A list of conditional branches to evaluate if the code hook times out.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-postdialogcodehookinvocationspecification.html#cfn-lex-bot-postdialogcodehookinvocationspecification-timeoutconditional

timeout_next_step

Specifies the next step that the bot runs when the code hook times out.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-postdialogcodehookinvocationspecification.html#cfn-lex-bot-postdialogcodehookinvocationspecification-timeoutnextstep

timeout_response

Specifies a list of message groups that Amazon Lex uses to respond to the user input when the code hook times out.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-postdialogcodehookinvocationspecification.html#cfn-lex-bot-postdialogcodehookinvocationspecification-timeoutresponse

PostFulfillmentStatusSpecificationProperty

class CfnBotPropsMixin.PostFulfillmentStatusSpecificationProperty(*, failure_conditional=None, failure_next_step=None, failure_response=None, success_conditional=None, success_next_step=None, success_response=None, timeout_conditional=None, timeout_next_step=None, timeout_response=None)

Bases: object

Provides a setting that determines whether the post-fulfillment response is sent to the user.

For more information, see ` <https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-complete>`_

Parameters:

  • failure_conditional (Union[IResolvable, ConditionalSpecificationProperty, Dict[str, Any], None]) – A list of conditional branches to evaluate after the fulfillment code hook throws an exception or returns with the State field of the Intent object set to Failed .

  • failure_next_step (Union[IResolvable, DialogStateProperty, Dict[str, Any], None]) – Specifies the next step the bot runs after the fulfillment code hook throws an exception or returns with the State field of the Intent object set to Failed .

  • failure_response (Union[IResolvable, ResponseSpecificationProperty, Dict[str, Any], None]) – Specifies a list of message groups that Amazon Lex uses to respond when fulfillment isn’t successful.

  • success_conditional (Union[IResolvable, ConditionalSpecificationProperty, Dict[str, Any], None]) – A list of conditional branches to evaluate after the fulfillment code hook finishes successfully.

  • success_next_step (Union[IResolvable, DialogStateProperty, Dict[str, Any], None]) – Specifies the next step in the conversation that Amazon Lex invokes when the fulfillment code hook completes successfully.

  • success_response (Union[IResolvable, ResponseSpecificationProperty, Dict[str, Any], None]) – Specifies a list of message groups that Amazon Lex uses to respond when the fulfillment is successful.

  • timeout_conditional (Union[IResolvable, ConditionalSpecificationProperty, Dict[str, Any], None]) – A list of conditional branches to evaluate if the fulfillment code hook times out.

  • timeout_next_step (Union[IResolvable, DialogStateProperty, Dict[str, Any], None]) – Specifies the next step that the bot runs when the fulfillment code hook times out.

  • timeout_response (Union[IResolvable, ResponseSpecificationProperty, Dict[str, Any], None]) – Specifies a list of message groups that Amazon Lex uses to respond when fulfillment isn’t completed within the timeout period.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-postfulfillmentstatusspecification.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
failure_conditional

A list of conditional branches to evaluate after the fulfillment code hook throws an exception or returns with the State field of the Intent object set to Failed .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-postfulfillmentstatusspecification.html#cfn-lex-bot-postfulfillmentstatusspecification-failureconditional

failure_next_step

Specifies the next step the bot runs after the fulfillment code hook throws an exception or returns with the State field of the Intent object set to Failed .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-postfulfillmentstatusspecification.html#cfn-lex-bot-postfulfillmentstatusspecification-failurenextstep

failure_response

Specifies a list of message groups that Amazon Lex uses to respond when fulfillment isn’t successful.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-postfulfillmentstatusspecification.html#cfn-lex-bot-postfulfillmentstatusspecification-failureresponse

success_conditional

A list of conditional branches to evaluate after the fulfillment code hook finishes successfully.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-postfulfillmentstatusspecification.html#cfn-lex-bot-postfulfillmentstatusspecification-successconditional

success_next_step

Specifies the next step in the conversation that Amazon Lex invokes when the fulfillment code hook completes successfully.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-postfulfillmentstatusspecification.html#cfn-lex-bot-postfulfillmentstatusspecification-successnextstep

success_response

Specifies a list of message groups that Amazon Lex uses to respond when the fulfillment is successful.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-postfulfillmentstatusspecification.html#cfn-lex-bot-postfulfillmentstatusspecification-successresponse

timeout_conditional

A list of conditional branches to evaluate if the fulfillment code hook times out.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-postfulfillmentstatusspecification.html#cfn-lex-bot-postfulfillmentstatusspecification-timeoutconditional

timeout_next_step

Specifies the next step that the bot runs when the fulfillment code hook times out.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-postfulfillmentstatusspecification.html#cfn-lex-bot-postfulfillmentstatusspecification-timeoutnextstep

timeout_response

Specifies a list of message groups that Amazon Lex uses to respond when fulfillment isn’t completed within the timeout period.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-postfulfillmentstatusspecification.html#cfn-lex-bot-postfulfillmentstatusspecification-timeoutresponse

PromptAttemptSpecificationProperty

class CfnBotPropsMixin.PromptAttemptSpecificationProperty(*, allowed_input_types=None, allow_interrupt=None, audio_and_dtmf_input_specification=None, text_input_specification=None)

Bases: object

Specifies the settings on a prompt attempt.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-promptattemptspecification.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.mixins_preview.aws_lex import mixins as lex_mixins

prompt_attempt_specification_property = lex_mixins.CfnBotPropsMixin.PromptAttemptSpecificationProperty(
    allowed_input_types=lex_mixins.CfnBotPropsMixin.AllowedInputTypesProperty(
        allow_audio_input=False,
        allow_dtmf_input=False
    ),
    allow_interrupt=False,
    audio_and_dtmf_input_specification=lex_mixins.CfnBotPropsMixin.AudioAndDTMFInputSpecificationProperty(
        audio_specification=lex_mixins.CfnBotPropsMixin.AudioSpecificationProperty(
            end_timeout_ms=123,
            max_length_ms=123
        ),
        dtmf_specification=lex_mixins.CfnBotPropsMixin.DTMFSpecificationProperty(
            deletion_character="deletionCharacter",
            end_character="endCharacter",
            end_timeout_ms=123,
            max_length=123
        ),
        start_timeout_ms=123
    ),
    text_input_specification=lex_mixins.CfnBotPropsMixin.TextInputSpecificationProperty(
        start_timeout_ms=123
    )
)

Attributes

allow_interrupt

Indicates whether the user can interrupt a speech prompt attempt from the bot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-promptattemptspecification.html#cfn-lex-bot-promptattemptspecification-allowinterrupt

allowed_input_types

Indicates the allowed input types of the prompt attempt.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-promptattemptspecification.html#cfn-lex-bot-promptattemptspecification-allowedinputtypes

audio_and_dtmf_input_specification

Specifies the settings on audio and DTMF input.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-promptattemptspecification.html#cfn-lex-bot-promptattemptspecification-audioanddtmfinputspecification

text_input_specification

Specifies the settings on text input.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-promptattemptspecification.html#cfn-lex-bot-promptattemptspecification-textinputspecification

PromptSpecificationProperty

class CfnBotPropsMixin.PromptSpecificationProperty(*, allow_interrupt=None, max_retries=None, message_groups_list=None, message_selection_strategy=None, prompt_attempts_specification=None)

Bases: object

Specifies a list of message groups that Amazon Lex sends to a user to elicit a response.

Parameters:

  • allow_interrupt (Union[bool, IResolvable, None]) – Indicates whether the user can interrupt a speech prompt from the bot.

  • max_retries (Union[int, float, None]) – The maximum number of times the bot tries to elicit a response from the user using this prompt.

  • message_groups_list (Union[IResolvable, Sequence[Union[IResolvable, MessageGroupProperty, Dict[str, Any]]], None]) – A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.

  • message_selection_strategy (Optional[str]) – Indicates how a message is selected from a message group among retries.

  • prompt_attempts_specification (Union[IResolvable, Mapping[str, Union[IResolvable, PromptAttemptSpecificationProperty, Dict[str, Any]]], None]) – Specifies the advanced settings on each attempt of the prompt.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-promptspecification.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.mixins_preview.aws_lex import mixins as lex_mixins

prompt_specification_property = lex_mixins.CfnBotPropsMixin.PromptSpecificationProperty(
    allow_interrupt=False,
    max_retries=123,
    message_groups_list=[lex_mixins.CfnBotPropsMixin.MessageGroupProperty(
        message=lex_mixins.CfnBotPropsMixin.MessageProperty(
            custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                value="value"
            ),
            image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                    text="text",
                    value="value"
                )],
                image_url="imageUrl",
                subtitle="subtitle",
                title="title"
            ),
            plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                value="value"
            ),
            ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                value="value"
            )
        ),
        variations=[lex_mixins.CfnBotPropsMixin.MessageProperty(
            custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                value="value"
            ),
            image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                    text="text",
                    value="value"
                )],
                image_url="imageUrl",
                subtitle="subtitle",
                title="title"
            ),
            plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                value="value"
            ),
            ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                value="value"
            )
        )]
    )],
    message_selection_strategy="messageSelectionStrategy",
    prompt_attempts_specification={
        "prompt_attempts_specification_key": lex_mixins.CfnBotPropsMixin.PromptAttemptSpecificationProperty(
            allowed_input_types=lex_mixins.CfnBotPropsMixin.AllowedInputTypesProperty(
                allow_audio_input=False,
                allow_dtmf_input=False
            ),
            allow_interrupt=False,
            audio_and_dtmf_input_specification=lex_mixins.CfnBotPropsMixin.AudioAndDTMFInputSpecificationProperty(
                audio_specification=lex_mixins.CfnBotPropsMixin.AudioSpecificationProperty(
                    end_timeout_ms=123,
                    max_length_ms=123
                ),
                dtmf_specification=lex_mixins.CfnBotPropsMixin.DTMFSpecificationProperty(
                    deletion_character="deletionCharacter",
                    end_character="endCharacter",
                    end_timeout_ms=123,
                    max_length=123
                ),
                start_timeout_ms=123
            ),
            text_input_specification=lex_mixins.CfnBotPropsMixin.TextInputSpecificationProperty(
                start_timeout_ms=123
            )
        )
    }
)

Attributes

allow_interrupt

Indicates whether the user can interrupt a speech prompt from the bot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-promptspecification.html#cfn-lex-bot-promptspecification-allowinterrupt

max_retries

The maximum number of times the bot tries to elicit a response from the user using this prompt.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-promptspecification.html#cfn-lex-bot-promptspecification-maxretries

message_groups_list

A collection of messages that Amazon Lex can send to the user.

Amazon Lex chooses the actual message to send at runtime.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-promptspecification.html#cfn-lex-bot-promptspecification-messagegroupslist

message_selection_strategy

Indicates how a message is selected from a message group among retries.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-promptspecification.html#cfn-lex-bot-promptspecification-messageselectionstrategy

prompt_attempts_specification

Specifies the advanced settings on each attempt of the prompt.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-promptspecification.html#cfn-lex-bot-promptspecification-promptattemptsspecification

QInConnectAssistantConfigurationProperty

class CfnBotPropsMixin.QInConnectAssistantConfigurationProperty(*, assistant_arn=None)

Bases: object

Parameters:

assistant_arn (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-qinconnectassistantconfiguration.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.mixins_preview.aws_lex import mixins as lex_mixins

q_in_connect_assistant_configuration_property = lex_mixins.CfnBotPropsMixin.QInConnectAssistantConfigurationProperty(
    assistant_arn="assistantArn"
)

Attributes

assistant_arn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-qinconnectassistantconfiguration.html#cfn-lex-bot-qinconnectassistantconfiguration-assistantarn

Type:

see

QInConnectIntentConfigurationProperty

class CfnBotPropsMixin.QInConnectIntentConfigurationProperty(*, q_in_connect_assistant_configuration=None)

Bases: object

Parameters:

q_in_connect_assistant_configuration (Union[IResolvable, QInConnectAssistantConfigurationProperty, Dict[str, Any], None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-qinconnectintentconfiguration.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.mixins_preview.aws_lex import mixins as lex_mixins

q_in_connect_intent_configuration_property = lex_mixins.CfnBotPropsMixin.QInConnectIntentConfigurationProperty(
    q_in_connect_assistant_configuration=lex_mixins.CfnBotPropsMixin.QInConnectAssistantConfigurationProperty(
        assistant_arn="assistantArn"
    )
)

Attributes

q_in_connect_assistant_configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-qinconnectintentconfiguration.html#cfn-lex-bot-qinconnectintentconfiguration-qinconnectassistantconfiguration

Type:

see

QnAIntentConfigurationProperty

class CfnBotPropsMixin.QnAIntentConfigurationProperty(*, bedrock_model_configuration=None, data_source_configuration=None)

Bases: object

Details about the the configuration of the built-in Amazon.QnAIntent .

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-qnaintentconfiguration.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.mixins_preview.aws_lex import mixins as lex_mixins

qn_aIntent_configuration_property = lex_mixins.CfnBotPropsMixin.QnAIntentConfigurationProperty(
    bedrock_model_configuration=lex_mixins.CfnBotPropsMixin.BedrockModelSpecificationProperty(
        bedrock_guardrail_configuration=lex_mixins.CfnBotPropsMixin.BedrockGuardrailConfigurationProperty(
            bedrock_guardrail_identifier="bedrockGuardrailIdentifier",
            bedrock_guardrail_version="bedrockGuardrailVersion"
        ),
        bedrock_model_custom_prompt="bedrockModelCustomPrompt",
        bedrock_trace_status="bedrockTraceStatus",
        model_arn="modelArn"
    ),
    data_source_configuration=lex_mixins.CfnBotPropsMixin.DataSourceConfigurationProperty(
        bedrock_knowledge_store_configuration=lex_mixins.CfnBotPropsMixin.BedrockKnowledgeStoreConfigurationProperty(
            bedrock_knowledge_base_arn="bedrockKnowledgeBaseArn",
            bkb_exact_response_fields=lex_mixins.CfnBotPropsMixin.BKBExactResponseFieldsProperty(
                answer_field="answerField"
            ),
            exact_response=False
        ),
        kendra_configuration=lex_mixins.CfnBotPropsMixin.QnAKendraConfigurationProperty(
            exact_response=False,
            kendra_index="kendraIndex",
            query_filter_string="queryFilterString",
            query_filter_string_enabled=False
        ),
        opensearch_configuration=lex_mixins.CfnBotPropsMixin.OpensearchConfigurationProperty(
            domain_endpoint="domainEndpoint",
            exact_response=False,
            exact_response_fields=lex_mixins.CfnBotPropsMixin.ExactResponseFieldsProperty(
                answer_field="answerField",
                question_field="questionField"
            ),
            include_fields=["includeFields"],
            index_name="indexName"
        )
    )
)

Attributes

bedrock_model_configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-qnaintentconfiguration.html#cfn-lex-bot-qnaintentconfiguration-bedrockmodelconfiguration

Type:

see

data_source_configuration

Contains details about the configuration of the data source used for the AMAZON.QnAIntent .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-qnaintentconfiguration.html#cfn-lex-bot-qnaintentconfiguration-datasourceconfiguration

QnAKendraConfigurationProperty

class CfnBotPropsMixin.QnAKendraConfigurationProperty(*, exact_response=None, kendra_index=None, query_filter_string=None, query_filter_string_enabled=None)

Bases: object

Contains details about the configuration of the Amazon Kendra index used for the AMAZON.QnAIntent .

Parameters:

  • exact_response (Union[bool, IResolvable, None]) – Specifies whether to return an exact response from the Amazon Kendra index or to let the Amazon Bedrock model you select generate a response based on the results. To use this feature, you must first add FAQ questions to your index by following the steps at Adding frequently asked questions (FAQs) to an index .

  • kendra_index (Optional[str]) – The ARN of the Amazon Kendra index to use.

  • query_filter_string (Optional[str]) – Contains the Amazon Kendra filter string to use if enabled. For more information on the Amazon Kendra search filter JSON format, see Using document attributes to filter search results .

  • query_filter_string_enabled (Union[bool, IResolvable, None]) – Specifies whether to enable an Amazon Kendra filter string or not.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-qnakendraconfiguration.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.mixins_preview.aws_lex import mixins as lex_mixins

qn_aKendra_configuration_property = lex_mixins.CfnBotPropsMixin.QnAKendraConfigurationProperty(
    exact_response=False,
    kendra_index="kendraIndex",
    query_filter_string="queryFilterString",
    query_filter_string_enabled=False
)

Attributes

exact_response

Specifies whether to return an exact response from the Amazon Kendra index or to let the Amazon Bedrock model you select generate a response based on the results.

To use this feature, you must first add FAQ questions to your index by following the steps at Adding frequently asked questions (FAQs) to an index .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-qnakendraconfiguration.html#cfn-lex-bot-qnakendraconfiguration-exactresponse

kendra_index

The ARN of the Amazon Kendra index to use.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-qnakendraconfiguration.html#cfn-lex-bot-qnakendraconfiguration-kendraindex

query_filter_string

Contains the Amazon Kendra filter string to use if enabled.

For more information on the Amazon Kendra search filter JSON format, see Using document attributes to filter search results .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-qnakendraconfiguration.html#cfn-lex-bot-qnakendraconfiguration-queryfilterstring

query_filter_string_enabled

Specifies whether to enable an Amazon Kendra filter string or not.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-qnakendraconfiguration.html#cfn-lex-bot-qnakendraconfiguration-queryfilterstringenabled

ReplicationProperty

class CfnBotPropsMixin.ReplicationProperty(*, replica_regions=None)

Bases: object

Parameters:

replica_regions (Optional[Sequence[str]])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-replication.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.mixins_preview.aws_lex import mixins as lex_mixins

replication_property = lex_mixins.CfnBotPropsMixin.ReplicationProperty(
    replica_regions=["replicaRegions"]
)

Attributes

replica_regions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-replication.html#cfn-lex-bot-replication-replicaregions

Type:

see

ResponseSpecificationProperty

class CfnBotPropsMixin.ResponseSpecificationProperty(*, allow_interrupt=None, message_groups_list=None)

Bases: object

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Parameters:

  • allow_interrupt (Union[bool, IResolvable, None]) – Indicates whether the user can interrupt a speech response from Amazon Lex.

  • message_groups_list (Union[IResolvable, Sequence[Union[IResolvable, MessageGroupProperty, Dict[str, Any]]], None]) – A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.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.mixins_preview.aws_lex import mixins as lex_mixins

response_specification_property = lex_mixins.CfnBotPropsMixin.ResponseSpecificationProperty(
    allow_interrupt=False,
    message_groups_list=[lex_mixins.CfnBotPropsMixin.MessageGroupProperty(
        message=lex_mixins.CfnBotPropsMixin.MessageProperty(
            custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                value="value"
            ),
            image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                    text="text",
                    value="value"
                )],
                image_url="imageUrl",
                subtitle="subtitle",
                title="title"
            ),
            plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                value="value"
            ),
            ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                value="value"
            )
        ),
        variations=[lex_mixins.CfnBotPropsMixin.MessageProperty(
            custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                value="value"
            ),
            image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                    text="text",
                    value="value"
                )],
                image_url="imageUrl",
                subtitle="subtitle",
                title="title"
            ),
            plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                value="value"
            ),
            ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                value="value"
            )
        )]
    )]
)

Attributes

allow_interrupt

Indicates whether the user can interrupt a speech response from Amazon Lex.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html#cfn-lex-bot-responsespecification-allowinterrupt

message_groups_list

A collection of responses that Amazon Lex can send to the user.

Amazon Lex chooses the actual response to send at runtime.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-responsespecification.html#cfn-lex-bot-responsespecification-messagegroupslist

RuntimeSettingsProperty

class CfnBotPropsMixin.RuntimeSettingsProperty(*, nlu_improvement_specification=None, slot_resolution_improvement_specification=None)

Bases: object

Contains specifications about the Amazon Lex runtime generative AI capabilities from Amazon Bedrock that you can turn on for your bot.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-runtimesettings.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.mixins_preview.aws_lex import mixins as lex_mixins

runtime_settings_property = lex_mixins.CfnBotPropsMixin.RuntimeSettingsProperty(
    nlu_improvement_specification=lex_mixins.CfnBotPropsMixin.NluImprovementSpecificationProperty(
        enabled=False
    ),
    slot_resolution_improvement_specification=lex_mixins.CfnBotPropsMixin.SlotResolutionImprovementSpecificationProperty(
        bedrock_model_specification=lex_mixins.CfnBotPropsMixin.BedrockModelSpecificationProperty(
            bedrock_guardrail_configuration=lex_mixins.CfnBotPropsMixin.BedrockGuardrailConfigurationProperty(
                bedrock_guardrail_identifier="bedrockGuardrailIdentifier",
                bedrock_guardrail_version="bedrockGuardrailVersion"
            ),
            bedrock_model_custom_prompt="bedrockModelCustomPrompt",
            bedrock_trace_status="bedrockTraceStatus",
            model_arn="modelArn"
        ),
        enabled=False
    )
)

Attributes

nlu_improvement_specification

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-runtimesettings.html#cfn-lex-bot-runtimesettings-nluimprovementspecification

Type:

see

slot_resolution_improvement_specification

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-runtimesettings.html#cfn-lex-bot-runtimesettings-slotresolutionimprovementspecification

Type:

see

S3BucketLogDestinationProperty

class CfnBotPropsMixin.S3BucketLogDestinationProperty(*, kms_key_arn=None, log_prefix=None, s3_bucket_arn=None)

Bases: object

Specifies an Amazon S3 bucket for logging audio conversations.

Parameters:

  • kms_key_arn (Optional[str]) – The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an Amazon S3 bucket.

  • log_prefix (Optional[str]) – The S3 prefix to assign to audio log files.

  • s3_bucket_arn (Optional[str]) – The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-s3bucketlogdestination.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.mixins_preview.aws_lex import mixins as lex_mixins

s3_bucket_log_destination_property = lex_mixins.CfnBotPropsMixin.S3BucketLogDestinationProperty(
    kms_key_arn="kmsKeyArn",
    log_prefix="logPrefix",
    s3_bucket_arn="s3BucketArn"
)

Attributes

kms_key_arn

The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an Amazon S3 bucket.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-s3bucketlogdestination.html#cfn-lex-bot-s3bucketlogdestination-kmskeyarn

log_prefix

The S3 prefix to assign to audio log files.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-s3bucketlogdestination.html#cfn-lex-bot-s3bucketlogdestination-logprefix

s3_bucket_arn

The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-s3bucketlogdestination.html#cfn-lex-bot-s3bucketlogdestination-s3bucketarn

S3LocationProperty

class CfnBotPropsMixin.S3LocationProperty(*, s3_bucket=None, s3_object_key=None, s3_object_version=None)

Bases: object

Defines an Amazon S3 bucket location.

Parameters:

  • s3_bucket (Optional[str]) – The S3 bucket name.

  • s3_object_key (Optional[str]) – The path and file name to the object in the S3 bucket.

  • s3_object_version (Optional[str]) – The version of the object in the S3 bucket.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-s3location.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.mixins_preview.aws_lex import mixins as lex_mixins

s3_location_property = lex_mixins.CfnBotPropsMixin.S3LocationProperty(
    s3_bucket="s3Bucket",
    s3_object_key="s3ObjectKey",
    s3_object_version="s3ObjectVersion"
)

Attributes

s3_bucket

The S3 bucket name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-s3location.html#cfn-lex-bot-s3location-s3bucket

s3_object_key

The path and file name to the object in the S3 bucket.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-s3location.html#cfn-lex-bot-s3location-s3objectkey

s3_object_version

The version of the object in the S3 bucket.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-s3location.html#cfn-lex-bot-s3location-s3objectversion

SSMLMessageProperty

class CfnBotPropsMixin.SSMLMessageProperty(*, value=None)

Bases: object

Defines a Speech Synthesis Markup Language (SSML) prompt.

Parameters:

value (Optional[str]) – The SSML text that defines the prompt.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-ssmlmessage.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.mixins_preview.aws_lex import mixins as lex_mixins

s_sMLMessage_property = lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
    value="value"
)

Attributes

value

The SSML text that defines the prompt.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-ssmlmessage.html#cfn-lex-bot-ssmlmessage-value

SampleUtteranceGenerationSpecificationProperty

class CfnBotPropsMixin.SampleUtteranceGenerationSpecificationProperty(*, bedrock_model_specification=None, enabled=None)

Bases: object

Contains specifications for the sample utterance generation feature.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-sampleutterancegenerationspecification.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.mixins_preview.aws_lex import mixins as lex_mixins

sample_utterance_generation_specification_property = lex_mixins.CfnBotPropsMixin.SampleUtteranceGenerationSpecificationProperty(
    bedrock_model_specification=lex_mixins.CfnBotPropsMixin.BedrockModelSpecificationProperty(
        bedrock_guardrail_configuration=lex_mixins.CfnBotPropsMixin.BedrockGuardrailConfigurationProperty(
            bedrock_guardrail_identifier="bedrockGuardrailIdentifier",
            bedrock_guardrail_version="bedrockGuardrailVersion"
        ),
        bedrock_model_custom_prompt="bedrockModelCustomPrompt",
        bedrock_trace_status="bedrockTraceStatus",
        model_arn="modelArn"
    ),
    enabled=False
)

Attributes

bedrock_model_specification

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-sampleutterancegenerationspecification.html#cfn-lex-bot-sampleutterancegenerationspecification-bedrockmodelspecification

Type:

see

enabled

Specifies whether to enable sample utterance generation or not.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-sampleutterancegenerationspecification.html#cfn-lex-bot-sampleutterancegenerationspecification-enabled

SampleUtteranceProperty

class CfnBotPropsMixin.SampleUtteranceProperty(*, utterance=None)

Bases: object

A sample utterance that invokes an intent or respond to a slot elicitation prompt.

Parameters:

utterance (Optional[str]) – A sample utterance that invokes an intent or respond to a slot elicitation prompt.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-sampleutterance.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.mixins_preview.aws_lex import mixins as lex_mixins

sample_utterance_property = lex_mixins.CfnBotPropsMixin.SampleUtteranceProperty(
    utterance="utterance"
)

Attributes

utterance

A sample utterance that invokes an intent or respond to a slot elicitation prompt.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-sampleutterance.html#cfn-lex-bot-sampleutterance-utterance

SampleValueProperty

class CfnBotPropsMixin.SampleValueProperty(*, value=None)

Bases: object

Defines one of the values for a slot type.

Parameters:

value (Optional[str]) – The value that can be used for a slot type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-samplevalue.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.mixins_preview.aws_lex import mixins as lex_mixins

sample_value_property = lex_mixins.CfnBotPropsMixin.SampleValueProperty(
    value="value"
)

Attributes

value

The value that can be used for a slot type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-samplevalue.html#cfn-lex-bot-samplevalue-value

SessionAttributeProperty

class CfnBotPropsMixin.SessionAttributeProperty(*, key=None, value=None)

Bases: object

A key/value pair representing session-specific context information.

It contains application information passed between Amazon Lex V2 and a client application.

Parameters:

  • key (Optional[str]) – The name of the session attribute.

  • value (Optional[str]) – The session-specific context information for the session attribute.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-sessionattribute.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.mixins_preview.aws_lex import mixins as lex_mixins

session_attribute_property = lex_mixins.CfnBotPropsMixin.SessionAttributeProperty(
    key="key",
    value="value"
)

Attributes

key

The name of the session attribute.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-sessionattribute.html#cfn-lex-bot-sessionattribute-key

value

The session-specific context information for the session attribute.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-sessionattribute.html#cfn-lex-bot-sessionattribute-value

SlotCaptureSettingProperty

class CfnBotPropsMixin.SlotCaptureSettingProperty(*, capture_conditional=None, capture_next_step=None, capture_response=None, code_hook=None, elicitation_code_hook=None, failure_conditional=None, failure_next_step=None, failure_response=None)

Bases: object

Settings used when Amazon Lex successfully captures a slot value from a user.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotcapturesetting.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
capture_conditional

A list of conditional branches to evaluate after the slot value is captured.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotcapturesetting.html#cfn-lex-bot-slotcapturesetting-captureconditional

capture_next_step

Specifies the next step that the bot runs when the slot value is captured before the code hook times out.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotcapturesetting.html#cfn-lex-bot-slotcapturesetting-capturenextstep

capture_response

Specifies a list of message groups that Amazon Lex uses to respond the user input.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotcapturesetting.html#cfn-lex-bot-slotcapturesetting-captureresponse

code_hook

Code hook called after Amazon Lex successfully captures a slot value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotcapturesetting.html#cfn-lex-bot-slotcapturesetting-codehook

elicitation_code_hook

Code hook called when Amazon Lex doesn’t capture a slot value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotcapturesetting.html#cfn-lex-bot-slotcapturesetting-elicitationcodehook

failure_conditional

A list of conditional branches to evaluate when the slot value isn’t captured.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotcapturesetting.html#cfn-lex-bot-slotcapturesetting-failureconditional

failure_next_step

Specifies the next step that the bot runs when the slot value code is not recognized.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotcapturesetting.html#cfn-lex-bot-slotcapturesetting-failurenextstep

failure_response

Specifies a list of message groups that Amazon Lex uses to respond the user input when the slot fails to be captured.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotcapturesetting.html#cfn-lex-bot-slotcapturesetting-failureresponse

SlotDefaultValueProperty

class CfnBotPropsMixin.SlotDefaultValueProperty(*, default_value=None)

Bases: object

Specifies the default value to use when a user doesn’t provide a value for a slot.

Parameters:

default_value (Optional[str]) – The default value to use when a user doesn’t provide a value for a slot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotdefaultvalue.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.mixins_preview.aws_lex import mixins as lex_mixins

slot_default_value_property = lex_mixins.CfnBotPropsMixin.SlotDefaultValueProperty(
    default_value="defaultValue"
)

Attributes

default_value

The default value to use when a user doesn’t provide a value for a slot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotdefaultvalue.html#cfn-lex-bot-slotdefaultvalue-defaultvalue

SlotDefaultValueSpecificationProperty

class CfnBotPropsMixin.SlotDefaultValueSpecificationProperty(*, default_value_list=None)

Bases: object

The default value to use when a user doesn’t provide a value for a slot.

Parameters:

default_value_list (Union[IResolvable, Sequence[Union[IResolvable, SlotDefaultValueProperty, Dict[str, Any]]], None]) – A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotdefaultvaluespecification.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.mixins_preview.aws_lex import mixins as lex_mixins

slot_default_value_specification_property = lex_mixins.CfnBotPropsMixin.SlotDefaultValueSpecificationProperty(
    default_value_list=[lex_mixins.CfnBotPropsMixin.SlotDefaultValueProperty(
        default_value="defaultValue"
    )]
)

Attributes

default_value_list

A list of default values.

Amazon Lex chooses the default value to use in the order that they are presented in the list.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotdefaultvaluespecification.html#cfn-lex-bot-slotdefaultvaluespecification-defaultvaluelist

SlotPriorityProperty

class CfnBotPropsMixin.SlotPriorityProperty(*, priority=None, slot_name=None)

Bases: object

Sets the priority that Amazon Lex should use when eliciting slot values from a user.

Parameters:

  • priority (Union[int, float, None]) – The priority that Amazon Lex should apply to the slot.

  • slot_name (Optional[str]) – The name of the slot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotpriority.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.mixins_preview.aws_lex import mixins as lex_mixins

slot_priority_property = lex_mixins.CfnBotPropsMixin.SlotPriorityProperty(
    priority=123,
    slot_name="slotName"
)

Attributes

priority

The priority that Amazon Lex should apply to the slot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotpriority.html#cfn-lex-bot-slotpriority-priority

slot_name

The name of the slot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotpriority.html#cfn-lex-bot-slotpriority-slotname

SlotProperty

class CfnBotPropsMixin.SlotProperty(*, description=None, multiple_values_setting=None, name=None, obfuscation_setting=None, slot_type_name=None, sub_slot_setting=None, value_elicitation_setting=None)

Bases: object

Specifies the definition of a slot.

Amazon Lex elicits slot values from uses to fulfill the user’s intent.

Parameters:

  • description (Optional[str]) – The description of the slot.

  • multiple_values_setting (Union[IResolvable, MultipleValuesSettingProperty, Dict[str, Any], None]) – Indicates whether a slot can return multiple values.

  • name (Optional[str]) – The name given to the slot.

  • obfuscation_setting (Union[IResolvable, ObfuscationSettingProperty, Dict[str, Any], None]) – Determines whether the contents of the slot are obfuscated in Amazon CloudWatch Logs logs. Use obfuscated slots to protect information such as personally identifiable information (PII) in logs.

  • slot_type_name (Optional[str]) – The name of the slot type that this slot is based on. The slot type defines the acceptable values for the slot.

  • sub_slot_setting (Union[IResolvable, SubSlotSettingProperty, Dict[str, Any], None])

  • value_elicitation_setting (Union[IResolvable, SlotValueElicitationSettingProperty, Dict[str, Any], None]) – Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values: - ORIGINAL_VALUE - Returns the value entered by the user, if the user value is similar to a slot value. - TOP_RESOLUTION - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned. If you don’t specify the valueSelectionStrategy , the default is ORIGINAL_VALUE .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slot.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
description

The description of the slot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slot.html#cfn-lex-bot-slot-description

multiple_values_setting

Indicates whether a slot can return multiple values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slot.html#cfn-lex-bot-slot-multiplevaluessetting

name

The name given to the slot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slot.html#cfn-lex-bot-slot-name

obfuscation_setting

Determines whether the contents of the slot are obfuscated in Amazon CloudWatch Logs logs.

Use obfuscated slots to protect information such as personally identifiable information (PII) in logs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slot.html#cfn-lex-bot-slot-obfuscationsetting

slot_type_name

The name of the slot type that this slot is based on.

The slot type defines the acceptable values for the slot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slot.html#cfn-lex-bot-slot-slottypename

sub_slot_setting

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slot.html#cfn-lex-bot-slot-subslotsetting

Type:

see

value_elicitation_setting

Determines the slot resolution strategy that Amazon Lex uses to return slot type values.

The field can be set to one of the following values:

  • ORIGINAL_VALUE - Returns the value entered by the user, if the user value is similar to a slot value.

  • TOP_RESOLUTION - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.

If you don’t specify the valueSelectionStrategy , the default is ORIGINAL_VALUE .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slot.html#cfn-lex-bot-slot-valueelicitationsetting

SlotResolutionImprovementSpecificationProperty

class CfnBotPropsMixin.SlotResolutionImprovementSpecificationProperty(*, bedrock_model_specification=None, enabled=None)

Bases: object

Contains specifications for the assisted slot resolution feature.

Parameters:

  • bedrock_model_specification (Union[IResolvable, BedrockModelSpecificationProperty, Dict[str, Any], None]) – An object containing information about the Amazon Bedrock model used to assist slot resolution.

  • enabled (Union[bool, IResolvable, None]) – Specifies whether assisted slot resolution is turned on or off.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotresolutionimprovementspecification.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.mixins_preview.aws_lex import mixins as lex_mixins

slot_resolution_improvement_specification_property = lex_mixins.CfnBotPropsMixin.SlotResolutionImprovementSpecificationProperty(
    bedrock_model_specification=lex_mixins.CfnBotPropsMixin.BedrockModelSpecificationProperty(
        bedrock_guardrail_configuration=lex_mixins.CfnBotPropsMixin.BedrockGuardrailConfigurationProperty(
            bedrock_guardrail_identifier="bedrockGuardrailIdentifier",
            bedrock_guardrail_version="bedrockGuardrailVersion"
        ),
        bedrock_model_custom_prompt="bedrockModelCustomPrompt",
        bedrock_trace_status="bedrockTraceStatus",
        model_arn="modelArn"
    ),
    enabled=False
)

Attributes

bedrock_model_specification

An object containing information about the Amazon Bedrock model used to assist slot resolution.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotresolutionimprovementspecification.html#cfn-lex-bot-slotresolutionimprovementspecification-bedrockmodelspecification

enabled

Specifies whether assisted slot resolution is turned on or off.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotresolutionimprovementspecification.html#cfn-lex-bot-slotresolutionimprovementspecification-enabled

SlotTypeProperty

class CfnBotPropsMixin.SlotTypeProperty(*, composite_slot_type_setting=None, description=None, external_source_setting=None, name=None, parent_slot_type_signature=None, slot_type_values=None, value_selection_setting=None)

Bases: object

Describes a slot type.

Parameters:

  • composite_slot_type_setting (Union[IResolvable, CompositeSlotTypeSettingProperty, Dict[str, Any], None])

  • description (Optional[str]) – A description of the slot type. Use the description to help identify the slot type in lists.

  • external_source_setting (Union[IResolvable, ExternalSourceSettingProperty, Dict[str, Any], None]) – Sets the type of external information used to create the slot type.

  • name (Optional[str]) – The name of the slot type. A slot type name must be unique withing the account.

  • parent_slot_type_signature (Optional[str]) – The built-in slot type used as a parent of this slot type. When you define a parent slot type, the new slot type has the configuration of the parent lot type. Only AMAZON.AlphaNumeric is supported.

  • slot_type_values (Union[IResolvable, Sequence[Union[IResolvable, SlotTypeValueProperty, Dict[str, Any]]], None]) – A list of SlotTypeValue objects that defines the values that the slot type can take. Each value can have a list of synonyms, additional values that help train the machine learning model about the values that it resolves for the slot.

  • value_selection_setting (Union[IResolvable, SlotValueSelectionSettingProperty, Dict[str, Any], None]) – Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values: - ORIGINAL_VALUE - Returns the value entered by the user, if the user value is similar to the slot value. - TOP_RESOLUTION - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned. If you don’t specify the valueSelectionStrategy , the default is ORIGINAL_VALUE .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slottype.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.mixins_preview.aws_lex import mixins as lex_mixins

slot_type_property = lex_mixins.CfnBotPropsMixin.SlotTypeProperty(
    composite_slot_type_setting=lex_mixins.CfnBotPropsMixin.CompositeSlotTypeSettingProperty(
        sub_slots=[lex_mixins.CfnBotPropsMixin.SubSlotTypeCompositionProperty(
            name="name",
            slot_type_id="slotTypeId"
        )]
    ),
    description="description",
    external_source_setting=lex_mixins.CfnBotPropsMixin.ExternalSourceSettingProperty(
        grammar_slot_type_setting=lex_mixins.CfnBotPropsMixin.GrammarSlotTypeSettingProperty(
            source=lex_mixins.CfnBotPropsMixin.GrammarSlotTypeSourceProperty(
                kms_key_arn="kmsKeyArn",
                s3_bucket_name="s3BucketName",
                s3_object_key="s3ObjectKey"
            )
        )
    ),
    name="name",
    parent_slot_type_signature="parentSlotTypeSignature",
    slot_type_values=[lex_mixins.CfnBotPropsMixin.SlotTypeValueProperty(
        sample_value=lex_mixins.CfnBotPropsMixin.SampleValueProperty(
            value="value"
        ),
        synonyms=[lex_mixins.CfnBotPropsMixin.SampleValueProperty(
            value="value"
        )]
    )],
    value_selection_setting=lex_mixins.CfnBotPropsMixin.SlotValueSelectionSettingProperty(
        advanced_recognition_setting=lex_mixins.CfnBotPropsMixin.AdvancedRecognitionSettingProperty(
            audio_recognition_strategy="audioRecognitionStrategy"
        ),
        regex_filter=lex_mixins.CfnBotPropsMixin.SlotValueRegexFilterProperty(
            pattern="pattern"
        ),
        resolution_strategy="resolutionStrategy"
    )
)

Attributes

composite_slot_type_setting

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slottype.html#cfn-lex-bot-slottype-compositeslottypesetting

Type:

see

description

A description of the slot type.

Use the description to help identify the slot type in lists.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slottype.html#cfn-lex-bot-slottype-description

external_source_setting

Sets the type of external information used to create the slot type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slottype.html#cfn-lex-bot-slottype-externalsourcesetting

name

The name of the slot type.

A slot type name must be unique withing the account.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slottype.html#cfn-lex-bot-slottype-name

parent_slot_type_signature

The built-in slot type used as a parent of this slot type.

When you define a parent slot type, the new slot type has the configuration of the parent lot type.

Only AMAZON.AlphaNumeric is supported.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slottype.html#cfn-lex-bot-slottype-parentslottypesignature

slot_type_values

A list of SlotTypeValue objects that defines the values that the slot type can take.

Each value can have a list of synonyms, additional values that help train the machine learning model about the values that it resolves for the slot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slottype.html#cfn-lex-bot-slottype-slottypevalues

value_selection_setting

Determines the slot resolution strategy that Amazon Lex uses to return slot type values.

The field can be set to one of the following values:

  • ORIGINAL_VALUE - Returns the value entered by the user, if the user value is similar to the slot value.

  • TOP_RESOLUTION - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.

If you don’t specify the valueSelectionStrategy , the default is ORIGINAL_VALUE .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slottype.html#cfn-lex-bot-slottype-valueselectionsetting

SlotTypeValueProperty

class CfnBotPropsMixin.SlotTypeValueProperty(*, sample_value=None, synonyms=None)

Bases: object

Each slot type can have a set of values.

Each SlotTypeValue represents a value that the slot type can take.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slottypevalue.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.mixins_preview.aws_lex import mixins as lex_mixins

slot_type_value_property = lex_mixins.CfnBotPropsMixin.SlotTypeValueProperty(
    sample_value=lex_mixins.CfnBotPropsMixin.SampleValueProperty(
        value="value"
    ),
    synonyms=[lex_mixins.CfnBotPropsMixin.SampleValueProperty(
        value="value"
    )]
)

Attributes

sample_value

The value of the slot type entry.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slottypevalue.html#cfn-lex-bot-slottypevalue-samplevalue

synonyms

Additional values related to the slot type entry.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slottypevalue.html#cfn-lex-bot-slottypevalue-synonyms

SlotValueElicitationSettingProperty

class CfnBotPropsMixin.SlotValueElicitationSettingProperty(*, default_value_specification=None, prompt_specification=None, sample_utterances=None, slot_capture_setting=None, slot_constraint=None, wait_and_continue_specification=None)

Bases: object

Specifies the elicitation setting details eliciting a slot.

Parameters:

  • default_value_specification (Union[IResolvable, SlotDefaultValueSpecificationProperty, Dict[str, Any], None]) – A list of default values for a slot. Default values are used when Amazon Lex hasn’t determined a value for a slot. You can specify default values from context variables, session attributes, and defined values.

  • prompt_specification (Union[IResolvable, PromptSpecificationProperty, Dict[str, Any], None]) – The prompt that Amazon Lex uses to elicit the slot value from the user.

  • sample_utterances (Union[IResolvable, Sequence[Union[IResolvable, SampleUtteranceProperty, Dict[str, Any]]], None]) – If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.

  • slot_capture_setting (Union[IResolvable, SlotCaptureSettingProperty, Dict[str, Any], None]) – Specifies the settings that Amazon Lex uses when a slot value is successfully entered by a user.

  • slot_constraint (Optional[str]) – Specifies whether the slot is required or optional.

  • wait_and_continue_specification (Union[IResolvable, WaitAndContinueSpecificationProperty, Dict[str, Any], None]) – Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueelicitationsetting.html

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
default_value_specification

A list of default values for a slot.

Default values are used when Amazon Lex hasn’t determined a value for a slot. You can specify default values from context variables, session attributes, and defined values.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueelicitationsetting.html#cfn-lex-bot-slotvalueelicitationsetting-defaultvaluespecification

prompt_specification

The prompt that Amazon Lex uses to elicit the slot value from the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueelicitationsetting.html#cfn-lex-bot-slotvalueelicitationsetting-promptspecification

sample_utterances

If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy.

This is optional. In most cases, Amazon Lex is capable of understanding user utterances.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueelicitationsetting.html#cfn-lex-bot-slotvalueelicitationsetting-sampleutterances

slot_capture_setting

Specifies the settings that Amazon Lex uses when a slot value is successfully entered by a user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueelicitationsetting.html#cfn-lex-bot-slotvalueelicitationsetting-slotcapturesetting

slot_constraint

Specifies whether the slot is required or optional.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueelicitationsetting.html#cfn-lex-bot-slotvalueelicitationsetting-slotconstraint

wait_and_continue_specification

Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueelicitationsetting.html#cfn-lex-bot-slotvalueelicitationsetting-waitandcontinuespecification

SlotValueOverrideMapProperty

class CfnBotPropsMixin.SlotValueOverrideMapProperty(*, slot_name=None, slot_value_override=None)

Bases: object

Maps a slot name to the SlotValueOverride object.

Parameters:

  • slot_name (Optional[str]) – The name of the slot.

  • slot_value_override (Union[IResolvable, SlotValueOverrideProperty, Dict[str, Any], None]) – The SlotValueOverride object to which the slot name will be mapped.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueoverridemap.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.mixins_preview.aws_lex import mixins as lex_mixins

# slot_value_override_property_: lex_mixins.CfnBotPropsMixin.SlotValueOverrideProperty

slot_value_override_map_property = lex_mixins.CfnBotPropsMixin.SlotValueOverrideMapProperty(
    slot_name="slotName",
    slot_value_override=lex_mixins.CfnBotPropsMixin.SlotValueOverrideProperty(
        shape="shape",
        value=lex_mixins.CfnBotPropsMixin.SlotValueProperty(
            interpreted_value="interpretedValue"
        ),
        values=[slot_value_override_property_]
    )
)

Attributes

slot_name

The name of the slot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueoverridemap.html#cfn-lex-bot-slotvalueoverridemap-slotname

slot_value_override

The SlotValueOverride object to which the slot name will be mapped.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueoverridemap.html#cfn-lex-bot-slotvalueoverridemap-slotvalueoverride

SlotValueOverrideProperty

class CfnBotPropsMixin.SlotValueOverrideProperty(*, shape=None, value=None, values=None)

Bases: object

The slot values that Amazon Lex uses when it sets slot values in a dialog step.

Parameters:

  • shape (Optional[str]) – When the shape value is List , it indicates that the values field contains a list of slot values. When the value is Scalar , it indicates that the value field contains a single value.

  • value (Union[IResolvable, SlotValueProperty, Dict[str, Any], None]) – The current value of the slot.

  • values (Union[IResolvable, Sequence[Union[IResolvable, SlotValueOverrideProperty, Dict[str, Any]]], None]) – A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueoverride.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.mixins_preview.aws_lex import mixins as lex_mixins

# slot_value_override_property_: lex_mixins.CfnBotPropsMixin.SlotValueOverrideProperty

slot_value_override_property = lex_mixins.CfnBotPropsMixin.SlotValueOverrideProperty(
    shape="shape",
    value=lex_mixins.CfnBotPropsMixin.SlotValueProperty(
        interpreted_value="interpretedValue"
    ),
    values=[slot_value_override_property_]
)

Attributes

shape

When the shape value is List , it indicates that the values field contains a list of slot values.

When the value is Scalar , it indicates that the value field contains a single value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueoverride.html#cfn-lex-bot-slotvalueoverride-shape

value

The current value of the slot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueoverride.html#cfn-lex-bot-slotvalueoverride-value

values

A list of one or more values that the user provided for the slot.

For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueoverride.html#cfn-lex-bot-slotvalueoverride-values

SlotValueProperty

class CfnBotPropsMixin.SlotValueProperty(*, interpreted_value=None)

Bases: object

The value to set in a slot.

Parameters:

interpreted_value (Optional[str]) – The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalue.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.mixins_preview.aws_lex import mixins as lex_mixins

slot_value_property = lex_mixins.CfnBotPropsMixin.SlotValueProperty(
    interpreted_value="interpretedValue"
)

Attributes

interpreted_value

The value that Amazon Lex determines for the slot.

The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalue.html#cfn-lex-bot-slotvalue-interpretedvalue

SlotValueRegexFilterProperty

class CfnBotPropsMixin.SlotValueRegexFilterProperty(*, pattern=None)

Bases: object

Provides a regular expression used to validate the value of a slot.

Parameters:

pattern (Optional[str]) – A regular expression used to validate the value of a slot. Use a standard regular expression. Amazon Lex supports the following characters in the regular expression: - A-Z, a-z - 0-9 - Unicode characters (”⁠u”) Represent Unicode characters with four digits, for example “⁠u0041” or “⁠u005A”. The following regular expression operators are not supported: - Infinite repeaters: *, +, or {x,} with no upper bound. - Wild card (.)

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueregexfilter.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.mixins_preview.aws_lex import mixins as lex_mixins

slot_value_regex_filter_property = lex_mixins.CfnBotPropsMixin.SlotValueRegexFilterProperty(
    pattern="pattern"
)

Attributes

pattern

A regular expression used to validate the value of a slot.

Use a standard regular expression. Amazon Lex supports the following characters in the regular expression:

  • A-Z, a-z

  • 0-9

  • Unicode characters (”⁠u”)

Represent Unicode characters with four digits, for example “⁠u0041” or “⁠u005A”.

The following regular expression operators are not supported:

  • Infinite repeaters: *, +, or {x,} with no upper bound.

  • Wild card (.)

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueregexfilter.html#cfn-lex-bot-slotvalueregexfilter-pattern

SlotValueSelectionSettingProperty

class CfnBotPropsMixin.SlotValueSelectionSettingProperty(*, advanced_recognition_setting=None, regex_filter=None, resolution_strategy=None)

Bases: object

Contains settings used by Amazon Lex to select a slot value.

Parameters:

  • advanced_recognition_setting (Union[IResolvable, AdvancedRecognitionSettingProperty, Dict[str, Any], None]) – Provides settings that enable advanced recognition settings for slot values. You can use this to enable using slot values as a custom vocabulary for recognizing user utterances.

  • regex_filter (Union[IResolvable, SlotValueRegexFilterProperty, Dict[str, Any], None]) – A regular expression used to validate the value of a slot.

  • resolution_strategy (Optional[str]) – Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values: - ORIGINAL_VALUE - Returns the value entered by the user, if the user value is similar to the slot value. - TOP_RESOLUTION - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned. If you don’t specify the valueSelectionStrategy , the default is ORIGINAL_VALUE .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueselectionsetting.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.mixins_preview.aws_lex import mixins as lex_mixins

slot_value_selection_setting_property = lex_mixins.CfnBotPropsMixin.SlotValueSelectionSettingProperty(
    advanced_recognition_setting=lex_mixins.CfnBotPropsMixin.AdvancedRecognitionSettingProperty(
        audio_recognition_strategy="audioRecognitionStrategy"
    ),
    regex_filter=lex_mixins.CfnBotPropsMixin.SlotValueRegexFilterProperty(
        pattern="pattern"
    ),
    resolution_strategy="resolutionStrategy"
)

Attributes

advanced_recognition_setting

Provides settings that enable advanced recognition settings for slot values.

You can use this to enable using slot values as a custom vocabulary for recognizing user utterances.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueselectionsetting.html#cfn-lex-bot-slotvalueselectionsetting-advancedrecognitionsetting

regex_filter

A regular expression used to validate the value of a slot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueselectionsetting.html#cfn-lex-bot-slotvalueselectionsetting-regexfilter

resolution_strategy

Determines the slot resolution strategy that Amazon Lex uses to return slot type values.

The field can be set to one of the following values:

  • ORIGINAL_VALUE - Returns the value entered by the user, if the user value is similar to the slot value.

  • TOP_RESOLUTION - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.

If you don’t specify the valueSelectionStrategy , the default is ORIGINAL_VALUE .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-slotvalueselectionsetting.html#cfn-lex-bot-slotvalueselectionsetting-resolutionstrategy

SpecificationsProperty

class CfnBotPropsMixin.SpecificationsProperty(*, slot_type_id=None, value_elicitation_setting=None)

Bases: object

Subslot specifications.

Parameters:

  • slot_type_id (Optional[str]) – The unique identifier assigned to the slot type.

  • value_elicitation_setting (Union[IResolvable, SubSlotValueElicitationSettingProperty, Dict[str, Any], None]) – Specifies the elicitation setting details for constituent sub slots of a composite slot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-specifications.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.mixins_preview.aws_lex import mixins as lex_mixins

specifications_property = lex_mixins.CfnBotPropsMixin.SpecificationsProperty(
    slot_type_id="slotTypeId",
    value_elicitation_setting=lex_mixins.CfnBotPropsMixin.SubSlotValueElicitationSettingProperty(
        default_value_specification=lex_mixins.CfnBotPropsMixin.SlotDefaultValueSpecificationProperty(
            default_value_list=[lex_mixins.CfnBotPropsMixin.SlotDefaultValueProperty(
                default_value="defaultValue"
            )]
        ),
        prompt_specification=lex_mixins.CfnBotPropsMixin.PromptSpecificationProperty(
            allow_interrupt=False,
            max_retries=123,
            message_groups_list=[lex_mixins.CfnBotPropsMixin.MessageGroupProperty(
                message=lex_mixins.CfnBotPropsMixin.MessageProperty(
                    custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                        value="value"
                    ),
                    image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                        buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                            text="text",
                            value="value"
                        )],
                        image_url="imageUrl",
                        subtitle="subtitle",
                        title="title"
                    ),
                    plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                        value="value"
                    ),
                    ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                        value="value"
                    )
                ),
                variations=[lex_mixins.CfnBotPropsMixin.MessageProperty(
                    custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                        value="value"
                    ),
                    image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                        buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                            text="text",
                            value="value"
                        )],
                        image_url="imageUrl",
                        subtitle="subtitle",
                        title="title"
                    ),
                    plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                        value="value"
                    ),
                    ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                        value="value"
                    )
                )]
            )],
            message_selection_strategy="messageSelectionStrategy",
            prompt_attempts_specification={
                "prompt_attempts_specification_key": lex_mixins.CfnBotPropsMixin.PromptAttemptSpecificationProperty(
                    allowed_input_types=lex_mixins.CfnBotPropsMixin.AllowedInputTypesProperty(
                        allow_audio_input=False,
                        allow_dtmf_input=False
                    ),
                    allow_interrupt=False,
                    audio_and_dtmf_input_specification=lex_mixins.CfnBotPropsMixin.AudioAndDTMFInputSpecificationProperty(
                        audio_specification=lex_mixins.CfnBotPropsMixin.AudioSpecificationProperty(
                            end_timeout_ms=123,
                            max_length_ms=123
                        ),
                        dtmf_specification=lex_mixins.CfnBotPropsMixin.DTMFSpecificationProperty(
                            deletion_character="deletionCharacter",
                            end_character="endCharacter",
                            end_timeout_ms=123,
                            max_length=123
                        ),
                        start_timeout_ms=123
                    ),
                    text_input_specification=lex_mixins.CfnBotPropsMixin.TextInputSpecificationProperty(
                        start_timeout_ms=123
                    )
                )
            }
        ),
        sample_utterances=[lex_mixins.CfnBotPropsMixin.SampleUtteranceProperty(
            utterance="utterance"
        )],
        wait_and_continue_specification=lex_mixins.CfnBotPropsMixin.WaitAndContinueSpecificationProperty(
            continue_response=lex_mixins.CfnBotPropsMixin.ResponseSpecificationProperty(
                allow_interrupt=False,
                message_groups_list=[lex_mixins.CfnBotPropsMixin.MessageGroupProperty(
                    message=lex_mixins.CfnBotPropsMixin.MessageProperty(
                        custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                            value="value"
                        ),
                        image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                            buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                                text="text",
                                value="value"
                            )],
                            image_url="imageUrl",
                            subtitle="subtitle",
                            title="title"
                        ),
                        plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                            value="value"
                        ),
                        ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                            value="value"
                        )
                    ),
                    variations=[lex_mixins.CfnBotPropsMixin.MessageProperty(
                        custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                            value="value"
                        ),
                        image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                            buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                                text="text",
                                value="value"
                            )],
                            image_url="imageUrl",
                            subtitle="subtitle",
                            title="title"
                        ),
                        plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                            value="value"
                        ),
                        ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                            value="value"
                        )
                    )]
                )]
            ),
            is_active=False,
            still_waiting_response=lex_mixins.CfnBotPropsMixin.StillWaitingResponseSpecificationProperty(
                allow_interrupt=False,
                frequency_in_seconds=123,
                message_groups_list=[lex_mixins.CfnBotPropsMixin.MessageGroupProperty(
                    message=lex_mixins.CfnBotPropsMixin.MessageProperty(
                        custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                            value="value"
                        ),
                        image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                            buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                                text="text",
                                value="value"
                            )],
                            image_url="imageUrl",
                            subtitle="subtitle",
                            title="title"
                        ),
                        plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                            value="value"
                        ),
                        ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                            value="value"
                        )
                    ),
                    variations=[lex_mixins.CfnBotPropsMixin.MessageProperty(
                        custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                            value="value"
                        ),
                        image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                            buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                                text="text",
                                value="value"
                            )],
                            image_url="imageUrl",
                            subtitle="subtitle",
                            title="title"
                        ),
                        plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                            value="value"
                        ),
                        ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                            value="value"
                        )
                    )]
                )],
                timeout_in_seconds=123
            ),
            waiting_response=lex_mixins.CfnBotPropsMixin.ResponseSpecificationProperty(
                allow_interrupt=False,
                message_groups_list=[lex_mixins.CfnBotPropsMixin.MessageGroupProperty(
                    message=lex_mixins.CfnBotPropsMixin.MessageProperty(
                        custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                            value="value"
                        ),
                        image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                            buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                                text="text",
                                value="value"
                            )],
                            image_url="imageUrl",
                            subtitle="subtitle",
                            title="title"
                        ),
                        plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                            value="value"
                        ),
                        ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                            value="value"
                        )
                    ),
                    variations=[lex_mixins.CfnBotPropsMixin.MessageProperty(
                        custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                            value="value"
                        ),
                        image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                            buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                                text="text",
                                value="value"
                            )],
                            image_url="imageUrl",
                            subtitle="subtitle",
                            title="title"
                        ),
                        plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                            value="value"
                        ),
                        ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                            value="value"
                        )
                    )]
                )]
            )
        )
    )
)

Attributes

slot_type_id

The unique identifier assigned to the slot type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-specifications.html#cfn-lex-bot-specifications-slottypeid

value_elicitation_setting

Specifies the elicitation setting details for constituent sub slots of a composite slot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-specifications.html#cfn-lex-bot-specifications-valueelicitationsetting

StillWaitingResponseSpecificationProperty

class CfnBotPropsMixin.StillWaitingResponseSpecificationProperty(*, allow_interrupt=None, frequency_in_seconds=None, message_groups_list=None, timeout_in_seconds=None)

Bases: object

Defines the messages that Amazon Lex sends to a user to remind them that the bot is waiting for a response.

Parameters:

  • allow_interrupt (Union[bool, IResolvable, None]) – Indicates that the user can interrupt the response by speaking while the message is being played.

  • frequency_in_seconds (Union[int, float, None]) – How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.

  • message_groups_list (Union[IResolvable, Sequence[Union[IResolvable, MessageGroupProperty, Dict[str, Any]]], None]) – One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.

  • timeout_in_seconds (Union[int, float, None]) – If Amazon Lex waits longer than this length of time for a response, it will stop sending messages.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-stillwaitingresponsespecification.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.mixins_preview.aws_lex import mixins as lex_mixins

still_waiting_response_specification_property = lex_mixins.CfnBotPropsMixin.StillWaitingResponseSpecificationProperty(
    allow_interrupt=False,
    frequency_in_seconds=123,
    message_groups_list=[lex_mixins.CfnBotPropsMixin.MessageGroupProperty(
        message=lex_mixins.CfnBotPropsMixin.MessageProperty(
            custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                value="value"
            ),
            image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                    text="text",
                    value="value"
                )],
                image_url="imageUrl",
                subtitle="subtitle",
                title="title"
            ),
            plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                value="value"
            ),
            ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                value="value"
            )
        ),
        variations=[lex_mixins.CfnBotPropsMixin.MessageProperty(
            custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                value="value"
            ),
            image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                    text="text",
                    value="value"
                )],
                image_url="imageUrl",
                subtitle="subtitle",
                title="title"
            ),
            plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                value="value"
            ),
            ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                value="value"
            )
        )]
    )],
    timeout_in_seconds=123
)

Attributes

allow_interrupt

Indicates that the user can interrupt the response by speaking while the message is being played.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-stillwaitingresponsespecification.html#cfn-lex-bot-stillwaitingresponsespecification-allowinterrupt

frequency_in_seconds

How often a message should be sent to the user.

Minimum of 1 second, maximum of 5 minutes.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-stillwaitingresponsespecification.html#cfn-lex-bot-stillwaitingresponsespecification-frequencyinseconds

message_groups_list

One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-stillwaitingresponsespecification.html#cfn-lex-bot-stillwaitingresponsespecification-messagegroupslist

timeout_in_seconds

If Amazon Lex waits longer than this length of time for a response, it will stop sending messages.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-stillwaitingresponsespecification.html#cfn-lex-bot-stillwaitingresponsespecification-timeoutinseconds

SubSlotSettingProperty

class CfnBotPropsMixin.SubSlotSettingProperty(*, expression=None, slot_specifications=None)

Bases: object

Specifications for the constituent sub slots and the expression for the composite slot.

Parameters:

  • expression (Optional[str]) – The expression text for defining the constituent sub slots in the composite slot using logical AND and OR operators.

  • slot_specifications (Union[IResolvable, Mapping[str, Union[IResolvable, SpecificationsProperty, Dict[str, Any]]], None]) – Specifications for the constituent sub slots of a composite slot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-subslotsetting.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.mixins_preview.aws_lex import mixins as lex_mixins

sub_slot_setting_property = lex_mixins.CfnBotPropsMixin.SubSlotSettingProperty(
    expression="expression",
    slot_specifications={
        "slot_specifications_key": lex_mixins.CfnBotPropsMixin.SpecificationsProperty(
            slot_type_id="slotTypeId",
            value_elicitation_setting=lex_mixins.CfnBotPropsMixin.SubSlotValueElicitationSettingProperty(
                default_value_specification=lex_mixins.CfnBotPropsMixin.SlotDefaultValueSpecificationProperty(
                    default_value_list=[lex_mixins.CfnBotPropsMixin.SlotDefaultValueProperty(
                        default_value="defaultValue"
                    )]
                ),
                prompt_specification=lex_mixins.CfnBotPropsMixin.PromptSpecificationProperty(
                    allow_interrupt=False,
                    max_retries=123,
                    message_groups_list=[lex_mixins.CfnBotPropsMixin.MessageGroupProperty(
                        message=lex_mixins.CfnBotPropsMixin.MessageProperty(
                            custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                                value="value"
                            ),
                            image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                                buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                                    text="text",
                                    value="value"
                                )],
                                image_url="imageUrl",
                                subtitle="subtitle",
                                title="title"
                            ),
                            plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                                value="value"
                            ),
                            ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                                value="value"
                            )
                        ),
                        variations=[lex_mixins.CfnBotPropsMixin.MessageProperty(
                            custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                                value="value"
                            ),
                            image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                                buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                                    text="text",
                                    value="value"
                                )],
                                image_url="imageUrl",
                                subtitle="subtitle",
                                title="title"
                            ),
                            plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                                value="value"
                            ),
                            ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                                value="value"
                            )
                        )]
                    )],
                    message_selection_strategy="messageSelectionStrategy",
                    prompt_attempts_specification={
                        "prompt_attempts_specification_key": lex_mixins.CfnBotPropsMixin.PromptAttemptSpecificationProperty(
                            allowed_input_types=lex_mixins.CfnBotPropsMixin.AllowedInputTypesProperty(
                                allow_audio_input=False,
                                allow_dtmf_input=False
                            ),
                            allow_interrupt=False,
                            audio_and_dtmf_input_specification=lex_mixins.CfnBotPropsMixin.AudioAndDTMFInputSpecificationProperty(
                                audio_specification=lex_mixins.CfnBotPropsMixin.AudioSpecificationProperty(
                                    end_timeout_ms=123,
                                    max_length_ms=123
                                ),
                                dtmf_specification=lex_mixins.CfnBotPropsMixin.DTMFSpecificationProperty(
                                    deletion_character="deletionCharacter",
                                    end_character="endCharacter",
                                    end_timeout_ms=123,
                                    max_length=123
                                ),
                                start_timeout_ms=123
                            ),
                            text_input_specification=lex_mixins.CfnBotPropsMixin.TextInputSpecificationProperty(
                                start_timeout_ms=123
                            )
                        )
                    }
                ),
                sample_utterances=[lex_mixins.CfnBotPropsMixin.SampleUtteranceProperty(
                    utterance="utterance"
                )],
                wait_and_continue_specification=lex_mixins.CfnBotPropsMixin.WaitAndContinueSpecificationProperty(
                    continue_response=lex_mixins.CfnBotPropsMixin.ResponseSpecificationProperty(
                        allow_interrupt=False,
                        message_groups_list=[lex_mixins.CfnBotPropsMixin.MessageGroupProperty(
                            message=lex_mixins.CfnBotPropsMixin.MessageProperty(
                                custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                                    value="value"
                                ),
                                image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                                    buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                                        text="text",
                                        value="value"
                                    )],
                                    image_url="imageUrl",
                                    subtitle="subtitle",
                                    title="title"
                                ),
                                plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                                    value="value"
                                ),
                                ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                                    value="value"
                                )
                            ),
                            variations=[lex_mixins.CfnBotPropsMixin.MessageProperty(
                                custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                                    value="value"
                                ),
                                image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                                    buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                                        text="text",
                                        value="value"
                                    )],
                                    image_url="imageUrl",
                                    subtitle="subtitle",
                                    title="title"
                                ),
                                plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                                    value="value"
                                ),
                                ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                                    value="value"
                                )
                            )]
                        )]
                    ),
                    is_active=False,
                    still_waiting_response=lex_mixins.CfnBotPropsMixin.StillWaitingResponseSpecificationProperty(
                        allow_interrupt=False,
                        frequency_in_seconds=123,
                        message_groups_list=[lex_mixins.CfnBotPropsMixin.MessageGroupProperty(
                            message=lex_mixins.CfnBotPropsMixin.MessageProperty(
                                custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                                    value="value"
                                ),
                                image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                                    buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                                        text="text",
                                        value="value"
                                    )],
                                    image_url="imageUrl",
                                    subtitle="subtitle",
                                    title="title"
                                ),
                                plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                                    value="value"
                                ),
                                ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                                    value="value"
                                )
                            ),
                            variations=[lex_mixins.CfnBotPropsMixin.MessageProperty(
                                custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                                    value="value"
                                ),
                                image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                                    buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                                        text="text",
                                        value="value"
                                    )],
                                    image_url="imageUrl",
                                    subtitle="subtitle",
                                    title="title"
                                ),
                                plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                                    value="value"
                                ),
                                ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                                    value="value"
                                )
                            )]
                        )],
                        timeout_in_seconds=123
                    ),
                    waiting_response=lex_mixins.CfnBotPropsMixin.ResponseSpecificationProperty(
                        allow_interrupt=False,
                        message_groups_list=[lex_mixins.CfnBotPropsMixin.MessageGroupProperty(
                            message=lex_mixins.CfnBotPropsMixin.MessageProperty(
                                custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                                    value="value"
                                ),
                                image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                                    buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                                        text="text",
                                        value="value"
                                    )],
                                    image_url="imageUrl",
                                    subtitle="subtitle",
                                    title="title"
                                ),
                                plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                                    value="value"
                                ),
                                ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                                    value="value"
                                )
                            ),
                            variations=[lex_mixins.CfnBotPropsMixin.MessageProperty(
                                custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                                    value="value"
                                ),
                                image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                                    buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                                        text="text",
                                        value="value"
                                    )],
                                    image_url="imageUrl",
                                    subtitle="subtitle",
                                    title="title"
                                ),
                                plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                                    value="value"
                                ),
                                ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                                    value="value"
                                )
                            )]
                        )]
                    )
                )
            )
        )
    }
)

Attributes

expression

The expression text for defining the constituent sub slots in the composite slot using logical AND and OR operators.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-subslotsetting.html#cfn-lex-bot-subslotsetting-expression

slot_specifications

Specifications for the constituent sub slots of a composite slot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-subslotsetting.html#cfn-lex-bot-subslotsetting-slotspecifications

SubSlotTypeCompositionProperty

class CfnBotPropsMixin.SubSlotTypeCompositionProperty(*, name=None, slot_type_id=None)

Bases: object

Subslot type composition.

Parameters:

  • name (Optional[str]) – Name of a constituent sub slot inside a composite slot.

  • slot_type_id (Optional[str]) – The unique identifier assigned to a slot type. This refers to either a built-in slot type or the unique slotTypeId of a custom slot type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-subslottypecomposition.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.mixins_preview.aws_lex import mixins as lex_mixins

sub_slot_type_composition_property = lex_mixins.CfnBotPropsMixin.SubSlotTypeCompositionProperty(
    name="name",
    slot_type_id="slotTypeId"
)

Attributes

name

Name of a constituent sub slot inside a composite slot.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-subslottypecomposition.html#cfn-lex-bot-subslottypecomposition-name

slot_type_id

The unique identifier assigned to a slot type.

This refers to either a built-in slot type or the unique slotTypeId of a custom slot type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-subslottypecomposition.html#cfn-lex-bot-subslottypecomposition-slottypeid

SubSlotValueElicitationSettingProperty

class CfnBotPropsMixin.SubSlotValueElicitationSettingProperty(*, default_value_specification=None, prompt_specification=None, sample_utterances=None, wait_and_continue_specification=None)

Bases: object

Subslot elicitation settings.

DefaultValueSpecification is a list of default values for a constituent sub slot in a composite slot. Default values are used when Amazon Lex hasn’t determined a value for a slot. You can specify default values from context variables, session attributes, and defined values. This is similar to DefaultValueSpecification for slots.

PromptSpecification is the prompt that Amazon Lex uses to elicit the sub slot value from the user. This is similar to PromptSpecification for slots.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-subslotvalueelicitationsetting.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.mixins_preview.aws_lex import mixins as lex_mixins

sub_slot_value_elicitation_setting_property = lex_mixins.CfnBotPropsMixin.SubSlotValueElicitationSettingProperty(
    default_value_specification=lex_mixins.CfnBotPropsMixin.SlotDefaultValueSpecificationProperty(
        default_value_list=[lex_mixins.CfnBotPropsMixin.SlotDefaultValueProperty(
            default_value="defaultValue"
        )]
    ),
    prompt_specification=lex_mixins.CfnBotPropsMixin.PromptSpecificationProperty(
        allow_interrupt=False,
        max_retries=123,
        message_groups_list=[lex_mixins.CfnBotPropsMixin.MessageGroupProperty(
            message=lex_mixins.CfnBotPropsMixin.MessageProperty(
                custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                    value="value"
                ),
                image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                    buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                        text="text",
                        value="value"
                    )],
                    image_url="imageUrl",
                    subtitle="subtitle",
                    title="title"
                ),
                plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                    value="value"
                ),
                ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                    value="value"
                )
            ),
            variations=[lex_mixins.CfnBotPropsMixin.MessageProperty(
                custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                    value="value"
                ),
                image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                    buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                        text="text",
                        value="value"
                    )],
                    image_url="imageUrl",
                    subtitle="subtitle",
                    title="title"
                ),
                plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                    value="value"
                ),
                ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                    value="value"
                )
            )]
        )],
        message_selection_strategy="messageSelectionStrategy",
        prompt_attempts_specification={
            "prompt_attempts_specification_key": lex_mixins.CfnBotPropsMixin.PromptAttemptSpecificationProperty(
                allowed_input_types=lex_mixins.CfnBotPropsMixin.AllowedInputTypesProperty(
                    allow_audio_input=False,
                    allow_dtmf_input=False
                ),
                allow_interrupt=False,
                audio_and_dtmf_input_specification=lex_mixins.CfnBotPropsMixin.AudioAndDTMFInputSpecificationProperty(
                    audio_specification=lex_mixins.CfnBotPropsMixin.AudioSpecificationProperty(
                        end_timeout_ms=123,
                        max_length_ms=123
                    ),
                    dtmf_specification=lex_mixins.CfnBotPropsMixin.DTMFSpecificationProperty(
                        deletion_character="deletionCharacter",
                        end_character="endCharacter",
                        end_timeout_ms=123,
                        max_length=123
                    ),
                    start_timeout_ms=123
                ),
                text_input_specification=lex_mixins.CfnBotPropsMixin.TextInputSpecificationProperty(
                    start_timeout_ms=123
                )
            )
        }
    ),
    sample_utterances=[lex_mixins.CfnBotPropsMixin.SampleUtteranceProperty(
        utterance="utterance"
    )],
    wait_and_continue_specification=lex_mixins.CfnBotPropsMixin.WaitAndContinueSpecificationProperty(
        continue_response=lex_mixins.CfnBotPropsMixin.ResponseSpecificationProperty(
            allow_interrupt=False,
            message_groups_list=[lex_mixins.CfnBotPropsMixin.MessageGroupProperty(
                message=lex_mixins.CfnBotPropsMixin.MessageProperty(
                    custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                        value="value"
                    ),
                    image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                        buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                            text="text",
                            value="value"
                        )],
                        image_url="imageUrl",
                        subtitle="subtitle",
                        title="title"
                    ),
                    plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                        value="value"
                    ),
                    ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                        value="value"
                    )
                ),
                variations=[lex_mixins.CfnBotPropsMixin.MessageProperty(
                    custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                        value="value"
                    ),
                    image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                        buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                            text="text",
                            value="value"
                        )],
                        image_url="imageUrl",
                        subtitle="subtitle",
                        title="title"
                    ),
                    plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                        value="value"
                    ),
                    ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                        value="value"
                    )
                )]
            )]
        ),
        is_active=False,
        still_waiting_response=lex_mixins.CfnBotPropsMixin.StillWaitingResponseSpecificationProperty(
            allow_interrupt=False,
            frequency_in_seconds=123,
            message_groups_list=[lex_mixins.CfnBotPropsMixin.MessageGroupProperty(
                message=lex_mixins.CfnBotPropsMixin.MessageProperty(
                    custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                        value="value"
                    ),
                    image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                        buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                            text="text",
                            value="value"
                        )],
                        image_url="imageUrl",
                        subtitle="subtitle",
                        title="title"
                    ),
                    plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                        value="value"
                    ),
                    ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                        value="value"
                    )
                ),
                variations=[lex_mixins.CfnBotPropsMixin.MessageProperty(
                    custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                        value="value"
                    ),
                    image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                        buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                            text="text",
                            value="value"
                        )],
                        image_url="imageUrl",
                        subtitle="subtitle",
                        title="title"
                    ),
                    plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                        value="value"
                    ),
                    ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                        value="value"
                    )
                )]
            )],
            timeout_in_seconds=123
        ),
        waiting_response=lex_mixins.CfnBotPropsMixin.ResponseSpecificationProperty(
            allow_interrupt=False,
            message_groups_list=[lex_mixins.CfnBotPropsMixin.MessageGroupProperty(
                message=lex_mixins.CfnBotPropsMixin.MessageProperty(
                    custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                        value="value"
                    ),
                    image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                        buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                            text="text",
                            value="value"
                        )],
                        image_url="imageUrl",
                        subtitle="subtitle",
                        title="title"
                    ),
                    plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                        value="value"
                    ),
                    ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                        value="value"
                    )
                ),
                variations=[lex_mixins.CfnBotPropsMixin.MessageProperty(
                    custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                        value="value"
                    ),
                    image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                        buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                            text="text",
                            value="value"
                        )],
                        image_url="imageUrl",
                        subtitle="subtitle",
                        title="title"
                    ),
                    plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                        value="value"
                    ),
                    ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                        value="value"
                    )
                )]
            )]
        )
    )
)

Attributes

default_value_specification

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-subslotvalueelicitationsetting.html#cfn-lex-bot-subslotvalueelicitationsetting-defaultvaluespecification

Type:

see

prompt_specification

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-subslotvalueelicitationsetting.html#cfn-lex-bot-subslotvalueelicitationsetting-promptspecification

Type:

see

sample_utterances

If you know a specific pattern that users might respond to an Amazon Lex request for a sub slot value, you can provide those utterances to improve accuracy.

This is optional. In most cases Amazon Lex is capable of understanding user utterances. This is similar to SampleUtterances for slots.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-subslotvalueelicitationsetting.html#cfn-lex-bot-subslotvalueelicitationsetting-sampleutterances

wait_and_continue_specification

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-subslotvalueelicitationsetting.html#cfn-lex-bot-subslotvalueelicitationsetting-waitandcontinuespecification

Type:

see

TestBotAliasSettingsProperty

class CfnBotPropsMixin.TestBotAliasSettingsProperty(*, bot_alias_locale_settings=None, conversation_log_settings=None, description=None, sentiment_analysis_settings=None)

Bases: object

Specifies configuration settings for the alias used to test the bot.

If the TestBotAliasSettings property is not specified, the settings are configured with default values.

Parameters:

  • bot_alias_locale_settings (Union[IResolvable, Sequence[Union[IResolvable, BotAliasLocaleSettingsItemProperty, Dict[str, Any]]], None]) – Specifies settings that are unique to a locale. For example, you can use a different Lambda function depending on the bot’s locale.

  • conversation_log_settings (Union[IResolvable, ConversationLogSettingsProperty, Dict[str, Any], None]) – Specifies settings for conversation logs that save audio, text, and metadata information for conversations with your users.

  • description (Optional[str]) – Specifies a description for the test bot alias.

  • sentiment_analysis_settings (Any) – Specifies whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-testbotaliassettings.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.mixins_preview.aws_lex import mixins as lex_mixins

# sentiment_analysis_settings: Any

test_bot_alias_settings_property = lex_mixins.CfnBotPropsMixin.TestBotAliasSettingsProperty(
    bot_alias_locale_settings=[lex_mixins.CfnBotPropsMixin.BotAliasLocaleSettingsItemProperty(
        bot_alias_locale_setting=lex_mixins.CfnBotPropsMixin.BotAliasLocaleSettingsProperty(
            code_hook_specification=lex_mixins.CfnBotPropsMixin.CodeHookSpecificationProperty(
                lambda_code_hook=lex_mixins.CfnBotPropsMixin.LambdaCodeHookProperty(
                    code_hook_interface_version="codeHookInterfaceVersion",
                    lambda_arn="lambdaArn"
                )
            ),
            enabled=False
        ),
        locale_id="localeId"
    )],
    conversation_log_settings=lex_mixins.CfnBotPropsMixin.ConversationLogSettingsProperty(
        audio_log_settings=[lex_mixins.CfnBotPropsMixin.AudioLogSettingProperty(
            destination=lex_mixins.CfnBotPropsMixin.AudioLogDestinationProperty(
                s3_bucket=lex_mixins.CfnBotPropsMixin.S3BucketLogDestinationProperty(
                    kms_key_arn="kmsKeyArn",
                    log_prefix="logPrefix",
                    s3_bucket_arn="s3BucketArn"
                )
            ),
            enabled=False
        )],
        text_log_settings=[lex_mixins.CfnBotPropsMixin.TextLogSettingProperty(
            destination=lex_mixins.CfnBotPropsMixin.TextLogDestinationProperty(
                cloud_watch=lex_mixins.CfnBotPropsMixin.CloudWatchLogGroupLogDestinationProperty(
                    cloud_watch_log_group_arn="cloudWatchLogGroupArn",
                    log_prefix="logPrefix"
                )
            ),
            enabled=False
        )]
    ),
    description="description",
    sentiment_analysis_settings=sentiment_analysis_settings
)

Attributes

bot_alias_locale_settings

Specifies settings that are unique to a locale.

For example, you can use a different Lambda function depending on the bot’s locale.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-testbotaliassettings.html#cfn-lex-bot-testbotaliassettings-botaliaslocalesettings

conversation_log_settings

Specifies settings for conversation logs that save audio, text, and metadata information for conversations with your users.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-testbotaliassettings.html#cfn-lex-bot-testbotaliassettings-conversationlogsettings

description

Specifies a description for the test bot alias.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-testbotaliassettings.html#cfn-lex-bot-testbotaliassettings-description

sentiment_analysis_settings

Specifies whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-testbotaliassettings.html#cfn-lex-bot-testbotaliassettings-sentimentanalysissettings

TextInputSpecificationProperty

class CfnBotPropsMixin.TextInputSpecificationProperty(*, start_timeout_ms=None)

Bases: object

Specifies the text input specifications.

Parameters:

start_timeout_ms (Union[int, float, None]) – Time for which a bot waits before re-prompting a customer for text input.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-textinputspecification.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.mixins_preview.aws_lex import mixins as lex_mixins

text_input_specification_property = lex_mixins.CfnBotPropsMixin.TextInputSpecificationProperty(
    start_timeout_ms=123
)

Attributes

start_timeout_ms

Time for which a bot waits before re-prompting a customer for text input.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-textinputspecification.html#cfn-lex-bot-textinputspecification-starttimeoutms

TextLogDestinationProperty

class CfnBotPropsMixin.TextLogDestinationProperty(*, cloud_watch=None)

Bases: object

Defines the Amazon CloudWatch Logs destination log group for conversation text logs.

Parameters:

cloud_watch (Union[IResolvable, CloudWatchLogGroupLogDestinationProperty, Dict[str, Any], None]) – Defines the Amazon CloudWatch Logs log group where text and metadata logs are delivered.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-textlogdestination.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.mixins_preview.aws_lex import mixins as lex_mixins

text_log_destination_property = lex_mixins.CfnBotPropsMixin.TextLogDestinationProperty(
    cloud_watch=lex_mixins.CfnBotPropsMixin.CloudWatchLogGroupLogDestinationProperty(
        cloud_watch_log_group_arn="cloudWatchLogGroupArn",
        log_prefix="logPrefix"
    )
)

Attributes

cloud_watch

Defines the Amazon CloudWatch Logs log group where text and metadata logs are delivered.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-textlogdestination.html#cfn-lex-bot-textlogdestination-cloudwatch

TextLogSettingProperty

class CfnBotPropsMixin.TextLogSettingProperty(*, destination=None, enabled=None)

Bases: object

Defines settings to enable text conversation logs.

Parameters:

  • destination (Union[IResolvable, TextLogDestinationProperty, Dict[str, Any], None]) – Specifies the Amazon CloudWatch Logs destination log group for conversation text logs.

  • enabled (Union[bool, IResolvable, None]) – Determines whether conversation logs should be stored for an alias.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-textlogsetting.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.mixins_preview.aws_lex import mixins as lex_mixins

text_log_setting_property = lex_mixins.CfnBotPropsMixin.TextLogSettingProperty(
    destination=lex_mixins.CfnBotPropsMixin.TextLogDestinationProperty(
        cloud_watch=lex_mixins.CfnBotPropsMixin.CloudWatchLogGroupLogDestinationProperty(
            cloud_watch_log_group_arn="cloudWatchLogGroupArn",
            log_prefix="logPrefix"
        )
    ),
    enabled=False
)

Attributes

destination

Specifies the Amazon CloudWatch Logs destination log group for conversation text logs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-textlogsetting.html#cfn-lex-bot-textlogsetting-destination

enabled

Determines whether conversation logs should be stored for an alias.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-textlogsetting.html#cfn-lex-bot-textlogsetting-enabled

VoiceSettingsProperty

class CfnBotPropsMixin.VoiceSettingsProperty(*, engine=None, voice_id=None)

Bases: object

Defines settings for using an Amazon Polly voice to communicate with a user.

Valid values include:

  • standard

  • neural

  • long-form

  • generative

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-voicesettings.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.mixins_preview.aws_lex import mixins as lex_mixins

voice_settings_property = lex_mixins.CfnBotPropsMixin.VoiceSettingsProperty(
    engine="engine",
    voice_id="voiceId"
)

Attributes

engine

Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user.

For more information, see the `engine parameter of the SynthesizeSpeech operation <https://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html#polly-SynthesizeSpeech-request-Engine>`_ in the Amazon Polly developer guide .

If you do not specify a value, the default is standard .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-voicesettings.html#cfn-lex-bot-voicesettings-engine

voice_id

The identifier of the Amazon Polly voice to use.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-voicesettings.html#cfn-lex-bot-voicesettings-voiceid

WaitAndContinueSpecificationProperty

class CfnBotPropsMixin.WaitAndContinueSpecificationProperty(*, continue_response=None, is_active=None, still_waiting_response=None, waiting_response=None)

Bases: object

Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.

Parameters:

  • continue_response (Union[IResolvable, ResponseSpecificationProperty, Dict[str, Any], None]) – The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.

  • is_active (Union[bool, IResolvable, None]) – Specifies whether the bot will wait for a user to respond. When this field is false, wait and continue responses for a slot aren’t used. If the IsActive field isn’t specified, the default is true.

  • still_waiting_response (Union[IResolvable, StillWaitingResponseSpecificationProperty, Dict[str, Any], None]) – A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.

  • waiting_response (Union[IResolvable, ResponseSpecificationProperty, Dict[str, Any], None]) – The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-waitandcontinuespecification.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.mixins_preview.aws_lex import mixins as lex_mixins

wait_and_continue_specification_property = lex_mixins.CfnBotPropsMixin.WaitAndContinueSpecificationProperty(
    continue_response=lex_mixins.CfnBotPropsMixin.ResponseSpecificationProperty(
        allow_interrupt=False,
        message_groups_list=[lex_mixins.CfnBotPropsMixin.MessageGroupProperty(
            message=lex_mixins.CfnBotPropsMixin.MessageProperty(
                custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                    value="value"
                ),
                image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                    buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                        text="text",
                        value="value"
                    )],
                    image_url="imageUrl",
                    subtitle="subtitle",
                    title="title"
                ),
                plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                    value="value"
                ),
                ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                    value="value"
                )
            ),
            variations=[lex_mixins.CfnBotPropsMixin.MessageProperty(
                custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                    value="value"
                ),
                image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                    buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                        text="text",
                        value="value"
                    )],
                    image_url="imageUrl",
                    subtitle="subtitle",
                    title="title"
                ),
                plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                    value="value"
                ),
                ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                    value="value"
                )
            )]
        )]
    ),
    is_active=False,
    still_waiting_response=lex_mixins.CfnBotPropsMixin.StillWaitingResponseSpecificationProperty(
        allow_interrupt=False,
        frequency_in_seconds=123,
        message_groups_list=[lex_mixins.CfnBotPropsMixin.MessageGroupProperty(
            message=lex_mixins.CfnBotPropsMixin.MessageProperty(
                custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                    value="value"
                ),
                image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                    buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                        text="text",
                        value="value"
                    )],
                    image_url="imageUrl",
                    subtitle="subtitle",
                    title="title"
                ),
                plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                    value="value"
                ),
                ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                    value="value"
                )
            ),
            variations=[lex_mixins.CfnBotPropsMixin.MessageProperty(
                custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                    value="value"
                ),
                image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                    buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                        text="text",
                        value="value"
                    )],
                    image_url="imageUrl",
                    subtitle="subtitle",
                    title="title"
                ),
                plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                    value="value"
                ),
                ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                    value="value"
                )
            )]
        )],
        timeout_in_seconds=123
    ),
    waiting_response=lex_mixins.CfnBotPropsMixin.ResponseSpecificationProperty(
        allow_interrupt=False,
        message_groups_list=[lex_mixins.CfnBotPropsMixin.MessageGroupProperty(
            message=lex_mixins.CfnBotPropsMixin.MessageProperty(
                custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                    value="value"
                ),
                image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                    buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                        text="text",
                        value="value"
                    )],
                    image_url="imageUrl",
                    subtitle="subtitle",
                    title="title"
                ),
                plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                    value="value"
                ),
                ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                    value="value"
                )
            ),
            variations=[lex_mixins.CfnBotPropsMixin.MessageProperty(
                custom_payload=lex_mixins.CfnBotPropsMixin.CustomPayloadProperty(
                    value="value"
                ),
                image_response_card=lex_mixins.CfnBotPropsMixin.ImageResponseCardProperty(
                    buttons=[lex_mixins.CfnBotPropsMixin.ButtonProperty(
                        text="text",
                        value="value"
                    )],
                    image_url="imageUrl",
                    subtitle="subtitle",
                    title="title"
                ),
                plain_text_message=lex_mixins.CfnBotPropsMixin.PlainTextMessageProperty(
                    value="value"
                ),
                ssml_message=lex_mixins.CfnBotPropsMixin.SSMLMessageProperty(
                    value="value"
                )
            )]
        )]
    )
)

Attributes

continue_response

The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-waitandcontinuespecification.html#cfn-lex-bot-waitandcontinuespecification-continueresponse

is_active

Specifies whether the bot will wait for a user to respond.

When this field is false, wait and continue responses for a slot aren’t used. If the IsActive field isn’t specified, the default is true.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-waitandcontinuespecification.html#cfn-lex-bot-waitandcontinuespecification-isactive

still_waiting_response

A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-waitandcontinuespecification.html#cfn-lex-bot-waitandcontinuespecification-stillwaitingresponse

waiting_response

The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-waitandcontinuespecification.html#cfn-lex-bot-waitandcontinuespecification-waitingresponse