Amazon Lex Model Building V2 2020-08-07

BuildBotLocale

$result = $client->buildBotLocale([/* ... */]);
$promise = $client->buildBotLocaleAsync([/* ... */]);

Parameter Syntax

$result = $client->buildBotLocale([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'localeId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'botId' => '<string>',
    'botLocaleStatus' => 'Creating|Building|Built|ReadyExpressTesting|Failed|Deleting|NotBuilt|Importing|Processing',
    'botVersion' => '<string>',
    'lastBuildSubmittedDateTime' => <DateTime>,
    'localeId' => '<string>',
]

Result Details

Errors

• ThrottlingException:

  Your request rate is too high. Reduce the frequency of requests.

• ServiceQuotaExceededException:

  You have reached a quota for your bot.

• ValidationException:

  One of the input parameters in your request isn't valid. Check the parameters and try your request again.

• PreconditionFailedException:

  Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

• ConflictException:

  The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

• InternalServerException:

  The service encountered an unexpected condition. Try your request again.

CreateBot

$result = $client->createBot([/* ... */]);
$promise = $client->createBotAsync([/* ... */]);

Parameter Syntax

$result = $client->createBot([
    'botName' => '<string>', // REQUIRED
    'botTags' => ['<string>', ...],
    'dataPrivacy' => [ // REQUIRED
        'childDirected' => true || false, // REQUIRED
    ],
    'description' => '<string>',
    'idleSessionTTLInSeconds' => <integer>, // REQUIRED
    'roleArn' => '<string>', // REQUIRED
    'testBotAliasTags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'botId' => '<string>',
    'botName' => '<string>',
    'botStatus' => 'Creating|Available|Inactive|Deleting|Failed|Versioning|Importing',
    'botTags' => ['<string>', ...],
    'creationDateTime' => <DateTime>,
    'dataPrivacy' => [
        'childDirected' => true || false,
    ],
    'description' => '<string>',
    'idleSessionTTLInSeconds' => <integer>,
    'roleArn' => '<string>',
    'testBotAliasTags' => ['<string>', ...],
]

Result Details

Errors

• ThrottlingException:

  Your request rate is too high. Reduce the frequency of requests.

• ServiceQuotaExceededException:

  You have reached a quota for your bot.

• ValidationException:

  One of the input parameters in your request isn't valid. Check the parameters and try your request again.

• PreconditionFailedException:

  Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

• ConflictException:

  The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

• InternalServerException:

  The service encountered an unexpected condition. Try your request again.

CreateBotAlias

$result = $client->createBotAlias([/* ... */]);
$promise = $client->createBotAliasAsync([/* ... */]);

Parameter Syntax

$result = $client->createBotAlias([
    'botAliasLocaleSettings' => [
        '<LocaleId>' => [
            'codeHookSpecification' => [
                'lambdaCodeHook' => [ // REQUIRED
                    'codeHookInterfaceVersion' => '<string>', // REQUIRED
                    'lambdaARN' => '<string>', // REQUIRED
                ],
            ],
            'enabled' => true || false, // REQUIRED
        ],
        // ...
    ],
    'botAliasName' => '<string>', // REQUIRED
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>',
    'conversationLogSettings' => [
        'audioLogSettings' => [
            [
                'destination' => [ // REQUIRED
                    's3Bucket' => [ // REQUIRED
                        'kmsKeyArn' => '<string>',
                        'logPrefix' => '<string>', // REQUIRED
                        's3BucketArn' => '<string>', // REQUIRED
                    ],
                ],
                'enabled' => true || false, // REQUIRED
            ],
            // ...
        ],
        'textLogSettings' => [
            [
                'destination' => [ // REQUIRED
                    'cloudWatch' => [ // REQUIRED
                        'cloudWatchLogGroupArn' => '<string>', // REQUIRED
                        'logPrefix' => '<string>', // REQUIRED
                    ],
                ],
                'enabled' => true || false, // REQUIRED
            ],
            // ...
        ],
    ],
    'description' => '<string>',
    'sentimentAnalysisSettings' => [
        'detectSentiment' => true || false, // REQUIRED
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'botAliasId' => '<string>',
    'botAliasLocaleSettings' => [
        '<LocaleId>' => [
            'codeHookSpecification' => [
                'lambdaCodeHook' => [
                    'codeHookInterfaceVersion' => '<string>',
                    'lambdaARN' => '<string>',
                ],
            ],
            'enabled' => true || false,
        ],
        // ...
    ],
    'botAliasName' => '<string>',
    'botAliasStatus' => 'Creating|Available|Deleting|Failed',
    'botId' => '<string>',
    'botVersion' => '<string>',
    'conversationLogSettings' => [
        'audioLogSettings' => [
            [
                'destination' => [
                    's3Bucket' => [
                        'kmsKeyArn' => '<string>',
                        'logPrefix' => '<string>',
                        's3BucketArn' => '<string>',
                    ],
                ],
                'enabled' => true || false,
            ],
            // ...
        ],
        'textLogSettings' => [
            [
                'destination' => [
                    'cloudWatch' => [
                        'cloudWatchLogGroupArn' => '<string>',
                        'logPrefix' => '<string>',
                    ],
                ],
                'enabled' => true || false,
            ],
            // ...
        ],
    ],
    'creationDateTime' => <DateTime>,
    'description' => '<string>',
    'sentimentAnalysisSettings' => [
        'detectSentiment' => true || false,
    ],
    'tags' => ['<string>', ...],
]

Result Details

Errors

• ThrottlingException:

  Your request rate is too high. Reduce the frequency of requests.

• ServiceQuotaExceededException:

  You have reached a quota for your bot.

• ValidationException:

  One of the input parameters in your request isn't valid. Check the parameters and try your request again.

• PreconditionFailedException:

  Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

• ConflictException:

  The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

• InternalServerException:

  The service encountered an unexpected condition. Try your request again.

CreateBotLocale

$result = $client->createBotLocale([/* ... */]);
$promise = $client->createBotLocaleAsync([/* ... */]);

Parameter Syntax

$result = $client->createBotLocale([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'description' => '<string>',
    'localeId' => '<string>', // REQUIRED
    'nluIntentConfidenceThreshold' => <float>, // REQUIRED
    'voiceSettings' => [
        'engine' => 'standard|neural',
        'voiceId' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'botId' => '<string>',
    'botLocaleStatus' => 'Creating|Building|Built|ReadyExpressTesting|Failed|Deleting|NotBuilt|Importing|Processing',
    'botVersion' => '<string>',
    'creationDateTime' => <DateTime>,
    'description' => '<string>',
    'localeId' => '<string>',
    'localeName' => '<string>',
    'nluIntentConfidenceThreshold' => <float>,
    'voiceSettings' => [
        'engine' => 'standard|neural',
        'voiceId' => '<string>',
    ],
]

Result Details

Errors

• ThrottlingException:

  Your request rate is too high. Reduce the frequency of requests.

• ServiceQuotaExceededException:

  You have reached a quota for your bot.

• ValidationException:

  One of the input parameters in your request isn't valid. Check the parameters and try your request again.

• PreconditionFailedException:

  Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

• ConflictException:

  The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

• InternalServerException:

  The service encountered an unexpected condition. Try your request again.

CreateBotVersion

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

Parameter Syntax

$result = $client->createBotVersion([
    'botId' => '<string>', // REQUIRED
    'botVersionLocaleSpecification' => [ // REQUIRED
        '<LocaleId>' => [
            'sourceBotVersion' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'description' => '<string>',
]);

Parameter Details

Result Syntax

[
    'botId' => '<string>',
    'botStatus' => 'Creating|Available|Inactive|Deleting|Failed|Versioning|Importing',
    'botVersion' => '<string>',
    'botVersionLocaleSpecification' => [
        '<LocaleId>' => [
            'sourceBotVersion' => '<string>',
        ],
        // ...
    ],
    'creationDateTime' => <DateTime>,
    'description' => '<string>',
]

Result Details

Errors

• ThrottlingException:

  Your request rate is too high. Reduce the frequency of requests.

• ServiceQuotaExceededException:

  You have reached a quota for your bot.

• ValidationException:

  One of the input parameters in your request isn't valid. Check the parameters and try your request again.

• PreconditionFailedException:

  Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

• ConflictException:

  The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

• InternalServerException:

  The service encountered an unexpected condition. Try your request again.

CreateExport

$result = $client->createExport([/* ... */]);
$promise = $client->createExportAsync([/* ... */]);

Parameter Syntax

$result = $client->createExport([
    'fileFormat' => 'LexJson|TSV', // REQUIRED
    'filePassword' => '<string>',
    'resourceSpecification' => [ // REQUIRED
        'botExportSpecification' => [
            'botId' => '<string>', // REQUIRED
            'botVersion' => '<string>', // REQUIRED
        ],
        'botLocaleExportSpecification' => [
            'botId' => '<string>', // REQUIRED
            'botVersion' => '<string>', // REQUIRED
            'localeId' => '<string>', // REQUIRED
        ],
        'customVocabularyExportSpecification' => [
            'botId' => '<string>', // REQUIRED
            'botVersion' => '<string>', // REQUIRED
            'localeId' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'creationDateTime' => <DateTime>,
    'exportId' => '<string>',
    'exportStatus' => 'InProgress|Completed|Failed|Deleting',
    'fileFormat' => 'LexJson|TSV',
    'resourceSpecification' => [
        'botExportSpecification' => [
            'botId' => '<string>',
            'botVersion' => '<string>',
        ],
        'botLocaleExportSpecification' => [
            'botId' => '<string>',
            'botVersion' => '<string>',
            'localeId' => '<string>',
        ],
        'customVocabularyExportSpecification' => [
            'botId' => '<string>',
            'botVersion' => '<string>',
            'localeId' => '<string>',
        ],
    ],
]

Result Details

Errors

• ThrottlingException:

  Your request rate is too high. Reduce the frequency of requests.

• ServiceQuotaExceededException:

  You have reached a quota for your bot.

• ValidationException:

  One of the input parameters in your request isn't valid. Check the parameters and try your request again.

• ResourceNotFoundException:

  You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

• ConflictException:

  The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

• InternalServerException:

  The service encountered an unexpected condition. Try your request again.

CreateIntent

$result = $client->createIntent([/* ... */]);
$promise = $client->createIntentAsync([/* ... */]);

Parameter Syntax

$result = $client->createIntent([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'description' => '<string>',
    'dialogCodeHook' => [
        'enabled' => true || false, // REQUIRED
    ],
    'fulfillmentCodeHook' => [
        'enabled' => true || false, // REQUIRED
        'fulfillmentUpdatesSpecification' => [
            'active' => true || false, // REQUIRED
            'startResponse' => [
                'allowInterrupt' => true || false,
                'delayInSeconds' => <integer>, // REQUIRED
                'messageGroups' => [ // REQUIRED
                    [
                        'message' => [ // REQUIRED
                            'customPayload' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>', // REQUIRED
                                        'value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>', // REQUIRED
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>', // REQUIRED
                                            'value' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>', // REQUIRED
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
            'timeoutInSeconds' => <integer>,
            'updateResponse' => [
                'allowInterrupt' => true || false,
                'frequencyInSeconds' => <integer>, // REQUIRED
                'messageGroups' => [ // REQUIRED
                    [
                        'message' => [ // REQUIRED
                            'customPayload' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>', // REQUIRED
                                        'value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>', // REQUIRED
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>', // REQUIRED
                                            'value' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>', // REQUIRED
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
        ],
        'postFulfillmentStatusSpecification' => [
            'failureResponse' => [
                'allowInterrupt' => true || false,
                'messageGroups' => [ // REQUIRED
                    [
                        'message' => [ // REQUIRED
                            'customPayload' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>', // REQUIRED
                                        'value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>', // REQUIRED
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>', // REQUIRED
                                            'value' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>', // REQUIRED
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
            'successResponse' => [
                'allowInterrupt' => true || false,
                'messageGroups' => [ // REQUIRED
                    [
                        'message' => [ // REQUIRED
                            'customPayload' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>', // REQUIRED
                                        'value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>', // REQUIRED
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>', // REQUIRED
                                            'value' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>', // REQUIRED
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
            'timeoutResponse' => [
                'allowInterrupt' => true || false,
                'messageGroups' => [ // REQUIRED
                    [
                        'message' => [ // REQUIRED
                            'customPayload' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>', // REQUIRED
                                        'value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>', // REQUIRED
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>', // REQUIRED
                                            'value' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>', // REQUIRED
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
        ],
    ],
    'inputContexts' => [
        [
            'name' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'intentClosingSetting' => [
        'active' => true || false,
        'closingResponse' => [ // REQUIRED
            'allowInterrupt' => true || false,
            'messageGroups' => [ // REQUIRED
                [
                    'message' => [ // REQUIRED
                        'customPayload' => [
                            'value' => '<string>', // REQUIRED
                        ],
                        'imageResponseCard' => [
                            'buttons' => [
                                [
                                    'text' => '<string>', // REQUIRED
                                    'value' => '<string>', // REQUIRED
                                ],
                                // ...
                            ],
                            'imageUrl' => '<string>',
                            'subtitle' => '<string>',
                            'title' => '<string>', // REQUIRED
                        ],
                        'plainTextMessage' => [
                            'value' => '<string>', // REQUIRED
                        ],
                        'ssmlMessage' => [
                            'value' => '<string>', // REQUIRED
                        ],
                    ],
                    'variations' => [
                        [
                            'customPayload' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>', // REQUIRED
                                        'value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>', // REQUIRED
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
    ],
    'intentConfirmationSetting' => [
        'active' => true || false,
        'declinationResponse' => [ // REQUIRED
            'allowInterrupt' => true || false,
            'messageGroups' => [ // REQUIRED
                [
                    'message' => [ // REQUIRED
                        'customPayload' => [
                            'value' => '<string>', // REQUIRED
                        ],
                        'imageResponseCard' => [
                            'buttons' => [
                                [
                                    'text' => '<string>', // REQUIRED
                                    'value' => '<string>', // REQUIRED
                                ],
                                // ...
                            ],
                            'imageUrl' => '<string>',
                            'subtitle' => '<string>',
                            'title' => '<string>', // REQUIRED
                        ],
                        'plainTextMessage' => [
                            'value' => '<string>', // REQUIRED
                        ],
                        'ssmlMessage' => [
                            'value' => '<string>', // REQUIRED
                        ],
                    ],
                    'variations' => [
                        [
                            'customPayload' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>', // REQUIRED
                                        'value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>', // REQUIRED
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
        'promptSpecification' => [ // REQUIRED
            'allowInterrupt' => true || false,
            'maxRetries' => <integer>, // REQUIRED
            'messageGroups' => [ // REQUIRED
                [
                    'message' => [ // REQUIRED
                        'customPayload' => [
                            'value' => '<string>', // REQUIRED
                        ],
                        'imageResponseCard' => [
                            'buttons' => [
                                [
                                    'text' => '<string>', // REQUIRED
                                    'value' => '<string>', // REQUIRED
                                ],
                                // ...
                            ],
                            'imageUrl' => '<string>',
                            'subtitle' => '<string>',
                            'title' => '<string>', // REQUIRED
                        ],
                        'plainTextMessage' => [
                            'value' => '<string>', // REQUIRED
                        ],
                        'ssmlMessage' => [
                            'value' => '<string>', // REQUIRED
                        ],
                    ],
                    'variations' => [
                        [
                            'customPayload' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>', // REQUIRED
                                        'value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>', // REQUIRED
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
    ],
    'intentName' => '<string>', // REQUIRED
    'kendraConfiguration' => [
        'kendraIndex' => '<string>', // REQUIRED
        'queryFilterString' => '<string>',
        'queryFilterStringEnabled' => true || false,
    ],
    'localeId' => '<string>', // REQUIRED
    'outputContexts' => [
        [
            'name' => '<string>', // REQUIRED
            'timeToLiveInSeconds' => <integer>, // REQUIRED
            'turnsToLive' => <integer>, // REQUIRED
        ],
        // ...
    ],
    'parentIntentSignature' => '<string>',
    'sampleUtterances' => [
        [
            'utterance' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'botId' => '<string>',
    'botVersion' => '<string>',
    'creationDateTime' => <DateTime>,
    'description' => '<string>',
    'dialogCodeHook' => [
        'enabled' => true || false,
    ],
    'fulfillmentCodeHook' => [
        'enabled' => true || false,
        'fulfillmentUpdatesSpecification' => [
            'active' => true || false,
            'startResponse' => [
                'allowInterrupt' => true || false,
                'delayInSeconds' => <integer>,
                'messageGroups' => [
                    [
                        'message' => [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>',
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>',
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>',
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
            'timeoutInSeconds' => <integer>,
            'updateResponse' => [
                'allowInterrupt' => true || false,
                'frequencyInSeconds' => <integer>,
                'messageGroups' => [
                    [
                        'message' => [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>',
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>',
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>',
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
        ],
        'postFulfillmentStatusSpecification' => [
            'failureResponse' => [
                'allowInterrupt' => true || false,
                'messageGroups' => [
                    [
                        'message' => [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>',
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>',
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>',
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
            'successResponse' => [
                'allowInterrupt' => true || false,
                'messageGroups' => [
                    [
                        'message' => [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>',
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>',
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>',
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
            'timeoutResponse' => [
                'allowInterrupt' => true || false,
                'messageGroups' => [
                    [
                        'message' => [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>',
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>',
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>',
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
        ],
    ],
    'inputContexts' => [
        [
            'name' => '<string>',
        ],
        // ...
    ],
    'intentClosingSetting' => [
        'active' => true || false,
        'closingResponse' => [
            'allowInterrupt' => true || false,
            'messageGroups' => [
                [
                    'message' => [
                        'customPayload' => [
                            'value' => '<string>',
                        ],
                        'imageResponseCard' => [
                            'buttons' => [
                                [
                                    'text' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'imageUrl' => '<string>',
                            'subtitle' => '<string>',
                            'title' => '<string>',
                        ],
                        'plainTextMessage' => [
                            'value' => '<string>',
                        ],
                        'ssmlMessage' => [
                            'value' => '<string>',
                        ],
                    ],
                    'variations' => [
                        [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
    ],
    'intentConfirmationSetting' => [
        'active' => true || false,
        'declinationResponse' => [
            'allowInterrupt' => true || false,
            'messageGroups' => [
                [
                    'message' => [
                        'customPayload' => [
                            'value' => '<string>',
                        ],
                        'imageResponseCard' => [
                            'buttons' => [
                                [
                                    'text' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'imageUrl' => '<string>',
                            'subtitle' => '<string>',
                            'title' => '<string>',
                        ],
                        'plainTextMessage' => [
                            'value' => '<string>',
                        ],
                        'ssmlMessage' => [
                            'value' => '<string>',
                        ],
                    ],
                    'variations' => [
                        [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
        'promptSpecification' => [
            'allowInterrupt' => true || false,
            'maxRetries' => <integer>,
            'messageGroups' => [
                [
                    'message' => [
                        'customPayload' => [
                            'value' => '<string>',
                        ],
                        'imageResponseCard' => [
                            'buttons' => [
                                [
                                    'text' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'imageUrl' => '<string>',
                            'subtitle' => '<string>',
                            'title' => '<string>',
                        ],
                        'plainTextMessage' => [
                            'value' => '<string>',
                        ],
                        'ssmlMessage' => [
                            'value' => '<string>',
                        ],
                    ],
                    'variations' => [
                        [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
    ],
    'intentId' => '<string>',
    'intentName' => '<string>',
    'kendraConfiguration' => [
        'kendraIndex' => '<string>',
        'queryFilterString' => '<string>',
        'queryFilterStringEnabled' => true || false,
    ],
    'localeId' => '<string>',
    'outputContexts' => [
        [
            'name' => '<string>',
            'timeToLiveInSeconds' => <integer>,
            'turnsToLive' => <integer>,
        ],
        // ...
    ],
    'parentIntentSignature' => '<string>',
    'sampleUtterances' => [
        [
            'utterance' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• ThrottlingException:

  Your request rate is too high. Reduce the frequency of requests.

• ServiceQuotaExceededException:

  You have reached a quota for your bot.

• ValidationException:

  One of the input parameters in your request isn't valid. Check the parameters and try your request again.

• PreconditionFailedException:

  Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

• ConflictException:

  The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

• InternalServerException:

  The service encountered an unexpected condition. Try your request again.

CreateResourcePolicy

$result = $client->createResourcePolicy([/* ... */]);
$promise = $client->createResourcePolicyAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'resourceArn' => '<string>',
    'revisionId' => '<string>',
]

Result Details

Errors

• ResourceNotFoundException:

  You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

• ServiceQuotaExceededException:

  You have reached a quota for your bot.

• PreconditionFailedException:

  Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

• ValidationException:

  One of the input parameters in your request isn't valid. Check the parameters and try your request again.

• InternalServerException:

  The service encountered an unexpected condition. Try your request again.

• ThrottlingException:

  Your request rate is too high. Reduce the frequency of requests.

CreateResourcePolicyStatement

$result = $client->createResourcePolicyStatement([/* ... */]);
$promise = $client->createResourcePolicyStatementAsync([/* ... */]);

Parameter Syntax

$result = $client->createResourcePolicyStatement([
    'action' => ['<string>', ...], // REQUIRED
    'condition' => [
        '<ConditionOperator>' => ['<string>', ...],
        // ...
    ],
    'effect' => 'Allow|Deny', // REQUIRED
    'expectedRevisionId' => '<string>',
    'principal' => [ // REQUIRED
        [
            'arn' => '<string>',
            'service' => '<string>',
        ],
        // ...
    ],
    'resourceArn' => '<string>', // REQUIRED
    'statementId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'resourceArn' => '<string>',
    'revisionId' => '<string>',
]

Result Details

Errors

• ResourceNotFoundException:

  You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

• ConflictException:

  The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

• ServiceQuotaExceededException:

  You have reached a quota for your bot.

• PreconditionFailedException:

  Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

• ValidationException:

  One of the input parameters in your request isn't valid. Check the parameters and try your request again.

• InternalServerException:

  The service encountered an unexpected condition. Try your request again.

• ThrottlingException:

  Your request rate is too high. Reduce the frequency of requests.

CreateSlot

$result = $client->createSlot([/* ... */]);
$promise = $client->createSlotAsync([/* ... */]);

Parameter Syntax

$result = $client->createSlot([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'description' => '<string>',
    'intentId' => '<string>', // REQUIRED
    'localeId' => '<string>', // REQUIRED
    'multipleValuesSetting' => [
        'allowMultipleValues' => true || false,
    ],
    'obfuscationSetting' => [
        'obfuscationSettingType' => 'None|DefaultObfuscation', // REQUIRED
    ],
    'slotName' => '<string>', // REQUIRED
    'slotTypeId' => '<string>',
    'valueElicitationSetting' => [ // REQUIRED
        'defaultValueSpecification' => [
            'defaultValueList' => [ // REQUIRED
                [
                    'defaultValue' => '<string>', // REQUIRED
                ],
                // ...
            ],
        ],
        'promptSpecification' => [
            'allowInterrupt' => true || false,
            'maxRetries' => <integer>, // REQUIRED
            'messageGroups' => [ // REQUIRED
                [
                    'message' => [ // REQUIRED
                        'customPayload' => [
                            'value' => '<string>', // REQUIRED
                        ],
                        'imageResponseCard' => [
                            'buttons' => [
                                [
                                    'text' => '<string>', // REQUIRED
                                    'value' => '<string>', // REQUIRED
                                ],
                                // ...
                            ],
                            'imageUrl' => '<string>',
                            'subtitle' => '<string>',
                            'title' => '<string>', // REQUIRED
                        ],
                        'plainTextMessage' => [
                            'value' => '<string>', // REQUIRED
                        ],
                        'ssmlMessage' => [
                            'value' => '<string>', // REQUIRED
                        ],
                    ],
                    'variations' => [
                        [
                            'customPayload' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>', // REQUIRED
                                        'value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>', // REQUIRED
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
        'sampleUtterances' => [
            [
                'utterance' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'slotConstraint' => 'Required|Optional', // REQUIRED
        'waitAndContinueSpecification' => [
            'active' => true || false,
            'continueResponse' => [ // REQUIRED
                'allowInterrupt' => true || false,
                'messageGroups' => [ // REQUIRED
                    [
                        'message' => [ // REQUIRED
                            'customPayload' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>', // REQUIRED
                                        'value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>', // REQUIRED
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>', // REQUIRED
                                            'value' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>', // REQUIRED
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
            'stillWaitingResponse' => [
                'allowInterrupt' => true || false,
                'frequencyInSeconds' => <integer>, // REQUIRED
                'messageGroups' => [ // REQUIRED
                    [
                        'message' => [ // REQUIRED
                            'customPayload' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>', // REQUIRED
                                        'value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>', // REQUIRED
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>', // REQUIRED
                                            'value' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>', // REQUIRED
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
                'timeoutInSeconds' => <integer>, // REQUIRED
            ],
            'waitingResponse' => [ // REQUIRED
                'allowInterrupt' => true || false,
                'messageGroups' => [ // REQUIRED
                    [
                        'message' => [ // REQUIRED
                            'customPayload' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>', // REQUIRED
                                        'value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>', // REQUIRED
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>', // REQUIRED
                                            'value' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>', // REQUIRED
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'botId' => '<string>',
    'botVersion' => '<string>',
    'creationDateTime' => <DateTime>,
    'description' => '<string>',
    'intentId' => '<string>',
    'localeId' => '<string>',
    'multipleValuesSetting' => [
        'allowMultipleValues' => true || false,
    ],
    'obfuscationSetting' => [
        'obfuscationSettingType' => 'None|DefaultObfuscation',
    ],
    'slotId' => '<string>',
    'slotName' => '<string>',
    'slotTypeId' => '<string>',
    'valueElicitationSetting' => [
        'defaultValueSpecification' => [
            'defaultValueList' => [
                [
                    'defaultValue' => '<string>',
                ],
                // ...
            ],
        ],
        'promptSpecification' => [
            'allowInterrupt' => true || false,
            'maxRetries' => <integer>,
            'messageGroups' => [
                [
                    'message' => [
                        'customPayload' => [
                            'value' => '<string>',
                        ],
                        'imageResponseCard' => [
                            'buttons' => [
                                [
                                    'text' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'imageUrl' => '<string>',
                            'subtitle' => '<string>',
                            'title' => '<string>',
                        ],
                        'plainTextMessage' => [
                            'value' => '<string>',
                        ],
                        'ssmlMessage' => [
                            'value' => '<string>',
                        ],
                    ],
                    'variations' => [
                        [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
        'sampleUtterances' => [
            [
                'utterance' => '<string>',
            ],
            // ...
        ],
        'slotConstraint' => 'Required|Optional',
        'waitAndContinueSpecification' => [
            'active' => true || false,
            'continueResponse' => [
                'allowInterrupt' => true || false,
                'messageGroups' => [
                    [
                        'message' => [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>',
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>',
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>',
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
            'stillWaitingResponse' => [
                'allowInterrupt' => true || false,
                'frequencyInSeconds' => <integer>,
                'messageGroups' => [
                    [
                        'message' => [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>',
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>',
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>',
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
                'timeoutInSeconds' => <integer>,
            ],
            'waitingResponse' => [
                'allowInterrupt' => true || false,
                'messageGroups' => [
                    [
                        'message' => [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>',
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>',
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>',
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
        ],
    ],
]

Result Details

Errors

• ThrottlingException:

  Your request rate is too high. Reduce the frequency of requests.

• ServiceQuotaExceededException:

  You have reached a quota for your bot.

• ValidationException:

  One of the input parameters in your request isn't valid. Check the parameters and try your request again.

• PreconditionFailedException:

  Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

• ConflictException:

  The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

• InternalServerException:

  The service encountered an unexpected condition. Try your request again.

CreateSlotType

$result = $client->createSlotType([/* ... */]);
$promise = $client->createSlotTypeAsync([/* ... */]);

Parameter Syntax

$result = $client->createSlotType([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'description' => '<string>',
    'externalSourceSetting' => [
        'grammarSlotTypeSetting' => [
            'source' => [
                'kmsKeyArn' => '<string>',
                's3BucketName' => '<string>', // REQUIRED
                's3ObjectKey' => '<string>', // REQUIRED
            ],
        ],
    ],
    'localeId' => '<string>', // REQUIRED
    'parentSlotTypeSignature' => '<string>',
    'slotTypeName' => '<string>', // REQUIRED
    'slotTypeValues' => [
        [
            'sampleValue' => [
                'value' => '<string>', // REQUIRED
            ],
            'synonyms' => [
                [
                    'value' => '<string>', // REQUIRED
                ],
                // ...
            ],
        ],
        // ...
    ],
    'valueSelectionSetting' => [
        'advancedRecognitionSetting' => [
            'audioRecognitionStrategy' => 'UseSlotValuesAsCustomVocabulary',
        ],
        'regexFilter' => [
            'pattern' => '<string>', // REQUIRED
        ],
        'resolutionStrategy' => 'OriginalValue|TopResolution', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'botId' => '<string>',
    'botVersion' => '<string>',
    'creationDateTime' => <DateTime>,
    'description' => '<string>',
    'externalSourceSetting' => [
        'grammarSlotTypeSetting' => [
            'source' => [
                'kmsKeyArn' => '<string>',
                's3BucketName' => '<string>',
                's3ObjectKey' => '<string>',
            ],
        ],
    ],
    'localeId' => '<string>',
    'parentSlotTypeSignature' => '<string>',
    'slotTypeId' => '<string>',
    'slotTypeName' => '<string>',
    'slotTypeValues' => [
        [
            'sampleValue' => [
                'value' => '<string>',
            ],
            'synonyms' => [
                [
                    'value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'valueSelectionSetting' => [
        'advancedRecognitionSetting' => [
            'audioRecognitionStrategy' => 'UseSlotValuesAsCustomVocabulary',
        ],
        'regexFilter' => [
            'pattern' => '<string>',
        ],
        'resolutionStrategy' => 'OriginalValue|TopResolution',
    ],
]

Result Details

Errors

• ThrottlingException:

  Your request rate is too high. Reduce the frequency of requests.

• ServiceQuotaExceededException:

  You have reached a quota for your bot.

• ValidationException:

  One of the input parameters in your request isn't valid. Check the parameters and try your request again.

• PreconditionFailedException:

  Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

• ConflictException:

  The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

• InternalServerException:

  The service encountered an unexpected condition. Try your request again.

CreateUploadUrl

$result = $client->createUploadUrl([/* ... */]);
$promise = $client->createUploadUrlAsync([/* ... */]);

Parameter Syntax

$result = $client->createUploadUrl([
]);

Parameter Details

Result Syntax

[
    'importId' => '<string>',
    'uploadUrl' => '<string>',
]

Result Details

Errors

• ThrottlingException:

  Your request rate is too high. Reduce the frequency of requests.

• ValidationException:

  One of the input parameters in your request isn't valid. Check the parameters and try your request again.

• ResourceNotFoundException:

  You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

• ConflictException:

  The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

• InternalServerException:

  The service encountered an unexpected condition. Try your request again.

DeleteBot

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

Parameter Syntax

$result = $client->deleteBot([
    'botId' => '<string>', // REQUIRED
    'skipResourceInUseCheck' => true || false,
]);

Parameter Details

Result Syntax

[
    'botId' => '<string>',
    'botStatus' => 'Creating|Available|Inactive|Deleting|Failed|Versioning|Importing',
]

Result Details

Errors

• ThrottlingException:

  Your request rate is too high. Reduce the frequency of requests.

• ServiceQuotaExceededException:

  You have reached a quota for your bot.

• ValidationException:

  One of the input parameters in your request isn't valid. Check the parameters and try your request again.

• ConflictException:

  The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

• PreconditionFailedException:

  Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

• InternalServerException:

  The service encountered an unexpected condition. Try your request again.

DeleteBotAlias

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

Parameter Syntax

$result = $client->deleteBotAlias([
    'botAliasId' => '<string>', // REQUIRED
    'botId' => '<string>', // REQUIRED
    'skipResourceInUseCheck' => true || false,
]);

Parameter Details

Result Syntax

[
    'botAliasId' => '<string>',
    'botAliasStatus' => 'Creating|Available|Deleting|Failed',
    'botId' => '<string>',
]

Result Details

Errors

• ThrottlingException:

  Your request rate is too high. Reduce the frequency of requests.

• ServiceQuotaExceededException:

  You have reached a quota for your bot.

• ValidationException:

  One of the input parameters in your request isn't valid. Check the parameters and try your request again.

• ConflictException:

  The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

• PreconditionFailedException:

  Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

• InternalServerException:

  The service encountered an unexpected condition. Try your request again.

DeleteBotLocale

$result = $client->deleteBotLocale([/* ... */]);
$promise = $client->deleteBotLocaleAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteBotLocale([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'localeId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'botId' => '<string>',
    'botLocaleStatus' => 'Creating|Building|Built|ReadyExpressTesting|Failed|Deleting|NotBuilt|Importing|Processing',
    'botVersion' => '<string>',
    'localeId' => '<string>',
]

Result Details

Errors

• ThrottlingException:

  Your request rate is too high. Reduce the frequency of requests.

• ServiceQuotaExceededException:

  You have reached a quota for your bot.

• ValidationException:

  One of the input parameters in your request isn't valid. Check the parameters and try your request again.

• PreconditionFailedException:

  Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

• ConflictException:

  The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

• InternalServerException:

  The service encountered an unexpected condition. Try your request again.

DeleteBotVersion

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

Parameter Syntax

$result = $client->deleteBotVersion([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'skipResourceInUseCheck' => true || false,
]);

Parameter Details

Result Syntax

[
    'botId' => '<string>',
    'botStatus' => 'Creating|Available|Inactive|Deleting|Failed|Versioning|Importing',
    'botVersion' => '<string>',
]

Result Details

Errors

• ThrottlingException:

  Your request rate is too high. Reduce the frequency of requests.

• ServiceQuotaExceededException:

  You have reached a quota for your bot.

• ValidationException:

  One of the input parameters in your request isn't valid. Check the parameters and try your request again.

• ConflictException:

  The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

• PreconditionFailedException:

  Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

• InternalServerException:

  The service encountered an unexpected condition. Try your request again.

DeleteCustomVocabulary

$result = $client->deleteCustomVocabulary([/* ... */]);
$promise = $client->deleteCustomVocabularyAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteCustomVocabulary([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'localeId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'botId' => '<string>',
    'botVersion' => '<string>',
    'customVocabularyStatus' => 'Ready|Deleting|Exporting|Importing|Creating',
    'localeId' => '<string>',
]

Result Details

Errors

• ThrottlingException:

  Your request rate is too high. Reduce the frequency of requests.

• ServiceQuotaExceededException:

  You have reached a quota for your bot.

• ValidationException:

  One of the input parameters in your request isn't valid. Check the parameters and try your request again.

• PreconditionFailedException:

  Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

• ConflictException:

  The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

• InternalServerException:

  The service encountered an unexpected condition. Try your request again.

DeleteExport

$result = $client->deleteExport([/* ... */]);
$promise = $client->deleteExportAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'exportId' => '<string>',
    'exportStatus' => 'InProgress|Completed|Failed|Deleting',
]

Result Details

Errors

• ThrottlingException:

  Your request rate is too high. Reduce the frequency of requests.

• ServiceQuotaExceededException:

  You have reached a quota for your bot.

• ValidationException:

  One of the input parameters in your request isn't valid. Check the parameters and try your request again.

• PreconditionFailedException:

  Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

• InternalServerException:

  The service encountered an unexpected condition. Try your request again.

DeleteImport

$result = $client->deleteImport([/* ... */]);
$promise = $client->deleteImportAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'importId' => '<string>',
    'importStatus' => 'InProgress|Completed|Failed|Deleting',
]

Result Details

Errors

• ThrottlingException:

  Your request rate is too high. Reduce the frequency of requests.

• ServiceQuotaExceededException:

  You have reached a quota for your bot.

• ValidationException:

  One of the input parameters in your request isn't valid. Check the parameters and try your request again.

• PreconditionFailedException:

  Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

• InternalServerException:

  The service encountered an unexpected condition. Try your request again.

DeleteIntent

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

Parameter Syntax

$result = $client->deleteIntent([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'intentId' => '<string>', // REQUIRED
    'localeId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ThrottlingException:

  Your request rate is too high. Reduce the frequency of requests.

• ServiceQuotaExceededException:

  You have reached a quota for your bot.

• ValidationException:

  One of the input parameters in your request isn't valid. Check the parameters and try your request again.

• ConflictException:

  The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

• PreconditionFailedException:

  Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

• InternalServerException:

  The service encountered an unexpected condition. Try your request again.

DeleteResourcePolicy

$result = $client->deleteResourcePolicy([/* ... */]);
$promise = $client->deleteResourcePolicyAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'resourceArn' => '<string>',
    'revisionId' => '<string>',
]

Result Details

Errors

• ResourceNotFoundException:

  You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

• PreconditionFailedException:

  Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

• InternalServerException:

  The service encountered an unexpected condition. Try your request again.

• ThrottlingException:

  Your request rate is too high. Reduce the frequency of requests.

DeleteResourcePolicyStatement

$result = $client->deleteResourcePolicyStatement([/* ... */]);
$promise = $client->deleteResourcePolicyStatementAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'resourceArn' => '<string>',
    'revisionId' => '<string>',
]

Result Details

Errors

• ResourceNotFoundException:

  You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

• PreconditionFailedException:

  Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

• InternalServerException:

  The service encountered an unexpected condition. Try your request again.

• ThrottlingException:

  Your request rate is too high. Reduce the frequency of requests.

DeleteSlot

$result = $client->deleteSlot([/* ... */]);
$promise = $client->deleteSlotAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteSlot([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'intentId' => '<string>', // REQUIRED
    'localeId' => '<string>', // REQUIRED
    'slotId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ThrottlingException:

  Your request rate is too high. Reduce the frequency of requests.

• ServiceQuotaExceededException:

  You have reached a quota for your bot.

• ValidationException:

  One of the input parameters in your request isn't valid. Check the parameters and try your request again.

• ConflictException:

  The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

• PreconditionFailedException:

  Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

• InternalServerException:

  The service encountered an unexpected condition. Try your request again.

DeleteSlotType

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

Parameter Syntax

$result = $client->deleteSlotType([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'localeId' => '<string>', // REQUIRED
    'skipResourceInUseCheck' => true || false,
    'slotTypeId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ThrottlingException:

  Your request rate is too high. Reduce the frequency of requests.

• ServiceQuotaExceededException:

  You have reached a quota for your bot.

• ValidationException:

  One of the input parameters in your request isn't valid. Check the parameters and try your request again.

• ConflictException:

  The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

• PreconditionFailedException:

  Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

• InternalServerException:

  The service encountered an unexpected condition. Try your request again.

DeleteUtterances

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

Parameter Syntax

$result = $client->deleteUtterances([
    'botId' => '<string>', // REQUIRED
    'localeId' => '<string>',
    'sessionId' => '<string>',
]);

Parameter Details