CfnQuickResponsePropsMixin

class aws_cdk.mixins_preview.aws_wisdom.mixins.CfnQuickResponsePropsMixin(props, *, strategy=None)

Bases: Mixin

Creates an Amazon Q in Connect quick response.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-quickresponse.html
CloudformationResource:: AWS::Wisdom::QuickResponse
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

cfn_quick_response_props_mixin = wisdom_mixins.CfnQuickResponsePropsMixin(wisdom_mixins.CfnQuickResponseMixinProps(
    channels=["channels"],
    content=wisdom_mixins.CfnQuickResponsePropsMixin.QuickResponseContentProviderProperty(
        content="content"
    ),
    content_type="contentType",
    description="description",
    grouping_configuration=wisdom_mixins.CfnQuickResponsePropsMixin.GroupingConfigurationProperty(
        criteria="criteria",
        values=["values"]
    ),
    is_active=False,
    knowledge_base_arn="knowledgeBaseArn",
    language="language",
    name="name",
    shortcut_key="shortcutKey",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Wisdom::QuickResponse.

Parameters:

props (Union[CfnQuickResponseMixinProps, 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 = ['channels', 'content', 'contentType', 'description', 'groupingConfiguration', 'isActive', 'knowledgeBaseArn', 'language', 'name', 'shortcutKey', 'tags']

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

GroupingConfigurationProperty

class CfnQuickResponsePropsMixin.GroupingConfigurationProperty(*, criteria=None, values=None)

Bases: object

The configuration information of the grouping of Amazon Q in Connect users.

Parameters:

criteria (Optional[str]) – The criteria used for grouping Amazon Q in Connect users. The following is the list of supported criteria values. - RoutingProfileArn : Grouping the users by their Amazon Connect routing profile ARN . User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value.
values (Optional[Sequence[str]]) – The list of values that define different groups of Amazon Q in Connect users. - When setting criteria to RoutingProfileArn , you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-quickresponse-groupingconfiguration.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_wisdom import mixins as wisdom_mixins

grouping_configuration_property = wisdom_mixins.CfnQuickResponsePropsMixin.GroupingConfigurationProperty(
    criteria="criteria",
    values=["values"]
)

Attributes

criteria

The criteria used for grouping Amazon Q in Connect users.

The following is the list of supported criteria values.

RoutingProfileArn : Grouping the users by their Amazon Connect routing profile ARN . User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-quickresponse-groupingconfiguration.html#cfn-wisdom-quickresponse-groupingconfiguration-criteria

values

The list of values that define different groups of Amazon Q in Connect users.

When setting criteria to RoutingProfileArn , you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-quickresponse-groupingconfiguration.html#cfn-wisdom-quickresponse-groupingconfiguration-values

QuickResponseContentProviderProperty

class CfnQuickResponsePropsMixin.QuickResponseContentProviderProperty(*, content=None)

Bases: object

The container quick response content.

Parameters:: content (Optional[str]) – The content of the quick response.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-quickresponse-quickresponsecontentprovider.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_wisdom import mixins as wisdom_mixins

quick_response_content_provider_property = wisdom_mixins.CfnQuickResponsePropsMixin.QuickResponseContentProviderProperty(
    content="content"
)

Attributes

content

The content of the quick response.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-quickresponse-quickresponsecontentprovider.html#cfn-wisdom-quickresponse-quickresponsecontentprovider-content

QuickResponseContentsProperty

class CfnQuickResponsePropsMixin.QuickResponseContentsProperty(*, markdown=None, plain_text=None)

Bases: object

The content of the quick response stored in different media types.

Parameters:

markdown (Union[IResolvable, QuickResponseContentProviderProperty, Dict[str, Any], None]) – The quick response content in markdown format.
plain_text (Union[IResolvable, QuickResponseContentProviderProperty, Dict[str, Any], None]) – The quick response content in plaintext format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-quickresponse-quickresponsecontents.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_wisdom import mixins as wisdom_mixins

quick_response_contents_property = wisdom_mixins.CfnQuickResponsePropsMixin.QuickResponseContentsProperty(
    markdown=wisdom_mixins.CfnQuickResponsePropsMixin.QuickResponseContentProviderProperty(
        content="content"
    ),
    plain_text=wisdom_mixins.CfnQuickResponsePropsMixin.QuickResponseContentProviderProperty(
        content="content"
    )
)

Attributes

markdown

The quick response content in markdown format.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-quickresponse-quickresponsecontents.html#cfn-wisdom-quickresponse-quickresponsecontents-markdown

plain_text

The quick response content in plaintext format.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-quickresponse-quickresponsecontents.html#cfn-wisdom-quickresponse-quickresponsecontents-plaintext