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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a custom slot type

To create a custom slot type, specify a name for the slot type and a set of enumeration values, the values that a slot of this type can assume.

Synopsis

data CreateSlotType = CreateSlotType' {
- compositeSlotTypeSetting :: Maybe CompositeSlotTypeSetting
- description :: Maybe Text
- externalSourceSetting :: Maybe ExternalSourceSetting
- parentSlotTypeSignature :: Maybe Text
- slotTypeValues :: Maybe (NonEmpty SlotTypeValue)
- valueSelectionSetting :: Maybe SlotValueSelectionSetting
- slotTypeName :: Text
- botId :: Text
- botVersion :: Text
- localeId :: Text
}
newCreateSlotType :: Text -> Text -> Text -> Text -> CreateSlotType
createSlotType_compositeSlotTypeSetting :: Lens' CreateSlotType (Maybe CompositeSlotTypeSetting)
createSlotType_description :: Lens' CreateSlotType (Maybe Text)
createSlotType_externalSourceSetting :: Lens' CreateSlotType (Maybe ExternalSourceSetting)
createSlotType_parentSlotTypeSignature :: Lens' CreateSlotType (Maybe Text)
createSlotType_slotTypeValues :: Lens' CreateSlotType (Maybe (NonEmpty SlotTypeValue))
createSlotType_valueSelectionSetting :: Lens' CreateSlotType (Maybe SlotValueSelectionSetting)
createSlotType_slotTypeName :: Lens' CreateSlotType Text
createSlotType_botId :: Lens' CreateSlotType Text
createSlotType_botVersion :: Lens' CreateSlotType Text
createSlotType_localeId :: Lens' CreateSlotType Text
data CreateSlotTypeResponse = CreateSlotTypeResponse' {
- botId :: Maybe Text
- botVersion :: Maybe Text
- compositeSlotTypeSetting :: Maybe CompositeSlotTypeSetting
- creationDateTime :: Maybe POSIX
- description :: Maybe Text
- externalSourceSetting :: Maybe ExternalSourceSetting
- localeId :: Maybe Text
- parentSlotTypeSignature :: Maybe Text
- slotTypeId :: Maybe Text
- slotTypeName :: Maybe Text
- slotTypeValues :: Maybe (NonEmpty SlotTypeValue)
- valueSelectionSetting :: Maybe SlotValueSelectionSetting
- httpStatus :: Int
}
newCreateSlotTypeResponse :: Int -> CreateSlotTypeResponse
createSlotTypeResponse_botId :: Lens' CreateSlotTypeResponse (Maybe Text)
createSlotTypeResponse_botVersion :: Lens' CreateSlotTypeResponse (Maybe Text)
createSlotTypeResponse_compositeSlotTypeSetting :: Lens' CreateSlotTypeResponse (Maybe CompositeSlotTypeSetting)
createSlotTypeResponse_creationDateTime :: Lens' CreateSlotTypeResponse (Maybe UTCTime)
createSlotTypeResponse_description :: Lens' CreateSlotTypeResponse (Maybe Text)
createSlotTypeResponse_externalSourceSetting :: Lens' CreateSlotTypeResponse (Maybe ExternalSourceSetting)
createSlotTypeResponse_localeId :: Lens' CreateSlotTypeResponse (Maybe Text)
createSlotTypeResponse_parentSlotTypeSignature :: Lens' CreateSlotTypeResponse (Maybe Text)
createSlotTypeResponse_slotTypeId :: Lens' CreateSlotTypeResponse (Maybe Text)
createSlotTypeResponse_slotTypeName :: Lens' CreateSlotTypeResponse (Maybe Text)
createSlotTypeResponse_slotTypeValues :: Lens' CreateSlotTypeResponse (Maybe (NonEmpty SlotTypeValue))
createSlotTypeResponse_valueSelectionSetting :: Lens' CreateSlotTypeResponse (Maybe SlotValueSelectionSetting)
createSlotTypeResponse_httpStatus :: Lens' CreateSlotTypeResponse Int

Creating a Request

data CreateSlotType Source #

See: newCreateSlotType smart constructor.

Constructors

CreateSlotType'

Fields

