Network.AWS.LexModels.PutSlotType

Creates a custom slot type or replaces an existing custom slot type.

To create a custom slot type, specify a name for the slot type and a set of enumeration values, which are the values that a slot of this type can assume. For more information, see 'how-it-works' .

If you specify the name of an existing slot type, the fields in the request replace the existing values in the > LATEST version of the slot type. Amazon Lex removes the fields that you don't provide in the request. If you don't specify required fields, Amazon Lex throws an exception. When you update the > LATEST version of a slot type, if a bot uses the > LATEST version of an intent that contains the slot type, the bot's status field is set to NOT_BUILT .

This operation requires permissions for the lex:PutSlotType action.

Creating a Request

putSlotType

Arguments

:: Text

pstName

-> PutSlotType

Creates a value of PutSlotType with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• pstChecksum - Identifies a specific revision of the > LATEST version. When you create a new slot type, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception. When you want to update a slot type, set the checksum field to the checksum of the most recent revision of the > LATEST version. If you don't specify the checksum field, or if the checksum does not match the > LATEST version, you get a PreconditionFailedException exception.
• pstValueSelectionStrategy - Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values: * ORIGINAL_VALUE - Returns the value entered by the user, if the user value is similar to the slot value. * TOP_RESOLUTION - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned. If you don't specify the valueSelectionStrategy , the default is ORIGINAL_VALUE .
• pstCreateVersion - Undocumented member.
• pstDescription - A description of the slot type.
• pstEnumerationValues - A list of EnumerationValue objects that defines the values that the slot type can take. Each value can have a list of synonyms , which are additional values that help train the machine learning model about the values that it resolves for a slot. When Amazon Lex resolves a slot value, it generates a resolution list that contains up to five possible values for the slot. If you are using a Lambda function, this resolution list is passed to the function. If you are not using a Lambda function you can choose to return the value that the user entered or the first value in the resolution list as the slot value. The valueSelectionStrategy field indicates the option to use.
• pstName - The name of the slot type. The name is not case sensitive. The name can't match a built-in slot type name, or a built-in slot type name with "AMAZON." removed. For example, because there is a built-in slot type called AMAZON.DATE , you can't create a custom slot type called DATE . For a list of built-in slot types, see Slot Type Reference in the Alexa Skills Kit .

data PutSlotType

See: putSlotType smart constructor.

Instances

Eq PutSlotType

Methods

(==) :: PutSlotType -> PutSlotType -> Bool

(/=) :: PutSlotType -> PutSlotType -> Bool

Data PutSlotType

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PutSlotType -> c PutSlotType

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PutSlotType

toConstr :: PutSlotType -> Constr

dataTypeOf :: PutSlotType -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c PutSlotType)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PutSlotType)

gmapT :: (forall b. Data b => b -> b) -> PutSlotType -> PutSlotType

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PutSlotType -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PutSlotType -> r

gmapQ :: (forall d. Data d => d -> u) -> PutSlotType -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> PutSlotType -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PutSlotType -> m PutSlotType

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PutSlotType -> m PutSlotType

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PutSlotType -> m PutSlotType

Read PutSlotType

Methods

readsPrec :: Int -> ReadS PutSlotType

readList :: ReadS [PutSlotType]

readPrec :: ReadPrec PutSlotType

readListPrec :: ReadPrec [PutSlotType]

Show PutSlotType

Methods

showsPrec :: Int -> PutSlotType -> ShowS

show :: PutSlotType -> String

showList :: [PutSlotType] -> ShowS

Generic PutSlotType

Associated Types

type Rep PutSlotType :: * -> *

Methods

from :: PutSlotType -> Rep PutSlotType x

to :: Rep PutSlotType x -> PutSlotType

Hashable PutSlotType

Methods

hashWithSalt :: Int -> PutSlotType -> Int

hash :: PutSlotType -> Int

ToJSON PutSlotType

Methods

toJSON :: PutSlotType -> Value

toEncoding :: PutSlotType -> Encoding

toJSONList :: [PutSlotType] -> Value

toEncodingList :: [PutSlotType] -> Encoding

NFData PutSlotType

Methods

