Class: Aws::Pinpoint::Types::EmailChannelResponse
- Inherits:
-
Struct
- Object
- Struct
- Aws::Pinpoint::Types::EmailChannelResponse
- Defined in:
- gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb
Overview
Provides information about the status and settings of the email channel for an application.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#application_id ⇒ String
The unique identifier for the application that the email channel applies to.
-
#configuration_set ⇒ String
The [Amazon SES configuration set][1] that's applied to messages that are sent through the channel.
-
#creation_date ⇒ String
The date and time, in ISO 8601 format, when the email channel was enabled.
-
#enabled ⇒ Boolean
Specifies whether the email channel is enabled for the application.
-
#from_address ⇒ String
The verified email address that email is sent from when you send email through the channel.
-
#has_credential ⇒ Boolean
(Not used) This property is retained only for backward compatibility.
-
#id ⇒ String
(Deprecated) An identifier for the email channel.
-
#identity ⇒ 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 ⇒ Boolean
Specifies whether the email channel is archived.
-
#last_modified_by ⇒ String
The user who last modified the email channel.
-
#last_modified_date ⇒ String
The date and time, in ISO 8601 format, when the email channel was last modified.
-
#messages_per_second ⇒ Integer
The maximum number of emails that can be sent through the channel each second.
-
#orchestration_sending_role_arn ⇒ String
The ARN of an IAM role for Amazon Pinpoint to use to send email from your campaigns or journeys through Amazon SES.
-
#platform ⇒ String
The type of messaging or notification platform for the channel.
-
#role_arn ⇒ 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 ⇒ Integer
The current version of the email channel.
Instance Attribute Details
#application_id ⇒ String
The unique identifier for the application that the email channel applies to.
4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4250 class EmailChannelResponse < Struct.new( :application_id, :configuration_set, :creation_date, :enabled, :from_address, :has_credential, :id, :identity, :is_archived, :last_modified_by, :last_modified_date, :messages_per_second, :platform, :role_arn, :orchestration_sending_role_arn, :version) SENSITIVE = [] include Aws::Structure end |
#configuration_set ⇒ String
The Amazon SES configuration set that's applied to messages that are sent through the channel.
4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4250 class EmailChannelResponse < Struct.new( :application_id, :configuration_set, :creation_date, :enabled, :from_address, :has_credential, :id, :identity, :is_archived, :last_modified_by, :last_modified_date, :messages_per_second, :platform, :role_arn, :orchestration_sending_role_arn, :version) SENSITIVE = [] include Aws::Structure end |
#creation_date ⇒ String
The date and time, in ISO 8601 format, when the email channel was enabled.
4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4250 class EmailChannelResponse < Struct.new( :application_id, :configuration_set, :creation_date, :enabled, :from_address, :has_credential, :id, :identity, :is_archived, :last_modified_by, :last_modified_date, :messages_per_second, :platform, :role_arn, :orchestration_sending_role_arn, :version) SENSITIVE = [] include Aws::Structure end |
#enabled ⇒ Boolean
Specifies whether the email channel is enabled for the application.
4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4250 class EmailChannelResponse < Struct.new( :application_id, :configuration_set, :creation_date, :enabled, :from_address, :has_credential, :id, :identity, :is_archived, :last_modified_by, :last_modified_date, :messages_per_second, :platform, :role_arn, :orchestration_sending_role_arn, :version) SENSITIVE = [] include Aws::Structure end |
#from_address ⇒ String
The verified email address that email is sent from when you send email through the channel.
4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4250 class EmailChannelResponse < Struct.new( :application_id, :configuration_set, :creation_date, :enabled, :from_address, :has_credential, :id, :identity, :is_archived, :last_modified_by, :last_modified_date, :messages_per_second, :platform, :role_arn, :orchestration_sending_role_arn, :version) SENSITIVE = [] include Aws::Structure end |
#has_credential ⇒ Boolean
(Not used) This property is retained only for backward compatibility.
4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4250 class EmailChannelResponse < Struct.new( :application_id, :configuration_set, :creation_date, :enabled, :from_address, :has_credential, :id, :identity, :is_archived, :last_modified_by, :last_modified_date, :messages_per_second, :platform, :role_arn, :orchestration_sending_role_arn, :version) SENSITIVE = [] include Aws::Structure end |
#id ⇒ String
(Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.
4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4250 class EmailChannelResponse < Struct.new( :application_id, :configuration_set, :creation_date, :enabled, :from_address, :has_credential, :id, :identity, :is_archived, :last_modified_by, :last_modified_date, :messages_per_second, :platform, :role_arn, :orchestration_sending_role_arn, :version) SENSITIVE = [] include Aws::Structure end |
#identity ⇒ 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.
4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4250 class EmailChannelResponse < Struct.new( :application_id, :configuration_set, :creation_date, :enabled, :from_address, :has_credential, :id, :identity, :is_archived, :last_modified_by, :last_modified_date, :messages_per_second, :platform, :role_arn, :orchestration_sending_role_arn, :version) SENSITIVE = [] include Aws::Structure end |
#is_archived ⇒ Boolean
Specifies whether the email channel is archived.
4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4250 class EmailChannelResponse < Struct.new( :application_id, :configuration_set, :creation_date, :enabled, :from_address, :has_credential, :id, :identity, :is_archived, :last_modified_by, :last_modified_date, :messages_per_second, :platform, :role_arn, :orchestration_sending_role_arn, :version) SENSITIVE = [] include Aws::Structure end |
#last_modified_by ⇒ String
The user who last modified the email channel.
4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4250 class EmailChannelResponse < Struct.new( :application_id, :configuration_set, :creation_date, :enabled, :from_address, :has_credential, :id, :identity, :is_archived, :last_modified_by, :last_modified_date, :messages_per_second, :platform, :role_arn, :orchestration_sending_role_arn, :version) SENSITIVE = [] include Aws::Structure end |
#last_modified_date ⇒ String
The date and time, in ISO 8601 format, when the email channel was last modified.
4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4250 class EmailChannelResponse < Struct.new( :application_id, :configuration_set, :creation_date, :enabled, :from_address, :has_credential, :id, :identity, :is_archived, :last_modified_by, :last_modified_date, :messages_per_second, :platform, :role_arn, :orchestration_sending_role_arn, :version) SENSITIVE = [] include Aws::Structure end |
#messages_per_second ⇒ Integer
The maximum number of emails that can be sent through the channel each second.
4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4250 class EmailChannelResponse < Struct.new( :application_id, :configuration_set, :creation_date, :enabled, :from_address, :has_credential, :id, :identity, :is_archived, :last_modified_by, :last_modified_date, :messages_per_second, :platform, :role_arn, :orchestration_sending_role_arn, :version) SENSITIVE = [] include Aws::Structure end |
#orchestration_sending_role_arn ⇒ String
The ARN of an IAM role for Amazon Pinpoint to use to send email from your campaigns or journeys through Amazon SES.
4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4250 class EmailChannelResponse < Struct.new( :application_id, :configuration_set, :creation_date, :enabled, :from_address, :has_credential, :id, :identity, :is_archived, :last_modified_by, :last_modified_date, :messages_per_second, :platform, :role_arn, :orchestration_sending_role_arn, :version) SENSITIVE = [] include Aws::Structure end |
#platform ⇒ String
The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.
4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4250 class EmailChannelResponse < Struct.new( :application_id, :configuration_set, :creation_date, :enabled, :from_address, :has_credential, :id, :identity, :is_archived, :last_modified_by, :last_modified_date, :messages_per_second, :platform, :role_arn, :orchestration_sending_role_arn, :version) SENSITIVE = [] include Aws::Structure end |
#role_arn ⇒ 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.
4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4250 class EmailChannelResponse < Struct.new( :application_id, :configuration_set, :creation_date, :enabled, :from_address, :has_credential, :id, :identity, :is_archived, :last_modified_by, :last_modified_date, :messages_per_second, :platform, :role_arn, :orchestration_sending_role_arn, :version) SENSITIVE = [] include Aws::Structure end |
#version ⇒ Integer
The current version of the email channel.
4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4250 class EmailChannelResponse < Struct.new( :application_id, :configuration_set, :creation_date, :enabled, :from_address, :has_credential, :id, :identity, :is_archived, :last_modified_by, :last_modified_date, :messages_per_second, :platform, :role_arn, :orchestration_sending_role_arn, :version) SENSITIVE = [] include Aws::Structure end |