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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

data GetIntents Source #

See: newGetIntents smart constructor.

Constructors

GetIntents'

Fields

maxResults :: Maybe Natural
The maximum number of intents to return in the response. The default is 10.
nameContains :: Maybe Text
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."
nextToken :: Maybe Text
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.

Instances

Instances details

ToHeaders GetIntents Source #
Instance details Defined in Amazonka.LexModels.GetIntents Methods toHeaders :: GetIntents -> [Header] #
ToPath GetIntents Source #
Instance details Defined in Amazonka.LexModels.GetIntents Methods toPath :: GetIntents -> ByteString #
ToQuery GetIntents Source #
Instance details Defined in Amazonka.LexModels.GetIntents Methods toQuery :: GetIntents -> QueryString #
AWSPager GetIntents Source #
Instance details Defined in Amazonka.LexModels.GetIntents Methods page :: GetIntents -> AWSResponse GetIntents -> Maybe GetIntents #
AWSRequest GetIntents Source #
Instance details Defined in Amazonka.LexModels.GetIntents Associated Types type AWSResponse GetIntents # Methods request :: (Service -> Service) -> GetIntents -> Request GetIntents # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetIntents -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetIntents))) #
Generic GetIntents Source #
Instance details Defined in Amazonka.LexModels.GetIntents Associated Types type Rep GetIntents :: Type -> Type # Methods from :: GetIntents -> Rep GetIntents x # to :: Rep GetIntents x -> GetIntents #
Read GetIntents Source #
Instance details Defined in Amazonka.LexModels.GetIntents Methods readsPrec :: Int -> ReadS GetIntents # readList :: ReadS [GetIntents] # readPrec :: ReadPrec GetIntents # readListPrec :: ReadPrec [GetIntents] #
Show GetIntents Source #
Instance details Defined in Amazonka.LexModels.GetIntents Methods showsPrec :: Int -> GetIntents -> ShowS # show :: GetIntents -> String # showList :: [GetIntents] -> ShowS #
NFData GetIntents Source #
Instance details Defined in Amazonka.LexModels.GetIntents Methods rnf :: GetIntents -> () #
Eq GetIntents Source #
Instance details Defined in Amazonka.LexModels.GetIntents Methods (==) :: GetIntents -> GetIntents -> Bool # (/=) :: GetIntents -> GetIntents -> Bool #
Hashable GetIntents Source #
Instance details Defined in Amazonka.LexModels.GetIntents Methods hashWithSalt :: Int -> GetIntents -> Int # hash :: GetIntents -> Int #
type AWSResponse GetIntents Source #
Instance details Defined in Amazonka.LexModels.GetIntents type AWSResponse GetIntents = GetIntentsResponse
type Rep GetIntents Source #
Instance details Defined in Amazonka.LexModels.GetIntents type Rep GetIntents = D1 ('MetaData "GetIntents" "Amazonka.LexModels.GetIntents" "amazonka-lex-models-2.0-8Q1WIjnrCCIAMPuyNOCiG7" 'False) (C1 ('MetaCons "GetIntents'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "nameContains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newGetIntents :: GetIntents Source #

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

$sel:maxResults:GetIntents', getIntents_maxResults - The maximum number of intents to return in the response. The default is 10.

$sel:nameContains:GetIntents', getIntents_nameContains - 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."

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

Request Lenses

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

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

getIntents_nameContains :: 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."

getIntents_nextToken :: 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.

Destructuring the Response

data GetIntentsResponse Source #

See: newGetIntentsResponse smart constructor.

Constructors

GetIntentsResponse'
Fields intents :: Maybe [IntentMetadata] An array of `Intent` objects. For more information, see PutBot. nextToken :: Maybe Text 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. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetIntentsResponse Source #
Instance details Defined in Amazonka.LexModels.GetIntents Associated Types type Rep GetIntentsResponse :: Type -> Type # Methods from :: GetIntentsResponse -> Rep GetIntentsResponse x # to :: Rep GetIntentsResponse x -> GetIntentsResponse #
Read GetIntentsResponse Source #
Instance details Defined in Amazonka.LexModels.GetIntents Methods readsPrec :: Int -> ReadS GetIntentsResponse # readList :: ReadS [GetIntentsResponse] # readPrec :: ReadPrec GetIntentsResponse # readListPrec :: ReadPrec [GetIntentsResponse] #
Show GetIntentsResponse Source #
Instance details Defined in Amazonka.LexModels.GetIntents Methods showsPrec :: Int -> GetIntentsResponse -> ShowS # show :: GetIntentsResponse -> String # showList :: [GetIntentsResponse] -> ShowS #
NFData GetIntentsResponse Source #
Instance details Defined in Amazonka.LexModels.GetIntents Methods rnf :: GetIntentsResponse -> () #
Eq GetIntentsResponse Source #
Instance details Defined in Amazonka.LexModels.GetIntents Methods (==) :: GetIntentsResponse -> GetIntentsResponse -> Bool # (/=) :: GetIntentsResponse -> GetIntentsResponse -> Bool #
type Rep GetIntentsResponse Source #
Instance details Defined in Amazonka.LexModels.GetIntents type Rep GetIntentsResponse = D1 ('MetaData "GetIntentsResponse" "Amazonka.LexModels.GetIntents" "amazonka-lex-models-2.0-8Q1WIjnrCCIAMPuyNOCiG7" 'False) (C1 ('MetaCons "GetIntentsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "intents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [IntentMetadata])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetIntentsResponse Source #

Arguments

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

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

$sel:intents:GetIntentsResponse', getIntentsResponse_intents - An array of Intent objects. For more information, see PutBot.

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

$sel:httpStatus:GetIntentsResponse', getIntentsResponse_httpStatus - The response's http status code.

Response Lenses

getIntentsResponse_intents :: Lens' GetIntentsResponse (Maybe [IntentMetadata]) Source #

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

getIntentsResponse_nextToken :: 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.

getIntentsResponse_httpStatus :: Lens' GetIntentsResponse Int Source #

The response's http status code.