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:

{
  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

Instance Attribute Details

#configuration_setString

The Amazon SES configuration set that you want to apply to messages that you send through the channel.

Returns:

  • (String)


6052
6053
6054
6055
6056
6057
6058
6059
6060
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6052

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

#enabledBoolean

Specifies whether to enable the email channel for the application.

Returns:

  • (Boolean)


6052
6053
6054
6055
6056
6057
6058
6059
6060
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6052

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

#from_addressString

The verified email address that you want to send email from when you send email through the channel.

Returns:

  • (String)


6052
6053
6054
6055
6056
6057
6058
6059
6060
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6052

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

#identityString

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.

Returns:

  • (String)


6052
6053
6054
6055
6056
6057
6058
6059
6060
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6052

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

#role_arnString

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.

Returns:

  • (String)


6052
6053
6054
6055
6056
6057
6058
6059
6060
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6052

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