Class: Aws::Pinpoint::Types::EmailChannelRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Pinpoint::Types::EmailChannelRequest
- Defined in:
- gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb
Overview
When making an API call, you may pass EmailChannelRequest data as a hash:
{
configuration_set: "__string",
enabled: false,
from_address: "__string", # required
identity: "__string", # required
role_arn: "__string",
}
Specifies the status and settings of the email channel for an application.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#configuration_set ⇒ String
The [Amazon SES configuration set][1] that you want to apply to messages that you send through the channel.
-
#enabled ⇒ Boolean
Specifies whether to enable the email channel for the application.
-
#from_address ⇒ String
The verified email address that you want to send email from when you send email through the channel.
-
#identity ⇒ 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.
-
#role_arn ⇒ 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.
Instance Attribute Details
#configuration_set ⇒ String
The Amazon SES configuration set that you want to apply to messages that you send through the channel.
6590 6591 6592 6593 6594 6595 6596 6597 6598 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6590 class EmailChannelRequest < Struct.new( :configuration_set, :enabled, :from_address, :identity, :role_arn) SENSITIVE = [] include Aws::Structure end |
#enabled ⇒ Boolean
Specifies whether to enable the email channel for the application.
6590 6591 6592 6593 6594 6595 6596 6597 6598 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6590 class EmailChannelRequest < Struct.new( :configuration_set, :enabled, :from_address, :identity, :role_arn) SENSITIVE = [] include Aws::Structure end |
#from_address ⇒ String
The verified email address that you want to send email from when you send email through the channel.
6590 6591 6592 6593 6594 6595 6596 6597 6598 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6590 class EmailChannelRequest < Struct.new( :configuration_set, :enabled, :from_address, :identity, :role_arn) SENSITIVE = [] include Aws::Structure end |
#identity ⇒ 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.
6590 6591 6592 6593 6594 6595 6596 6597 6598 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6590 class EmailChannelRequest < Struct.new( :configuration_set, :enabled, :from_address, :identity, :role_arn) SENSITIVE = [] include Aws::Structure end |
#role_arn ⇒ 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.
6590 6591 6592 6593 6594 6595 6596 6597 6598 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6590 class EmailChannelRequest < Struct.new( :configuration_set, :enabled, :from_address, :identity, :role_arn) SENSITIVE = [] include Aws::Structure end |