Class: Aws::Pinpoint::Types::EmailChannelResponse

Inherits:
Struct
  • Object
show all
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

Instance Attribute Details

#application_idString

The unique identifier for the application that the email channel applies to.

Returns:

  • (String)


6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6144

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,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#configuration_setString

The Amazon SES configuration set that's applied to messages that are sent through the channel.

Returns:

  • (String)


6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6144

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,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#creation_dateString

The date and time, in ISO 8601 format, when the email channel was enabled.

Returns:

  • (String)


6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6144

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,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#enabledBoolean

Specifies whether the email channel is enabled for the application.

Returns:

  • (Boolean)


6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6144

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,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#from_addressString

The verified email address that email is sent from when you send email through the channel.

Returns:

  • (String)


6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6144

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,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#has_credentialBoolean

(Not used) This property is retained only for backward compatibility.

Returns:

  • (Boolean)


6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6144

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,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#idString

(Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.

Returns:

  • (String)


6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6144

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,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#identityString

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.

Returns:

  • (String)


6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6144

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,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#is_archivedBoolean

Specifies whether the email channel is archived.

Returns:

  • (Boolean)


6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6144

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,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_byString

The user who last modified the email channel.

Returns:

  • (String)


6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6144

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,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_dateString

The date and time, in ISO 8601 format, when the email channel was last modified.

Returns:

  • (String)


6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6144

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,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#messages_per_secondInteger

The maximum number of emails that can be sent through the channel each second.

Returns:

  • (Integer)


6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6144

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,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#platformString

The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.

Returns:

  • (String)


6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6144

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,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.

Returns:

  • (String)


6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6144

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,
  :version)
  SENSITIVE = []
  include Aws::Structure
end

#versionInteger

The current version of the email channel.

Returns:

  • (Integer)


6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6144

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,
  :version)
  SENSITIVE = []
  include Aws::Structure
end