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.LexV2Models.Types.FulfillmentUpdateResponseSpecification

Description

Documentation

data FulfillmentUpdateResponseSpecification Source #

Provides settings for a message that is sent periodically to the user while a fulfillment Lambda function is running.

See: newFulfillmentUpdateResponseSpecification smart constructor.

Constructors

FulfillmentUpdateResponseSpecification'

Fields

allowInterrupt :: Maybe Bool
Determines whether the user can interrupt an update message while it is playing.
frequencyInSeconds :: Natural
The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user.
messageGroups :: NonEmpty MessageGroup
One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

Instances

Instances details

FromJSON FulfillmentUpdateResponseSpecification Source #
Instance details Defined in Amazonka.LexV2Models.Types.FulfillmentUpdateResponseSpecification Methods parseJSON :: Value -> Parser FulfillmentUpdateResponseSpecification # parseJSONList :: Value -> Parser [FulfillmentUpdateResponseSpecification] #
ToJSON FulfillmentUpdateResponseSpecification Source #
Instance details Defined in Amazonka.LexV2Models.Types.FulfillmentUpdateResponseSpecification Methods toJSON :: FulfillmentUpdateResponseSpecification -> Value # toEncoding :: FulfillmentUpdateResponseSpecification -> Encoding # toJSONList :: [FulfillmentUpdateResponseSpecification] -> Value # toEncodingList :: [FulfillmentUpdateResponseSpecification] -> Encoding #
Generic FulfillmentUpdateResponseSpecification Source #
Instance details Defined in Amazonka.LexV2Models.Types.FulfillmentUpdateResponseSpecification Associated Types type Rep FulfillmentUpdateResponseSpecification :: Type -> Type # Methods from :: FulfillmentUpdateResponseSpecification -> Rep FulfillmentUpdateResponseSpecification x # to :: Rep FulfillmentUpdateResponseSpecification x -> FulfillmentUpdateResponseSpecification #
Read FulfillmentUpdateResponseSpecification Source #
Instance details Defined in Amazonka.LexV2Models.Types.FulfillmentUpdateResponseSpecification Methods readsPrec :: Int -> ReadS FulfillmentUpdateResponseSpecification # readList :: ReadS [FulfillmentUpdateResponseSpecification] # readPrec :: ReadPrec FulfillmentUpdateResponseSpecification # readListPrec :: ReadPrec [FulfillmentUpdateResponseSpecification] #
Show FulfillmentUpdateResponseSpecification Source #
Instance details Defined in Amazonka.LexV2Models.Types.FulfillmentUpdateResponseSpecification Methods showsPrec :: Int -> FulfillmentUpdateResponseSpecification -> ShowS # show :: FulfillmentUpdateResponseSpecification -> String # showList :: [FulfillmentUpdateResponseSpecification] -> ShowS #
NFData FulfillmentUpdateResponseSpecification Source #
Instance details Defined in Amazonka.LexV2Models.Types.FulfillmentUpdateResponseSpecification Methods rnf :: FulfillmentUpdateResponseSpecification -> () #
Eq FulfillmentUpdateResponseSpecification Source #
Instance details Defined in Amazonka.LexV2Models.Types.FulfillmentUpdateResponseSpecification Methods (==) :: FulfillmentUpdateResponseSpecification -> FulfillmentUpdateResponseSpecification -> Bool # (/=) :: FulfillmentUpdateResponseSpecification -> FulfillmentUpdateResponseSpecification -> Bool #
Hashable FulfillmentUpdateResponseSpecification Source #
Instance details Defined in Amazonka.LexV2Models.Types.FulfillmentUpdateResponseSpecification Methods hashWithSalt :: Int -> FulfillmentUpdateResponseSpecification -> Int # hash :: FulfillmentUpdateResponseSpecification -> Int #
type Rep FulfillmentUpdateResponseSpecification Source #
Instance details Defined in Amazonka.LexV2Models.Types.FulfillmentUpdateResponseSpecification type Rep FulfillmentUpdateResponseSpecification = D1 ('MetaData "FulfillmentUpdateResponseSpecification" "Amazonka.LexV2Models.Types.FulfillmentUpdateResponseSpecification" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "FulfillmentUpdateResponseSpecification'" 'PrefixI 'True) (S1 ('MetaSel ('Just "allowInterrupt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "frequencyInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :: S1 ('MetaSel ('Just "messageGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty MessageGroup)))))

newFulfillmentUpdateResponseSpecification Source #

Arguments

:: Natural	`$sel:frequencyInSeconds:FulfillmentUpdateResponseSpecification'`
-> NonEmpty MessageGroup	`$sel:messageGroups:FulfillmentUpdateResponseSpecification'`
-> FulfillmentUpdateResponseSpecification

Create a value of FulfillmentUpdateResponseSpecification 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:allowInterrupt:FulfillmentUpdateResponseSpecification', fulfillmentUpdateResponseSpecification_allowInterrupt - Determines whether the user can interrupt an update message while it is playing.

$sel:frequencyInSeconds:FulfillmentUpdateResponseSpecification', fulfillmentUpdateResponseSpecification_frequencyInSeconds - The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user.

$sel:messageGroups:FulfillmentUpdateResponseSpecification', fulfillmentUpdateResponseSpecification_messageGroups - One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

fulfillmentUpdateResponseSpecification_allowInterrupt :: Lens' FulfillmentUpdateResponseSpecification (Maybe Bool) Source #

Determines whether the user can interrupt an update message while it is playing.

fulfillmentUpdateResponseSpecification_frequencyInSeconds :: Lens' FulfillmentUpdateResponseSpecification Natural Source #

The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user.

fulfillmentUpdateResponseSpecification_messageGroups :: Lens' FulfillmentUpdateResponseSpecification (NonEmpty MessageGroup) Source #

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.