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.CreateSlot

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a slot in an intent. A slot is a variable needed to fulfill an intent. For example, an OrderPizza intent might need slots for size, crust, and number of pizzas. For each slot, you define one or more utterances that Amazon Lex uses to elicit a response from the user.

Synopsis

data CreateSlot = CreateSlot' {
- description :: Maybe Text
- multipleValuesSetting :: Maybe MultipleValuesSetting
- obfuscationSetting :: Maybe ObfuscationSetting
- slotTypeId :: Maybe Text
- subSlotSetting :: Maybe SubSlotSetting
- slotName :: Text
- valueElicitationSetting :: SlotValueElicitationSetting
- botId :: Text
- botVersion :: Text
- localeId :: Text
- intentId :: Text
}
newCreateSlot :: Text -> SlotValueElicitationSetting -> Text -> Text -> Text -> Text -> CreateSlot
createSlot_description :: Lens' CreateSlot (Maybe Text)
createSlot_multipleValuesSetting :: Lens' CreateSlot (Maybe MultipleValuesSetting)
createSlot_obfuscationSetting :: Lens' CreateSlot (Maybe ObfuscationSetting)
createSlot_slotTypeId :: Lens' CreateSlot (Maybe Text)
createSlot_subSlotSetting :: Lens' CreateSlot (Maybe SubSlotSetting)
createSlot_slotName :: Lens' CreateSlot Text
createSlot_valueElicitationSetting :: Lens' CreateSlot SlotValueElicitationSetting
createSlot_botId :: Lens' CreateSlot Text
createSlot_botVersion :: Lens' CreateSlot Text
createSlot_localeId :: Lens' CreateSlot Text
createSlot_intentId :: Lens' CreateSlot Text
data CreateSlotResponse = CreateSlotResponse' {
- botId :: Maybe Text
- botVersion :: Maybe Text
- creationDateTime :: Maybe POSIX
- description :: Maybe Text
- intentId :: Maybe Text
- localeId :: Maybe Text
- multipleValuesSetting :: Maybe MultipleValuesSetting
- obfuscationSetting :: Maybe ObfuscationSetting
- slotId :: Maybe Text
- slotName :: Maybe Text
- slotTypeId :: Maybe Text
- subSlotSetting :: Maybe SubSlotSetting
- valueElicitationSetting :: Maybe SlotValueElicitationSetting
- httpStatus :: Int
}
newCreateSlotResponse :: Int -> CreateSlotResponse
createSlotResponse_botId :: Lens' CreateSlotResponse (Maybe Text)
createSlotResponse_botVersion :: Lens' CreateSlotResponse (Maybe Text)
createSlotResponse_creationDateTime :: Lens' CreateSlotResponse (Maybe UTCTime)
createSlotResponse_description :: Lens' CreateSlotResponse (Maybe Text)
createSlotResponse_intentId :: Lens' CreateSlotResponse (Maybe Text)
createSlotResponse_localeId :: Lens' CreateSlotResponse (Maybe Text)
createSlotResponse_multipleValuesSetting :: Lens' CreateSlotResponse (Maybe MultipleValuesSetting)
createSlotResponse_obfuscationSetting :: Lens' CreateSlotResponse (Maybe ObfuscationSetting)
createSlotResponse_slotId :: Lens' CreateSlotResponse (Maybe Text)
createSlotResponse_slotName :: Lens' CreateSlotResponse (Maybe Text)
createSlotResponse_slotTypeId :: Lens' CreateSlotResponse (Maybe Text)
createSlotResponse_subSlotSetting :: Lens' CreateSlotResponse (Maybe SubSlotSetting)
createSlotResponse_valueElicitationSetting :: Lens' CreateSlotResponse (Maybe SlotValueElicitationSetting)
createSlotResponse_httpStatus :: Lens' CreateSlotResponse Int

Creating a Request

data CreateSlot Source #

See: newCreateSlot smart constructor.

Constructors

CreateSlot'

Fields

