Skip to content

EmailChannelResponse

Source code in docs_src/capo_pinpoint/types/email_channel_response.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
class EmailChannelResponse(TypedDict, closed=True):
    application_id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The unique identifier for the application that the email channel applies to.</p>"""
    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's applied to messages that are sent through the channel.</p>"""
    creation_date: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The date and time, in ISO 8601 format, when the email channel was enabled.</p>"""
    enabled: NotRequired["capo_pinpoint.types.__boolean.__boolean"]
    """<p>Specifies whether the email channel is enabled for the application.</p>"""
    from_address: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The verified email address that email is sent from when you send email through the channel.</p>"""
    has_credential: NotRequired["capo_pinpoint.types.__boolean.__boolean"]
    """<p>(Not used) This property is retained only for backward compatibility.</p>"""
    id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>(Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.</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's used when you send email through the channel.</p>"""
    is_archived: NotRequired["capo_pinpoint.types.__boolean.__boolean"]
    """<p>Specifies whether the email channel is archived.</p>"""
    last_modified_by: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The user who last modified the email channel.</p>"""
    last_modified_date: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The date and time, in ISO 8601 format, when the email channel was last modified.</p>"""
    messages_per_second: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>The maximum number of emails that can be sent through the channel each second.</p>"""
    platform: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.</p>"""
    role_arn: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit 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>"""
    version: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>The current version of the email channel.</p>"""

application_id instance-attribute 

application_id: NotRequired[__string]

The unique identifier for the application that the email channel applies to.

configuration_set instance-attribute 

configuration_set: NotRequired[__string]

The Amazon SES configuration set that's applied to messages that are sent through the channel.

creation_date instance-attribute 

creation_date: NotRequired[__string]

The date and time, in ISO 8601 format, when the email channel was enabled.

enabled instance-attribute 

enabled: NotRequired[__boolean]

Specifies whether the email channel is enabled for the application.

from_address instance-attribute 

from_address: NotRequired[__string]

The verified email address that email is sent from when you send email through the channel.

has_credential instance-attribute 

has_credential: NotRequired[__boolean]

(Not used) This property is retained only for backward compatibility.

id instance-attribute 

id: NotRequired[__string]

(Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.

identity instance-attribute 

identity: NotRequired[__string]

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

is_archived instance-attribute 

is_archived: NotRequired[__boolean]

Specifies whether the email channel is archived.

last_modified_by instance-attribute 

last_modified_by: NotRequired[__string]

The user who last modified the email channel.

last_modified_date instance-attribute 

last_modified_date: NotRequired[__string]

The date and time, in ISO 8601 format, when the email channel was last modified.

messages_per_second instance-attribute 

messages_per_second: NotRequired[__integer]

The maximum number of emails that can be sent through the channel each second.

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.

platform instance-attribute 

platform: NotRequired[__string]

The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.

role_arn instance-attribute 

role_arn: NotRequired[__string]

The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.

version instance-attribute 

version: NotRequired[__integer]

The current version of the email channel.