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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

For a list of built-in slot types, see Slot Type Reference in the Alexa Skills Kit.

This operation requires permission for the lex:GetBuiltInSlotTypes action.

This operation returns paginated results.

Synopsis

data GetBuiltinSlotTypes = GetBuiltinSlotTypes' {
- locale :: Maybe Locale
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- signatureContains :: Maybe Text
}
newGetBuiltinSlotTypes :: GetBuiltinSlotTypes
getBuiltinSlotTypes_locale :: Lens' GetBuiltinSlotTypes (Maybe Locale)
getBuiltinSlotTypes_maxResults :: Lens' GetBuiltinSlotTypes (Maybe Natural)
getBuiltinSlotTypes_nextToken :: Lens' GetBuiltinSlotTypes (Maybe Text)
getBuiltinSlotTypes_signatureContains :: Lens' GetBuiltinSlotTypes (Maybe Text)
data GetBuiltinSlotTypesResponse = GetBuiltinSlotTypesResponse' {
- nextToken :: Maybe Text
- slotTypes :: Maybe [BuiltinSlotTypeMetadata]
- httpStatus :: Int
}
newGetBuiltinSlotTypesResponse :: Int -> GetBuiltinSlotTypesResponse
getBuiltinSlotTypesResponse_nextToken :: Lens' GetBuiltinSlotTypesResponse (Maybe Text)
getBuiltinSlotTypesResponse_slotTypes :: Lens' GetBuiltinSlotTypesResponse (Maybe [BuiltinSlotTypeMetadata])
getBuiltinSlotTypesResponse_httpStatus :: Lens' GetBuiltinSlotTypesResponse Int

Creating a Request

data GetBuiltinSlotTypes Source #

See: newGetBuiltinSlotTypes smart constructor.

Constructors

GetBuiltinSlotTypes'

Fields

locale :: Maybe Locale
A list of locales that the slot type supports.
maxResults :: Maybe Natural
The maximum number of slot types to return in the response. The default is 10.
nextToken :: Maybe Text
A pagination token that fetches the next page of slot types. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of slot types, specify the pagination token in the next request.
signatureContains :: Maybe Text
Substring to match in built-in slot type signatures. A slot type will be returned if any part of its signature matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."

Instances

Instances details

ToHeaders GetBuiltinSlotTypes Source #
Instance details Defined in Amazonka.LexModels.GetBuiltinSlotTypes Methods toHeaders :: GetBuiltinSlotTypes -> [Header] #
ToPath GetBuiltinSlotTypes Source #
Instance details Defined in Amazonka.LexModels.GetBuiltinSlotTypes Methods toPath :: GetBuiltinSlotTypes -> ByteString #
ToQuery GetBuiltinSlotTypes Source #
Instance details Defined in Amazonka.LexModels.GetBuiltinSlotTypes Methods toQuery :: GetBuiltinSlotTypes -> QueryString #
AWSPager GetBuiltinSlotTypes Source #
Instance details Defined in Amazonka.LexModels.GetBuiltinSlotTypes Methods page :: GetBuiltinSlotTypes -> AWSResponse GetBuiltinSlotTypes -> Maybe GetBuiltinSlotTypes #
AWSRequest GetBuiltinSlotTypes Source #
Instance details Defined in Amazonka.LexModels.GetBuiltinSlotTypes Associated Types type AWSResponse GetBuiltinSlotTypes # Methods request :: (Service -> Service) -> GetBuiltinSlotTypes -> Request GetBuiltinSlotTypes # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetBuiltinSlotTypes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetBuiltinSlotTypes))) #
Generic GetBuiltinSlotTypes Source #
Instance details Defined in Amazonka.LexModels.GetBuiltinSlotTypes Associated Types type Rep GetBuiltinSlotTypes :: Type -> Type # Methods from :: GetBuiltinSlotTypes -> Rep GetBuiltinSlotTypes x # to :: Rep GetBuiltinSlotTypes x -> GetBuiltinSlotTypes #
Read GetBuiltinSlotTypes Source #
Instance details Defined in Amazonka.LexModels.GetBuiltinSlotTypes Methods readsPrec :: Int -> ReadS GetBuiltinSlotTypes # readList :: ReadS [GetBuiltinSlotTypes] # readPrec :: ReadPrec GetBuiltinSlotTypes # readListPrec :: ReadPrec [GetBuiltinSlotTypes] #
Show GetBuiltinSlotTypes Source #
Instance details Defined in Amazonka.LexModels.GetBuiltinSlotTypes Methods showsPrec :: Int -> GetBuiltinSlotTypes -> ShowS # show :: GetBuiltinSlotTypes -> String # showList :: [GetBuiltinSlotTypes] -> ShowS #
NFData GetBuiltinSlotTypes Source #
Instance details Defined in Amazonka.LexModels.GetBuiltinSlotTypes Methods rnf :: GetBuiltinSlotTypes -> () #
Eq GetBuiltinSlotTypes Source #
Instance details Defined in Amazonka.LexModels.GetBuiltinSlotTypes Methods (==) :: GetBuiltinSlotTypes -> GetBuiltinSlotTypes -> Bool # (/=) :: GetBuiltinSlotTypes -> GetBuiltinSlotTypes -> Bool #
Hashable GetBuiltinSlotTypes Source #
Instance details Defined in Amazonka.LexModels.GetBuiltinSlotTypes Methods hashWithSalt :: Int -> GetBuiltinSlotTypes -> Int # hash :: GetBuiltinSlotTypes -> Int #
type AWSResponse GetBuiltinSlotTypes Source #
Instance details Defined in Amazonka.LexModels.GetBuiltinSlotTypes type AWSResponse GetBuiltinSlotTypes = GetBuiltinSlotTypesResponse
type Rep GetBuiltinSlotTypes Source #
Instance details Defined in Amazonka.LexModels.GetBuiltinSlotTypes type Rep GetBuiltinSlotTypes = D1 ('MetaData "GetBuiltinSlotTypes" "Amazonka.LexModels.GetBuiltinSlotTypes" "amazonka-lex-models-2.0-8Q1WIjnrCCIAMPuyNOCiG7" 'False) (C1 ('MetaCons "GetBuiltinSlotTypes'" '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)))))

newGetBuiltinSlotTypes :: GetBuiltinSlotTypes Source #

Create a value of GetBuiltinSlotTypes 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:GetBuiltinSlotTypes', getBuiltinSlotTypes_locale - A list of locales that the slot type supports.

$sel:maxResults:GetBuiltinSlotTypes', getBuiltinSlotTypes_maxResults - The maximum number of slot types to return in the response. The default is 10.

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

$sel:signatureContains:GetBuiltinSlotTypes', getBuiltinSlotTypes_signatureContains - Substring to match in built-in slot type signatures. A slot type will be returned if any part of its signature matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."

Request Lenses

getBuiltinSlotTypes_locale :: Lens' GetBuiltinSlotTypes (Maybe Locale) Source #

A list of locales that the slot type supports.

getBuiltinSlotTypes_maxResults :: Lens' GetBuiltinSlotTypes (Maybe Natural) Source #

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

getBuiltinSlotTypes_nextToken :: Lens' GetBuiltinSlotTypes (Maybe Text) Source #

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

getBuiltinSlotTypes_signatureContains :: Lens' GetBuiltinSlotTypes (Maybe Text) Source #

Substring to match in built-in slot type signatures. A slot type will be returned if any part of its signature matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."

Destructuring the Response

data GetBuiltinSlotTypesResponse Source #

See: newGetBuiltinSlotTypesResponse smart constructor.

Constructors

GetBuiltinSlotTypesResponse'
Fields nextToken :: Maybe Text If the response is truncated, the response includes a pagination token that you can use in your next request to fetch the next page of slot types. slotTypes :: Maybe [BuiltinSlotTypeMetadata] An array of `BuiltInSlotTypeMetadata` objects, one entry for each slot type returned. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newGetBuiltinSlotTypesResponse Source #

Arguments

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

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

GetBuiltinSlotTypes, getBuiltinSlotTypesResponse_nextToken - If the response is truncated, the response includes a pagination token that you can use in your next request to fetch the next page of slot types.

$sel:slotTypes:GetBuiltinSlotTypesResponse', getBuiltinSlotTypesResponse_slotTypes - An array of BuiltInSlotTypeMetadata objects, one entry for each slot type returned.

$sel:httpStatus:GetBuiltinSlotTypesResponse', getBuiltinSlotTypesResponse_httpStatus - The response's http status code.

Response Lenses

getBuiltinSlotTypesResponse_nextToken :: Lens' GetBuiltinSlotTypesResponse (Maybe Text) Source #

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

getBuiltinSlotTypesResponse_slotTypes :: Lens' GetBuiltinSlotTypesResponse (Maybe [BuiltinSlotTypeMetadata]) Source #

An array of BuiltInSlotTypeMetadata objects, one entry for each slot type returned.

getBuiltinSlotTypesResponse_httpStatus :: Lens' GetBuiltinSlotTypesResponse Int Source #

The response's http status code.