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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets metadata information about a slot.

Synopsis

data DescribeSlot = DescribeSlot' {
- slotId :: Text
- botId :: Text
- botVersion :: Text
- localeId :: Text
- intentId :: Text
}
newDescribeSlot :: Text -> Text -> Text -> Text -> Text -> DescribeSlot
describeSlot_slotId :: Lens' DescribeSlot Text
describeSlot_botId :: Lens' DescribeSlot Text
describeSlot_botVersion :: Lens' DescribeSlot Text
describeSlot_localeId :: Lens' DescribeSlot Text
describeSlot_intentId :: Lens' DescribeSlot Text
data DescribeSlotResponse = DescribeSlotResponse' {
- botId :: Maybe Text
- botVersion :: Maybe Text
- creationDateTime :: Maybe POSIX
- description :: Maybe Text
- intentId :: Maybe Text
- lastUpdatedDateTime :: Maybe POSIX
- 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
}
newDescribeSlotResponse :: Int -> DescribeSlotResponse
describeSlotResponse_botId :: Lens' DescribeSlotResponse (Maybe Text)
describeSlotResponse_botVersion :: Lens' DescribeSlotResponse (Maybe Text)
describeSlotResponse_creationDateTime :: Lens' DescribeSlotResponse (Maybe UTCTime)
describeSlotResponse_description :: Lens' DescribeSlotResponse (Maybe Text)
describeSlotResponse_intentId :: Lens' DescribeSlotResponse (Maybe Text)
describeSlotResponse_lastUpdatedDateTime :: Lens' DescribeSlotResponse (Maybe UTCTime)
describeSlotResponse_localeId :: Lens' DescribeSlotResponse (Maybe Text)
describeSlotResponse_multipleValuesSetting :: Lens' DescribeSlotResponse (Maybe MultipleValuesSetting)
describeSlotResponse_obfuscationSetting :: Lens' DescribeSlotResponse (Maybe ObfuscationSetting)
describeSlotResponse_slotId :: Lens' DescribeSlotResponse (Maybe Text)
describeSlotResponse_slotName :: Lens' DescribeSlotResponse (Maybe Text)
describeSlotResponse_slotTypeId :: Lens' DescribeSlotResponse (Maybe Text)
describeSlotResponse_subSlotSetting :: Lens' DescribeSlotResponse (Maybe SubSlotSetting)
describeSlotResponse_valueElicitationSetting :: Lens' DescribeSlotResponse (Maybe SlotValueElicitationSetting)
describeSlotResponse_httpStatus :: Lens' DescribeSlotResponse Int

Creating a Request

data DescribeSlot Source #

See: newDescribeSlot smart constructor.

Constructors

DescribeSlot'

Fields

slotId :: Text
The unique identifier 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 of the slot to describe. The string must match one of the supported locales. For more information, see Supported languages.
intentId :: Text
The identifier of the intent that contains the slot.

Instances

Instances details