compositeSlotTypeSetting :: Maybe CompositeSlotTypeSetting
Specifications for a composite slot type.
description :: Maybe Text
A description of the slot type. Use the description to help identify the slot type in lists.
externalSourceSetting :: Maybe ExternalSourceSetting
Sets the type of external information used to create the slot type.
parentSlotTypeSignature :: Maybe Text
The built-in slot type used as a parent of this slot type. When you define a parent slot type, the new slot type has the configuration of the parent slot type.
Only AMAZON.AlphaNumeric is supported.
slotTypeValues :: Maybe (NonEmpty SlotTypeValue)
A list of SlotTypeValue objects that defines the values that the slot type can take. Each value can have a list of synonyms, additional values that help train the machine learning model about the values that it resolves for a slot.
valueSelectionSetting :: Maybe SlotValueSelectionSetting
Determines the strategy that Amazon Lex uses to select a value from the list of possible values. The field can be set to one of the following values:
- OriginalValue - Returns the value entered by the user, if the user value is similar to the slot value.
- TopResolution - If there is a resolution list for the slot, return the first value in the resolution list. If there is no resolution list, return null.
If you don't specify the valueSelectionSetting parameter, the default is OriginalValue.
slotTypeName :: Text
The name for the slot. A slot type name must be unique within the account.
botId :: Text
The identifier of the bot associated with this slot type.
botVersion :: Text
The identifier of the bot version associated with this slot type.
localeId :: Text
The identifier of the language and locale that the slot type will be used in. The string must match one of the supported locales. All of the bots, intents, and slots used by the slot type must have the same locale. For more information, see Supported languages.

Instances

Instances details

ToJSON CreateSlotType Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlotType Methods toJSON :: CreateSlotType -> Value # toEncoding :: CreateSlotType -> Encoding # toJSONList :: [CreateSlotType] -> Value # toEncodingList :: [CreateSlotType] -> Encoding #
ToHeaders CreateSlotType Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlotType Methods toHeaders :: CreateSlotType -> [Header] #
ToPath CreateSlotType Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlotType Methods toPath :: CreateSlotType -> ByteString #
ToQuery CreateSlotType Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlotType Methods toQuery :: CreateSlotType -> QueryString #
AWSRequest CreateSlotType Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlotType Associated Types type AWSResponse CreateSlotType # Methods request :: (Service -> Service) -> CreateSlotType -> Request CreateSlotType # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateSlotType -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateSlotType))) #
Generic CreateSlotType Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlotType Associated Types type Rep CreateSlotType :: Type -> Type # Methods from :: CreateSlotType -> Rep CreateSlotType x # to :: Rep CreateSlotType x -> CreateSlotType #
Read CreateSlotType Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlotType Methods readsPrec :: Int -> ReadS CreateSlotType # readList :: ReadS [CreateSlotType] # readPrec :: ReadPrec CreateSlotType # readListPrec :: ReadPrec [CreateSlotType] #
Show CreateSlotType Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlotType Methods showsPrec :: Int -> CreateSlotType -> ShowS # show :: CreateSlotType -> String # showList :: [CreateSlotType] -> ShowS #
NFData CreateSlotType Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlotType Methods rnf :: CreateSlotType -> () #
Eq CreateSlotType Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlotType Methods (==) :: CreateSlotType -> CreateSlotType -> Bool # (/=) :: CreateSlotType -> CreateSlotType -> Bool #
Hashable CreateSlotType Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlotType Methods hashWithSalt :: Int -> CreateSlotType -> Int # hash :: CreateSlotType -> Int #
type AWSResponse CreateSlotType Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlotType type AWSResponse CreateSlotType = CreateSlotTypeResponse
type Rep CreateSlotType Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlotType type Rep CreateSlotType = D1 ('MetaData "CreateSlotType" "Amazonka.LexV2Models.CreateSlotType" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "CreateSlotType'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "compositeSlotTypeSetting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CompositeSlotTypeSetting)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "externalSourceSetting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExternalSourceSetting)) :: (S1 ('MetaSel ('Just "parentSlotTypeSignature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "slotTypeValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty SlotTypeValue)))))) :: ((S1 ('MetaSel ('Just "valueSelectionSetting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SlotValueSelectionSetting)) :: S1 ('MetaSel ('Just "slotTypeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (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))))))

newCreateSlotType Source #

Arguments

