Amazon Pinpoint · Schema
EmailChannelRequest
Specifies the status and settings of the email channel for an application.
CampaignsCommunicationsEmailMarketingMessagingPush NotificationsSMSVoiceCustomer EngagementSegmentationJourneysAnalytics
Properties
| Name | Type | Description |
|---|---|---|
| ConfigurationSet | object | |
| Enabled | object | |
| FromAddress | object | |
| Identity | object | |
| RoleArn | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/json-schema/amazon-pinpoint-email-channel-request-schema.json",
"title": "EmailChannelRequest",
"description": "Specifies the status and settings of the email channel for an application.",
"type": "object",
"properties": {
"ConfigurationSet": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "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."
}
]
},
"Enabled": {
"allOf": [
{
"$ref": "#/components/schemas/__boolean"
},
{
"description": "Specifies whether to enable the email channel for the application."
}
]
},
"FromAddress": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": " <p>The verified email address that you want to send email from when you send email through the channel.</p>"
}
]
},
"Identity": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": " <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>"
}
]
},
"RoleArn": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": " <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>"
}
]
}
},
"required": [
"FromAddress",
"Identity"
]
}