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

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

Overview

Provides information about the status and settings of the email channel for an application.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_id ⇒ String

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

Returns:

  • (String) 


4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 4239

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_set ⇒ String

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

[1]: docs.aws.amazon.com/ses/latest/APIReference/API_ConfigurationSet.html

Returns:

  • (String) 


4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 4239

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_date ⇒ String

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

Returns:

  • (String) 


4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 4239

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

#enabled ⇒ Boolean

Specifies whether the email channel is enabled for the application.

Returns:

  • (Boolean) 


4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 4239

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_address ⇒ String

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

Returns:

  • (String) 


4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 4239

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_credential ⇒ Boolean

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

Returns:

  • (Boolean) 


4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 4239

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

#id ⇒ String

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

Returns:

  • (String) 


4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 4239

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

#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.

Returns:

  • (String) 


4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 4239

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_archived ⇒ Boolean

Specifies whether the email channel is archived.

Returns:

  • (Boolean) 


4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 4239

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_by ⇒ String

The user who last modified the email channel.

Returns:

  • (String) 


4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 4239

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_date ⇒ String

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

Returns:

  • (String) 


4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 4239

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_second ⇒ Integer

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

Returns:

  • (Integer) 


4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 4239

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

#platform ⇒ String

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

Returns:

  • (String) 


4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 4239

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_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.

Returns:

  • (String) 


4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 4239

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

#version ⇒ Integer

The current version of the email channel.

Returns:

  • (Integer) 


4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 4239

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