Class: Aws::Pinpoint::Types::EmailChannelRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-pinpoint/types.rb

Overview

Note:

When making an API call, you may pass EmailChannelRequest data as a hash:

{
  configuration_set: "__string",
  enabled: false,
  from_address: "__string",
  identity: "__string",
  role_arn: "__string",
}

Email Channel Request

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#configuration_set ⇒ String

The configuration set that you want to use when you send email using the Pinpoint Email API.

Returns:

  • (String) 


3293
3294
3295
3296
3297
3298
3299
3300
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 3293

class EmailChannelRequest < Struct.new(
  :configuration_set,
  :enabled,
  :from_address,
  :identity,
  :role_arn)
  include Aws::Structure
end

#enabled ⇒ Boolean

If the channel is enabled for sending messages.

Returns:

  • (Boolean) 


3293
3294
3295
3296
3297
3298
3299
3300
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 3293

class EmailChannelRequest < Struct.new(
  :configuration_set,
  :enabled,
  :from_address,
  :identity,
  :role_arn)
  include Aws::Structure
end

#from_address ⇒ String

The email address used to send emails from.

Returns:

  • (String) 


3293
3294
3295
3296
3297
3298
3299
3300
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 3293

class EmailChannelRequest < Struct.new(
  :configuration_set,
  :enabled,
  :from_address,
  :identity,
  :role_arn)
  include Aws::Structure
end

#identity ⇒ String

The ARN of an identity verified with SES.

Returns:

  • (String) 


3293
3294
3295
3296
3297
3298
3299
3300
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 3293

class EmailChannelRequest < Struct.new(
  :configuration_set,
  :enabled,
  :from_address,
  :identity,
  :role_arn)
  include Aws::Structure
end

#role_arn ⇒ String

The ARN of an IAM Role used to submit events to Mobile Analytics’ event ingestion service

Returns:

  • (String) 


3293
3294
3295
3296
3297
3298
3299
3300
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 3293

class EmailChannelRequest < Struct.new(
  :configuration_set,
  :enabled,
  :from_address,
  :identity,
  :role_arn)
  include Aws::Structure
end