:: Text	`CreateSlotType`
-> Text	`CreateSlotType`
-> Text	`CreateSlotType`
-> Text	`CreateSlotType`
-> CreateSlotType

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

CreateSlotType, createSlotType_compositeSlotTypeSetting - Specifications for a composite slot type.

CreateSlotType, createSlotType_description - A description of the slot type. Use the description to help identify the slot type in lists.

CreateSlotType, createSlotType_externalSourceSetting - Sets the type of external information used to create the slot type.

CreateSlotType, createSlotType_parentSlotTypeSignature - The built-in slot type used as a parent of this slot type. When you define a parent slot type, the new slot type has the configuration of the parent slot type.

Only AMAZON.AlphaNumeric is supported.

CreateSlotType, createSlotType_slotTypeValues - A list of SlotTypeValue objects that defines the values that the slot type can take. Each value can have a list of synonyms, additional values that help train the machine learning model about the values that it resolves for a slot.

CreateSlotType, createSlotType_valueSelectionSetting - Determines the strategy that Amazon Lex uses to select a value from the list of possible values. The field can be set to one of the following values:

OriginalValue - Returns the value entered by the user, if the user value is similar to the slot value.
TopResolution - If there is a resolution list for the slot, return the first value in the resolution list. If there is no resolution list, return null.

If you don't specify the valueSelectionSetting parameter, the default is OriginalValue.

CreateSlotType, createSlotType_slotTypeName - The name for the slot. A slot type name must be unique within the account.

CreateSlotType, createSlotType_botId - The identifier of the bot associated with this slot type.

CreateSlotType, createSlotType_botVersion - The identifier of the bot version associated with this slot type.

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

Request Lenses

createSlotType_compositeSlotTypeSetting :: Lens' CreateSlotType (Maybe CompositeSlotTypeSetting) Source #

Specifications for a composite slot type.

createSlotType_description :: Lens' CreateSlotType (Maybe Text) Source #

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

createSlotType_externalSourceSetting :: Lens' CreateSlotType (Maybe ExternalSourceSetting) Source #

Sets the type of external information used to create the slot type.

createSlotType_parentSlotTypeSignature :: Lens' CreateSlotType (Maybe Text) Source #

The built-in slot type used as a parent of this slot type. When you define a parent slot type, the new slot type has the configuration of the parent slot type.

Only AMAZON.AlphaNumeric is supported.

createSlotType_slotTypeValues :: Lens' CreateSlotType (Maybe (NonEmpty SlotTypeValue)) Source #

A list of SlotTypeValue objects that defines the values that the slot type can take. Each value can have a list of synonyms, additional values that help train the machine learning model about the values that it resolves for a slot.

createSlotType_valueSelectionSetting :: Lens' CreateSlotType (Maybe SlotValueSelectionSetting) Source #

Determines the strategy that Amazon Lex uses to select a value from the list of possible values. The field can be set to one of the following values:

OriginalValue - Returns the value entered by the user, if the user value is similar to the slot value.
TopResolution - If there is a resolution list for the slot, return the first value in the resolution list. If there is no resolution list, return null.

If you don't specify the valueSelectionSetting parameter, the default is OriginalValue.

createSlotType_slotTypeName :: Lens' CreateSlotType Text Source #

The name for the slot. A slot type name must be unique within the account.

createSlotType_botId :: Lens' CreateSlotType Text Source #

The identifier of the bot associated with this slot type.

createSlotType_botVersion :: Lens' CreateSlotType Text Source #

The identifier of the bot version associated with this slot type.

createSlotType_localeId :: Lens' CreateSlotType Text Source #

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

Destructuring the Response

data CreateSlotTypeResponse Source #

See: newCreateSlotTypeResponse smart constructor.

Constructors

CreateSlotTypeResponse'

Fields