description :: Maybe Text
A description of the slot. Use this to help identify the slot in lists.
multipleValuesSetting :: Maybe MultipleValuesSetting
Indicates whether the slot returns multiple values in one response. Multi-value slots are only available in the en-US locale. If you set this value to true in any other locale, Amazon Lex throws a ValidationException.
If the multipleValuesSetting is not set, the default value is false.
obfuscationSetting :: Maybe ObfuscationSetting
Determines how slot values are used in Amazon CloudWatch logs. If the value of the obfuscationSetting parameter is DefaultObfuscation, slot values are obfuscated in the log output. If the value is None, the actual value is present in the log output.
The default is to obfuscate values in the CloudWatch logs.
slotTypeId :: Maybe Text
The unique identifier for the slot type associated with this slot. The slot type determines the values that can be entered into the slot.
subSlotSetting :: Maybe SubSlotSetting
Specifications for the constituent sub slots and the expression for the composite slot.
slotName :: Text
The name of the slot. Slot names must be unique within the bot that contains the slot.
valueElicitationSetting :: SlotValueElicitationSetting
Specifies prompts that Amazon Lex sends to the user to elicit a response that provides the value for the slot.
botId :: Text
The identifier of the bot associated with the slot.
botVersion :: Text
The version of the bot associated with the slot.
localeId :: Text
The identifier of the language and locale that the slot will be used in. The string must match one of the supported locales. All of the bots, intents, slot types used by the slot must have the same locale. For more information, see Supported languages.
intentId :: Text
The identifier of the intent that contains the slot.

Instances

Instances details

