amazonka-lex-models-1.6.1: Amazon Lex Model Building Service SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.LexModels.GetBot

Contents

Description

Returns metadata information for a specific bot. You must provide the bot name and the bot version or alias.

This operation requires permissions for the lex:GetBot action.

Synopsis

Creating a Request

getBot Source #

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

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

data GetBot Source #

See: getBot smart constructor.

Instances
Eq GetBot Source # 
Instance details

Defined in Network.AWS.LexModels.GetBot

Methods

(==) :: GetBot -> GetBot -> Bool #

(/=) :: GetBot -> GetBot -> Bool #

Data GetBot Source # 
Instance details

Defined in Network.AWS.LexModels.GetBot

Methods

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

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

toConstr :: GetBot -> Constr #

dataTypeOf :: GetBot -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GetBot) #

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

gmapT :: (forall b. Data b => b -> b) -> GetBot -> GetBot #

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

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

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

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

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

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

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

Read GetBot Source # 
Instance details

Defined in Network.AWS.LexModels.GetBot

Show GetBot Source # 
Instance details

Defined in Network.AWS.LexModels.GetBot

Generic GetBot Source # 
Instance details

Defined in Network.AWS.LexModels.GetBot

Associated Types

type Rep GetBot :: Type -> Type #

Methods

from :: GetBot -> Rep GetBot x #

to :: Rep GetBot x -> GetBot #

Hashable GetBot Source # 
Instance details

Defined in Network.AWS.LexModels.GetBot

Methods

hashWithSalt :: Int -> GetBot -> Int #

hash :: GetBot -> Int #

AWSRequest GetBot Source # 
Instance details

Defined in Network.AWS.LexModels.GetBot

Associated Types

type Rs GetBot :: Type #

ToHeaders GetBot Source # 
Instance details

Defined in Network.AWS.LexModels.GetBot

Methods

toHeaders :: GetBot -> [Header] #

ToPath GetBot Source # 
Instance details

Defined in Network.AWS.LexModels.GetBot

Methods

toPath :: GetBot -> ByteString #

ToQuery GetBot Source # 
Instance details

Defined in Network.AWS.LexModels.GetBot

NFData GetBot Source # 
Instance details

Defined in Network.AWS.LexModels.GetBot

Methods

rnf :: GetBot -> () #

type Rep GetBot Source # 
Instance details

Defined in Network.AWS.LexModels.GetBot

type Rep GetBot = D1 (MetaData "GetBot" "Network.AWS.LexModels.GetBot" "amazonka-lex-models-1.6.1-16JSA2D34IH7p8RxcjidTj" False) (C1 (MetaCons "GetBot'" PrefixI True) (S1 (MetaSel (Just "_gbName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_gbVersionOrAlias") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))
type Rs GetBot Source # 
Instance details

Defined in Network.AWS.LexModels.GetBot

Request Lenses

gbName :: Lens' GetBot Text Source #

The name of the bot. The name is case sensitive.

gbVersionOrAlias :: Lens' GetBot Text Source #

The version or alias of the bot.

Destructuring the Response

getBotResponse Source #

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

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

  • gbrsFailureReason - If status is FAILED , Amazon Lex explains why it failed to build the bot.
  • gbrsStatus - The status of the bot. If the bot is ready to run, the status is READY . If there was a problem with building the bot, the status is FAILED and the failureReason explains why the bot did not build. If the bot was saved but not built, the status is NOT BUILT .
  • gbrsAbortStatement - The message that Amazon Lex returns when the user elects to end the conversation without completing it. For more information, see PutBot .
  • gbrsIntents - An array of intent objects. For more information, see PutBot .
  • gbrsChecksum - Checksum of the bot used to identify a specific revision of the bot's > LATEST version.
  • gbrsLocale - The target locale for the bot.
  • gbrsCreatedDate - The date that the bot was created.
  • gbrsName - The name of the bot.
  • gbrsVersion - The version of the bot. For a new bot, the version is always > LATEST .
  • gbrsIdleSessionTTLInSeconds - The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot .
  • gbrsClarificationPrompt - The message Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot .
  • gbrsVoiceId - The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot .
  • gbrsLastUpdatedDate - The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.
  • gbrsChildDirected - For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
  • gbrsDescription - A description of the bot.
  • gbrsResponseStatus - -- | The response status code.

data GetBotResponse Source #

See: getBotResponse smart constructor.

Instances
Eq GetBotResponse Source # 
Instance details

Defined in Network.AWS.LexModels.GetBot

Data GetBotResponse Source # 
Instance details

Defined in Network.AWS.LexModels.GetBot

Methods

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

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

toConstr :: GetBotResponse -> Constr #

dataTypeOf :: GetBotResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GetBotResponse) #

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

