Amazonka.Pinpoint.Types.EmailChannelResponse

Documentation

data EmailChannelResponse

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

See: newEmailChannelResponse smart constructor.

Constructors

EmailChannelResponse'

Fields

• applicationId :: Maybe Text

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

• configurationSet :: Maybe Text

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

• creationDate :: Maybe Text

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

• enabled :: Maybe Bool

  Specifies whether the email channel is enabled for the application.

• fromAddress :: Maybe Text

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

• hasCredential :: Maybe Bool

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

• id :: Maybe Text

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

• identity :: Maybe Text

  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.

• isArchived :: Maybe Bool

  Specifies whether the email channel is archived.

• lastModifiedBy :: Maybe Text

  The user who last modified the email channel.

• lastModifiedDate :: Maybe Text

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

• messagesPerSecond :: Maybe Int

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

• roleArn :: Maybe Text

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

• version :: Maybe Int

  The current version of the email channel.

• platform :: Text

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

Instances

FromJSON EmailChannelResponse

Defined in Amazonka.Pinpoint.Types.EmailChannelResponse

Methods

parseJSON :: Value -> Parser EmailChannelResponse

parseJSONList :: Value -> Parser [EmailChannelResponse]

Generic EmailChannelResponse

Defined in Amazonka.Pinpoint.Types.EmailChannelResponse

Associated Types

type Rep EmailChannelResponse :: Type -> Type

Methods

from :: EmailChannelResponse -> Rep EmailChannelResponse x

to :: Rep EmailChannelResponse x -> EmailChannelResponse

Read EmailChannelResponse

Defined in Amazonka.Pinpoint.Types.EmailChannelResponse

Methods

readsPrec :: Int -> ReadS EmailChannelResponse

readList :: ReadS [EmailChannelResponse]

readPrec :: ReadPrec EmailChannelResponse

readListPrec :: ReadPrec [EmailChannelResponse]

Show EmailChannelResponse

Defined in Amazonka.Pinpoint.Types.EmailChannelResponse

Methods

showsPrec :: Int -> EmailChannelResponse -> ShowS

show :: EmailChannelResponse -> String

showList :: [EmailChannelResponse] -> ShowS

NFData EmailChannelResponse

Defined in Amazonka.Pinpoint.Types.EmailChannelResponse

Methods

rnf :: EmailChannelResponse -> ()

Eq EmailChannelResponse

Defined in Amazonka.Pinpoint.Types.EmailChannelResponse

Methods

(==) :: EmailChannelResponse -> EmailChannelResponse -> Bool

(/=) :: EmailChannelResponse -> EmailChannelResponse -> Bool

Hashable EmailChannelResponse

Defined in Amazonka.Pinpoint.Types.EmailChannelResponse

Methods

hashWithSalt :: Int -> EmailChannelResponse -> Int

hash :: EmailChannelResponse -> Int

type Rep EmailChannelResponse

Defined in Amazonka.Pinpoint.Types.EmailChannelResponse

type Rep EmailChannelResponse = D1 ('MetaData "EmailChannelResponse" "Amazonka.Pinpoint.Types.EmailChannelResponse" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "EmailChannelResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "configurationSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "fromAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "hasCredential") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "identity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "isArchived") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "lastModifiedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "messagesPerSecond") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "platform") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newEmailChannelResponse

Arguments

:: Text

$sel:platform:EmailChannelResponse'

-> EmailChannelResponse

Create a value of EmailChannelResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:applicationId:EmailChannelResponse', emailChannelResponse_applicationId - The unique identifier for the application that the email channel applies to.

$sel:configurationSet:EmailChannelResponse', emailChannelResponse_configurationSet - The Amazon SES configuration set that's applied to messages that are sent through the channel.

$sel:creationDate:EmailChannelResponse', emailChannelResponse_creationDate - The date and time, in ISO 8601 format, when the email channel was enabled.

$sel:enabled:EmailChannelResponse', emailChannelResponse_enabled - Specifies whether the email channel is enabled for the application.

$sel:fromAddress:EmailChannelResponse', emailChannelResponse_fromAddress - The verified email address that email is sent from when you send email through the channel.

$sel:hasCredential:EmailChannelResponse', emailChannelResponse_hasCredential - (Not used) This property is retained only for backward compatibility.

$sel:id:EmailChannelResponse', emailChannelResponse_id - (Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.

$sel:identity:EmailChannelResponse', emailChannelResponse_identity - 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.

$sel:isArchived:EmailChannelResponse', emailChannelResponse_isArchived - Specifies whether the email channel is archived.

$sel:lastModifiedBy:EmailChannelResponse', emailChannelResponse_lastModifiedBy - The user who last modified the email channel.

$sel:lastModifiedDate:EmailChannelResponse', emailChannelResponse_lastModifiedDate - The date and time, in ISO 8601 format, when the email channel was last modified.

$sel:messagesPerSecond:EmailChannelResponse', emailChannelResponse_messagesPerSecond - The maximum number of emails that can be sent through the channel each second.

$sel:roleArn:EmailChannelResponse', emailChannelResponse_roleArn - The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.

$sel:version:EmailChannelResponse', emailChannelResponse_version - The current version of the email channel.

$sel:platform:EmailChannelResponse', emailChannelResponse_platform - The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.

emailChannelResponse_applicationId :: Lens' EmailChannelResponse (Maybe Text)

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

emailChannelResponse_configurationSet :: Lens' EmailChannelResponse (Maybe Text)

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

emailChannelResponse_creationDate :: Lens' EmailChannelResponse (Maybe Text)

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

emailChannelResponse_enabled :: Lens' EmailChannelResponse (Maybe Bool)

Specifies whether the email channel is enabled for the application.

emailChannelResponse_fromAddress :: Lens' EmailChannelResponse (Maybe Text)

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

emailChannelResponse_hasCredential :: Lens' EmailChannelResponse (Maybe Bool)

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

emailChannelResponse_id :: Lens' EmailChannelResponse (Maybe Text)

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

emailChannelResponse_identity :: Lens' EmailChannelResponse (Maybe Text)

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.

emailChannelResponse_isArchived :: Lens' EmailChannelResponse (Maybe Bool)

Specifies whether the email channel is archived.

emailChannelResponse_lastModifiedBy :: Lens' EmailChannelResponse (Maybe Text)

The user who last modified the email channel.

emailChannelResponse_lastModifiedDate :: Lens' EmailChannelResponse (Maybe Text)

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

emailChannelResponse_messagesPerSecond :: Lens' EmailChannelResponse (Maybe Int)

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

emailChannelResponse_roleArn :: Lens' EmailChannelResponse (Maybe Text)

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

emailChannelResponse_version :: Lens' EmailChannelResponse (Maybe Int)

The current version of the email channel.

emailChannelResponse_platform :: Lens' EmailChannelResponse Text

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