Menu
Lumberyard
User Guide (Version 1.13)

Slot Types

You can use the following operations to manage slot types.

GET /admin/listbuiltinslottypes/{next_token}

Returns a list of built-in slot types.

Request Parameters

Name Type Description
next_token string Specifies a pagination token to pass to a call to retrieve the next page of built-in slot types. To retrieve the first page of built-in slot types, specify an empty string.

Response Parameters

Name Type Description
slotTypes array Contains information about built-in slot types.
nextToken string Contains a pagination token to pass to retrieve the next page of built-in slot types. If no additional pages exist, the string is empty.

GET /admin/listcustomslottypes/{next_token}

Returns a list of custom slot types.

Request Parameters

Name Type Description
next_token string Specifies a pagination token to pass to retrieve the next page of custom slot types. To retrieve the first page of custom slot types, specify an empty string.

Response Parameters

Name Type Description
slotTypes array Contains custom slot type information.
nextToken string Contains a pagination token to pass to retrieve the next page of custom slot types. If no additional pages exist, the string is empty.

PUT /admin/slottype

Creates a custom slot type or replaces an existing custom slot type.

Request Parameters

Name Type Description
slotType object Describes the slot type to create or update.

Response Parameters

Name Type Description
status string Contains READY if the custom slot type is created or updated, or another state as defined by the Amazon Lex PutSlotType API.

DELETE /admin/slottype/{name}

Deletes all versions of the slot type.

Request Parameters

Name Type Description
name string The name of the slot type to delete.

Response Parameters

Name Type Description
status string Contains DELETED or an error message.

GET /admin/slottype/versions/{name}/{next_token}

Returns information about all the versions of a slot type.

Request Parameters

Name Type Description
name string The name of the slot type.
next_token string Specifies a pagination token to pass to retrieve the next page of slot type versions. To retrieve the first page of slot type versions, specify an empty string.

Response Parameters

Name Type Description
intents array Contains slot type version information.
nextToken string Contains a pagination token to pass to retrieve the next page of slot type versions. If no additional pages exist, the string is empty.

GET /admin/slottype/{name}/{version}

Returns information about a specific version of a slot type.

Request Parameters

Name Type Description
name string The name of the slot type to return.
version string The version of the slot type to return.

Response Parameters

Name Type Description
slotType object Contains information about the specified version of the slot type.

PUT /admin/slottype/version/{name}

Creates a new version of the slot type based on the latest version.

Request Parameters

Name Type Description
name string The name of the slot type.

Response Parameters

Name Type Description
status string Contains READY if the custom slot type version is created, or another state as defined by the Amazon Lex CreateSlotTypeVersion API.