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

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::EmailChannelResponse

Includes:

Structure

Defined in:

lib/aws-sdk-pinpoint/types.rb

Overview

Email Channel Response.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #application_id ⇒ String

  The unique ID of the application to which the email channel belongs.

• #configuration_set ⇒ String

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

• #creation_date ⇒ String

  The date that the settings were last updated in ISO 8601 format.

• #enabled ⇒ Boolean

  If the channel is enabled for sending messages.

• #from_address ⇒ String

  The email address used to send emails from.

• #has_credential ⇒ Boolean

  Not used.

• #id ⇒ String

  Channel ID.

• #identity ⇒ String

  The ARN of an identity verified with SES.

• #is_archived ⇒ Boolean

  Is this channel archived.

• #last_modified_by ⇒ String

  Who last updated this entry.

• #last_modified_date ⇒ String

  Last date this was updated.

• #messages_per_second ⇒ Integer

  Messages per second that can be sent.

• #platform ⇒ String

  Platform type.

• #role_arn ⇒ String

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

• #version ⇒ Integer

  Version of channel.

Instance Attribute Details

#application_id ⇒ String

The unique ID of the application to which the email channel belongs.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 3368

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)
  include Aws::Structure
end

#configuration_set ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 3368

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)
  include Aws::Structure
end

#creation_date ⇒ String

The date that the settings were last updated in ISO 8601 format.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 3368

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)
  include Aws::Structure
end

#enabled ⇒ Boolean

If the channel is enabled for sending messages.

Returns:

• (Boolean)

# File 'lib/aws-sdk-pinpoint/types.rb', line 3368

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)
  include Aws::Structure
end

#from_address ⇒ String

The email address used to send emails from.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 3368

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)
  include Aws::Structure
end

#has_credential ⇒ Boolean

Not used. Retained for backwards compatibility.

Returns:

• (Boolean)

# File 'lib/aws-sdk-pinpoint/types.rb', line 3368

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)
  include Aws::Structure
end

#id ⇒ String

Channel ID. Not used, only for backwards compatibility.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 3368

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)
  include Aws::Structure
end

#identity ⇒ String

The ARN of an identity verified with SES.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 3368

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)
  include Aws::Structure
end

#is_archived ⇒ Boolean

Is this channel archived

Returns:

• (Boolean)

# File 'lib/aws-sdk-pinpoint/types.rb', line 3368

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)
  include Aws::Structure
end

#last_modified_by ⇒ String

Who last updated this entry

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 3368

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)
  include Aws::Structure
end

#last_modified_date ⇒ String

Last date this was updated

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 3368

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)
  include Aws::Structure
end

#messages_per_second ⇒ Integer

Messages per second that can be sent

Returns:

• (Integer)

# File 'lib/aws-sdk-pinpoint/types.rb', line 3368

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)
  include Aws::Structure
end

#platform ⇒ String

Platform type. Will be “EMAIL”

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 3368

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)
  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)

# File 'lib/aws-sdk-pinpoint/types.rb', line 3368

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)
  include Aws::Structure
end

#version ⇒ Integer

Version of channel

Returns:

• (Integer)

# File 'lib/aws-sdk-pinpoint/types.rb', line 3368

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)
  include Aws::Structure
end