gmapT :: (forall b. Data b => b -> b) -> GetBotResponse -> GetBotResponse #

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

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

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

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

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

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

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

Read GetBotResponse Source # 
Instance details

Defined in Network.AWS.LexModels.GetBot

Show GetBotResponse Source # 
Instance details

Defined in Network.AWS.LexModels.GetBot

Generic GetBotResponse Source # 
Instance details

Defined in Network.AWS.LexModels.GetBot

Associated Types

type Rep GetBotResponse :: Type -> Type #

NFData GetBotResponse Source # 
Instance details

Defined in Network.AWS.LexModels.GetBot

Methods

rnf :: GetBotResponse -> () #

type Rep GetBotResponse Source # 
Instance details

Defined in Network.AWS.LexModels.GetBot

type Rep GetBotResponse = D1 (MetaData "GetBotResponse" "Network.AWS.LexModels.GetBot" "amazonka-lex-models-1.6.1-16JSA2D34IH7p8RxcjidTj" False) (C1 (MetaCons "GetBotResponse'" PrefixI True) ((((S1 (MetaSel (Just "_gbrsFailureReason") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_gbrsStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe LexStatus))) :*: (S1 (MetaSel (Just "_gbrsAbortStatement") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Statement)) :*: S1 (MetaSel (Just "_gbrsIntents") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Intent])))) :*: ((S1 (MetaSel (Just "_gbrsChecksum") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_gbrsLocale") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Locale))) :*: (S1 (MetaSel (Just "_gbrsCreatedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 (MetaSel (Just "_gbrsName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 (MetaSel (Just "_gbrsVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_gbrsIdleSessionTTLInSeconds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) :*: (S1 (MetaSel (Just "_gbrsClarificationPrompt") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Prompt)) :*: S1 (MetaSel (Just "_gbrsVoiceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_gbrsLastUpdatedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 (MetaSel (Just "_gbrsChildDirected") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 (MetaSel (Just "_gbrsDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_gbrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))))

Response Lenses

gbrsFailureReason :: Lens' GetBotResponse (Maybe Text) Source #

If status is FAILED , Amazon Lex explains why it failed to build the bot.

gbrsStatus :: Lens' GetBotResponse (Maybe LexStatus) Source #

The status of the bot. If the bot is ready to run, the status is READY . If there was a problem with building the bot, the status is FAILED and the failureReason explains why the bot did not build. If the bot was saved but not built, the status is NOT BUILT .

gbrsAbortStatement :: Lens' GetBotResponse (Maybe Statement) Source #

The message that Amazon Lex returns when the user elects to end the conversation without completing it. For more information, see PutBot .

gbrsIntents :: Lens' GetBotResponse [Intent] Source #

An array of intent objects. For more information, see PutBot .

gbrsChecksum :: Lens' GetBotResponse (Maybe Text) Source #

Checksum of the bot used to identify a specific revision of the bot's > LATEST version.

gbrsLocale :: Lens' GetBotResponse (Maybe Locale) Source #

The target locale for the bot.

gbrsCreatedDate :: Lens' GetBotResponse (Maybe UTCTime) Source #

The date that the bot was created.

gbrsName :: Lens' GetBotResponse (Maybe Text) Source #

The name of the bot.

gbrsVersion :: Lens' GetBotResponse (Maybe Text) Source #

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

gbrsIdleSessionTTLInSeconds :: Lens' GetBotResponse (Maybe Natural) Source #

The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot .

gbrsClarificationPrompt :: Lens' GetBotResponse (Maybe Prompt) Source #

The message Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot .

gbrsVoiceId :: Lens' GetBotResponse (Maybe Text) Source #

The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot .

gbrsLastUpdatedDate :: Lens' GetBotResponse (Maybe UTCTime) Source #

The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.

gbrsChildDirected :: Lens' GetBotResponse (Maybe Bool) Source #

For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.

gbrsDescription :: Lens' GetBotResponse (Maybe Text) Source #

A description of the bot.

gbrsResponseStatus :: Lens' GetBotResponse Int Source #

  • - | The response status code.