ListBuiltInSlotTypes - Amazon Lex

ListBuiltInSlotTypes

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

Request Syntax

POST /builtins/locales/localeId/slottypes/ HTTP/1.1 Content-type: application/json { "maxResults": number, "nextToken": "string", "sortBy": { "attribute": "string", "order": "string" } }

URI Request Parameters

The request uses the following URI parameters.

localeId

The identifier of the language and locale of the slot types to list. The string must match one of the supported locales. For more information, see Supported languages.

Required: Yes

Request Body

The request accepts the following data in JSON format.

maxResults

The maximum number of built-in slot types to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.

Type: Integer

Valid Range: Fixed value of 20.

Required: No

nextToken

If the response from the ListBuiltInSlotTypes operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.

Type: String

Required: No

sortBy

Determines the sort order for the response from the ListBuiltInSlotTypes operation. You can choose to sort by the slot type signature in either ascending or descending order.

Type: BuiltInSlotTypeSortBy object

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "builtInSlotTypeSummaries": [ { "description": "string", "slotTypeSignature": "string" } ], "localeId": "string", "nextToken": "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.

builtInSlotTypeSummaries

Summary information for the built-in slot types that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more slot types available, the nextToken field contains a token to get the next page of results.

Type: Array of BuiltInSlotTypeSummary objects

localeId

The language and locale of the slot types in the list.

Type: String

nextToken

A token that indicates whether there are more results to return in a response to the ListBuiltInSlotTypes operation. If the nextToken field is present, you send the contents as the nextToken parameter of a LIstBuiltInSlotTypes operation request to get the next page of results.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

HTTP Status Code: 500

ServiceQuotaExceededException

HTTP Status Code: 402

ThrottlingException

HTTP Status Code: 429

ValidationException

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: