If you are using Amazon Lex V2, refer to the Amazon Lex V2 guide instead.
If you are using Amazon Lex V1, we recommend upgrading your bots to Amazon Lex V2. We are no longer adding new features to V1 and strongly recommend using V2 for all new bots.
GetBuiltinSlotTypes
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
This operation requires permission for the
lex:GetBuiltInSlotTypes action.
Request Syntax
GET /builtins/slottypes/?locale=locale&maxResults=maxResults&nextToken=nextToken&signatureContains=signatureContains HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- locale
-
A list of locales that the slot type supports.
Valid Values:
de-DE | en-AU | en-GB | en-IN | en-US | es-419 | es-ES | es-US | fr-FR | fr-CA | it-IT | ja-JP | ko-KR - maxResults
-
The maximum number of slot types to return in the response. The default is 10.
Valid Range: Minimum value of 1. Maximum value of 50.
- 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.
- 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 Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"slotTypes": [
{
"signature": "string",
"supportedLocales": [ "string" ]
}
]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- 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.
Type: String
- slotTypes
-
An array of
BuiltInSlotTypeMetadataobjects, one entry for each slot type returned.Type: Array of BuiltinSlotTypeMetadata objects
Errors
- BadRequestException
-
The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.
HTTP Status Code: 400
- InternalFailureException
-
An internal Amazon Lex error occurred. Try your request again.
HTTP Status Code: 500
- LimitExceededException
-
The request exceeded a limit. Try your request again.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
