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.LexRuntime.Types.ActiveContext

Description

Documentation

data ActiveContext Source #

A context is a variable that contains information about the current state of the conversation between a user and Amazon Lex. Context can be set automatically by Amazon Lex when an intent is fulfilled, or it can be set at runtime using the PutContent, PutText, or PutSession operation.

See: newActiveContext smart constructor.

Constructors

ActiveContext'
Fields name :: Text The name of the context. timeToLive :: ActiveContextTimeToLive The length of time or number of turns that a context remains active. parameters :: HashMap Text (Sensitive Text) State variables for the current context. You can use these values as default values for slots in subsequent events.

Instances

Instances details

FromJSON ActiveContext Source #
Instance details Defined in Amazonka.LexRuntime.Types.ActiveContext Methods parseJSON :: Value -> Parser ActiveContext # parseJSONList :: Value -> Parser [ActiveContext] #
ToJSON ActiveContext Source #
Instance details Defined in Amazonka.LexRuntime.Types.ActiveContext Methods toJSON :: ActiveContext -> Value # toEncoding :: ActiveContext -> Encoding # toJSONList :: [ActiveContext] -> Value # toEncodingList :: [ActiveContext] -> Encoding #
Generic ActiveContext Source #
Instance details Defined in Amazonka.LexRuntime.Types.ActiveContext Associated Types type Rep ActiveContext :: Type -> Type # Methods from :: ActiveContext -> Rep ActiveContext x # to :: Rep ActiveContext x -> ActiveContext #
Show ActiveContext Source #
Instance details Defined in Amazonka.LexRuntime.Types.ActiveContext Methods showsPrec :: Int -> ActiveContext -> ShowS # show :: ActiveContext -> String # showList :: [ActiveContext] -> ShowS #
NFData ActiveContext Source #
Instance details Defined in Amazonka.LexRuntime.Types.ActiveContext Methods rnf :: ActiveContext -> () #
Eq ActiveContext Source #
Instance details Defined in Amazonka.LexRuntime.Types.ActiveContext Methods (==) :: ActiveContext -> ActiveContext -> Bool # (/=) :: ActiveContext -> ActiveContext -> Bool #
Hashable ActiveContext Source #
Instance details Defined in Amazonka.LexRuntime.Types.ActiveContext Methods hashWithSalt :: Int -> ActiveContext -> Int # hash :: ActiveContext -> Int #
type Rep ActiveContext Source #
Instance details Defined in Amazonka.LexRuntime.Types.ActiveContext type Rep ActiveContext = D1 ('MetaData "ActiveContext" "Amazonka.LexRuntime.Types.ActiveContext" "amazonka-lex-runtime-2.0-Hs8dyr5aBISIGW4JmDmUkW" 'False) (C1 ('MetaCons "ActiveContext'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "timeToLive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ActiveContextTimeToLive) :: S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text (Sensitive Text))))))

newActiveContext Source #

Arguments

:: Text	`$sel:name:ActiveContext'`
-> ActiveContextTimeToLive	`$sel:timeToLive:ActiveContext'`
-> ActiveContext

Create a value of ActiveContext 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:name:ActiveContext', activeContext_name - The name of the context.

$sel:timeToLive:ActiveContext', activeContext_timeToLive - The length of time or number of turns that a context remains active.

$sel:parameters:ActiveContext', activeContext_parameters - State variables for the current context. You can use these values as default values for slots in subsequent events.

activeContext_name :: Lens' ActiveContext Text Source #

The name of the context.

activeContext_timeToLive :: Lens' ActiveContext ActiveContextTimeToLive Source #

The length of time or number of turns that a context remains active.

activeContext_parameters :: Lens' ActiveContext (HashMap Text Text) Source #

State variables for the current context. You can use these values as default values for slots in subsequent events.