You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

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

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

Email Channel Request

Instance Attribute Summary collapse

Instance Attribute Details

#enabledBoolean

If the channel is enabled for sending messages.

Returns:

  • (Boolean)


2305
2306
2307
2308
2309
2310
2311
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2305

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

#from_addressString

The email address used to send emails from.

Returns:

  • (String)


2305
2306
2307
2308
2309
2310
2311
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2305

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

#identityString

The ARN of an identity verified with SES.

Returns:

  • (String)


2305
2306
2307
2308
2309
2310
2311
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2305

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

#role_arnString

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

Returns:

  • (String)


2305
2306
2307
2308
2309
2310
2311
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2305

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