rnf :: PutSlotType -> ()

AWSRequest PutSlotType

Associated Types

type Rs PutSlotType :: *

Methods

request :: PutSlotType -> Request PutSlotType

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * PutSlotType -> ClientResponse -> m (Response PutSlotType)

ToHeaders PutSlotType

Methods

toHeaders :: PutSlotType -> [Header]

ToPath PutSlotType

Methods

toPath :: PutSlotType -> ByteString

ToQuery PutSlotType

Methods

toQuery :: PutSlotType -> QueryString

type Rep PutSlotType

type Rep PutSlotType = D1 * (MetaData "PutSlotType" "Network.AWS.LexModels.PutSlotType" "amazonka-lex-models-1.6.0-Iv3mghdDvOI9Mj0nI0DuS4" False) (C1 * (MetaCons "PutSlotType'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_pstChecksum") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_pstValueSelectionStrategy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe SlotValueSelectionStrategy))) (S1 * (MetaSel (Just Symbol "_pstCreateVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_pstDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_pstEnumerationValues") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (List1 EnumerationValue)))) (S1 * (MetaSel (Just Symbol "_pstName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))

type Rs PutSlotType

type Rs PutSlotType = PutSlotTypeResponse

Request Lenses

pstChecksum :: Lens' PutSlotType (Maybe Text)

Identifies a specific revision of the > LATEST version. When you create a new slot type, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception. When you want to update a slot type, set the checksum field to the checksum of the most recent revision of the > LATEST version. If you don't specify the checksum field, or if the checksum does not match the > LATEST version, you get a PreconditionFailedException exception.

pstValueSelectionStrategy :: Lens' PutSlotType (Maybe SlotValueSelectionStrategy)

Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values: * ORIGINAL_VALUE - Returns the value entered by the user, if the user value is similar to the slot value. * TOP_RESOLUTION - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned. If you don't specify the valueSelectionStrategy , the default is ORIGINAL_VALUE .

pstCreateVersion :: Lens' PutSlotType (Maybe Bool)

Undocumented member.

pstDescription :: Lens' PutSlotType (Maybe Text)

A description of the slot type.

pstEnumerationValues :: Lens' PutSlotType (Maybe (NonEmpty EnumerationValue))

A list of EnumerationValue objects that defines the values that the slot type can take. Each value can have a list of synonyms , which are additional values that help train the machine learning model about the values that it resolves for a slot. When Amazon Lex resolves a slot value, it generates a resolution list that contains up to five possible values for the slot. If you are using a Lambda function, this resolution list is passed to the function. If you are not using a Lambda function you can choose to return the value that the user entered or the first value in the resolution list as the slot value. The valueSelectionStrategy field indicates the option to use.

pstName :: Lens' PutSlotType Text

The name of the slot type. The name is not case sensitive. The name can't match a built-in slot type name, or a built-in slot type name with "AMAZON." removed. For example, because there is a built-in slot type called AMAZON.DATE , you can't create a custom slot type called DATE . For a list of built-in slot types, see Slot Type Reference in the Alexa Skills Kit .

Destructuring the Response

putSlotTypeResponse

Arguments

:: Int

pstrsResponseStatus

-> PutSlotTypeResponse

Creates a value of PutSlotTypeResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• pstrsChecksum - Checksum of the > LATEST version of the slot type.
• pstrsValueSelectionStrategy - The slot resolution strategy that Amazon Lex uses to determine the value of the slot. For more information, see PutSlotType .
• pstrsCreatedDate - The date that the slot type was created.
• pstrsName - The name of the slot type.
• pstrsVersion - The version of the slot type. For a new slot type, the version is always > LATEST .
• pstrsLastUpdatedDate - The date that the slot type was updated. When you create a slot type, the creation date and last update date are the same.
• pstrsCreateVersion - Undocumented member.
• pstrsDescription - A description of the slot type.
• pstrsEnumerationValues - A list of EnumerationValue objects that defines the values that the slot type can take.
• pstrsResponseStatus - -- | The response status code.

data PutSlotTypeResponse

See: putSlotTypeResponse smart constructor.

Instances

Eq PutSlotTypeResponse

Methods

(==) :: PutSlotTypeResponse -> PutSlotTypeResponse -> Bool

(/=) :: PutSlotTypeResponse -> PutSlotTypeResponse -> Bool

Data PutSlotTypeResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PutSlotTypeResponse -> c PutSlotTypeResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PutSlotTypeResponse

toConstr :: PutSlotTypeResponse -> Constr

dataTypeOf :: PutSlotTypeResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c PutSlotTypeResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PutSlotTypeResponse)

gmapT :: (forall b. Data b => b -> b) -> PutSlotTypeResponse -> PutSlotTypeResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PutSlotTypeResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PutSlotTypeResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> PutSlotTypeResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> PutSlotTypeResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PutSlotTypeResponse -> m PutSlotTypeResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PutSlotTypeResponse -> m PutSlotTypeResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PutSlotTypeResponse -> m PutSlotTypeResponse

Read PutSlotTypeResponse

Methods

readsPrec :: Int -> ReadS PutSlotTypeResponse

readList :: ReadS [PutSlotTypeResponse]

readPrec :: ReadPrec PutSlotTypeResponse

readListPrec :: ReadPrec [PutSlotTypeResponse]

Show PutSlotTypeResponse

Methods

showsPrec :: Int -> PutSlotTypeResponse -> ShowS

show :: PutSlotTypeResponse -> String

showList :: [PutSlotTypeResponse] -> ShowS

Generic PutSlotTypeResponse

Associated Types

type Rep PutSlotTypeResponse :: * -> *

Methods

from :: PutSlotTypeResponse -> Rep PutSlotTypeResponse x

to :: Rep PutSlotTypeResponse x -> PutSlotTypeResponse

NFData PutSlotTypeResponse

Methods

rnf :: PutSlotTypeResponse -> ()

type Rep PutSlotTypeResponse

type Rep PutSlotTypeResponse = D1 * (MetaData "PutSlotTypeResponse" "Network.AWS.LexModels.PutSlotType" "amazonka-lex-models-1.6.0-Iv3mghdDvOI9Mj0nI0DuS4" False) (C1 * (MetaCons "PutSlotTypeResponse'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_pstrsChecksum") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_pstrsValueSelectionStrategy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe SlotValueSelectionStrategy)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_pstrsCreatedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX))) ((:*:) * (S1 * (MetaSel (Just Symbol "_pstrsName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_pstrsVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_pstrsLastUpdatedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX))) (S1 * (MetaSel (Just Symbol "_pstrsCreateVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_pstrsDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_pstrsEnumerationValues") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (List1 EnumerationValue)))) (S1 * (MetaSel (Just Symbol "_pstrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))))

