amazonka-pinpoint-2.0: Amazon Pinpoint SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Pinpoint.Types.EmailChannelRequest

Description

 
Synopsis

Documentation

data EmailChannelRequest Source #

Specifies the status and settings of the email channel for an application.

See: newEmailChannelRequest smart constructor.

Constructors

EmailChannelRequest' 

Fields

  • configurationSet :: Maybe Text

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

  • enabled :: Maybe Bool

    Specifies whether to enable the email channel for the application.

  • roleArn :: Maybe Text

    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.

  • fromAddress :: Text

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

  • identity :: Text

    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.

Instances

Instances details
ToJSON EmailChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailChannelRequest

Generic EmailChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailChannelRequest

Associated Types

type Rep EmailChannelRequest :: Type -> Type #

Read EmailChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailChannelRequest

Show EmailChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailChannelRequest

NFData EmailChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailChannelRequest

Methods

rnf :: EmailChannelRequest -> () #

Eq EmailChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailChannelRequest

Hashable EmailChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailChannelRequest

type Rep EmailChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.EmailChannelRequest

type Rep EmailChannelRequest = D1 ('MetaData "EmailChannelRequest" "Amazonka.Pinpoint.Types.EmailChannelRequest" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "EmailChannelRequest'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "configurationSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "fromAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "identity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newEmailChannelRequest Source #

Create a value of EmailChannelRequest 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:configurationSet:EmailChannelRequest', emailChannelRequest_configurationSet - The Amazon SES configuration set that you want to apply to messages that you send through the channel.

$sel:enabled:EmailChannelRequest', emailChannelRequest_enabled - Specifies whether to enable the email channel for the application.

$sel:roleArn:EmailChannelRequest', emailChannelRequest_roleArn - 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.

$sel:fromAddress:EmailChannelRequest', emailChannelRequest_fromAddress - The verified email address that you want to send email from when you send email through the channel.

$sel:identity:EmailChannelRequest', emailChannelRequest_identity - 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.

emailChannelRequest_configurationSet :: Lens' EmailChannelRequest (Maybe Text) Source #

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

emailChannelRequest_enabled :: Lens' EmailChannelRequest (Maybe Bool) Source #

Specifies whether to enable the email channel for the application.

emailChannelRequest_roleArn :: Lens' EmailChannelRequest (Maybe Text) Source #

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.

emailChannelRequest_fromAddress :: Lens' EmailChannelRequest Text Source #

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

emailChannelRequest_identity :: Lens' EmailChannelRequest Text Source #

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.