ToHeaders DescribeSlot Source #
Instance details Defined in Amazonka.LexV2Models.DescribeSlot Methods toHeaders :: DescribeSlot -> [Header] #
ToPath DescribeSlot Source #
Instance details Defined in Amazonka.LexV2Models.DescribeSlot Methods toPath :: DescribeSlot -> ByteString #
ToQuery DescribeSlot Source #
Instance details Defined in Amazonka.LexV2Models.DescribeSlot Methods toQuery :: DescribeSlot -> QueryString #
AWSRequest DescribeSlot Source #
Instance details Defined in Amazonka.LexV2Models.DescribeSlot Associated Types type AWSResponse DescribeSlot # Methods request :: (Service -> Service) -> DescribeSlot -> Request DescribeSlot # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeSlot -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeSlot))) #
Generic DescribeSlot Source #
Instance details Defined in Amazonka.LexV2Models.DescribeSlot Associated Types type Rep DescribeSlot :: Type -> Type # Methods from :: DescribeSlot -> Rep DescribeSlot x # to :: Rep DescribeSlot x -> DescribeSlot #
Read DescribeSlot Source #
Instance details Defined in Amazonka.LexV2Models.DescribeSlot Methods readsPrec :: Int -> ReadS DescribeSlot # readList :: ReadS [DescribeSlot] # readPrec :: ReadPrec DescribeSlot # readListPrec :: ReadPrec [DescribeSlot] #
Show DescribeSlot Source #
Instance details Defined in Amazonka.LexV2Models.DescribeSlot Methods showsPrec :: Int -> DescribeSlot -> ShowS # show :: DescribeSlot -> String # showList :: [DescribeSlot] -> ShowS #
NFData DescribeSlot Source #
Instance details Defined in Amazonka.LexV2Models.DescribeSlot Methods rnf :: DescribeSlot -> () #
Eq DescribeSlot Source #
Instance details Defined in Amazonka.LexV2Models.DescribeSlot Methods (==) :: DescribeSlot -> DescribeSlot -> Bool # (/=) :: DescribeSlot -> DescribeSlot -> Bool #
Hashable DescribeSlot Source #
Instance details Defined in Amazonka.LexV2Models.DescribeSlot Methods hashWithSalt :: Int -> DescribeSlot -> Int # hash :: DescribeSlot -> Int #
type AWSResponse DescribeSlot Source #
Instance details Defined in Amazonka.LexV2Models.DescribeSlot type AWSResponse DescribeSlot = DescribeSlotResponse
type Rep DescribeSlot Source #
Instance details Defined in Amazonka.LexV2Models.DescribeSlot type Rep DescribeSlot = D1 ('MetaData "DescribeSlot" "Amazonka.LexV2Models.DescribeSlot" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "DescribeSlot'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "slotId") '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) :: S1 ('MetaSel ('Just "intentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newDescribeSlot Source #

Arguments

:: Text	`DescribeSlot`
-> Text	`DescribeSlot`
-> Text	`DescribeSlot`
-> Text	`DescribeSlot`
-> Text	`DescribeSlot`
-> DescribeSlot

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

DescribeSlot, describeSlot_slotId - The unique identifier for the slot.

DescribeSlot, describeSlot_botId - The identifier of the bot associated with the slot.

DescribeSlot, describeSlot_botVersion - The version of the bot associated with the slot.

DescribeSlot, describeSlot_localeId - The identifier of the language and locale of the slot to describe. The string must match one of the supported locales. For more information, see Supported languages.

DescribeSlot, describeSlot_intentId - The identifier of the intent that contains the slot.

Request Lenses

describeSlot_slotId :: Lens' DescribeSlot Text Source #

The unique identifier for the slot.

describeSlot_botId :: Lens' DescribeSlot Text Source #

The identifier of the bot associated with the slot.

describeSlot_botVersion :: Lens' DescribeSlot Text Source #

The version of the bot associated with the slot.

describeSlot_localeId :: Lens' DescribeSlot Text Source #

The identifier of the language and locale of the slot to describe. The string must match one of the supported locales. For more information, see Supported languages.

describeSlot_intentId :: Lens' DescribeSlot Text Source #

The identifier of the intent that contains the slot.

Destructuring the Response

data DescribeSlotResponse Source #

See: newDescribeSlotResponse smart constructor.

Constructors

DescribeSlotResponse'

Fields

botId :: Maybe Text
The identifier of the bot associated with the slot.
botVersion :: Maybe Text
The version of the bot associated with the slot.
creationDateTime :: Maybe POSIX
A timestamp of the date and time that the slot was created.
description :: Maybe Text
The description specified for the slot.
intentId :: Maybe Text
The identifier of the intent associated with the slot.
lastUpdatedDateTime :: Maybe POSIX
A timestamp of the date and time that the slot was last updated.
localeId :: Maybe Text
The language and locale specified for the slot.
multipleValuesSetting :: Maybe MultipleValuesSetting
Indicates whether the slot accepts multiple values in a single utterance.
If the multipleValuesSetting is not set, the default value is false.
obfuscationSetting :: Maybe ObfuscationSetting
Whether slot values are shown in Amazon CloudWatch logs. If the value is None, the actual value of the slot is shown in logs.
slotId :: Maybe Text
The unique identifier generated for the slot.
slotName :: Maybe Text
The name specified for the slot.
slotTypeId :: Maybe Text
The identifier of the slot type that determines the values entered into the slot.
subSlotSetting :: Maybe SubSlotSetting
Specifications for the constituent sub slots and the expression for the composite slot.
valueElicitationSetting :: Maybe SlotValueElicitationSetting
Prompts that Amazon Lex uses to elicit a value for the slot.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeSlotResponse Source #
Instance details Defined in Amazonka.LexV2Models.DescribeSlot Associated Types type Rep DescribeSlotResponse :: Type -> Type # Methods from :: DescribeSlotResponse -> Rep DescribeSlotResponse x # to :: Rep DescribeSlotResponse x -> DescribeSlotResponse #
Read DescribeSlotResponse Source #
Instance details Defined in Amazonka.LexV2Models.DescribeSlot Methods readsPrec :: Int -> ReadS DescribeSlotResponse # readList :: ReadS [DescribeSlotResponse] # readPrec :: ReadPrec DescribeSlotResponse # readListPrec :: ReadPrec [DescribeSlotResponse] #
Show DescribeSlotResponse Source #
Instance details Defined in Amazonka.LexV2Models.DescribeSlot Methods showsPrec :: Int -> DescribeSlotResponse -> ShowS # show :: DescribeSlotResponse -> String # showList :: [DescribeSlotResponse] -> ShowS #
NFData DescribeSlotResponse Source #
Instance details Defined in Amazonka.LexV2Models.DescribeSlot Methods rnf :: DescribeSlotResponse -> () #
Eq DescribeSlotResponse Source #
Instance details Defined in Amazonka.LexV2Models.DescribeSlot Methods (==) :: DescribeSlotResponse -> DescribeSlotResponse -> Bool # (/=) :: DescribeSlotResponse -> DescribeSlotResponse -> Bool #
type Rep DescribeSlotResponse Source #
Instance details Defined in Amazonka.LexV2Models.DescribeSlot type Rep DescribeSlotResponse = D1 ('MetaData "DescribeSlotResponse" "Amazonka.LexV2Models.DescribeSlot" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "DescribeSlotResponse'" '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 "lastUpdatedDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: 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))))))