ToJSON CreateSlot Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlot Methods toJSON :: CreateSlot -> Value # toEncoding :: CreateSlot -> Encoding # toJSONList :: [CreateSlot] -> Value # toEncodingList :: [CreateSlot] -> Encoding #
ToHeaders CreateSlot Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlot Methods toHeaders :: CreateSlot -> [Header] #
ToPath CreateSlot Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlot Methods toPath :: CreateSlot -> ByteString #
ToQuery CreateSlot Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlot Methods toQuery :: CreateSlot -> QueryString #
AWSRequest CreateSlot Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlot Associated Types type AWSResponse CreateSlot # Methods request :: (Service -> Service) -> CreateSlot -> Request CreateSlot # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateSlot -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateSlot))) #
Generic CreateSlot Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlot Associated Types type Rep CreateSlot :: Type -> Type # Methods from :: CreateSlot -> Rep CreateSlot x # to :: Rep CreateSlot x -> CreateSlot #
Read CreateSlot Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlot Methods readsPrec :: Int -> ReadS CreateSlot # readList :: ReadS [CreateSlot] # readPrec :: ReadPrec CreateSlot # readListPrec :: ReadPrec [CreateSlot] #
Show CreateSlot Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlot Methods showsPrec :: Int -> CreateSlot -> ShowS # show :: CreateSlot -> String # showList :: [CreateSlot] -> ShowS #
NFData CreateSlot Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlot Methods rnf :: CreateSlot -> () #
Eq CreateSlot Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlot Methods (==) :: CreateSlot -> CreateSlot -> Bool # (/=) :: CreateSlot -> CreateSlot -> Bool #
Hashable CreateSlot Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlot Methods hashWithSalt :: Int -> CreateSlot -> Int # hash :: CreateSlot -> Int #
type AWSResponse CreateSlot Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlot type AWSResponse CreateSlot = CreateSlotResponse
type Rep CreateSlot Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlot type Rep CreateSlot = D1 ('MetaData "CreateSlot" "Amazonka.LexV2Models.CreateSlot" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "CreateSlot'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "multipleValuesSetting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MultipleValuesSetting))) :: (S1 ('MetaSel ('Just "obfuscationSetting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ObfuscationSetting)) :: (S1 ('MetaSel ('Just "slotTypeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "subSlotSetting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SubSlotSetting))))) :: ((S1 ('MetaSel ('Just "slotName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "valueElicitationSetting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SlotValueElicitationSetting) :: S1 ('MetaSel ('Just "botId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "botVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "localeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "intentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateSlot Source #

Arguments

:: Text	`CreateSlot`
-> SlotValueElicitationSetting	`CreateSlot`
-> Text	`CreateSlot`
-> Text	`CreateSlot`
-> Text	`CreateSlot`
-> Text	`CreateSlot`
-> CreateSlot

Create a value of CreateSlot 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:

CreateSlot, createSlot_description - A description of the slot. Use this to help identify the slot in lists.

CreateSlot, createSlot_multipleValuesSetting - Indicates whether the slot returns multiple values in one response. Multi-value slots are only available in the en-US locale. If you set this value to true in any other locale, Amazon Lex throws a ValidationException.

If the multipleValuesSetting is not set, the default value is false.

CreateSlot, createSlot_obfuscationSetting - Determines how slot values are used in Amazon CloudWatch logs. If the value of the obfuscationSetting parameter is DefaultObfuscation, slot values are obfuscated in the log output. If the value is None, the actual value is present in the log output.

The default is to obfuscate values in the CloudWatch logs.

CreateSlot, createSlot_slotTypeId - The unique identifier for the slot type associated with this slot. The slot type determines the values that can be entered into the slot.

CreateSlot, createSlot_subSlotSetting - Specifications for the constituent sub slots and the expression for the composite slot.

CreateSlot, createSlot_slotName - The name of the slot. Slot names must be unique within the bot that contains the slot.

CreateSlot, createSlot_valueElicitationSetting - Specifies prompts that Amazon Lex sends to the user to elicit a response that provides the value for the slot.

CreateSlot, createSlot_botId - The identifier of the bot associated with the slot.

CreateSlot, createSlot_botVersion - The version of the bot associated with the slot.

CreateSlot, createSlot_localeId - The identifier of the language and locale that the slot will be used in. The string must match one of the supported locales. All of the bots, intents, slot types used by the slot must have the same locale. For more information, see Supported languages.

CreateSlot, createSlot_intentId - The identifier of the intent that contains the slot.

Request Lenses

createSlot_description :: Lens' CreateSlot (Maybe Text) Source #

A description of the slot. Use this to help identify the slot in lists.

createSlot_multipleValuesSetting :: Lens' CreateSlot (Maybe MultipleValuesSetting) Source #

Indicates whether the slot returns multiple values in one response. Multi-value slots are only available in the en-US locale. If you set this value to true in any other locale, Amazon Lex throws a ValidationException.

If the multipleValuesSetting is not set, the default value is false.

createSlot_obfuscationSetting :: Lens' CreateSlot (Maybe ObfuscationSetting) Source #

Determines how slot values are used in Amazon CloudWatch logs. If the value of the obfuscationSetting parameter is DefaultObfuscation, slot values are obfuscated in the log output. If the value is None, the actual value is present in the log output.

The default is to obfuscate values in the CloudWatch logs.

createSlot_slotTypeId :: Lens' CreateSlot (Maybe Text) Source #

The unique identifier for the slot type associated with this slot. The slot type determines the values that can be entered into the slot.

createSlot_subSlotSetting :: Lens' CreateSlot (Maybe SubSlotSetting) Source #

Specifications for the constituent sub slots and the expression for the composite slot.

createSlot_slotName :: Lens' CreateSlot Text Source #

The name of the slot. Slot names must be unique within the bot that contains the slot.

createSlot_valueElicitationSetting :: Lens' CreateSlot SlotValueElicitationSetting Source #

Specifies prompts that Amazon Lex sends to the user to elicit a response that provides the value for the slot.

createSlot_botId :: Lens' CreateSlot Text Source #

The identifier of the bot associated with the slot.

createSlot_botVersion :: Lens' CreateSlot Text Source #

The version of the bot associated with the slot.

createSlot_localeId :: Lens' CreateSlot Text Source #

The identifier of the language and locale that the slot will be used in. The string must match one of the supported locales. All of the bots, intents, slot types used by the slot must have the same locale. For more information, see Supported languages.

createSlot_intentId :: Lens' CreateSlot Text Source #

The identifier of the intent that contains the slot.

Destructuring the Response

data CreateSlotResponse Source #

See: newCreateSlotResponse smart constructor.

Constructors

CreateSlotResponse'

Fields

botId :: Maybe Text
The unique identifier of the bot associated with the slot.
botVersion :: Maybe Text
The version of the bot associated with the slot.
creationDateTime :: Maybe POSIX
The timestamp of the date and time that the slot was created.
description :: Maybe Text
The description associated with the slot.
intentId :: Maybe Text
The unique identifier of the intent associated with the slot.
localeId :: Maybe Text
The language and local specified for the slot.
multipleValuesSetting :: Maybe MultipleValuesSetting
Indicates whether the slot returns multiple values in one response.
obfuscationSetting :: Maybe ObfuscationSetting
Indicates whether the slot is configured to obfuscate values in Amazon CloudWatch logs.
slotId :: Maybe Text
The unique identifier associated with the slot. Use this to identify the slot when you update or delete it.
slotName :: Maybe Text
The name specified for the slot.
slotTypeId :: Maybe Text
The unique identifier of the slot type associated with this slot.
subSlotSetting :: Maybe SubSlotSetting
Specifications for the constituent sub slots and the expression for the composite slot.
valueElicitationSetting :: Maybe SlotValueElicitationSetting
The value elicitation settings specified for the slot.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic CreateSlotResponse Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlot Associated Types type Rep CreateSlotResponse :: Type -> Type # Methods from :: CreateSlotResponse -> Rep CreateSlotResponse x # to :: Rep CreateSlotResponse x -> CreateSlotResponse #
Read CreateSlotResponse Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlot Methods readsPrec :: Int -> ReadS CreateSlotResponse # readList :: ReadS [CreateSlotResponse] # readPrec :: ReadPrec CreateSlotResponse # readListPrec :: ReadPrec [CreateSlotResponse] #
Show CreateSlotResponse Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlot Methods showsPrec :: Int -> CreateSlotResponse -> ShowS # show :: CreateSlotResponse -> String # showList :: [CreateSlotResponse] -> ShowS #
NFData CreateSlotResponse Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlot Methods rnf :: CreateSlotResponse -> () #
Eq CreateSlotResponse Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlot Methods (==) :: CreateSlotResponse -> CreateSlotResponse -> Bool # (/=) :: CreateSlotResponse -> CreateSlotResponse -> Bool #
type Rep CreateSlotResponse Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlot type Rep CreateSlotResponse = D1 ('MetaData "CreateSlotResponse" "Amazonka.LexV2Models.CreateSlot" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "CreateSlotResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "botId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "botVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "creationDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "intentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "localeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "multipleValuesSetting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MultipleValuesSetting))))) :: ((S1 ('MetaSel ('Just "obfuscationSetting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ObfuscationSetting)) :: (S1 ('MetaSel ('Just "slotId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "slotName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "slotTypeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "subSlotSetting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SubSlotSetting))) :: (S1 ('MetaSel ('Just "valueElicitationSetting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SlotValueElicitationSetting)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newCreateSlotResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateSlotResponse'`
-> CreateSlotResponse

Create a value of CreateSlotResponse 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:

CreateSlot, createSlotResponse_botId - The unique identifier of the bot associated with the slot.

CreateSlot, createSlotResponse_botVersion - The version of the bot associated with the slot.

CreateSlotResponse, createSlotResponse_creationDateTime - The timestamp of the date and time that the slot was created.

CreateSlot, createSlotResponse_description - The description associated with the slot.

CreateSlot, createSlotResponse_intentId - The unique identifier of the intent associated with the slot.

CreateSlot, createSlotResponse_localeId - The language and local specified for the slot.

CreateSlot, createSlotResponse_multipleValuesSetting - Indicates whether the slot returns multiple values in one response.

CreateSlot, createSlotResponse_obfuscationSetting - Indicates whether the slot is configured to obfuscate values in Amazon CloudWatch logs.

CreateSlotResponse, createSlotResponse_slotId - The unique identifier associated with the slot. Use this to identify the slot when you update or delete it.

CreateSlot, createSlotResponse_slotName - The name specified for the slot.

CreateSlot, createSlotResponse_slotTypeId - The unique identifier of the slot type associated with this slot.

CreateSlot, createSlotResponse_subSlotSetting - Specifications for the constituent sub slots and the expression for the composite slot.

CreateSlot, createSlotResponse_valueElicitationSetting - The value elicitation settings specified for the slot.

$sel:httpStatus:CreateSlotResponse', createSlotResponse_httpStatus - The response's http status code.

Response Lenses

createSlotResponse_botId :: Lens' CreateSlotResponse (Maybe Text) Source #

The unique identifier of the bot associated with the slot.

createSlotResponse_botVersion :: Lens' CreateSlotResponse (Maybe Text) Source #

The version of the bot associated with the slot.

createSlotResponse_creationDateTime :: Lens' CreateSlotResponse (Maybe UTCTime) Source #

The timestamp of the date and time that the slot was created.

createSlotResponse_description :: Lens' CreateSlotResponse (Maybe Text) Source #

The description associated with the slot.

createSlotResponse_intentId :: Lens' CreateSlotResponse (Maybe Text) Source #

The unique identifier of the intent associated with the slot.

createSlotResponse_localeId :: Lens' CreateSlotResponse (Maybe Text) Source #

The language and local specified for the slot.

createSlotResponse_multipleValuesSetting :: Lens' CreateSlotResponse (Maybe MultipleValuesSetting) Source #

Indicates whether the slot returns multiple values in one response.

createSlotResponse_obfuscationSetting :: Lens' CreateSlotResponse (Maybe ObfuscationSetting) Source #

Indicates whether the slot is configured to obfuscate values in Amazon CloudWatch logs.

createSlotResponse_slotId :: Lens' CreateSlotResponse (Maybe Text) Source #

The unique identifier associated with the slot. Use this to identify the slot when you update or delete it.

createSlotResponse_slotName :: Lens' CreateSlotResponse (Maybe Text) Source #

The name specified for the slot.

createSlotResponse_slotTypeId :: Lens' CreateSlotResponse (Maybe Text) Source #

The unique identifier of the slot type associated with this slot.

createSlotResponse_subSlotSetting :: Lens' CreateSlotResponse (Maybe SubSlotSetting) Source #

Specifications for the constituent sub slots and the expression for the composite slot.

createSlotResponse_valueElicitationSetting :: Lens' CreateSlotResponse (Maybe SlotValueElicitationSetting) Source #

The value elicitation settings specified for the slot.

createSlotResponse_httpStatus :: Lens' CreateSlotResponse Int Source #

The response's http status code.