Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SES.Types.WorkmailAction

Description

Synopsis

data WorkmailAction = WorkmailAction' {
- topicArn :: Maybe Text
- organizationArn :: Text
}
newWorkmailAction :: Text -> WorkmailAction
workmailAction_topicArn :: Lens' WorkmailAction (Maybe Text)
workmailAction_organizationArn :: Lens' WorkmailAction Text

Documentation

data WorkmailAction Source #

When included in a receipt rule, this action calls Amazon WorkMail and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS). You will typically not use this action directly because Amazon WorkMail adds the rule automatically during its setup procedure.

For information using a receipt rule to call Amazon WorkMail, see the Amazon SES Developer Guide.

See: newWorkmailAction smart constructor.

Constructors

WorkmailAction'

Fields

topicArn :: Maybe Text
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
organizationArn :: Text
The ARN of the Amazon WorkMail organization. An example of an Amazon WorkMail organization ARN is arn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7. For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide.

Instances

Instances details

Eq WorkmailAction Source #
Instance details Defined in Amazonka.SES.Types.WorkmailAction Methods (==) :: WorkmailAction -> WorkmailAction -> Bool # (/=) :: WorkmailAction -> WorkmailAction -> Bool #
Read WorkmailAction Source #
Instance details Defined in Amazonka.SES.Types.WorkmailAction Methods readsPrec :: Int -> ReadS WorkmailAction # readList :: ReadS [WorkmailAction] # readPrec :: ReadPrec WorkmailAction # readListPrec :: ReadPrec [WorkmailAction] #
Show WorkmailAction Source #
Instance details Defined in Amazonka.SES.Types.WorkmailAction Methods showsPrec :: Int -> WorkmailAction -> ShowS # show :: WorkmailAction -> String # showList :: [WorkmailAction] -> ShowS #
Generic WorkmailAction Source #
Instance details Defined in Amazonka.SES.Types.WorkmailAction Associated Types type Rep WorkmailAction :: Type -> Type # Methods from :: WorkmailAction -> Rep WorkmailAction x # to :: Rep WorkmailAction x -> WorkmailAction #
NFData WorkmailAction Source #
Instance details Defined in Amazonka.SES.Types.WorkmailAction Methods rnf :: WorkmailAction -> () #
Hashable WorkmailAction Source #
Instance details Defined in Amazonka.SES.Types.WorkmailAction Methods hashWithSalt :: Int -> WorkmailAction -> Int # hash :: WorkmailAction -> Int #
ToQuery WorkmailAction Source #
Instance details Defined in Amazonka.SES.Types.WorkmailAction Methods toQuery :: WorkmailAction -> QueryString #
FromXML WorkmailAction Source #
Instance details Defined in Amazonka.SES.Types.WorkmailAction Methods parseXML :: [Node] -> Either String WorkmailAction #
type Rep WorkmailAction Source #
Instance details Defined in Amazonka.SES.Types.WorkmailAction type Rep WorkmailAction = D1 ('MetaData "WorkmailAction" "Amazonka.SES.Types.WorkmailAction" "libZSservicesZSamazonka-sesZSamazonka-ses" 'False) (C1 ('MetaCons "WorkmailAction'" 'PrefixI 'True) (S1 ('MetaSel ('Just "topicArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "organizationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newWorkmailAction Source #

Arguments

:: Text	`$sel:organizationArn:WorkmailAction'`
-> WorkmailAction

Create a value of WorkmailAction 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:topicArn:WorkmailAction', workmailAction_topicArn - The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

$sel:organizationArn:WorkmailAction', workmailAction_organizationArn - The ARN of the Amazon WorkMail organization. An example of an Amazon WorkMail organization ARN is arn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7. For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide.

workmailAction_topicArn :: Lens' WorkmailAction (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

workmailAction_organizationArn :: Lens' WorkmailAction Text Source #

The ARN of the Amazon WorkMail organization. An example of an Amazon WorkMail organization ARN is arn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7. For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide.