Skip to content

EmailChannelRequest

Used by
Source code in docs_src/capo_pinpoint/types/email_channel_request.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
class EmailChannelRequest(TypedDict, closed=True):
    configuration_set: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The <a href="https://docs.aws.amazon.com/ses/latest/APIReference/API_ConfigurationSet.html">Amazon SES configuration set</a> that you want to apply to messages that you send through the channel.</p>"""
    enabled: NotRequired["capo_pinpoint.types.__boolean.__boolean"]
    """<p>Specifies whether to enable the email channel for the application.</p>"""
    from_address: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The verified email address that you want to send email from when you send email through the channel.</p>"""
    identity: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you want to use when you send email through the channel.</p>"""
    role_arn: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The ARN of the AWS Identity and Access Management (IAM) role that you want Amazon Pinpoint to use when it submits email-related event data for the channel.</p>"""
    orchestration_sending_role_arn: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The ARN of an IAM role for Amazon Pinpoint to use to send email from your campaigns or journeys through Amazon SES.</p>"""

configuration_set instance-attribute 

configuration_set: NotRequired[__string]

The Amazon SES configuration set that you want to apply to messages that you send through the channel.

enabled instance-attribute 

enabled: NotRequired[__boolean]

Specifies whether to enable the email channel for the application.

from_address instance-attribute 

from_address: NotRequired[__string]

The verified email address that you want to send email from when you send email through the channel.

identity instance-attribute 

identity: NotRequired[__string]

The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you want to use when you send email through the channel.

orchestration_sending_role_arn instance-attribute 

orchestration_sending_role_arn: NotRequired[__string]

The ARN of an IAM role for Amazon Pinpoint to use to send email from your campaigns or journeys through Amazon SES.

role_arn instance-attribute 

role_arn: NotRequired[__string]

The ARN of the AWS Identity and Access Management (IAM) role that you want Amazon Pinpoint to use when it submits email-related event data for the channel.