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

Contents

Description

Returns intent information as follows:

  • If you specify the nameContains field, returns the > LATEST version of all intents that contain the specified string.
  • If you don't specify the nameContains field, returns information about the > LATEST version of all intents.

The operation requires permission for the lex:GetIntents action.

This operation returns paginated results.

Synopsis

Creating a Request

getIntents :: GetIntents Source #

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

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

  • giNameContains - Substring to match in intent names. An intent will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."
  • giNextToken - A pagination token that fetches the next page of intents. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of intents, specify the pagination token in the next request.
  • giMaxResults - The maximum number of intents to return in the response. The default is 10.

data GetIntents Source #

See: getIntents smart constructor.

Instances
Eq GetIntents Source # 
Instance details

Defined in Network.AWS.LexModels.GetIntents

Data GetIntents Source # 
Instance details

Defined in Network.AWS.LexModels.GetIntents

Methods

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

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

toConstr :: GetIntents -> Constr #

dataTypeOf :: GetIntents -> DataType #

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

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

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

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

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

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

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

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

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

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

Read GetIntents Source # 
Instance details

Defined in Network.AWS.LexModels.GetIntents

Show GetIntents Source # 
Instance details

Defined in Network.AWS.LexModels.GetIntents

Generic GetIntents Source # 
Instance details

Defined in Network.AWS.LexModels.GetIntents

Associated Types

type Rep GetIntents :: Type -> Type #

Hashable GetIntents Source # 
Instance details

Defined in Network.AWS.LexModels.GetIntents

AWSPager GetIntents Source # 
Instance details

Defined in Network.AWS.LexModels.GetIntents

AWSRequest GetIntents Source # 
Instance details

Defined in Network.AWS.LexModels.GetIntents

Associated Types

type Rs GetIntents :: Type #

ToHeaders GetIntents Source # 
Instance details

Defined in Network.AWS.LexModels.GetIntents

Methods

toHeaders :: GetIntents -> [Header] #

ToPath GetIntents Source # 
Instance details

Defined in Network.AWS.LexModels.GetIntents

ToQuery GetIntents Source # 
Instance details

Defined in Network.AWS.LexModels.GetIntents

NFData GetIntents Source # 
Instance details

Defined in Network.AWS.LexModels.GetIntents

Methods

rnf :: GetIntents -> () #

type Rep GetIntents Source # 
Instance details

Defined in Network.AWS.LexModels.GetIntents

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

Defined in Network.AWS.LexModels.GetIntents

Request Lenses

giNameContains :: Lens' GetIntents (Maybe Text) Source #

Substring to match in intent names. An intent will be returned if any part of its name matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."

giNextToken :: Lens' GetIntents (Maybe Text) Source #

A pagination token that fetches the next page of intents. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of intents, specify the pagination token in the next request.

giMaxResults :: Lens' GetIntents (Maybe Natural) Source #

The maximum number of intents to return in the response. The default is 10.

Destructuring the Response

getIntentsResponse Source #

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

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

  • gisrsIntents - An array of Intent objects. For more information, see PutBot .
  • gisrsNextToken - If the response is truncated, the response includes a pagination token that you can specify in your next request to fetch the next page of intents.
  • gisrsResponseStatus - -- | The response status code.

data GetIntentsResponse Source #

See: getIntentsResponse smart constructor.

Instances
Eq GetIntentsResponse Source # 
Instance details

Defined in Network.AWS.LexModels.GetIntents

Data GetIntentsResponse Source # 
Instance details

Defined in Network.AWS.LexModels.GetIntents

Methods

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

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

toConstr :: GetIntentsResponse -> Constr #

dataTypeOf :: GetIntentsResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read GetIntentsResponse Source # 
Instance details

Defined in Network.AWS.LexModels.GetIntents

Show GetIntentsResponse Source # 
Instance details

Defined in Network.AWS.LexModels.GetIntents

Generic GetIntentsResponse Source # 
Instance details

Defined in Network.AWS.LexModels.GetIntents

Associated Types

type Rep GetIntentsResponse :: Type -> Type #

NFData GetIntentsResponse Source # 
Instance details

Defined in Network.AWS.LexModels.GetIntents

Methods

rnf :: GetIntentsResponse -> () #

type Rep GetIntentsResponse Source # 
Instance details

Defined in Network.AWS.LexModels.GetIntents

type Rep GetIntentsResponse = D1 (MetaData "GetIntentsResponse" "Network.AWS.LexModels.GetIntents" "amazonka-lex-models-1.6.1-16JSA2D34IH7p8RxcjidTj" False) (C1 (MetaCons "GetIntentsResponse'" PrefixI True) (S1 (MetaSel (Just "_gisrsIntents") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [IntentMetadata])) :*: (S1 (MetaSel (Just "_gisrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_gisrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

gisrsIntents :: Lens' GetIntentsResponse [IntentMetadata] Source #

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

gisrsNextToken :: Lens' GetIntentsResponse (Maybe Text) Source #

If the response is truncated, the response includes a pagination token that you can specify in your next request to fetch the next page of intents.

gisrsResponseStatus :: Lens' GetIntentsResponse Int Source #

  • - | The response status code.