Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Snowball.Types.Notification

Description

Synopsis

Documentation

data Notification Source #

The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job. The Notification object is returned as a part of the response syntax of the DescribeJob action in the JobMetadata data type.

When the notification settings are defined during job creation, you can choose to notify based on a specific set of job states using the JobStatesToNotify array of strings, or you can specify that you want to have Amazon SNS notifications sent out for all job states with NotifyAll set to true.

See: newNotification smart constructor.

Constructors

Notification'

Fields

jobStatesToNotify :: Maybe [JobState]
The list of job states that will trigger a notification for this job.
notifyAll :: Maybe Bool
Any change in job state will trigger a notification for this job.
snsTopicARN :: Maybe Text
The new SNS TopicArn that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the CreateTopic Amazon SNS API action.
You can subscribe email addresses to an Amazon SNS topic through the Amazon Web Services Management Console, or by using the Subscribe Amazon Simple Notification Service (Amazon SNS) API action.

Instances

Instances details

FromJSON Notification Source #
Instance details Defined in Amazonka.Snowball.Types.Notification Methods parseJSON :: Value -> Parser Notification # parseJSONList :: Value -> Parser [Notification] #
ToJSON Notification Source #
Instance details Defined in Amazonka.Snowball.Types.Notification Methods toJSON :: Notification -> Value # toEncoding :: Notification -> Encoding # toJSONList :: [Notification] -> Value # toEncodingList :: [Notification] -> Encoding #
Generic Notification Source #
Instance details Defined in Amazonka.Snowball.Types.Notification Associated Types type Rep Notification :: Type -> Type # Methods from :: Notification -> Rep Notification x # to :: Rep Notification x -> Notification #
Read Notification Source #
Instance details Defined in Amazonka.Snowball.Types.Notification Methods readsPrec :: Int -> ReadS Notification # readList :: ReadS [Notification] # readPrec :: ReadPrec Notification # readListPrec :: ReadPrec [Notification] #
Show Notification Source #
Instance details Defined in Amazonka.Snowball.Types.Notification Methods showsPrec :: Int -> Notification -> ShowS # show :: Notification -> String # showList :: [Notification] -> ShowS #
NFData Notification Source #
Instance details Defined in Amazonka.Snowball.Types.Notification Methods rnf :: Notification -> () #
Eq Notification Source #
Instance details Defined in Amazonka.Snowball.Types.Notification Methods (==) :: Notification -> Notification -> Bool # (/=) :: Notification -> Notification -> Bool #
Hashable Notification Source #
Instance details Defined in Amazonka.Snowball.Types.Notification Methods hashWithSalt :: Int -> Notification -> Int # hash :: Notification -> Int #
type Rep Notification Source #
Instance details Defined in Amazonka.Snowball.Types.Notification type Rep Notification = D1 ('MetaData "Notification" "Amazonka.Snowball.Types.Notification" "amazonka-snowball-2.0-6vnXQdr1CFv4zLyXDWX7zH" 'False) (C1 ('MetaCons "Notification'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobStatesToNotify") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [JobState])) :: (S1 ('MetaSel ('Just "notifyAll") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "snsTopicARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newNotification :: Notification Source #

Create a value of Notification 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:jobStatesToNotify:Notification', notification_jobStatesToNotify - The list of job states that will trigger a notification for this job.

$sel:notifyAll:Notification', notification_notifyAll - Any change in job state will trigger a notification for this job.

$sel:snsTopicARN:Notification', notification_snsTopicARN - The new SNS TopicArn that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the CreateTopic Amazon SNS API action.

You can subscribe email addresses to an Amazon SNS topic through the Amazon Web Services Management Console, or by using the Subscribe Amazon Simple Notification Service (Amazon SNS) API action.

notification_jobStatesToNotify :: Lens' Notification (Maybe [JobState]) Source #

The list of job states that will trigger a notification for this job.

notification_notifyAll :: Lens' Notification (Maybe Bool) Source #

Any change in job state will trigger a notification for this job.

notification_snsTopicARN :: Lens' Notification (Maybe Text) Source #

The new SNS TopicArn that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the CreateTopic Amazon SNS API action.

You can subscribe email addresses to an Amazon SNS topic through the Amazon Web Services Management Console, or by using the Subscribe Amazon Simple Notification Service (Amazon SNS) API action.