botId :: Maybe Text
The identifier for the bot associated with the slot type.
botVersion :: Maybe Text
The version of the bot associated with the slot type.
compositeSlotTypeSetting :: Maybe CompositeSlotTypeSetting
Specifications for a composite slot type.
creationDateTime :: Maybe POSIX
A timestamp of the date and time that the slot type was created.
description :: Maybe Text
The description specified for the slot type.
externalSourceSetting :: Maybe ExternalSourceSetting
The type of external information used to create the slot type.
localeId :: Maybe Text
The specified language and local specified for the slot type.
parentSlotTypeSignature :: Maybe Text
The signature of the base slot type specified for the slot type.
slotTypeId :: Maybe Text
The unique identifier assigned to the slot type. Use this to identify the slot type in the UpdateSlotType and DeleteSlotType operations.
slotTypeName :: Maybe Text
The name specified for the slot type.
slotTypeValues :: Maybe (NonEmpty SlotTypeValue)
The list of values that the slot type can assume.
valueSelectionSetting :: Maybe SlotValueSelectionSetting
The strategy that Amazon Lex uses to select a value from the list of possible values.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic CreateSlotTypeResponse Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlotType Associated Types type Rep CreateSlotTypeResponse :: Type -> Type # Methods from :: CreateSlotTypeResponse -> Rep CreateSlotTypeResponse x # to :: Rep CreateSlotTypeResponse x -> CreateSlotTypeResponse #
Read CreateSlotTypeResponse Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlotType Methods readsPrec :: Int -> ReadS CreateSlotTypeResponse # readList :: ReadS [CreateSlotTypeResponse] # readPrec :: ReadPrec CreateSlotTypeResponse # readListPrec :: ReadPrec [CreateSlotTypeResponse] #
Show CreateSlotTypeResponse Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlotType Methods showsPrec :: Int -> CreateSlotTypeResponse -> ShowS # show :: CreateSlotTypeResponse -> String # showList :: [CreateSlotTypeResponse] -> ShowS #
NFData CreateSlotTypeResponse Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlotType Methods rnf :: CreateSlotTypeResponse -> () #
Eq CreateSlotTypeResponse Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlotType Methods (==) :: CreateSlotTypeResponse -> CreateSlotTypeResponse -> Bool # (/=) :: CreateSlotTypeResponse -> CreateSlotTypeResponse -> Bool #
type Rep CreateSlotTypeResponse Source #
Instance details Defined in Amazonka.LexV2Models.CreateSlotType type Rep CreateSlotTypeResponse = D1 ('MetaData "CreateSlotTypeResponse" "Amazonka.LexV2Models.CreateSlotType" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "CreateSlotTypeResponse'" '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 "compositeSlotTypeSetting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CompositeSlotTypeSetting)))) :: (S1 ('MetaSel ('Just "creationDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "externalSourceSetting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExternalSourceSetting))))) :: ((S1 ('MetaSel ('Just "localeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "parentSlotTypeSignature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "slotTypeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "slotTypeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "slotTypeValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty SlotTypeValue)))) :: (S1 ('MetaSel ('Just "valueSelectionSetting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SlotValueSelectionSetting)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newCreateSlotTypeResponse Source #

Arguments

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

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

CreateSlotType, createSlotTypeResponse_botId - The identifier for the bot associated with the slot type.

CreateSlotType, createSlotTypeResponse_botVersion - The version of the bot associated with the slot type.

CreateSlotType, createSlotTypeResponse_compositeSlotTypeSetting - Specifications for a composite slot type.

CreateSlotTypeResponse, createSlotTypeResponse_creationDateTime - A timestamp of the date and time that the slot type was created.

CreateSlotType, createSlotTypeResponse_description - The description specified for the slot type.

CreateSlotType, createSlotTypeResponse_externalSourceSetting - The type of external information used to create the slot type.

CreateSlotType, createSlotTypeResponse_localeId - The specified language and local specified for the slot type.

CreateSlotType, createSlotTypeResponse_parentSlotTypeSignature - The signature of the base slot type specified for the slot type.

CreateSlotTypeResponse, createSlotTypeResponse_slotTypeId - The unique identifier assigned to the slot type. Use this to identify the slot type in the UpdateSlotType and DeleteSlotType operations.

CreateSlotType, createSlotTypeResponse_slotTypeName - The name specified for the slot type.

CreateSlotType, createSlotTypeResponse_slotTypeValues - The list of values that the slot type can assume.

CreateSlotType, createSlotTypeResponse_valueSelectionSetting - The strategy that Amazon Lex uses to select a value from the list of possible values.

$sel:httpStatus:CreateSlotTypeResponse', createSlotTypeResponse_httpStatus - The response's http status code.