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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a list of built-in intents that meet the specified criteria.

This operation requires permission for the lex:GetBuiltinIntents action.

This operation returns paginated results.

Synopsis

data GetBuiltinIntents = GetBuiltinIntents' {
- locale :: Maybe Locale
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- signatureContains :: Maybe Text
}
newGetBuiltinIntents :: GetBuiltinIntents
getBuiltinIntents_locale :: Lens' GetBuiltinIntents (Maybe Locale)
getBuiltinIntents_maxResults :: Lens' GetBuiltinIntents (Maybe Natural)
getBuiltinIntents_nextToken :: Lens' GetBuiltinIntents (Maybe Text)
getBuiltinIntents_signatureContains :: Lens' GetBuiltinIntents (Maybe Text)
data GetBuiltinIntentsResponse = GetBuiltinIntentsResponse' {
- intents :: Maybe [BuiltinIntentMetadata]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newGetBuiltinIntentsResponse :: Int -> GetBuiltinIntentsResponse
getBuiltinIntentsResponse_intents :: Lens' GetBuiltinIntentsResponse (Maybe [BuiltinIntentMetadata])
getBuiltinIntentsResponse_nextToken :: Lens' GetBuiltinIntentsResponse (Maybe Text)
getBuiltinIntentsResponse_httpStatus :: Lens' GetBuiltinIntentsResponse Int

Creating a Request

data GetBuiltinIntents Source #

See: newGetBuiltinIntents smart constructor.

Constructors

GetBuiltinIntents'

Fields

locale :: Maybe Locale
A list of locales that the intent supports.
maxResults :: Maybe Natural
The maximum number of intents to return in the response. The default is 10.
nextToken :: Maybe Text
A pagination token that fetches the next page of intents. If this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of intents, use the pagination token in the next request.
signatureContains :: Maybe Text
Substring to match in built-in intent signatures. An intent will be returned if any part of its signature matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz." To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.

Instances

Instances details

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

newGetBuiltinIntents :: GetBuiltinIntents Source #

Create a value of GetBuiltinIntents 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:locale:GetBuiltinIntents', getBuiltinIntents_locale - A list of locales that the intent supports.

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

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

$sel:signatureContains:GetBuiltinIntents', getBuiltinIntents_signatureContains - Substring to match in built-in intent signatures. An intent will be returned if any part of its signature matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz." To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.

Request Lenses

getBuiltinIntents_locale :: Lens' GetBuiltinIntents (Maybe Locale) Source #

A list of locales that the intent supports.

getBuiltinIntents_maxResults :: Lens' GetBuiltinIntents (Maybe Natural) Source #

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

getBuiltinIntents_nextToken :: Lens' GetBuiltinIntents (Maybe Text) Source #

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

getBuiltinIntents_signatureContains :: Lens' GetBuiltinIntents (Maybe Text) Source #

Substring to match in built-in intent signatures. An intent will be returned if any part of its signature matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz." To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.

Destructuring the Response

data GetBuiltinIntentsResponse Source #

See: newGetBuiltinIntentsResponse smart constructor.

Constructors

GetBuiltinIntentsResponse'

Fields

intents :: Maybe [BuiltinIntentMetadata]
An array of builtinIntentMetadata objects, one for each intent in the response.
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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newGetBuiltinIntentsResponse Source #

Arguments

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

Create a value of GetBuiltinIntentsResponse 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:GetBuiltinIntentsResponse', getBuiltinIntentsResponse_intents - An array of builtinIntentMetadata objects, one for each intent in the response.

GetBuiltinIntents, getBuiltinIntentsResponse_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.

$sel:httpStatus:GetBuiltinIntentsResponse', getBuiltinIntentsResponse_httpStatus - The response's http status code.

Response Lenses

getBuiltinIntentsResponse_intents :: Lens' GetBuiltinIntentsResponse (Maybe [BuiltinIntentMetadata]) Source #

An array of builtinIntentMetadata objects, one for each intent in the response.

getBuiltinIntentsResponse_nextToken :: Lens' GetBuiltinIntentsResponse (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.

getBuiltinIntentsResponse_httpStatus :: Lens' GetBuiltinIntentsResponse Int Source #

The response's http status code.