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.
GetBuiltinIntent
Returns information about a built-in intent.
This operation requires permission for the
lex:GetBuiltinIntent action.
Request Syntax
GET /builtins/intents/signature HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- signature
-
The unique identifier for a built-in intent. To find the signature for an intent, see Standard Built-in Intents
in the Alexa Skills Kit. Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"signature": "string",
"slots": [
{
"name": "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.
- signature
-
The unique identifier for a built-in intent.
Type: String
- slots
-
An array of
BuiltinIntentSlotobjects, one entry for each slot type in the intent.Type: Array of BuiltinIntentSlot objects
- supportedLocales
-
A list of locales that the intent supports.
Type: Array of strings
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
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
- NotFoundException
-
The resource specified in the request was not found. Check the resource and try again.
HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
