CfnMessageTemplatePropsMixin

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

Bases: Mixin

Creates an Amazon Q in Connect message template.

The name of the message template has to be unique for each knowledge base. The channel subtype of the message template is immutable and cannot be modified after creation. After the message template is created, you can use the $LATEST qualifier to reference the created message template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-messagetemplate.html

CloudformationResource:

AWS::Wisdom::MessageTemplate

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_message_template_props_mixin = wisdom_mixins.CfnMessageTemplatePropsMixin(wisdom_mixins.CfnMessageTemplateMixinProps(
    channel_subtype="channelSubtype",
    content=wisdom_mixins.CfnMessageTemplatePropsMixin.ContentProperty(
        email_message_template_content=wisdom_mixins.CfnMessageTemplatePropsMixin.EmailMessageTemplateContentProperty(
            body=wisdom_mixins.CfnMessageTemplatePropsMixin.EmailMessageTemplateContentBodyProperty(
                html=wisdom_mixins.CfnMessageTemplatePropsMixin.MessageTemplateBodyContentProviderProperty(
                    content="content"
                ),
                plain_text=wisdom_mixins.CfnMessageTemplatePropsMixin.MessageTemplateBodyContentProviderProperty(
                    content="content"
                )
            ),
            headers=[wisdom_mixins.CfnMessageTemplatePropsMixin.EmailMessageTemplateHeaderProperty(
                name="name",
                value="value"
            )],
            subject="subject"
        ),
        sms_message_template_content=wisdom_mixins.CfnMessageTemplatePropsMixin.SmsMessageTemplateContentProperty(
            body=wisdom_mixins.CfnMessageTemplatePropsMixin.SmsMessageTemplateContentBodyProperty(
                plain_text=wisdom_mixins.CfnMessageTemplatePropsMixin.MessageTemplateBodyContentProviderProperty(
                    content="content"
                )
            )
        )
    ),
    default_attributes=wisdom_mixins.CfnMessageTemplatePropsMixin.MessageTemplateAttributesProperty(
        agent_attributes=wisdom_mixins.CfnMessageTemplatePropsMixin.AgentAttributesProperty(
            first_name="firstName",
            last_name="lastName"
        ),
        custom_attributes={
            "custom_attributes_key": "customAttributes"
        },
        customer_profile_attributes=wisdom_mixins.CfnMessageTemplatePropsMixin.CustomerProfileAttributesProperty(
            account_number="accountNumber",
            additional_information="additionalInformation",
            address1="address1",
            address2="address2",
            address3="address3",
            address4="address4",
            billing_address1="billingAddress1",
            billing_address2="billingAddress2",
            billing_address3="billingAddress3",
            billing_address4="billingAddress4",
            billing_city="billingCity",
            billing_country="billingCountry",
            billing_county="billingCounty",
            billing_postal_code="billingPostalCode",
            billing_province="billingProvince",
            billing_state="billingState",
            birth_date="birthDate",
            business_email_address="businessEmailAddress",
            business_name="businessName",
            business_phone_number="businessPhoneNumber",
            city="city",
            country="country",
            county="county",
            custom={
                "custom_key": "custom"
            },
            email_address="emailAddress",
            first_name="firstName",
            gender="gender",
            home_phone_number="homePhoneNumber",
            last_name="lastName",
            mailing_address1="mailingAddress1",
            mailing_address2="mailingAddress2",
            mailing_address3="mailingAddress3",
            mailing_address4="mailingAddress4",
            mailing_city="mailingCity",
            mailing_country="mailingCountry",
            mailing_county="mailingCounty",
            mailing_postal_code="mailingPostalCode",
            mailing_province="mailingProvince",
            mailing_state="mailingState",
            middle_name="middleName",
            mobile_phone_number="mobilePhoneNumber",
            party_type="partyType",
            phone_number="phoneNumber",
            postal_code="postalCode",
            profile_arn="profileArn",
            profile_id="profileId",
            province="province",
            shipping_address1="shippingAddress1",
            shipping_address2="shippingAddress2",
            shipping_address3="shippingAddress3",
            shipping_address4="shippingAddress4",
            shipping_city="shippingCity",
            shipping_country="shippingCountry",
            shipping_county="shippingCounty",
            shipping_postal_code="shippingPostalCode",
            shipping_province="shippingProvince",
            shipping_state="shippingState",
            state="state"
        ),
        system_attributes=wisdom_mixins.CfnMessageTemplatePropsMixin.SystemAttributesProperty(
            customer_endpoint=wisdom_mixins.CfnMessageTemplatePropsMixin.SystemEndpointAttributesProperty(
                address="address"
            ),
            name="name",
            system_endpoint=wisdom_mixins.CfnMessageTemplatePropsMixin.SystemEndpointAttributesProperty(
                address="address"
            )
        )
    ),
    description="description",
    grouping_configuration=wisdom_mixins.CfnMessageTemplatePropsMixin.GroupingConfigurationProperty(
        criteria="criteria",
        values=["values"]
    ),
    knowledge_base_arn="knowledgeBaseArn",
    language="language",
    message_template_attachments=[wisdom_mixins.CfnMessageTemplatePropsMixin.MessageTemplateAttachmentProperty(
        attachment_id="attachmentId",
        attachment_name="attachmentName",
        s3_presigned_url="s3PresignedUrl"
    )],
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

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 = ['channelSubtype', 'content', 'defaultAttributes', 'description', 'groupingConfiguration', 'knowledgeBaseArn', 'language', 'messageTemplateAttachments', 'name', '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

AgentAttributesProperty

class CfnMessageTemplatePropsMixin.AgentAttributesProperty(*, first_name=None, last_name=None)

Bases: object

Information about an agent.

Parameters:

  • first_name (Optional[str]) – The agent’s first name as entered in their Amazon Connect user account.

  • last_name (Optional[str]) – The agent’s last name as entered in their Amazon Connect user account.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-agentattributes.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

agent_attributes_property = wisdom_mixins.CfnMessageTemplatePropsMixin.AgentAttributesProperty(
    first_name="firstName",
    last_name="lastName"
)

Attributes

first_name

The agent’s first name as entered in their Amazon Connect user account.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-agentattributes.html#cfn-wisdom-messagetemplate-agentattributes-firstname

last_name

The agent’s last name as entered in their Amazon Connect user account.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-agentattributes.html#cfn-wisdom-messagetemplate-agentattributes-lastname

ContentProperty

class CfnMessageTemplatePropsMixin.ContentProperty(*, email_message_template_content=None, sms_message_template_content=None)

Bases: object

The content of the message template.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-content.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

content_property = wisdom_mixins.CfnMessageTemplatePropsMixin.ContentProperty(
    email_message_template_content=wisdom_mixins.CfnMessageTemplatePropsMixin.EmailMessageTemplateContentProperty(
        body=wisdom_mixins.CfnMessageTemplatePropsMixin.EmailMessageTemplateContentBodyProperty(
            html=wisdom_mixins.CfnMessageTemplatePropsMixin.MessageTemplateBodyContentProviderProperty(
                content="content"
            ),
            plain_text=wisdom_mixins.CfnMessageTemplatePropsMixin.MessageTemplateBodyContentProviderProperty(
                content="content"
            )
        ),
        headers=[wisdom_mixins.CfnMessageTemplatePropsMixin.EmailMessageTemplateHeaderProperty(
            name="name",
            value="value"
        )],
        subject="subject"
    ),
    sms_message_template_content=wisdom_mixins.CfnMessageTemplatePropsMixin.SmsMessageTemplateContentProperty(
        body=wisdom_mixins.CfnMessageTemplatePropsMixin.SmsMessageTemplateContentBodyProperty(
            plain_text=wisdom_mixins.CfnMessageTemplatePropsMixin.MessageTemplateBodyContentProviderProperty(
                content="content"
            )
        )
    )
)

Attributes

email_message_template_content

The content of the message template that applies to the email channel subtype.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-content.html#cfn-wisdom-messagetemplate-content-emailmessagetemplatecontent

sms_message_template_content

The content of message template that applies to SMS channel subtype.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-content.html#cfn-wisdom-messagetemplate-content-smsmessagetemplatecontent

CustomerProfileAttributesProperty

class CfnMessageTemplatePropsMixin.CustomerProfileAttributesProperty(*, account_number=None, additional_information=None, address1=None, address2=None, address3=None, address4=None, billing_address1=None, billing_address2=None, billing_address3=None, billing_address4=None, billing_city=None, billing_country=None, billing_county=None, billing_postal_code=None, billing_province=None, billing_state=None, birth_date=None, business_email_address=None, business_name=None, business_phone_number=None, city=None, country=None, county=None, custom=None, email_address=None, first_name=None, gender=None, home_phone_number=None, last_name=None, mailing_address1=None, mailing_address2=None, mailing_address3=None, mailing_address4=None, mailing_city=None, mailing_country=None, mailing_county=None, mailing_postal_code=None, mailing_province=None, mailing_state=None, middle_name=None, mobile_phone_number=None, party_type=None, phone_number=None, postal_code=None, profile_arn=None, profile_id=None, province=None, shipping_address1=None, shipping_address2=None, shipping_address3=None, shipping_address4=None, shipping_city=None, shipping_country=None, shipping_county=None, shipping_postal_code=None, shipping_province=None, shipping_state=None, state=None)

Bases: object

The customer profile attributes that are used with the message template.

Parameters:

  • account_number (Optional[str]) – A unique account number that you have given to the customer.

  • additional_information (Optional[str]) – Any additional information relevant to the customer’s profile.

  • address1 (Optional[str]) – The first line of a customer address.

  • address2 (Optional[str]) – The second line of a customer address.

  • address3 (Optional[str]) – The third line of a customer address.

  • address4 (Optional[str]) – The fourth line of a customer address.

  • billing_address1 (Optional[str]) – The first line of a customer’s billing address.

  • billing_address2 (Optional[str]) – The second line of a customer’s billing address.

  • billing_address3 (Optional[str]) – The third line of a customer’s billing address.

  • billing_address4 (Optional[str]) – The fourth line of a customer’s billing address.

  • billing_city (Optional[str]) – The city of a customer’s billing address.

  • billing_country (Optional[str]) – The country of a customer’s billing address.

  • billing_county (Optional[str]) – The county of a customer’s billing address.

  • billing_postal_code (Optional[str]) – The postal code of a customer’s billing address.

  • billing_province (Optional[str]) – The province of a customer’s billing address.

  • billing_state (Optional[str]) – The state of a customer’s billing address.

  • birth_date (Optional[str]) – The customer’s birth date.

  • business_email_address (Optional[str]) – The customer’s business email address.

  • business_name (Optional[str]) – The name of the customer’s business.

  • business_phone_number (Optional[str]) – The customer’s business phone number.

  • city (Optional[str]) – The city in which a customer lives.

  • country (Optional[str]) – The country in which a customer lives.

  • county (Optional[str]) – The county in which a customer lives.

  • custom (Union[Mapping[str, str], IResolvable, None]) – The custom attributes in customer profile attributes.

  • email_address (Optional[str]) – The customer’s email address, which has not been specified as a personal or business address.

  • first_name (Optional[str]) – The customer’s first name.

  • gender (Optional[str]) – The customer’s gender.

  • home_phone_number (Optional[str]) – The customer’s mobile phone number.

  • last_name (Optional[str]) – The customer’s last name.

  • mailing_address1 (Optional[str]) – The first line of a customer’s mailing address.

  • mailing_address2 (Optional[str]) – The second line of a customer’s mailing address.

  • mailing_address3 (Optional[str]) – The third line of a customer’s mailing address.

  • mailing_address4 (Optional[str]) – The fourth line of a customer’s mailing address.

  • mailing_city (Optional[str]) – The city of a customer’s mailing address.

  • mailing_country (Optional[str]) – The country of a customer’s mailing address.

  • mailing_county (Optional[str]) – The county of a customer’s mailing address.

  • mailing_postal_code (Optional[str]) – The postal code of a customer’s mailing address.

  • mailing_province (Optional[str]) – The province of a customer’s mailing address.

  • mailing_state (Optional[str]) – The state of a customer’s mailing address.

  • middle_name (Optional[str]) – The customer’s middle name.

  • mobile_phone_number (Optional[str]) – The customer’s mobile phone number.

  • party_type (Optional[str]) – The customer’s party type.

  • phone_number (Optional[str]) – The customer’s phone number, which has not been specified as a mobile, home, or business number.

  • postal_code (Optional[str]) – The postal code of a customer address.

  • profile_arn (Optional[str]) – The ARN of a customer profile.

  • profile_id (Optional[str]) – The unique identifier of a customer profile.

  • province (Optional[str]) – The province in which a customer lives.

  • shipping_address1 (Optional[str]) – The first line of a customer’s shipping address.

  • shipping_address2 (Optional[str]) – The second line of a customer’s shipping address.

  • shipping_address3 (Optional[str]) – The third line of a customer’s shipping address.

  • shipping_address4 (Optional[str]) – The fourth line of a customer’s shipping address.

  • shipping_city (Optional[str]) – The city of a customer’s shipping address.

  • shipping_country (Optional[str]) – The country of a customer’s shipping address.

  • shipping_county (Optional[str]) – The county of a customer’s shipping address.

  • shipping_postal_code (Optional[str]) – The postal code of a customer’s shipping address.

  • shipping_province (Optional[str]) – The province of a customer’s shipping address.

  • shipping_state (Optional[str]) – The state of a customer’s shipping address.

  • state (Optional[str]) – The state in which a customer lives.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.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

customer_profile_attributes_property = wisdom_mixins.CfnMessageTemplatePropsMixin.CustomerProfileAttributesProperty(
    account_number="accountNumber",
    additional_information="additionalInformation",
    address1="address1",
    address2="address2",
    address3="address3",
    address4="address4",
    billing_address1="billingAddress1",
    billing_address2="billingAddress2",
    billing_address3="billingAddress3",
    billing_address4="billingAddress4",
    billing_city="billingCity",
    billing_country="billingCountry",
    billing_county="billingCounty",
    billing_postal_code="billingPostalCode",
    billing_province="billingProvince",
    billing_state="billingState",
    birth_date="birthDate",
    business_email_address="businessEmailAddress",
    business_name="businessName",
    business_phone_number="businessPhoneNumber",
    city="city",
    country="country",
    county="county",
    custom={
        "custom_key": "custom"
    },
    email_address="emailAddress",
    first_name="firstName",
    gender="gender",
    home_phone_number="homePhoneNumber",
    last_name="lastName",
    mailing_address1="mailingAddress1",
    mailing_address2="mailingAddress2",
    mailing_address3="mailingAddress3",
    mailing_address4="mailingAddress4",
    mailing_city="mailingCity",
    mailing_country="mailingCountry",
    mailing_county="mailingCounty",
    mailing_postal_code="mailingPostalCode",
    mailing_province="mailingProvince",
    mailing_state="mailingState",
    middle_name="middleName",
    mobile_phone_number="mobilePhoneNumber",
    party_type="partyType",
    phone_number="phoneNumber",
    postal_code="postalCode",
    profile_arn="profileArn",
    profile_id="profileId",
    province="province",
    shipping_address1="shippingAddress1",
    shipping_address2="shippingAddress2",
    shipping_address3="shippingAddress3",
    shipping_address4="shippingAddress4",
    shipping_city="shippingCity",
    shipping_country="shippingCountry",
    shipping_county="shippingCounty",
    shipping_postal_code="shippingPostalCode",
    shipping_province="shippingProvince",
    shipping_state="shippingState",
    state="state"
)

Attributes

account_number

A unique account number that you have given to the customer.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-accountnumber

additional_information

Any additional information relevant to the customer’s profile.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-additionalinformation

address1

The first line of a customer address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-address1

address2

The second line of a customer address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-address2

address3

The third line of a customer address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-address3

address4

The fourth line of a customer address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-address4

billing_address1

The first line of a customer’s billing address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-billingaddress1

billing_address2

The second line of a customer’s billing address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-billingaddress2

billing_address3

The third line of a customer’s billing address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-billingaddress3

billing_address4

The fourth line of a customer’s billing address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-billingaddress4

billing_city

The city of a customer’s billing address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-billingcity

billing_country

The country of a customer’s billing address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-billingcountry

billing_county

The county of a customer’s billing address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-billingcounty

billing_postal_code

The postal code of a customer’s billing address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-billingpostalcode

billing_province

The province of a customer’s billing address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-billingprovince

billing_state

The state of a customer’s billing address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-billingstate

birth_date

The customer’s birth date.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-birthdate

business_email_address

The customer’s business email address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-businessemailaddress

business_name

The name of the customer’s business.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-businessname

business_phone_number

The customer’s business phone number.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-businessphonenumber

city

The city in which a customer lives.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-city

country

The country in which a customer lives.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-country

county

The county in which a customer lives.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-county

custom

The custom attributes in customer profile attributes.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-custom

email_address

The customer’s email address, which has not been specified as a personal or business address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-emailaddress

first_name

The customer’s first name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-firstname

gender

The customer’s gender.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-gender

home_phone_number

The customer’s mobile phone number.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-homephonenumber

last_name

The customer’s last name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-lastname

mailing_address1

The first line of a customer’s mailing address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-mailingaddress1

mailing_address2

The second line of a customer’s mailing address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-mailingaddress2

mailing_address3

The third line of a customer’s mailing address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-mailingaddress3

mailing_address4

The fourth line of a customer’s mailing address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-mailingaddress4

mailing_city

The city of a customer’s mailing address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-mailingcity

mailing_country

The country of a customer’s mailing address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-mailingcountry

mailing_county

The county of a customer’s mailing address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-mailingcounty

mailing_postal_code

The postal code of a customer’s mailing address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-mailingpostalcode

mailing_province

The province of a customer’s mailing address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-mailingprovince

mailing_state

The state of a customer’s mailing address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-mailingstate

middle_name

The customer’s middle name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-middlename

mobile_phone_number

The customer’s mobile phone number.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-mobilephonenumber

party_type

The customer’s party type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-partytype

phone_number

The customer’s phone number, which has not been specified as a mobile, home, or business number.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-phonenumber

postal_code

The postal code of a customer address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-postalcode

profile_arn

The ARN of a customer profile.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-profilearn

profile_id

The unique identifier of a customer profile.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-profileid

province

The province in which a customer lives.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-province

shipping_address1

The first line of a customer’s shipping address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-shippingaddress1

shipping_address2

The second line of a customer’s shipping address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-shippingaddress2

shipping_address3

The third line of a customer’s shipping address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-shippingaddress3

shipping_address4

The fourth line of a customer’s shipping address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-shippingaddress4

shipping_city

The city of a customer’s shipping address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-shippingcity

shipping_country

The country of a customer’s shipping address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-shippingcountry

shipping_county

The county of a customer’s shipping address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-shippingcounty

shipping_postal_code

The postal code of a customer’s shipping address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-shippingpostalcode

shipping_province

The province of a customer’s shipping address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-shippingprovince

shipping_state

The state of a customer’s shipping address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-shippingstate

state

The state in which a customer lives.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-customerprofileattributes.html#cfn-wisdom-messagetemplate-customerprofileattributes-state

EmailMessageTemplateContentBodyProperty

class CfnMessageTemplatePropsMixin.EmailMessageTemplateContentBodyProperty(*, html=None, plain_text=None)

Bases: object

The body to use in email messages.

Parameters:

  • html (Union[IResolvable, MessageTemplateBodyContentProviderProperty, Dict[str, Any], None]) – The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.

  • plain_text (Union[IResolvable, MessageTemplateBodyContentProviderProperty, Dict[str, Any], None]) – The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don’t render HTML content and clients that are connected to high-latency networks, such as mobile devices.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-emailmessagetemplatecontentbody.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

email_message_template_content_body_property = wisdom_mixins.CfnMessageTemplatePropsMixin.EmailMessageTemplateContentBodyProperty(
    html=wisdom_mixins.CfnMessageTemplatePropsMixin.MessageTemplateBodyContentProviderProperty(
        content="content"
    ),
    plain_text=wisdom_mixins.CfnMessageTemplatePropsMixin.MessageTemplateBodyContentProviderProperty(
        content="content"
    )
)

Attributes

html

The message body, in HTML format, to use in email messages that are based on the message template.

We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-emailmessagetemplatecontentbody.html#cfn-wisdom-messagetemplate-emailmessagetemplatecontentbody-html

plain_text

The message body, in plain text format, to use in email messages that are based on the message template.

We recommend using plain text format for email clients that don’t render HTML content and clients that are connected to high-latency networks, such as mobile devices.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-emailmessagetemplatecontentbody.html#cfn-wisdom-messagetemplate-emailmessagetemplatecontentbody-plaintext

EmailMessageTemplateContentProperty

class CfnMessageTemplatePropsMixin.EmailMessageTemplateContentProperty(*, body=None, headers=None, subject=None)

Bases: object

The content of the message template that applies to the email channel subtype.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-emailmessagetemplatecontent.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

email_message_template_content_property = wisdom_mixins.CfnMessageTemplatePropsMixin.EmailMessageTemplateContentProperty(
    body=wisdom_mixins.CfnMessageTemplatePropsMixin.EmailMessageTemplateContentBodyProperty(
        html=wisdom_mixins.CfnMessageTemplatePropsMixin.MessageTemplateBodyContentProviderProperty(
            content="content"
        ),
        plain_text=wisdom_mixins.CfnMessageTemplatePropsMixin.MessageTemplateBodyContentProviderProperty(
            content="content"
        )
    ),
    headers=[wisdom_mixins.CfnMessageTemplatePropsMixin.EmailMessageTemplateHeaderProperty(
        name="name",
        value="value"
    )],
    subject="subject"
)

Attributes

body

The body to use in email messages.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-emailmessagetemplatecontent.html#cfn-wisdom-messagetemplate-emailmessagetemplatecontent-body

headers

The email headers to include in email messages.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-emailmessagetemplatecontent.html#cfn-wisdom-messagetemplate-emailmessagetemplatecontent-headers

subject

The subject line, or title, to use in email messages.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-emailmessagetemplatecontent.html#cfn-wisdom-messagetemplate-emailmessagetemplatecontent-subject

EmailMessageTemplateHeaderProperty

class CfnMessageTemplatePropsMixin.EmailMessageTemplateHeaderProperty(*, name=None, value=None)

Bases: object

The email headers to include in email messages.

Parameters:

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

  • value (Optional[str]) – The value of the email header.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-emailmessagetemplateheader.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

email_message_template_header_property = wisdom_mixins.CfnMessageTemplatePropsMixin.EmailMessageTemplateHeaderProperty(
    name="name",
    value="value"
)

Attributes

name

The name of the email header.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-emailmessagetemplateheader.html#cfn-wisdom-messagetemplate-emailmessagetemplateheader-name

value

The value of the email header.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-emailmessagetemplateheader.html#cfn-wisdom-messagetemplate-emailmessagetemplateheader-value

GroupingConfigurationProperty

class CfnMessageTemplatePropsMixin.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-messagetemplate-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.CfnMessageTemplatePropsMixin.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.

See:

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

values

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

See:

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

MessageTemplateAttachmentProperty

class CfnMessageTemplatePropsMixin.MessageTemplateAttachmentProperty(*, attachment_id=None, attachment_name=None, s3_presigned_url=None)

Bases: object

Information about the message template attachment.

Parameters:

  • attachment_id (Optional[str]) – The identifier of the attachment file.

  • attachment_name (Optional[str]) – The name of the attachment file being uploaded. The name should include the file extension.

  • s3_presigned_url (Optional[str]) – The S3 Presigned URL for the attachment file. When generating the PreSignedUrl, please ensure that the expires-in time is set to 30 minutes. The URL can be generated through the AWS Console or through the AWS CLI. For more information, see Sharing objects with presigned URLs .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-messagetemplateattachment.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

message_template_attachment_property = wisdom_mixins.CfnMessageTemplatePropsMixin.MessageTemplateAttachmentProperty(
    attachment_id="attachmentId",
    attachment_name="attachmentName",
    s3_presigned_url="s3PresignedUrl"
)

Attributes

attachment_id

The identifier of the attachment file.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-messagetemplateattachment.html#cfn-wisdom-messagetemplate-messagetemplateattachment-attachmentid

attachment_name

The name of the attachment file being uploaded.

The name should include the file extension.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-messagetemplateattachment.html#cfn-wisdom-messagetemplate-messagetemplateattachment-attachmentname

s3_presigned_url

The S3 Presigned URL for the attachment file.

When generating the PreSignedUrl, please ensure that the expires-in time is set to 30 minutes. The URL can be generated through the AWS Console or through the AWS CLI. For more information, see Sharing objects with presigned URLs .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-messagetemplateattachment.html#cfn-wisdom-messagetemplate-messagetemplateattachment-s3presignedurl

MessageTemplateAttributesProperty

class CfnMessageTemplatePropsMixin.MessageTemplateAttributesProperty(*, agent_attributes=None, custom_attributes=None, customer_profile_attributes=None, system_attributes=None)

Bases: object

The attributes that are used with the message template.

Parameters:

  • agent_attributes (Union[IResolvable, AgentAttributesProperty, Dict[str, Any], None]) – The agent attributes that are used with the message template.

  • custom_attributes (Union[Mapping[str, str], IResolvable, None]) – The custom attributes that are used with the message template.

  • customer_profile_attributes (Union[IResolvable, CustomerProfileAttributesProperty, Dict[str, Any], None]) – The customer profile attributes that are used with the message template.

  • system_attributes (Union[IResolvable, SystemAttributesProperty, Dict[str, Any], None]) – The system attributes that are used with the message template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-messagetemplateattributes.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

message_template_attributes_property = wisdom_mixins.CfnMessageTemplatePropsMixin.MessageTemplateAttributesProperty(
    agent_attributes=wisdom_mixins.CfnMessageTemplatePropsMixin.AgentAttributesProperty(
        first_name="firstName",
        last_name="lastName"
    ),
    custom_attributes={
        "custom_attributes_key": "customAttributes"
    },
    customer_profile_attributes=wisdom_mixins.CfnMessageTemplatePropsMixin.CustomerProfileAttributesProperty(
        account_number="accountNumber",
        additional_information="additionalInformation",
        address1="address1",
        address2="address2",
        address3="address3",
        address4="address4",
        billing_address1="billingAddress1",
        billing_address2="billingAddress2",
        billing_address3="billingAddress3",
        billing_address4="billingAddress4",
        billing_city="billingCity",
        billing_country="billingCountry",
        billing_county="billingCounty",
        billing_postal_code="billingPostalCode",
        billing_province="billingProvince",
        billing_state="billingState",
        birth_date="birthDate",
        business_email_address="businessEmailAddress",
        business_name="businessName",
        business_phone_number="businessPhoneNumber",
        city="city",
        country="country",
        county="county",
        custom={
            "custom_key": "custom"
        },
        email_address="emailAddress",
        first_name="firstName",
        gender="gender",
        home_phone_number="homePhoneNumber",
        last_name="lastName",
        mailing_address1="mailingAddress1",
        mailing_address2="mailingAddress2",
        mailing_address3="mailingAddress3",
        mailing_address4="mailingAddress4",
        mailing_city="mailingCity",
        mailing_country="mailingCountry",
        mailing_county="mailingCounty",
        mailing_postal_code="mailingPostalCode",
        mailing_province="mailingProvince",
        mailing_state="mailingState",
        middle_name="middleName",
        mobile_phone_number="mobilePhoneNumber",
        party_type="partyType",
        phone_number="phoneNumber",
        postal_code="postalCode",
        profile_arn="profileArn",
        profile_id="profileId",
        province="province",
        shipping_address1="shippingAddress1",
        shipping_address2="shippingAddress2",
        shipping_address3="shippingAddress3",
        shipping_address4="shippingAddress4",
        shipping_city="shippingCity",
        shipping_country="shippingCountry",
        shipping_county="shippingCounty",
        shipping_postal_code="shippingPostalCode",
        shipping_province="shippingProvince",
        shipping_state="shippingState",
        state="state"
    ),
    system_attributes=wisdom_mixins.CfnMessageTemplatePropsMixin.SystemAttributesProperty(
        customer_endpoint=wisdom_mixins.CfnMessageTemplatePropsMixin.SystemEndpointAttributesProperty(
            address="address"
        ),
        name="name",
        system_endpoint=wisdom_mixins.CfnMessageTemplatePropsMixin.SystemEndpointAttributesProperty(
            address="address"
        )
    )
)

Attributes

agent_attributes

The agent attributes that are used with the message template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-messagetemplateattributes.html#cfn-wisdom-messagetemplate-messagetemplateattributes-agentattributes

custom_attributes

The custom attributes that are used with the message template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-messagetemplateattributes.html#cfn-wisdom-messagetemplate-messagetemplateattributes-customattributes

customer_profile_attributes

The customer profile attributes that are used with the message template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-messagetemplateattributes.html#cfn-wisdom-messagetemplate-messagetemplateattributes-customerprofileattributes

system_attributes

The system attributes that are used with the message template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-messagetemplateattributes.html#cfn-wisdom-messagetemplate-messagetemplateattributes-systemattributes

MessageTemplateBodyContentProviderProperty

class CfnMessageTemplatePropsMixin.MessageTemplateBodyContentProviderProperty(*, content=None)

Bases: object

The container of the message template body.

Parameters:

content (Optional[str]) – The content of the message template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-messagetemplatebodycontentprovider.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

message_template_body_content_provider_property = wisdom_mixins.CfnMessageTemplatePropsMixin.MessageTemplateBodyContentProviderProperty(
    content="content"
)

Attributes

content

The content of the message template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-messagetemplatebodycontentprovider.html#cfn-wisdom-messagetemplate-messagetemplatebodycontentprovider-content

SmsMessageTemplateContentBodyProperty

class CfnMessageTemplatePropsMixin.SmsMessageTemplateContentBodyProperty(*, plain_text=None)

Bases: object

The body to use in SMS messages.

Parameters:

plain_text (Union[IResolvable, MessageTemplateBodyContentProviderProperty, Dict[str, Any], None]) – The message body to use in SMS messages.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-smsmessagetemplatecontentbody.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

sms_message_template_content_body_property = wisdom_mixins.CfnMessageTemplatePropsMixin.SmsMessageTemplateContentBodyProperty(
    plain_text=wisdom_mixins.CfnMessageTemplatePropsMixin.MessageTemplateBodyContentProviderProperty(
        content="content"
    )
)

Attributes

plain_text

The message body to use in SMS messages.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-smsmessagetemplatecontentbody.html#cfn-wisdom-messagetemplate-smsmessagetemplatecontentbody-plaintext

SmsMessageTemplateContentProperty

class CfnMessageTemplatePropsMixin.SmsMessageTemplateContentProperty(*, body=None)

Bases: object

The content of the message template that applies to the SMS channel subtype.

Parameters:

body (Union[IResolvable, SmsMessageTemplateContentBodyProperty, Dict[str, Any], None]) – The body to use in SMS messages.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-smsmessagetemplatecontent.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

sms_message_template_content_property = wisdom_mixins.CfnMessageTemplatePropsMixin.SmsMessageTemplateContentProperty(
    body=wisdom_mixins.CfnMessageTemplatePropsMixin.SmsMessageTemplateContentBodyProperty(
        plain_text=wisdom_mixins.CfnMessageTemplatePropsMixin.MessageTemplateBodyContentProviderProperty(
            content="content"
        )
    )
)

Attributes

body

The body to use in SMS messages.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-smsmessagetemplatecontent.html#cfn-wisdom-messagetemplate-smsmessagetemplatecontent-body

SystemAttributesProperty

class CfnMessageTemplatePropsMixin.SystemAttributesProperty(*, customer_endpoint=None, name=None, system_endpoint=None)

Bases: object

The system attributes that are used with the message template.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-systemattributes.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

system_attributes_property = wisdom_mixins.CfnMessageTemplatePropsMixin.SystemAttributesProperty(
    customer_endpoint=wisdom_mixins.CfnMessageTemplatePropsMixin.SystemEndpointAttributesProperty(
        address="address"
    ),
    name="name",
    system_endpoint=wisdom_mixins.CfnMessageTemplatePropsMixin.SystemEndpointAttributesProperty(
        address="address"
    )
)

Attributes

customer_endpoint

The CustomerEndpoint attribute.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-systemattributes.html#cfn-wisdom-messagetemplate-systemattributes-customerendpoint

name

The name of the task.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-systemattributes.html#cfn-wisdom-messagetemplate-systemattributes-name

system_endpoint

The SystemEndpoint attribute.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-systemattributes.html#cfn-wisdom-messagetemplate-systemattributes-systemendpoint

SystemEndpointAttributesProperty

class CfnMessageTemplatePropsMixin.SystemEndpointAttributesProperty(*, address=None)

Bases: object

The system endpoint attributes that are used with the message template.

Parameters:

address (Optional[str]) – The customer’s phone number if used with customerEndpoint , or the number the customer dialed to call your contact center if used with systemEndpoint .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-systemendpointattributes.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

system_endpoint_attributes_property = wisdom_mixins.CfnMessageTemplatePropsMixin.SystemEndpointAttributesProperty(
    address="address"
)

Attributes

address

The customer’s phone number if used with customerEndpoint , or the number the customer dialed to call your contact center if used with systemEndpoint .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-messagetemplate-systemendpointattributes.html#cfn-wisdom-messagetemplate-systemendpointattributes-address