newDescribeSlotResponse Source #

Arguments

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

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

DescribeSlot, describeSlotResponse_botId - The identifier of the bot associated with the slot.

DescribeSlot, describeSlotResponse_botVersion - The version of the bot associated with the slot.

DescribeSlotResponse, describeSlotResponse_creationDateTime - A timestamp of the date and time that the slot was created.

DescribeSlotResponse, describeSlotResponse_description - The description specified for the slot.

DescribeSlot, describeSlotResponse_intentId - The identifier of the intent associated with the slot.

DescribeSlotResponse, describeSlotResponse_lastUpdatedDateTime - A timestamp of the date and time that the slot was last updated.

DescribeSlot, describeSlotResponse_localeId - The language and locale specified for the slot.

$sel:multipleValuesSetting:DescribeSlotResponse', describeSlotResponse_multipleValuesSetting - Indicates whether the slot accepts multiple values in a single utterance.

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

$sel:obfuscationSetting:DescribeSlotResponse', describeSlotResponse_obfuscationSetting - Whether slot values are shown in Amazon CloudWatch logs. If the value is None, the actual value of the slot is shown in logs.

DescribeSlot, describeSlotResponse_slotId - The unique identifier generated for the slot.

DescribeSlotResponse, describeSlotResponse_slotName - The name specified for the slot.

DescribeSlotResponse, describeSlotResponse_slotTypeId - The identifier of the slot type that determines the values entered into the slot.

$sel:subSlotSetting:DescribeSlotResponse', describeSlotResponse_subSlotSetting - Specifications for the constituent sub slots and the expression for the composite slot.

DescribeSlotResponse, describeSlotResponse_valueElicitationSetting - Prompts that Amazon Lex uses to elicit a value for the slot.

$sel:httpStatus:DescribeSlotResponse', describeSlotResponse_httpStatus - The response's http status code.

Response Lenses

describeSlotResponse_botId :: Lens' DescribeSlotResponse (Maybe Text) Source #

The identifier of the bot associated with the slot.

describeSlotResponse_botVersion :: Lens' DescribeSlotResponse (Maybe Text) Source #

The version of the bot associated with the slot.

describeSlotResponse_creationDateTime :: Lens' DescribeSlotResponse (Maybe UTCTime) Source #

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

describeSlotResponse_description :: Lens' DescribeSlotResponse (Maybe Text) Source #

The description specified for the slot.

describeSlotResponse_intentId :: Lens' DescribeSlotResponse (Maybe Text) Source #

The identifier of the intent associated with the slot.

describeSlotResponse_lastUpdatedDateTime :: Lens' DescribeSlotResponse (Maybe UTCTime) Source #

A timestamp of the date and time that the slot was last updated.

describeSlotResponse_localeId :: Lens' DescribeSlotResponse (Maybe Text) Source #

The language and locale specified for the slot.

describeSlotResponse_multipleValuesSetting :: Lens' DescribeSlotResponse (Maybe MultipleValuesSetting) Source #

Indicates whether the slot accepts multiple values in a single utterance.

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

describeSlotResponse_obfuscationSetting :: Lens' DescribeSlotResponse (Maybe ObfuscationSetting) Source #

Whether slot values are shown in Amazon CloudWatch logs. If the value is None, the actual value of the slot is shown in logs.

describeSlotResponse_slotId :: Lens' DescribeSlotResponse (Maybe Text) Source #

The unique identifier generated for the slot.

describeSlotResponse_slotName :: Lens' DescribeSlotResponse (Maybe Text) Source #

The name specified for the slot.

describeSlotResponse_slotTypeId :: Lens' DescribeSlotResponse (Maybe Text) Source #

The identifier of the slot type that determines the values entered into the slot.

describeSlotResponse_subSlotSetting :: Lens' DescribeSlotResponse (Maybe SubSlotSetting) Source #

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

describeSlotResponse_valueElicitationSetting :: Lens' DescribeSlotResponse (Maybe SlotValueElicitationSetting) Source #

Prompts that Amazon Lex uses to elicit a value for the slot.

describeSlotResponse_httpStatus :: Lens' DescribeSlotResponse Int Source #

The response's http status code.