CreateBotVersion

$result = $client->createBotVersion([/* ... */]);
$promise = $client->createBotVersionAsync([/* ... */]);

Creates a new version of the bot based on the $LATEST version. If the $LATEST version of this resource hasn't changed since you created the last version, Amazon Lex doesn't create a new version. It returns the last created version.

When you create the first version of a bot, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro.

This operation requires permission for the lex:CreateBotVersion action.

Parameter Syntax

$result = $client->createBotVersion([
    'checksum' => '<string>',
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'abortStatement' => [
        'messages' => [
            [
                'content' => '<string>',
                'contentType' => 'PlainText|SSML|CustomPayload',
                'groupNumber' => <integer>,
            ],
            // ...
        ],
        'responseCard' => '<string>',
    ],
    'checksum' => '<string>',
    'childDirected' => true || false,
    'clarificationPrompt' => [
        'maxAttempts' => <integer>,
        'messages' => [
            [
                'content' => '<string>',
                'contentType' => 'PlainText|SSML|CustomPayload',
                'groupNumber' => <integer>,
            ],
            // ...
        ],
        'responseCard' => '<string>',
    ],
    'createdDate' => <DateTime>,
    'description' => '<string>',
    'detectSentiment' => true || false,
    'enableModelImprovements' => true || false,
    'failureReason' => '<string>',
    'idleSessionTTLInSeconds' => <integer>,
    'intents' => [
        [
            'intentName' => '<string>',
            'intentVersion' => '<string>',
        ],
        // ...
    ],
    'lastUpdatedDate' => <DateTime>,
    'locale' => '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',
    'name' => '<string>',
    'status' => 'BUILDING|READY|READY_BASIC_TESTING|FAILED|NOT_BUILT',
    'version' => '<string>',
    'voiceId' => '<string>',
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. Check the resource and try again.

ConflictException:

There was a conflict processing the request. Try your request again.

LimitExceededException:

The request exceeded a limit. Try your request again.

InternalFailureException:

An internal Amazon Lex error occurred. Try your request again.

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.

PreconditionFailedException:

The checksum of the resource that you are trying to change does not match the checksum in the request. Check the resource's checksum and try again.

CreateIntentVersion

$result = $client->createIntentVersion([/* ... */]);
$promise = $client->createIntentVersionAsync([/* ... */]);

Creates a new version of an intent based on the $LATEST version of the intent. If the $LATEST version of this intent hasn't changed since you last updated it, Amazon Lex doesn't create a new version. It returns the last version you created.

When you create a version of an intent, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro.

This operation requires permissions to perform the lex:CreateIntentVersion action.

Parameter Syntax

$result = $client->createIntentVersion([
    'checksum' => '<string>',
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'checksum' => '<string>',
    'conclusionStatement' => [
        'messages' => [
            [
                'content' => '<string>',
                'contentType' => 'PlainText|SSML|CustomPayload',
                'groupNumber' => <integer>,
            ],
            // ...
        ],
        'responseCard' => '<string>',
    ],
    'confirmationPrompt' => [
        'maxAttempts' => <integer>,
        'messages' => [
            [
                'content' => '<string>',
                'contentType' => 'PlainText|SSML|CustomPayload',
                'groupNumber' => <integer>,
            ],
            // ...
        ],
        'responseCard' => '<string>',
    ],
    'createdDate' => <DateTime>,
    'description' => '<string>',
    'dialogCodeHook' => [
        'messageVersion' => '<string>',
        'uri' => '<string>',
    ],
    'followUpPrompt' => [
        'prompt' => [
            'maxAttempts' => <integer>,
            'messages' => [
                [
                    'content' => '<string>',
                    'contentType' => 'PlainText|SSML|CustomPayload',
                    'groupNumber' => <integer>,
                ],
                // ...
            ],
            'responseCard' => '<string>',
        ],
        'rejectionStatement' => [
            'messages' => [
                [
                    'content' => '<string>',
                    'contentType' => 'PlainText|SSML|CustomPayload',
                    'groupNumber' => <integer>,
                ],
                // ...
            ],
            'responseCard' => '<string>',
        ],
    ],
    'fulfillmentActivity' => [
        'codeHook' => [
            'messageVersion' => '<string>',
            'uri' => '<string>',
        ],
        'type' => 'ReturnIntent|CodeHook',
    ],
    'inputContexts' => [
        [
            'name' => '<string>',
        ],
        // ...
    ],
    'kendraConfiguration' => [
        'kendraIndex' => '<string>',
        'queryFilterString' => '<string>',
        'role' => '<string>',
    ],
    'lastUpdatedDate' => <DateTime>,
    'name' => '<string>',
    'outputContexts' => [
        [
            'name' => '<string>',
            'timeToLiveInSeconds' => <integer>,
            'turnsToLive' => <integer>,
        ],
        // ...
    ],
    'parentIntentSignature' => '<string>',
    'rejectionStatement' => [
        'messages' => [
            [
                'content' => '<string>',
                'contentType' => 'PlainText|SSML|CustomPayload',
                'groupNumber' => <integer>,
            ],
            // ...
        ],
        'responseCard' => '<string>',
    ],
    'sampleUtterances' => ['<string>', ...],
    'slots' => [
        [
            'defaultValueSpec' => [
                'defaultValueList' => [
                    [
                        'defaultValue' => '<string>',
                    ],
                    // ...
                ],
            ],
            'description' => '<string>',
            'name' => '<string>',
            'obfuscationSetting' => 'NONE|DEFAULT_OBFUSCATION',
            'priority' => <integer>,
            'responseCard' => '<string>',
            'sampleUtterances' => ['<string>', ...],
            'slotConstraint' => 'Required|Optional',
            'slotType' => '<string>',
            'slotTypeVersion' => '<string>',
            'valueElicitationPrompt' => [
                'maxAttempts' => <integer>,
                'messages' => [
                    [
                        'content' => '<string>',
                        'contentType' => 'PlainText|SSML|CustomPayload',
                        'groupNumber' => <integer>,
                    ],
                    // ...
                ],
                'responseCard' => '<string>',
            ],
        ],
        // ...
    ],
    'version' => '<string>',
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. Check the resource and try again.

ConflictException:

There was a conflict processing the request. Try your request again.

LimitExceededException:

The request exceeded a limit. Try your request again.

InternalFailureException:

An internal Amazon Lex error occurred. Try your request again.

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.

PreconditionFailedException:

The checksum of the resource that you are trying to change does not match the checksum in the request. Check the resource's checksum and try again.

CreateSlotTypeVersion

$result = $client->createSlotTypeVersion([/* ... */]);
$promise = $client->createSlotTypeVersionAsync([/* ... */]);

Creates a new version of a slot type based on the $LATEST version of the specified slot type. If the $LATEST version of this resource has not changed since the last version that you created, Amazon Lex doesn't create a new version. It returns the last version that you created.

When you create a version of a slot type, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro.

This operation requires permissions for the lex:CreateSlotTypeVersion action.

Parameter Syntax

$result = $client->createSlotTypeVersion([
    'checksum' => '<string>',
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'checksum' => '<string>',
    'createdDate' => <DateTime>,
    'description' => '<string>',
    'enumerationValues' => [
        [
            'synonyms' => ['<string>', ...],
            'value' => '<string>',
        ],
        // ...
    ],
    'lastUpdatedDate' => <DateTime>,
    'name' => '<string>',
    'parentSlotTypeSignature' => '<string>',
    'slotTypeConfigurations' => [
        [
            'regexConfiguration' => [
                'pattern' => '<string>',
            ],
        ],
        // ...
    ],
    'valueSelectionStrategy' => 'ORIGINAL_VALUE|TOP_RESOLUTION',
    'version' => '<string>',
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. Check the resource and try again.

ConflictException:

There was a conflict processing the request. Try your request again.

LimitExceededException:

The request exceeded a limit. Try your request again.

InternalFailureException:

An internal Amazon Lex error occurred. Try your request again.

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.

PreconditionFailedException:

The checksum of the resource that you are trying to change does not match the checksum in the request. Check the resource's checksum and try again.

DeleteBot

$result = $client->deleteBot([/* ... */]);
$promise = $client->deleteBotAsync([/* ... */]);

Deletes all versions of the bot, including the $LATEST version. To delete a specific version of the bot, use the DeleteBotVersion operation. The DeleteBot operation doesn't immediately remove the bot schema. Instead, it is marked for deletion and removed later.

Amazon Lex stores utterances indefinitely for improving the ability of your bot to respond to user inputs. These utterances are not removed when the bot is deleted. To remove the utterances, use the DeleteUtterances operation.

If a bot has an alias, you can't delete it. Instead, the DeleteBot operation returns a ResourceInUseException exception that includes a reference to the alias that refers to the bot. To remove the reference to the bot, delete the alias. If you get the same exception again, delete the referring alias until the DeleteBot operation is successful.

This operation requires permissions for the lex:DeleteBot action.

Parameter Syntax

$result = $client->deleteBot([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. Check the resource and try again.

ConflictException:

There was a conflict processing the request. Try your request again.

LimitExceededException:

The request exceeded a limit. Try your request again.

InternalFailureException:

An internal Amazon Lex error occurred. Try your request again.

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.

ResourceInUseException:

The resource that you are attempting to delete is referred to by another resource. Use this information to remove references to the resource that you are trying to delete.

The body of the exception contains a JSON object that describes the resource.

{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,

"resourceReference": {

"name": string, "version": string } }

DeleteBotAlias

$result = $client->deleteBotAlias([/* ... */]);
$promise = $client->deleteBotAliasAsync([/* ... */]);

Deletes an alias for the specified bot.

You can't delete an alias that is used in the association between a bot and a messaging channel. If an alias is used in a channel association, the DeleteBot operation returns a ResourceInUseException exception that includes a reference to the channel association that refers to the bot. You can remove the reference to the alias by deleting the channel association. If you get the same exception again, delete the referring association until the DeleteBotAlias operation is successful.

Parameter Syntax

$result = $client->deleteBotAlias([
    'botName' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. Check the resource and try again.

ConflictException:

There was a conflict processing the request. Try your request again.

LimitExceededException:

The request exceeded a limit. Try your request again.

InternalFailureException:

An internal Amazon Lex error occurred. Try your request again.

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.

ResourceInUseException:

The resource that you are attempting to delete is referred to by another resource. Use this information to remove references to the resource that you are trying to delete.

The body of the exception contains a JSON object that describes the resource.

{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,

"resourceReference": {

"name": string, "version": string } }

DeleteBotChannelAssociation

$result = $client->deleteBotChannelAssociation([/* ... */]);
$promise = $client->deleteBotChannelAssociationAsync([/* ... */]);

Deletes the association between an Amazon Lex bot and a messaging platform.

This operation requires permission for the lex:DeleteBotChannelAssociation action.

Parameter Syntax

$result = $client->deleteBotChannelAssociation([
    'botAlias' => '<string>', // REQUIRED
    'botName' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. Check the resource and try again.

ConflictException:

There was a conflict processing the request. Try your request again.

LimitExceededException:

The request exceeded a limit. Try your request again.

InternalFailureException:

An internal Amazon Lex error occurred. Try your request again.

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.

DeleteBotVersion

$result = $client->deleteBotVersion([/* ... */]);
$promise = $client->deleteBotVersionAsync([/* ... */]);

Deletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot operation.

This operation requires permissions for the lex:DeleteBotVersion action.

Parameter Syntax

$result = $client->deleteBotVersion([
    'name' => '<string>', // REQUIRED
    'version' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. Check the resource and try again.

ConflictException:

There was a conflict processing the request. Try your request again.

LimitExceededException:

The request exceeded a limit. Try your request again.

InternalFailureException:

An internal Amazon Lex error occurred. Try your request again.

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.

ResourceInUseException:

The resource that you are attempting to delete is referred to by another resource. Use this information to remove references to the resource that you are trying to delete.

The body of the exception contains a JSON object that describes the resource.

{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,

"resourceReference": {

"name": string, "version": string } }

DeleteIntent

$result = $client->deleteIntent([/* ... */]);
$promise = $client->deleteIntentAsync([/* ... */]);

Deletes all versions of the intent, including the $LATEST version. To delete a specific version of the intent, use the DeleteIntentVersion operation.

You can delete a version of an intent only if it is not referenced. To delete an intent that is referred to in one or more bots (see how-it-works), you must remove those references first.

This operation requires permission for the lex:DeleteIntent action.

Parameter Syntax

$result = $client->deleteIntent([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. Check the resource and try again.

ConflictException:

There was a conflict processing the request. Try your request again.

LimitExceededException:

The request exceeded a limit. Try your request again.

InternalFailureException:

An internal Amazon Lex error occurred. Try your request again.

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.

ResourceInUseException:

The resource that you are attempting to delete is referred to by another resource. Use this information to remove references to the resource that you are trying to delete.

The body of the exception contains a JSON object that describes the resource.

{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,

"resourceReference": {

"name": string, "version": string } }

DeleteIntentVersion

$result = $client->deleteIntentVersion([/* ... */]);
$promise = $client->deleteIntentVersionAsync([/* ... */]);

Deletes a specific version of an intent. To delete all versions of a intent, use the DeleteIntent operation.

This operation requires permissions for the lex:DeleteIntentVersion action.

Parameter Syntax

$result = $client->deleteIntentVersion([
    'name' => '<string>', // REQUIRED
    'version' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. Check the resource and try again.

ConflictException:

There was a conflict processing the request. Try your request again.

LimitExceededException:

The request exceeded a limit. Try your request again.

InternalFailureException:

An internal Amazon Lex error occurred. Try your request again.

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.

ResourceInUseException:

The resource that you are attempting to delete is referred to by another resource. Use this information to remove references to the resource that you are trying to delete.

The body of the exception contains a JSON object that describes the resource.

{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,

"resourceReference": {

"name": string, "version": string } }

DeleteSlotType

$result = $client->deleteSlotType([/* ... */]);
$promise = $client->deleteSlotTypeAsync([/* ... */]);

Deletes all versions of the slot type, including the $LATEST version. To delete a specific version of the slot type, use the DeleteSlotTypeVersion operation.

You can delete a version of a slot type only if it is not referenced. To delete a slot type that is referred to in one or more intents, you must remove those references first.

This operation requires permission for the lex:DeleteSlotType action.

Parameter Syntax

$result = $client->deleteSlotType([
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. Check the resource and try again.

ConflictException:

There was a conflict processing the request. Try your request again.

LimitExceededException:

The request exceeded a limit. Try your request again.

InternalFailureException:

An internal Amazon Lex error occurred. Try your request again.

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.

ResourceInUseException:

The resource that you are attempting to delete is referred to by another resource. Use this information to remove references to the resource that you are trying to delete.

The body of the exception contains a JSON object that describes the resource.

{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,

"resourceReference": {

"name": string, "version": string } }

DeleteSlotTypeVersion

$result = $client->deleteSlotTypeVersion([/* ... */]);
$promise = $client->deleteSlotTypeVersionAsync([/* ... */]);

Deletes a specific version of a slot type. To delete all versions of a slot type, use the DeleteSlotType operation.

This operation requires permissions for the lex:DeleteSlotTypeVersion action.

Parameter Syntax

$result = $client->deleteSlotTypeVersion([
    'name' => '<string>', // REQUIRED
    'version' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. Check the resource and try again.

ConflictException:

There was a conflict processing the request. Try your request again.

LimitExceededException:

The request exceeded a limit. Try your request again.

InternalFailureException:

An internal Amazon Lex error occurred. Try your request again.

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.

ResourceInUseException:

The resource that you are attempting to delete is referred to by another resource. Use this information to remove references to the resource that you are trying to delete.

The body of the exception contains a JSON object that describes the resource.

{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,

"resourceReference": {

"name": string, "version": string } }

DeleteUtterances

$result = $client->deleteUtterances([/* ... */]);
$promise = $client->deleteUtterancesAsync([/* ... */]);

Deletes stored utterances.

Amazon Lex stores the utterances that users send to your bot. Utterances are stored for 15 days for use with the GetUtterancesView operation, and then stored indefinitely for use in improving the ability of your bot to respond to user input.

Use the DeleteUtterances operation to manually delete stored utterances for a specific user. When you use the DeleteUtterances operation, utterances stored for improving your bot's ability to respond to user input are deleted immediately. Utterances stored for use with the GetUtterancesView operation are deleted after 15 days.

This operation requires permissions for the lex:DeleteUtterances action.

Parameter Syntax

$result = $client->deleteUtterances([
    'botName' => '<string>', // REQUIRED
    'userId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. Check the resource and try again.

LimitExceededException:

The request exceeded a limit. Try your request again.

InternalFailureException:

An internal Amazon Lex error occurred. Try your request again.

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.

GetBot

$result = $client->getBot([/* ... */]);
$promise = $client->getBotAsync([/* ... */]);

Returns metadata information for a specific bot. You must provide the bot name and the bot version or alias.

This operation requires permissions for the lex:GetBot action.

Parameter Syntax

$result = $client->getBot([
    'name' => '<string>', // REQUIRED
    'versionOrAlias' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'abortStatement' => [
        'messages' => [
            [
                'content' => '<string>',
                'contentType' => 'PlainText|SSML|CustomPayload',
                'groupNumber' => <integer>,
            ],
            // ...
        ],
        'responseCard' => '<string>',
    ],
    'checksum' => '<string>',
    'childDirected' => true || false,
    'clarificationPrompt' => [
        'maxAttempts' => <integer>,
        'messages' => [
            [
                'content' => '<string>',
                'contentType' => 'PlainText|SSML|CustomPayload',
                'groupNumber' => <integer>,
            ],
            // ...
        ],
        'responseCard' => '<string>',
    ],
    'createdDate' => <DateTime>,
    'description' => '<string>',
    'detectSentiment' => true || false,
    'enableModelImprovements' => true || false,
    'failureReason' => '<string>',
    'idleSessionTTLInSeconds' => <integer>,
    'intents' => [
        [
            'intentName' => '<string>',
            'intentVersion' => '<string>',
        ],
        // ...
    ],
    'lastUpdatedDate' => <DateTime>,
    'locale' => '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',
    'name' => '<string>',
    'nluIntentConfidenceThreshold' => <float>,
    'status' => 'BUILDING|READY|READY_BASIC_TESTING|FAILED|NOT_BUILT',
    'version' => '<string>',
    'voiceId' => '<string>',
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. Check the resource and try again.

LimitExceededException:

The request exceeded a limit. Try your request again.

InternalFailureException:

An internal Amazon Lex error occurred. Try your request again.

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.

Examples

Example 1: To get information about a bot

This example shows how to get configuration information for a bot.

$result = $client->getBot([
    'name' => 'DocOrderPizza',
    'versionOrAlias' => '$LATEST',
]);

Result syntax:

[
    'version' => '$LATEST',
    'name' => 'DocOrderPizzaBot',
    'abortStatement' => [
        'messages' => [
            [
                'content' => 'I don't understand. Can you try again?',
                'contentType' => 'PlainText',
            ],
            [
                'content' => 'I'm sorry, I don't understand.',
                'contentType' => 'PlainText',
            ],
        ],
    ],
    'checksum' => '20172ee3-fa06-49b2-bbc5-667c090303e9',
    'childDirected' => 1,
    'clarificationPrompt' => [
        'maxAttempts' => 1,
        'messages' => [
            [
                'content' => 'I'm sorry, I didn't hear that. Can you repeate what you just said?',
                'contentType' => 'PlainText',
            ],
            [
                'content' => 'Can you say that again?',
                'contentType' => 'PlainText',
            ],
        ],
    ],
    'createdDate' => ,
    'description' => 'Orders a pizza from a local pizzeria.',
    'idleSessionTTLInSeconds' => 300,
    'intents' => [
        [
            'intentName' => 'DocOrderPizza',
            'intentVersion' => '$LATEST',
        ],
    ],
    'lastUpdatedDate' => ,
    'locale' => 'en-US',
    'status' => 'NOT_BUILT',
]

GetBotAlias

$result = $client->getBotAlias([/* ... */]);
$promise = $client->getBotAliasAsync([/* ... */]);

Returns information about an Amazon Lex bot alias. For more information about aliases, see versioning-aliases.

This operation requires permissions for the lex:GetBotAlias action.

Parameter Syntax

$result = $client->getBotAlias([
    'botName' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'botName' => '<string>',
    'botVersion' => '<string>',
    'checksum' => '<string>',
    'conversationLogs' => [
        'iamRoleArn' => '<string>',
        'logSettings' => [
            [
                'destination' => 'CLOUDWATCH_LOGS|S3',
                'kmsKeyArn' => '<string>',
                'logType' => 'AUDIO|TEXT',
                'resourceArn' => '<string>',
                'resourcePrefix' => '<string>',
            ],
            // ...
        ],
    ],
    'createdDate' => <DateTime>,
    'description' => '<string>',
    'lastUpdatedDate' => <DateTime>,
    'name' => '<string>',
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. Check the resource and try again.

LimitExceededException:

The request exceeded a limit. Try your request again.

InternalFailureException:

An internal Amazon Lex error occurred. Try your request again.

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.

GetBotAliases

$result = $client->getBotAliases([/* ... */]);
$promise = $client->getBotAliasesAsync([/* ... */]);

Returns a list of aliases for a specified Amazon Lex bot.

This operation requires permissions for the lex:GetBotAliases action.

Parameter Syntax

$result = $client->getBotAliases([
    'botName' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nameContains' => '<string>',
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'BotAliases' => [
        [
            'botName' => '<string>',
            'botVersion' => '<string>',
            'checksum' => '<string>',
            'conversationLogs' => [
                'iamRoleArn' => '<string>',
                'logSettings' => [
                    [
                        'destination' => 'CLOUDWATCH_LOGS|S3',
                        'kmsKeyArn' => '<string>',
                        'logType' => 'AUDIO|TEXT',
                        'resourceArn' => '<string>',
                        'resourcePrefix' => '<string>',
                    ],
                    // ...
                ],
            ],
            'createdDate' => <DateTime>,
            'description' => '<string>',
            'lastUpdatedDate' => <DateTime>,
            'name' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

LimitExceededException:

The request exceeded a limit. Try your request again.

InternalFailureException:

An internal Amazon Lex error occurred. Try your request again.

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.

GetBotChannelAssociation

$result = $client->getBotChannelAssociation([/* ... */]);
$promise = $client->getBotChannelAssociationAsync([/* ... */]);

Returns information about the association between an Amazon Lex bot and a messaging platform.

This operation requires permissions for the lex:GetBotChannelAssociation action.

Parameter Syntax

$result = $client->getBotChannelAssociation([
    'botAlias' => '<string>', // REQUIRED
    'botName' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'botAlias' => '<string>',
    'botConfiguration' => ['<string>', ...],
    'botName' => '<string>',
    'createdDate' => <DateTime>,
    'description' => '<string>',
    'failureReason' => '<string>',
    'name' => '<string>',
    'status' => 'IN_PROGRESS|CREATED|FAILED',
    'type' => 'Facebook|Slack|Twilio-Sms|Kik',
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. Check the resource and try again.

LimitExceededException:

The request exceeded a limit. Try your request again.

InternalFailureException:

An internal Amazon Lex error occurred. Try your request again.

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.

GetBotChannelAssociations

$result = $client->getBotChannelAssociations([/* ... */]);
$promise = $client->getBotChannelAssociationsAsync([/* ... */]);

Returns a list of all of the channels associated with the specified bot.

The GetBotChannelAssociations operation requires permissions for the lex:GetBotChannelAssociations action.

Parameter Syntax

$result = $client->getBotChannelAssociations([
    'botAlias' => '<string>', // REQUIRED
    'botName' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nameContains' => '<string>',
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'botChannelAssociations' => [
        [
            'botAlias' => '<string>',
            'botConfiguration' => ['<string>', ...],
            'botName' => '<string>',
            'createdDate' => <DateTime>,
            'description' => '<string>',
            'failureReason' => '<string>',
            'name' => '<string>',
            'status' => 'IN_PROGRESS|CREATED|FAILED',
            'type' => 'Facebook|Slack|Twilio-Sms|Kik',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

LimitExceededException:

The request exceeded a limit. Try your request again.

InternalFailureException:

An internal Amazon Lex error occurred. Try your request again.

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.

GetBotVersions

$result = $client->getBotVersions([/* ... */]);
$promise = $client->getBotVersionsAsync([/* ... */]);

Gets information about all of the versions of a bot.

The GetBotVersions operation returns a BotMetadata object for each version of a bot. For example, if a bot has three numbered versions, the GetBotVersions operation returns four BotMetadata objects in the response, one for each numbered version and one for the $LATEST version.

The GetBotVersions operation always returns at least one version, the $LATEST version.

This operation requires permissions for the lex:GetBotVersions action.

Parameter Syntax

$result = $client->getBotVersions([
    'maxResults' => <integer>,
    'name' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'bots' => [
        [
            'createdDate' => <DateTime>,
            'description' => '<string>',
            'lastUpdatedDate' => <DateTime>,
            'name' => '<string>',
            'status' => 'BUILDING|READY|READY_BASIC_TESTING|FAILED|NOT_BUILT',
            'version' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. Check the resource and try again.

LimitExceededException:

The request exceeded a limit. Try your request again.

InternalFailureException:

An internal Amazon Lex error occurred. Try your request again.

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.

GetBots

$result = $client->getBots([/* ... */]);
$promise = $client->getBotsAsync([/* ... */]);

Returns bot information as follows:

• If you provide the nameContains field, the response includes information for the $LATEST version of all bots whose name contains the specified string.

• If you don't specify the nameContains field, the operation returns information about the $LATEST version of all of your bots.

This operation requires permission for the lex:GetBots action.

Parameter Syntax

$result = $client->getBots([
    'maxResults' => <integer>,
    'nameContains' => '<string>',
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'bots' => [
        [
            'createdDate' => <DateTime>,
            'description' => '<string>',
            'lastUpdatedDate' => <DateTime>,
            'name' => '<string>',
            'status' => 'BUILDING|READY|READY_BASIC_TESTING|FAILED|NOT_BUILT',
            'version' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. Check the resource and try again.

LimitExceededException:

The request exceeded a limit. Try your request again.

InternalFailureException:

An internal Amazon Lex error occurred. Try your request again.

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.

Examples

Example 1: To get a list of bots

This example shows how to get a list of all of the bots in your account.

$result = $client->getBots([
    'maxResults' => 5,
    'nextToken' => '',
]);

Result syntax:

[
    'bots' => [
        [
            'version' => '$LATEST',
            'name' => 'DocOrderPizzaBot',
            'createdDate' => ,
            'description' => 'Orders a pizza from a local pizzeria.',
            'lastUpdatedDate' => ,
            'status' => 'NOT_BUILT',
        ],
    ],
]

GetBuiltinIntent

$result = $client->getBuiltinIntent([/* ... */]);
$promise = $client->getBuiltinIntentAsync([/* ... */]);

Returns information about a built-in intent.

This operation requires permission for the lex:GetBuiltinIntent action.

Parameter Syntax

$result = $client->getBuiltinIntent([
    'signature' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'signature' => '<string>',
    'slots' => [
        [
            'name' => '<string>',
        ],
        // ...
    ],
    'supportedLocales' => ['<string>', ...],
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. Check the resource and try again.

LimitExceededException:

The request exceeded a limit. Try your request again.

InternalFailureException:

An internal Amazon Lex error occurred. Try your request again.

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.

GetBuiltinIntents

$result = $client->getBuiltinIntents([/* ... */]);
$promise = $client->getBuiltinIntentsAsync([/* ... */]);

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

This operation requires permission for the lex:GetBuiltinIntents action.

Parameter Syntax

$result = $client->getBuiltinIntents([
    'locale' => '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' => <integer>,
    'nextToken' => '<string>',
    'signatureContains' => '<string>',
]);

Parameter Details

Result Syntax

[
    'intents' => [
        [
            'signature' => '<string>',
            'supportedLocales' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

LimitExceededException:

The request exceeded a limit. Try your request again.

InternalFailureException:

An internal Amazon Lex error occurred. Try your request again.

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.

GetBuiltinSlotTypes

$result = $client->getBuiltinSlotTypes([/* ... */]);
$promise = $client->getBuiltinSlotTypesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getBuiltinSlotTypes([
    'locale' => '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' => <integer>,
    'nextToken' => '<string>',
    'signatureContains' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'slotTypes' => [
        [
            'signature' => '<string>',
            'supportedLocales' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Errors

LimitExceededException:

The request exceeded a limit. Try your request again.

InternalFailureException:

An internal Amazon Lex error occurred. Try your request again.

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.

GetExport

$result = $client->getExport([/* ... */]);
$promise = $client->getExportAsync([/* ... */]);

Exports the contents of a Amazon Lex resource in a specified format.

Parameter Syntax

$result = $client->getExport([
    'exportType' => 'ALEXA_SKILLS_KIT|LEX', // REQUIRED
    'name' => '<string>', // REQUIRED
    'resourceType' => 'BOT|INTENT|SLOT_TYPE', // REQUIRED
    'version' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'exportStatus' => 'IN_PROGRESS|READY|FAILED',
    'exportType' => 'ALEXA_SKILLS_KIT|LEX',
    'failureReason' => '<string>',
    'name' => '<string>',
    'resourceType' => 'BOT|INTENT|SLOT_TYPE',
    'url' => '<string>',
    'version' => '<string>',
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. Check the resource and try again.

LimitExceededException:

The request exceeded a limit. Try your request again.

InternalFailureException:

An internal Amazon Lex error occurred. Try your request again.

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.

GetImport

$result = $client->getImport([/* ... */]);
$promise = $client->getImportAsync([/* ... */]);

Gets information about an import job started with the StartImport operation.

Parameter Syntax

$result = $client->getImport([
    'importId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'createdDate' => <DateTime>,
    'failureReason' => ['<string>', ...],
    'importId' => '<string>',
    'importStatus' => 'IN_PROGRESS|COMPLETE|FAILED',
    'mergeStrategy' => 'OVERWRITE_LATEST|FAIL_ON_CONFLICT',
    'name' => '<string>',
    'resourceType' => 'BOT|INTENT|SLOT_TYPE',
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. Check the resource and try again.

LimitExceededException:

The request exceeded a limit. Try your request again.

InternalFailureException:

An internal Amazon Lex error occurred. Try your request again.

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.

GetIntent

$result = $client->getIntent([/* ... */]);
$promise = $client->getIntentAsync([/* ... */]);

Returns information about an intent. In addition to the intent name, you must specify the intent version.

This operation requires permissions to perform the lex:GetIntent action.

Parameter Syntax

$result = $client->getIntent([
    'name' => '<string>', // REQUIRED
    'version' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'checksum' => '<string>',
    'conclusionStatement' => [
        'messages' => [
            [
                'content' => '<string>',
                'contentType' => 'PlainText|SSML|CustomPayload',
                'groupNumber' => <integer>,
            ],
            // ...
        ],
        'responseCard' => '<string>',
    ],
    'confirmationPrompt' => [
        'maxAttempts' => <integer>,
        'messages' => [
            [
                'content' => '<string>',
                'contentType' => 'PlainText|SSML|CustomPayload',
                'groupNumber' => <integer>,
            ],
            // ...
        ],
        'responseCard' => '<string>',
    ],
    'createdDate' => <DateTime>,
    'description' => '<string>',
    'dialogCodeHook' => [
        'messageVersion' => '<string>',
        'uri' => '<string>',
    ],
    'followUpPrompt' => [
        'prompt' => [
            'maxAttempts' => <integer>,
            'messages' => [
                [
                    'content' => '<string>',
                    'contentType' => 'PlainText|SSML|CustomPayload',
                    'groupNumber' => <integer>,
                ],
                // ...
            ],
            'responseCard' => '<string>',
        ],
        'rejectionStatement' => [
            'messages' => [
                [
                    'content' => '<string>',
                    'contentType' => 'PlainText|SSML|CustomPayload',
                    'groupNumber' => <integer>,
                ],
                // ...
            ],
            'responseCard' => '<string>',
        ],
    ],
    'fulfillmentActivity' => [
        'codeHook' => [
            'messageVersion' => '<string>',
            'uri' => '<string>',
        ],
        'type' => 'ReturnIntent|CodeHook',
    ],
    'inputContexts' => [
        [
            'name' => '<string>',
        ],
        // ...
    ],
    'kendraConfiguration' => [
        'kendraIndex' => '<string>',
        'queryFilterString' => '<string>',
        'role' => '<string>',
    ],
    'lastUpdatedDate' => <DateTime>,
    'name' => '<string>',
    'outputContexts' => [
        [
            'name' => '<string>',
            'timeToLiveInSeconds' => <integer>,
            'turnsToLive' => <integer>,
        ],
        // ...
    ],
    'parentIntentSignature' => '<string>',
    'rejectionStatement' => [
        'messages' => [
            [
                'content' => '<string>',
                'contentType' => 'PlainText|SSML|CustomPayload',
                'groupNumber' => <integer>,
            ],
            // ...
        ],
        'responseCard' => '<string>',
    ],
    'sampleUtterances' => ['<string>', ...],
    'slots' => [
        [
            'defaultValueSpec' => [
                'defaultValueList' => [
                    [
                        'defaultValue' => '<string>',
                    ],
                    // ...
                ],
            ],
            'description' => '<string>',
            'name' => '<string>',
            'obfuscationSetting' => 'NONE|DEFAULT_OBFUSCATION',
            'priority' => <integer>,
            'responseCard' => '<string>',
            'sampleUtterances' => ['<string>', ...],
            'slotConstraint' => 'Required|Optional',
            'slotType' => '<string>',
            'slotTypeVersion' => '<string>',
            'valueElicitationPrompt' => [
                'maxAttempts' => <integer>,
                'messages' => [
                    [
                        'content' => '<string>',
                        'contentType' => 'PlainText|SSML|CustomPayload',
                        'groupNumber' => <integer>,
                    ],
                    // ...
                ],
                'responseCard' => '<string>',
            ],
        ],
        // ...
    ],
    'version' => '<string>',
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. Check the resource and try again.

LimitExceededException:

The request exceeded a limit. Try your request again.

InternalFailureException:

An internal Amazon Lex error occurred. Try your request again.

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.

Examples

Example 1: To get a information about an intent

This example shows how to get information about an intent.

$result = $client->getIntent([
    'version' => '$LATEST',
    'name' => 'DocOrderPizza',
]);

Result syntax:

[
    'version' => '$LATEST',
    'name' => 'DocOrderPizza',
    'checksum' => 'ca9bc13d-afc8-4706-bbaf-091f7a5935d6',
    'conclusionStatement' => [
        'messages' => [
            [
                'content' => 'All right, I ordered you a {Crust} crust {Type} pizza with {Sauce} sauce.',
                'contentType' => 'PlainText',
            ],
            [
                'content' => 'OK, your {Crust} crust {Type} pizza with {Sauce} sauce is on the way.',
                'contentType' => 'PlainText',
            ],
        ],
        'responseCard' => 'foo',
    ],
    'confirmationPrompt' => [
        'maxAttempts' => 1,
        'messages' => [
            [
                'content' => 'Should I order your {Crust} crust {Type} pizza with {Sauce} sauce?',
                'contentType' => 'PlainText',
            ],
        ],
    ],
    'createdDate' => ,
    'description' => 'Order a pizza from a local pizzeria.',
    'fulfillmentActivity' => [
        'type' => 'ReturnIntent',
    ],
    'lastUpdatedDate' => ,
    'rejectionStatement' => [
        'messages' => [
            [
                'content' => 'Ok, I'll cancel your order.',
                'contentType' => 'PlainText',
            ],
            [
                'content' => 'I cancelled your order.',
                'contentType' => 'PlainText',
            ],
        ],
    ],
    'sampleUtterances' => [
        'Order me a pizza.',
        'Order me a {Type} pizza.',
        'I want a {Crust} crust {Type} pizza',
        'I want a {Crust} crust {Type} pizza with {Sauce} sauce.',
    ],
    'slots' => [
        [
            'name' => 'Type',
            'description' => 'The type of pizza to order.',
            'priority' => 1,
            'sampleUtterances' => [
                'Get me a {Type} pizza.',
                'A {Type} pizza please.',
                'I'd like a {Type} pizza.',
            ],
            'slotConstraint' => 'Required',
            'slotType' => 'DocPizzaType',
            'slotTypeVersion' => '$LATEST',
            'valueElicitationPrompt' => [
                'maxAttempts' => 1,
                'messages' => [
                    [
                        'content' => 'What type of pizza would you like?',
                        'contentType' => 'PlainText',
                    ],
                    [
                        'content' => 'Vegie or cheese pizza?',
                        'contentType' => 'PlainText',
                    ],
                    [
                        'content' => 'I can get you a vegie or a cheese pizza.',
                        'contentType' => 'PlainText',
                    ],
                ],
            ],
        ],
        [
            'name' => 'Crust',
            'description' => 'The type of pizza crust to order.',
            'priority' => 2,
            'sampleUtterances' => [
                'Make it a {Crust} crust.',
                'I'd like a {Crust} crust.',
            ],
            'slotConstraint' => 'Required',
            'slotType' => 'DocPizzaCrustType',
            'slotTypeVersion' => '$LATEST',
            'valueElicitationPrompt' => [
                'maxAttempts' => 1,
                'messages' => [
                    [
                        'content' => 'What type of crust would you like?',
                        'contentType' => 'PlainText',
                    ],
                    [
                        'content' => 'Thick or thin crust?',
                        'contentType' => 'PlainText',
                    ],
                ],
            ],
        ],
        [
            'name' => 'Sauce',
            'description' => 'The type of sauce to use on the pizza.',
            'priority' => 3,
            'sampleUtterances' => [
                'Make it {Sauce} sauce.',
                'I'd like {Sauce} sauce.',
            ],
            'slotConstraint' => 'Required',
            'slotType' => 'DocPizzaSauceType',
            'slotTypeVersion' => '$LATEST',
            'valueElicitationPrompt' => [
                'maxAttempts' => 1,
                'messages' => [
                    [
                        'content' => 'White or red sauce?',
                        'contentType' => 'PlainText',
                    ],
                    [
                        'content' => 'Garlic or tomato sauce?',
                        'contentType' => 'PlainText',
                    ],
                ],
            ],
        ],
    ],
]

GetIntentVersions

$result = $client->getIntentVersions([/* ... */]);
$promise = $client->getIntentVersionsAsync([/* ... */]);

Gets information about all of the versions of an intent.

The GetIntentVersions operation returns an IntentMetadata object for each version of an intent. For example, if an intent has three numbered versions, the GetIntentVersions operation returns four IntentMetadata objects in the response, one for each numbered version and one for the $LATEST version.

The GetIntentVersions operation always returns at least one version, the $LATEST version.

This operation requires permissions for the lex:GetIntentVersions action.

Parameter Syntax

$result = $client->getIntentVersions([
    'maxResults' => <integer>,
    'name' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'intents' => [
        [
            'createdDate' => <DateTime>,
            'description' => '<string>',
            'lastUpdatedDate' => <DateTime>,
            'name' => '<string>',
            'version' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. Check the resource and try again.

LimitExceededException:

The request exceeded a limit. Try your request again.

InternalFailureException:

An internal Amazon Lex error occurred. Try your request again.

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.

GetIntents

$result = $client->getIntents([/* ... */]);
$promise = $client->getIntentsAsync([/* ... */]);

Returns intent information as follows:

• If you specify the nameContains field, returns the $LATEST version of all intents that contain the specified string.

• If you don't specify the nameContains field, returns information about the $LATEST version of all intents.

The operation requires permission for the lex:GetIntents action.

Parameter Syntax

$result = $client->getIntents([
    'maxResults' => <integer>,
    'nameContains' => '<string>',
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'intents' => [
        [
            'createdDate' => <DateTime>,
            'description' => '<string>',
            'lastUpdatedDate' => <DateTime>,
            'name' => '<string>',
            'version' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. Check the resource and try again.

LimitExceededException:

The request exceeded a limit. Try your request again.

InternalFailureException:

An internal Amazon Lex error occurred. Try your request again.

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.

Examples

Example 1: To get a list of intents

This example shows how to get a list of all of the intents in your account.

$result = $client->getIntents([
    'maxResults' => 10,
    'nextToken' => '',
]);

Result syntax:

[
    'intents' => [
        [
            'version' => '$LATEST',
            'name' => 'DocOrderPizza',
            'createdDate' => ,
            'description' => 'Order a pizza from a local pizzeria.',
            'lastUpdatedDate' => ,
        ],
    ],
]

GetMigration

$result = $client->getMigration([/* ... */]);
$promise = $client->getMigrationAsync([/* ... */]);

Provides details about an ongoing or complete migration from an Amazon Lex V1 bot to an Amazon Lex V2 bot. Use this operation to view the migration alerts and warnings related to the migration.

Parameter Syntax

$result = $client->getMigration([
    'migrationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'alerts' => [
        [
            'details' => ['<string>', ...],
            'message' => '<string>',
            'referenceURLs' => ['<string>', ...],
            'type' => 'ERROR|WARN',
        ],
        // ...
    ],
    'migrationId' => '<string>',
    'migrationStatus' => 'IN_PROGRESS|COMPLETED|FAILED',
    'migrationStrategy' => 'CREATE_NEW|UPDATE_EXISTING',
    'migrationTimestamp' => <DateTime>,
    'v1BotLocale' => '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',
    'v1BotName' => '<string>',
    'v1BotVersion' => '<string>',
    'v2BotId' => '<string>',
    'v2BotRole' => '<string>',
]

Result Details

Errors

LimitExceededException:

The request exceeded a limit. Try your request again.

InternalFailureException:

An internal Amazon Lex error occurred. Try your request again.

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.

NotFoundException:

The resource specified in the request was not found. Check the resource and try again.

GetMigrations

$result = $client->getMigrations([/* ... */]);
$promise = $client->getMigrationsAsync([/* ... */]);

Gets a list of migrations between Amazon Lex V1 and Amazon Lex V2.

Parameter Syntax

$result = $client->getMigrations([
    'maxResults' => <integer>,
    'migrationStatusEquals' => 'IN_PROGRESS|COMPLETED|FAILED',
    'nextToken' => '<string>',
    'sortByAttribute' => 'V1_BOT_NAME|MIGRATION_DATE_TIME',
    'sortByOrder' => 'ASCENDING|DESCENDING',
    'v1BotNameContains' => '<string>',
]);

Parameter Details

Result Syntax

[
    'migrationSummaries' => [
        [
            'migrationId' => '<string>',
            'migrationStatus' => 'IN_PROGRESS|COMPLETED|FAILED',
            'migrationStrategy' => 'CREATE_NEW|UPDATE_EXISTING',
            'migrationTimestamp' => <DateTime>,
            'v1BotLocale' => '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',
            'v1BotName' => '<string>',
            'v1BotVersion' => '<string>',
            'v2BotId' => '<string>',
            'v2BotRole' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

LimitExceededException:

The request exceeded a limit. Try your request again.

InternalFailureException:

An internal Amazon Lex error occurred. Try your request again.

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.

GetSlotType

$result = $client->getSlotType([/* ... */]);
$promise = $client->getSlotTypeAsync([/* ... */]);

Returns information about a specific version of a slot type. In addition to specifying the slot type name, you must specify the slot type version.

This operation requires permissions for the lex:GetSlotType action.

Parameter Syntax

$result = $client->getSlotType([
    'name' => '<string>', // REQUIRED
    'version' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'checksum' => '<string>',
    'createdDate' => <DateTime>,
    'description' => '<string>',
    'enumerationValues' => [
        [
            'synonyms' => ['<string>', ...],
            'value' => '<string>',
        ],
        // ...
    ],
    'lastUpdatedDate' => <DateTime>,
    'name' => '<string>',
    'parentSlotTypeSignature' => '<string>',
    'slotTypeConfigurations' => [
        [
            'regexConfiguration' => [
                'pattern' => '<string>',
            ],
        ],
        // ...
    ],
    'valueSelectionStrategy' => 'ORIGINAL_VALUE|TOP_RESOLUTION',
    'version' => '<string>',
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. Check the resource and try again.

LimitExceededException:

The request exceeded a limit. Try your request again.

InternalFailureException:

An internal Amazon Lex error occurred. Try your request again.

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.

Examples

Example 1: To get information about a slot type

This example shows how to get information about a slot type.

$result = $client->getSlotType([
    'version' => '$LATEST',
    'name' => 'DocPizzaCrustType',
]);

Result syntax:

[
    'version' => '$LATEST',
    'name' => 'DocPizzaCrustType',
    'checksum' => '210b3d5a-90a3-4b22-ac7e-f50c2c71095f',
    'createdDate' => ,
    'description' => 'Available crust types',
    'enumerationValues' => [
        [
            'value' => 'thick',
        ],
        [
            'value' => 'thin',
        ],
    ],
    'lastUpdatedDate' => ,
]

GetSlotTypeVersions

$result = $client->getSlotTypeVersions([/* ... */]);
$promise = $client->getSlotTypeVersionsAsync([/* ... */]);

Gets information about all versions of a slot type.

The GetSlotTypeVersions operation returns a SlotTypeMetadata object for each version of a slot type. For example, if a slot type has three numbered versions, the GetSlotTypeVersions operation returns four SlotTypeMetadata objects in the response, one for each numbered version and one for the $LATEST version.

The GetSlotTypeVersions operation always returns at least one version, the $LATEST version.

This operation requires permissions for the lex:GetSlotTypeVersions action.

Parameter Syntax

$result = $client->getSlotTypeVersions([
    'maxResults' => <integer>,
    'name' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'slotTypes' => [
        [
            'createdDate' => <DateTime>,
            'description' => '<string>',
            'lastUpdatedDate' => <DateTime>,
            'name' => '<string>',
            'version' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. Check the resource and try again.

LimitExceededException:

The request exceeded a limit. Try your request again.

InternalFailureException:

An internal Amazon Lex error occurred. Try your request again.

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.

GetSlotTypes

$result = $client->getSlotTypes([/* ... */]);
$promise = $client->getSlotTypesAsync([/* ... */]);

Returns slot type information as follows:

• If you specify the nameContains field, returns the $LATEST version of all slot types that contain the specified string.

• If you don't specify the nameContains field, returns information about the $LATEST version of all slot types.

The operation requires permission for the lex:GetSlotTypes action.

Parameter Syntax

$result = $client->getSlotTypes([
    'maxResults' => <integer>,
    'nameContains' => '<string>',
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'slotTypes' => [
        [
            'createdDate' => <DateTime>,
            'description' => '<string>',
            'lastUpdatedDate' => <DateTime>,
            'name' => '<string>',
            'version' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. Check the resource and try again.

LimitExceededException:

The request exceeded a limit. Try your request again.

InternalFailureException:

An internal Amazon Lex error occurred. Try your request again.

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.

Examples

Example 1: To get a list of slot types

This example shows how to get a list of all of the slot types in your account.

$result = $client->getSlotTypes([
    'maxResults' => 10,
    'nextToken' => '',
]);

Result syntax:

[
    'slotTypes' => [
        [
            'version' => '$LATEST',
            'name' => 'DocPizzaCrustType',
            'createdDate' => ,
            'description' => 'Available crust types',
            'lastUpdatedDate' => ,
        ],
        [
            'version' => '$LATEST',
            'name' => 'DocPizzaSauceType',
            'createdDate' => ,
            'description' => 'Available pizza sauces',
            'lastUpdatedDate' => ,
        ],
        [
            'version' => '$LATEST',
            'name' => 'DocPizzaType',
            'createdDate' => ,
            'description' => 'Available pizzas',
            'lastUpdatedDate' => ,
        ],
    ],
]

GetUtterancesView

$result = $client->getUtterancesView([/* ... */]);
$promise = $client->getUtterancesViewAsync([/* ... */]);

Use the GetUtterancesView operation to get information about the utterances that your users have made to your bot. You can use this list to tune the utterances that your bot responds to.

For example, say that you have created a bot to order flowers. After your users have used your bot for a while, use the GetUtterancesView operation to see the requests that they have made and whether they have been successful. You might find that the utterance "I want flowers" is not being recognized. You could add this utterance to the OrderFlowers intent so that your bot recognizes that utterance.

After you publish a new version of a bot, you can get information about the old version and the new so that you can compare the performance across the two versions.

Utterance statistics are generated once a day. Data is available for the last 15 days. You can request information for up to 5 versions of your bot in each request. Amazon Lex returns the most frequent utterances received by the bot in the last 15 days. The response contains information about a maximum of 100 utterances for each version.

If you set childDirected field to true when you created your bot, if you are using slot obfuscation with one or more slots, or if you opted out of participating in improving Amazon Lex, utterances are not available.

This operation requires permissions for the lex:GetUtterancesView action.

Parameter Syntax

$result = $client->getUtterancesView([
    'botName' => '<string>', // REQUIRED
    'botVersions' => ['<string>', ...], // REQUIRED
    'statusType' => 'Detected|Missed', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'botName' => '<string>',
    'utterances' => [
        [
            'botVersion' => '<string>',
            'utterances' => [
                [
                    'count' => <integer>,
                    'distinctUsers' => <integer>,
                    'firstUtteredDate' => <DateTime>,
                    'lastUtteredDate' => <DateTime>,
                    'utteranceString' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

LimitExceededException:

The request exceeded a limit. Try your request again.

InternalFailureException:

An internal Amazon Lex error occurred. Try your request again.

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.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Gets a list of tags associated with the specified resource. Only bots, bot aliases, and bot channels can have tags associated with them.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

NotFoundException:

The resource specified in the request was not found. Check the resource and try again.

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.

InternalFailureException:

An internal Amazon Lex error occurred. Try your request again.

LimitExceededException:

The request exceeded a limit. Try your request again.

PutBot

$result = $client->putBot([/* ... */]);
$promise = $client->putBotAsync([/* ... */]);

Creates an Amazon Lex conversational bot or replaces an existing bot. When you create or update a bot you are only required to specify a name, a locale, and whether the bot is directed toward children under age 13. You can use this to add intents later, or to remove intents from an existing bot. When you create a bot with the minimum information, the bot is created or updated but Amazon Lex returns the response FAILED. You can build the bot after you add one or more intents. For more information about Amazon Lex bots, see how-it-works.

$result = $client->putBot([
    'abortStatement' => [
        'messages' => [ // REQUIRED
            [
                'content' => '<string>', // REQUIRED
                'contentType' => 'PlainText|SSML|CustomPayload', // REQUIRED
                'groupNumber' => <integer>,
            ],
            // ...
        ],
        'responseCard' => '<string>',
    ],
    'checksum' => '<string>',
    'childDirected' => true || false, // REQUIRED
    'clarificationPrompt' => [
        'maxAttempts' => <integer>, // REQUIRED
        'messages' => [ // REQUIRED
            [
                'content' => '<string>', // REQUIRED
                'contentType' => 'PlainText|SSML|CustomPayload', // REQUIRED
                'groupNumber' => <integer>,
            ],
            // ...
        ],
        'responseCard' => '<string>',
    ],
    'createVersion' => true || false,
    'description' => '<string>',
    'detectSentiment' => true || false,
    'enableModelImprovements' => true || false,
    'idleSessionTTLInSeconds' => <integer>,
    'intents' => [
        [
            'intentName' => '<string>', // REQUIRED
            'intentVersion' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'locale' => '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', // REQUIRED
    'name' => '<string>', // REQUIRED
    'nluIntentConfidenceThreshold' => <float>,
    'processBehavior' => 'SAVE|BUILD',
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'voiceId' => '<string>',
]);

[
    'abortStatement' => [
        'messages' => [
            [
                'content' => '<string>',
                'contentType' => 'PlainText|SSML|CustomPayload',
                'groupNumber' => <integer>,
            ],
            // ...
        ],
        'responseCard' => '<string>',
    ],
    'checksum' => '<string>',
    'childDirected' => true || false,
    'clarificationPrompt' => [
        'maxAttempts' => <integer>,
        'messages' => [
            [
                'content' => '<string>',
                'contentType' => 'PlainText|SSML|CustomPayload',
                'groupNumber' => <integer>,
            ],
            // ...
        ],
        'responseCard' => '<string>',
    ],
    'createVersion' => true || false,
    'createdDate' => <DateTime>,
    'description' => '<string>',
    'detectSentiment' => true || false,
    'enableModelImprovements' => true || false,
    'failureReason' => '<string>',
    'idleSessionTTLInSeconds' => <integer>,
    'intents' => [
        [
            'intentName' => '<string>',
            'intentVersion' => '<string>',
        ],
        // ...
    ],
    'lastUpdatedDate' => <DateTime>,
    'locale' => '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',
    'name' => '<string>',
    'nluIntentConfidenceThreshold' => <float>,
    'status' => 'BUILDING|READY|READY_BASIC_TESTING|FAILED|NOT_BUILT',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'version' => '<string>',
    'voiceId' => '<string>',
]

$result = $client->putBot([
    'name' => 'DocOrderPizzaBot',
    'abortStatement' => [
        'messages' => [
            [
                'content' => 'I don't understand. Can you try again?',
                'contentType' => 'PlainText',
            ],
            [
                'content' => 'I'm sorry, I don't understand.',
                'contentType' => 'PlainText',
            ],
        ],
    ],
    'childDirected' => 1,
    'clarificationPrompt' => [
        'maxAttempts' => 1,
        'messages' => [
            [
                'content' => 'I'm sorry, I didn't hear that. Can you repeat what you just said?',
                'contentType' => 'PlainText',
            ],
            [
                'content' => 'Can you say that again?',
                'contentType' => 'PlainText',
            ],
        ],
    ],
    'description' => 'Orders a pizza from a local pizzeria.',
    'idleSessionTTLInSeconds' => 300,
    'intents' => [
        [
            'intentName' => 'DocOrderPizza',
            'intentVersion' => '$LATEST',
        ],
    ],
    'locale' => 'en-US',
    'processBehavior' => 'SAVE',
]);

[
    'version' => '$LATEST',
    'name' => 'DocOrderPizzaBot',
    'abortStatement' => [
        'messages' => [
            [
                'content' => 'I don't understand. Can you try again?',
                'contentType' => 'PlainText',
            ],
            [
                'content' => 'I'm sorry, I don't understand.',
                'contentType' => 'PlainText',
            ],
        ],
    ],
    'checksum' => '20172ee3-fa06-49b2-bbc5-667c090303e9',
    'childDirected' => 1,
    'clarificationPrompt' => [
        'maxAttempts' => 1,
        'messages' => [
            [
                'content' => 'I'm sorry, I didn't hear that. Can you repeate what you just said?',
                'contentType' => 'PlainText',
            ],
            [
                'content' => 'Can you say that again?',
                'contentType' => 'PlainText',
            ],
        ],
    ],
    'createdDate' => ,
    'description' => 'Orders a pizza from a local pizzeria.',
    'idleSessionTTLInSeconds' => 300,
    'intents' => [
        [
            'intentName' => 'DocOrderPizza',
            'intentVersion' => '$LATEST',
        ],
    ],
    'lastUpdatedDate' => ,
    'locale' => 'en-US',
    'status' => 'NOT_BUILT',
]