Response Lenses

pstrsChecksum :: Lens' PutSlotTypeResponse (Maybe Text)

Checksum of the > LATEST version of the slot type.

pstrsValueSelectionStrategy :: Lens' PutSlotTypeResponse (Maybe SlotValueSelectionStrategy)

The slot resolution strategy that Amazon Lex uses to determine the value of the slot. For more information, see PutSlotType .

pstrsCreatedDate :: Lens' PutSlotTypeResponse (Maybe UTCTime)

The date that the slot type was created.

pstrsName :: Lens' PutSlotTypeResponse (Maybe Text)

The name of the slot type.

pstrsVersion :: Lens' PutSlotTypeResponse (Maybe Text)

The version of the slot type. For a new slot type, the version is always > LATEST .

pstrsLastUpdatedDate :: Lens' PutSlotTypeResponse (Maybe UTCTime)

The date that the slot type was updated. When you create a slot type, the creation date and last update date are the same.

pstrsCreateVersion :: Lens' PutSlotTypeResponse (Maybe Bool)

Undocumented member.

pstrsDescription :: Lens' PutSlotTypeResponse (Maybe Text)

A description of the slot type.

pstrsEnumerationValues :: Lens' PutSlotTypeResponse (Maybe (NonEmpty EnumerationValue))

A list of EnumerationValue objects that defines the values that the slot type can take.

pstrsResponseStatus :: Lens' PutSlotTypeResponse Int

• - | The response status code.