Amazon Lex Model Building V2 2020-08-07
- Client: Aws\LexModelsV2\LexModelsV2Client
- Service ID: models.lex.v2
- Version: 2020-08-07
This page describes the parameters and results for the operations of the Amazon Lex Model Building V2 (2020-08-07), and shows how to use the Aws\LexModelsV2\LexModelsV2Client object to call the described operations. This documentation is specific to the 2020-08-07 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- BatchCreateCustomVocabularyItem ( array $params = [] )
- Create a batch of custom vocabulary items for a given bot locale's custom vocabulary.
- BatchDeleteCustomVocabularyItem ( array $params = [] )
- Delete a batch of custom vocabulary items for a given bot locale's custom vocabulary.
- BatchUpdateCustomVocabularyItem ( array $params = [] )
- Update a batch of custom vocabulary items for a given bot locale's custom vocabulary.
- BuildBotLocale ( array $params = [] )
- Builds a bot, its intents, and its slot types into a specific locale.
- CreateBot ( array $params = [] )
- Creates an Amazon Lex conversational bot.
- CreateBotAlias ( array $params = [] )
- Creates an alias for the specified version of a bot.
- CreateBotLocale ( array $params = [] )
- Creates a locale in the bot.
- CreateBotReplica ( array $params = [] )
- Action to create a replication of the source bot in the secondary region.
- CreateBotVersion ( array $params = [] )
- Creates an immutable version of the bot.
- CreateExport ( array $params = [] )
- Creates a zip archive containing the contents of a bot or a bot locale.
- CreateIntent ( array $params = [] )
- Creates an intent.
- CreateResourcePolicy ( array $params = [] )
- Creates a new resource policy with the specified policy statements.
- CreateResourcePolicyStatement ( array $params = [] )
- Adds a new resource policy statement to a bot or bot alias.
- CreateSlot ( array $params = [] )
- Creates a slot in an intent.
- CreateSlotType ( array $params = [] )
- Creates a custom slot type To create a custom slot type, specify a name for the slot type and a set of enumeration values, the values that a slot of this type can assume.
- CreateTestSetDiscrepancyReport ( array $params = [] )
- Create a report that describes the differences between the bot and the test set.
- CreateUploadUrl ( array $params = [] )
- Gets a pre-signed S3 write URL that you use to upload the zip archive when importing a bot or a bot locale.
- DeleteBot ( array $params = [] )
- Deletes all versions of a bot, including the Draft version.
- DeleteBotAlias ( array $params = [] )
- Deletes the specified bot alias.
- DeleteBotLocale ( array $params = [] )
- Removes a locale from a bot.
- DeleteBotReplica ( array $params = [] )
- The action to delete the replicated bot in the secondary region.
- DeleteBotVersion ( array $params = [] )
- Deletes a specific version of a bot.
- DeleteCustomVocabulary ( array $params = [] )
- Removes a custom vocabulary from the specified locale in the specified bot.
- DeleteExport ( array $params = [] )
- Removes a previous export and the associated files stored in an S3 bucket.
- DeleteImport ( array $params = [] )
- Removes a previous import and the associated file stored in an S3 bucket.
- DeleteIntent ( array $params = [] )
- Removes the specified intent.
- DeleteResourcePolicy ( array $params = [] )
- Removes an existing policy from a bot or bot alias.
- DeleteResourcePolicyStatement ( array $params = [] )
- Deletes a policy statement from a resource policy.
- DeleteSlot ( array $params = [] )
- Deletes the specified slot from an intent.
- DeleteSlotType ( array $params = [] )
- Deletes a slot type from a bot locale.
- DeleteTestSet ( array $params = [] )
- The action to delete the selected test set.
- DeleteUtterances ( array $params = [] )
- Deletes stored utterances.
- DescribeBot ( array $params = [] )
- Provides metadata information about a bot.
- DescribeBotAlias ( array $params = [] )
- Get information about a specific bot alias.
- DescribeBotLocale ( array $params = [] )
- Describes the settings that a bot has for a specific locale.
- DescribeBotRecommendation ( array $params = [] )
- Provides metadata information about a bot recommendation.
- DescribeBotReplica ( array $params = [] )
- Monitors the bot replication status through the UI console.
- DescribeBotResourceGeneration ( array $params = [] )
- Returns information about a request to generate a bot through natural language description, made through the StartBotResource API.
- DescribeBotVersion ( array $params = [] )
- Provides metadata about a version of a bot.
- DescribeCustomVocabularyMetadata ( array $params = [] )
- Provides metadata information about a custom vocabulary.
- DescribeExport ( array $params = [] )
- Gets information about a specific export.
- DescribeImport ( array $params = [] )
- Gets information about a specific import.
- DescribeIntent ( array $params = [] )
- Returns metadata about an intent.
- DescribeResourcePolicy ( array $params = [] )
- Gets the resource policy and policy revision for a bot or bot alias.
- DescribeSlot ( array $params = [] )
- Gets metadata information about a slot.
- DescribeSlotType ( array $params = [] )
- Gets metadata information about a slot type.
- DescribeTestExecution ( array $params = [] )
- Gets metadata information about the test execution.
- DescribeTestSet ( array $params = [] )
- Gets metadata information about the test set.
- DescribeTestSetDiscrepancyReport ( array $params = [] )
- Gets metadata information about the test set discrepancy report.
- DescribeTestSetGeneration ( array $params = [] )
- Gets metadata information about the test set generation.
- GenerateBotElement ( array $params = [] )
- Generates sample utterances for an intent.
- GetTestExecutionArtifactsUrl ( array $params = [] )
- The pre-signed Amazon S3 URL to download the test execution result artifacts.
- ListAggregatedUtterances ( array $params = [] )
- Provides a list of utterances that users have sent to the bot.
- ListBotAliasReplicas ( array $params = [] )
- The action to list the replicated bots created from the source bot alias.
- ListBotAliases ( array $params = [] )
- Gets a list of aliases for the specified bot.
- ListBotLocales ( array $params = [] )
- Gets a list of locales for the specified bot.
- ListBotRecommendations ( array $params = [] )
- Get a list of bot recommendations that meet the specified criteria.
- ListBotReplicas ( array $params = [] )
- The action to list the replicated bots.
- ListBotResourceGenerations ( array $params = [] )
- Lists the generation requests made for a bot locale.
- ListBotVersionReplicas ( array $params = [] )
- Contains information about all the versions replication statuses applicable for Global Resiliency.
- ListBotVersions ( array $params = [] )
- Gets information about all of the versions of a bot.
- ListBots ( array $params = [] )
- Gets a list of available bots.
- ListBuiltInIntents ( array $params = [] )
- Gets a list of built-in intents provided by Amazon Lex that you can use in your bot.
- ListBuiltInSlotTypes ( array $params = [] )
- Gets a list of built-in slot types that meet the specified criteria.
- ListCustomVocabularyItems ( array $params = [] )
- Paginated list of custom vocabulary items for a given bot locale's custom vocabulary.
- ListExports ( array $params = [] )
- Lists the exports for a bot, bot locale, or custom vocabulary.
- ListImports ( array $params = [] )
- Lists the imports for a bot, bot locale, or custom vocabulary.
- ListIntentMetrics ( array $params = [] )
- Retrieves summary metrics for the intents in your bot.
- ListIntentPaths ( array $params = [] )
- Retrieves summary statistics for a path of intents that users take over sessions with your bot.
- ListIntentStageMetrics ( array $params = [] )
- Retrieves summary metrics for the stages within intents in your bot.
- ListIntents ( array $params = [] )
- Get a list of intents that meet the specified criteria.
- ListRecommendedIntents ( array $params = [] )
- Gets a list of recommended intents provided by the bot recommendation that you can use in your bot.
- ListSessionAnalyticsData ( array $params = [] )
- Retrieves a list of metadata for individual user sessions with your bot.
- ListSessionMetrics ( array $params = [] )
- Retrieves summary metrics for the user sessions with your bot.
- ListSlotTypes ( array $params = [] )
- Gets a list of slot types that match the specified criteria.
- ListSlots ( array $params = [] )
- Gets a list of slots that match the specified criteria.
- ListTagsForResource ( array $params = [] )
- Gets a list of tags associated with a resource.
- ListTestExecutionResultItems ( array $params = [] )
- Gets a list of test execution result items.
- ListTestExecutions ( array $params = [] )
- The list of test set executions.
- ListTestSetRecords ( array $params = [] )
- The list of test set records.
- ListTestSets ( array $params = [] )
- The list of the test sets
- ListUtteranceAnalyticsData ( array $params = [] )
- To use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances operation, which provides access to utterance-related analytics.
- ListUtteranceMetrics ( array $params = [] )
- To use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances operation, which provides access to utterance-related analytics.
- SearchAssociatedTranscripts ( array $params = [] )
- Search for associated transcripts that meet the specified criteria.
- StartBotRecommendation ( array $params = [] )
- Use this to provide your transcript data, and to start the bot recommendation process.
- StartBotResourceGeneration ( array $params = [] )
- Starts a request for the descriptive bot builder to generate a bot locale configuration based on the prompt you provide it.
- StartImport ( array $params = [] )
- Starts importing a bot, bot locale, or custom vocabulary from a zip archive that you uploaded to an S3 bucket.
- StartTestExecution ( array $params = [] )
- The action to start test set execution.
- StartTestSetGeneration ( array $params = [] )
- The action to start the generation of test set.
- StopBotRecommendation ( array $params = [] )
- Stop an already running Bot Recommendation request.
- TagResource ( array $params = [] )
- Adds the specified tags to the specified resource.
- UntagResource ( array $params = [] )
- Removes tags from a bot, bot alias, or bot channel.
- UpdateBot ( array $params = [] )
- Updates the configuration of an existing bot.
- UpdateBotAlias ( array $params = [] )
- Updates the configuration of an existing bot alias.
- UpdateBotLocale ( array $params = [] )
- Updates the settings that a bot has for a specific locale.
- UpdateBotRecommendation ( array $params = [] )
- Updates an existing bot recommendation request.
- UpdateExport ( array $params = [] )
- Updates the password used to protect an export zip archive.
- UpdateIntent ( array $params = [] )
- Updates the settings for an intent.
- UpdateResourcePolicy ( array $params = [] )
- Replaces the existing resource policy for a bot or bot alias with a new one.
- UpdateSlot ( array $params = [] )
- Updates the settings for a slot.
- UpdateSlotType ( array $params = [] )
- Updates the configuration of an existing slot type.
- UpdateTestSet ( array $params = [] )
- The action to update the test set.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
- ListAggregatedUtterances
- ListBotAliasReplicas
- ListBotAliases
- ListBotLocales
- ListBotRecommendations
- ListBotResourceGenerations
- ListBotVersionReplicas
- ListBotVersions
- ListBots
- ListBuiltInIntents
- ListBuiltInSlotTypes
- ListCustomVocabularyItems
- ListExports
- ListImports
- ListIntentMetrics
- ListIntentStageMetrics
- ListIntents
- ListRecommendedIntents
- ListSessionAnalyticsData
- ListSessionMetrics
- ListSlotTypes
- ListSlots
- ListTestExecutionResultItems
- ListTestExecutions
- ListTestSetRecords
- ListTestSets
- ListUtteranceAnalyticsData
- ListUtteranceMetrics
Waiters
Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:
Waiter name | API Operation | Delay | Max Attempts |
---|---|---|---|
BotAvailable | DescribeBot | 10 | 35 |
BotAliasAvailable | DescribeBotAlias | 10 | 35 |
BotExportCompleted | DescribeExport | 10 | 35 |
BotImportCompleted | DescribeImport | 10 | 35 |
BotLocaleBuilt | DescribeBotLocale | 10 | 35 |
BotLocaleExpressTestingAvailable | DescribeBotLocale | 10 | 35 |
BotVersionAvailable | DescribeBotVersion | 10 | 35 |
BotLocaleCreated | DescribeBotLocale | 10 | 35 |
Operations
BatchCreateCustomVocabularyItem
$result = $client->batchCreateCustomVocabularyItem
([/* ... */]); $promise = $client->batchCreateCustomVocabularyItemAsync
([/* ... */]);
Create a batch of custom vocabulary items for a given bot locale's custom vocabulary.
Parameter Syntax
$result = $client->batchCreateCustomVocabularyItem([ 'botId' => '<string>', // REQUIRED 'botVersion' => '<string>', // REQUIRED 'customVocabularyItemList' => [ // REQUIRED [ 'displayAs' => '<string>', 'phrase' => '<string>', // REQUIRED 'weight' => <integer>, ], // ... ], 'localeId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The identifier of the bot associated with this custom vocabulary.
- botVersion
-
- Required: Yes
- Type: string
The identifier of the version of the bot associated with this custom vocabulary.
- customVocabularyItemList
-
- Required: Yes
- Type: Array of NewCustomVocabularyItem structures
A list of new custom vocabulary items. Each entry must contain a phrase and can optionally contain a displayAs and/or a weight.
- localeId
-
- Required: Yes
- Type: string
The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported Languages .
Result Syntax
[ 'botId' => '<string>', 'botVersion' => '<string>', 'errors' => [ [ 'errorCode' => 'DUPLICATE_INPUT|RESOURCE_DOES_NOT_EXIST|RESOURCE_ALREADY_EXISTS|INTERNAL_SERVER_FAILURE', 'errorMessage' => '<string>', 'itemId' => '<string>', ], // ... ], 'localeId' => '<string>', 'resources' => [ [ 'displayAs' => '<string>', 'itemId' => '<string>', 'phrase' => '<string>', 'weight' => <integer>, ], // ... ], ]
Result Details
Members
- botId
-
- Type: string
The identifier of the bot associated with this custom vocabulary.
- botVersion
-
- Type: string
The identifier of the version of the bot associated with this custom vocabulary.
- errors
-
- Type: Array of FailedCustomVocabularyItem structures
A list of custom vocabulary items that failed to create during the operation. The reason for the error is contained within each error object.
- localeId
-
- Type: string
The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported Languages .
- resources
-
- Type: Array of CustomVocabularyItem structures
A list of custom vocabulary items that were successfully created during the operation.
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.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
BatchDeleteCustomVocabularyItem
$result = $client->batchDeleteCustomVocabularyItem
([/* ... */]); $promise = $client->batchDeleteCustomVocabularyItemAsync
([/* ... */]);
Delete a batch of custom vocabulary items for a given bot locale's custom vocabulary.
Parameter Syntax
$result = $client->batchDeleteCustomVocabularyItem([ 'botId' => '<string>', // REQUIRED 'botVersion' => '<string>', // REQUIRED 'customVocabularyItemList' => [ // REQUIRED [ 'itemId' => '<string>', // REQUIRED ], // ... ], 'localeId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The identifier of the bot associated with this custom vocabulary.
- botVersion
-
- Required: Yes
- Type: string
The identifier of the version of the bot associated with this custom vocabulary.
- customVocabularyItemList
-
- Required: Yes
- Type: Array of CustomVocabularyEntryId structures
A list of custom vocabulary items requested to be deleted. Each entry must contain the unique custom vocabulary entry identifier.
- localeId
-
- Required: Yes
- Type: string
The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported Languages .
Result Syntax
[ 'botId' => '<string>', 'botVersion' => '<string>', 'errors' => [ [ 'errorCode' => 'DUPLICATE_INPUT|RESOURCE_DOES_NOT_EXIST|RESOURCE_ALREADY_EXISTS|INTERNAL_SERVER_FAILURE', 'errorMessage' => '<string>', 'itemId' => '<string>', ], // ... ], 'localeId' => '<string>', 'resources' => [ [ 'displayAs' => '<string>', 'itemId' => '<string>', 'phrase' => '<string>', 'weight' => <integer>, ], // ... ], ]
Result Details
Members
- botId
-
- Type: string
The identifier of the bot associated with this custom vocabulary.
- botVersion
-
- Type: string
The identifier of the version of the bot associated with this custom vocabulary.
- errors
-
- Type: Array of FailedCustomVocabularyItem structures
A list of custom vocabulary items that failed to delete during the operation. The reason for the error is contained within each error object.
- localeId
-
- Type: string
The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
- resources
-
- Type: Array of CustomVocabularyItem structures
A list of custom vocabulary items that were successfully deleted during the operation.
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.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
BatchUpdateCustomVocabularyItem
$result = $client->batchUpdateCustomVocabularyItem
([/* ... */]); $promise = $client->batchUpdateCustomVocabularyItemAsync
([/* ... */]);
Update a batch of custom vocabulary items for a given bot locale's custom vocabulary.
Parameter Syntax
$result = $client->batchUpdateCustomVocabularyItem([ 'botId' => '<string>', // REQUIRED 'botVersion' => '<string>', // REQUIRED 'customVocabularyItemList' => [ // REQUIRED [ 'displayAs' => '<string>', 'itemId' => '<string>', // REQUIRED 'phrase' => '<string>', // REQUIRED 'weight' => <integer>, ], // ... ], 'localeId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The identifier of the bot associated with this custom vocabulary
- botVersion
-
- Required: Yes
- Type: string
The identifier of the version of the bot associated with this custom vocabulary.
- customVocabularyItemList
-
- Required: Yes
- Type: Array of CustomVocabularyItem structures
A list of custom vocabulary items with updated fields. Each entry must contain a phrase and can optionally contain a displayAs and/or a weight.
- localeId
-
- Required: Yes
- Type: string
The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported Languages .
Result Syntax
[ 'botId' => '<string>', 'botVersion' => '<string>', 'errors' => [ [ 'errorCode' => 'DUPLICATE_INPUT|RESOURCE_DOES_NOT_EXIST|RESOURCE_ALREADY_EXISTS|INTERNAL_SERVER_FAILURE', 'errorMessage' => '<string>', 'itemId' => '<string>', ], // ... ], 'localeId' => '<string>', 'resources' => [ [ 'displayAs' => '<string>', 'itemId' => '<string>', 'phrase' => '<string>', 'weight' => <integer>, ], // ... ], ]
Result Details
Members
- botId
-
- Type: string
The identifier of the bot associated with this custom vocabulary.
- botVersion
-
- Type: string
The identifier of the version of the bot associated with this custom vocabulary.
- errors
-
- Type: Array of FailedCustomVocabularyItem structures
A list of custom vocabulary items that failed to update during the operation. The reason for the error is contained within each error object.
- localeId
-
- Type: string
The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported Languages .
- resources
-
- Type: Array of CustomVocabularyItem structures
A list of custom vocabulary items that were successfully updated during the operation.
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.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
BuildBotLocale
$result = $client->buildBotLocale
([/* ... */]); $promise = $client->buildBotLocaleAsync
([/* ... */]);
Builds a bot, its intents, and its slot types into a specific locale. A bot can be built into multiple locales. At runtime the locale is used to choose a specific build of the bot.
Parameter Syntax
$result = $client->buildBotLocale([ 'botId' => '<string>', // REQUIRED 'botVersion' => '<string>', // REQUIRED 'localeId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The identifier of the bot to build. The identifier is returned in the response from the CreateBot operation.
- botVersion
-
- Required: Yes
- Type: string
The version of the bot to build. This can only be the draft version of the bot.
- localeId
-
- Required: Yes
- Type: string
The identifier of the language and locale that the bot will be used in. The string must match one of the supported locales. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages.
Result Syntax
[ 'botId' => '<string>', 'botLocaleStatus' => 'Creating|Building|Built|ReadyExpressTesting|Failed|Deleting|NotBuilt|Importing|Processing', 'botVersion' => '<string>', 'lastBuildSubmittedDateTime' => <DateTime>, 'localeId' => '<string>', ]
Result Details
Members
- botId
-
- Type: string
The identifier of the specified bot.
- botLocaleStatus
-
- Type: string
The bot's build status. When the status is
ReadyExpressTesting
you can test the bot using the utterances defined for the intents and slot types. When the status isBuilt
, the bot is ready for use and can be tested using any utterance. - botVersion
-
- Type: string
The version of the bot that was built. This is only the draft version of the bot.
- lastBuildSubmittedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp indicating the date and time that the bot was last built for this locale.
- localeId
-
- Type: string
The language and locale specified of where the bot can be used.
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
([/* ... */]);
Creates an Amazon Lex conversational bot.
Parameter Syntax
$result = $client->createBot([ 'botMembers' => [ [ 'botMemberAliasId' => '<string>', // REQUIRED 'botMemberAliasName' => '<string>', // REQUIRED 'botMemberId' => '<string>', // REQUIRED 'botMemberName' => '<string>', // REQUIRED 'botMemberVersion' => '<string>', // REQUIRED ], // ... ], 'botName' => '<string>', // REQUIRED 'botTags' => ['<string>', ...], 'botType' => 'Bot|BotNetwork', 'dataPrivacy' => [ // REQUIRED 'childDirected' => true || false, // REQUIRED ], 'description' => '<string>', 'idleSessionTTLInSeconds' => <integer>, // REQUIRED 'roleArn' => '<string>', // REQUIRED 'testBotAliasTags' => ['<string>', ...], ]);
Parameter Details
Members
- botMembers
-
- Type: Array of BotMember structures
The list of bot members in a network to be created.
- botName
-
- Required: Yes
- Type: string
The name of the bot. The bot name must be unique in the account that creates the bot.
- botTags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A list of tags to add to the bot. You can only add tags when you create a bot. You can't use the
UpdateBot
operation to update tags. To update tags, use theTagResource
operation. - botType
-
- Type: string
The type of a bot to create.
- dataPrivacy
-
- Required: Yes
- Type: DataPrivacy structure
Provides information on additional privacy protections Amazon Lex should use with the bot's data.
- description
-
- Type: string
A description of the bot. It appears in lists to help you identify a particular bot.
- idleSessionTTLInSeconds
-
- Required: Yes
- Type: int
The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.
You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.
- roleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.
- testBotAliasTags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A list of tags to add to the test alias for a bot. You can only add tags when you create a bot. You can't use the
UpdateAlias
operation to update tags. To update tags on the test alias, use theTagResource
operation.
Result Syntax
[ 'botId' => '<string>', 'botMembers' => [ [ 'botMemberAliasId' => '<string>', 'botMemberAliasName' => '<string>', 'botMemberId' => '<string>', 'botMemberName' => '<string>', 'botMemberVersion' => '<string>', ], // ... ], 'botName' => '<string>', 'botStatus' => 'Creating|Available|Inactive|Deleting|Failed|Versioning|Importing|Updating', 'botTags' => ['<string>', ...], 'botType' => 'Bot|BotNetwork', 'creationDateTime' => <DateTime>, 'dataPrivacy' => [ 'childDirected' => true || false, ], 'description' => '<string>', 'idleSessionTTLInSeconds' => <integer>, 'roleArn' => '<string>', 'testBotAliasTags' => ['<string>', ...], ]
Result Details
Members
- botId
-
- Type: string
A unique identifier for a particular bot. You use this to identify the bot when you call other Amazon Lex API operations.
- botMembers
-
- Type: Array of BotMember structures
The list of bots in a network that was created.
- botName
-
- Type: string
The name specified for the bot.
- botStatus
-
- Type: string
Shows the current status of the bot. The bot is first in the
Creating
status. Once the bot is read for use, it changes to theAvailable
status. After the bot is created, you can use theDRAFT
version of the bot. - botTags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A list of tags associated with the bot.
- botType
-
- Type: string
The type of a bot that was created.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp indicating the date and time that the bot was created.
- dataPrivacy
-
- Type: DataPrivacy structure
The data privacy settings specified for the bot.
- description
-
- Type: string
The description specified for the bot.
- idleSessionTTLInSeconds
-
- Type: int
The session idle time specified for the bot.
- roleArn
-
- Type: string
The IAM role specified for the bot.
- testBotAliasTags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A list of tags associated with the test alias for the bot.
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
([/* ... */]);
Creates an alias for the specified version of a bot. Use an alias to enable you to change the version of a bot without updating applications that use the bot.
For example, you can create an alias called "PROD" that your applications use to call the Amazon Lex bot.
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 'selectiveLoggingEnabled' => true || false, ], // ... ], 'textLogSettings' => [ [ 'destination' => [ // REQUIRED 'cloudWatch' => [ // REQUIRED 'cloudWatchLogGroupArn' => '<string>', // REQUIRED 'logPrefix' => '<string>', // REQUIRED ], ], 'enabled' => true || false, // REQUIRED 'selectiveLoggingEnabled' => true || false, ], // ... ], ], 'description' => '<string>', 'sentimentAnalysisSettings' => [ 'detectSentiment' => true || false, // REQUIRED ], 'tags' => ['<string>', ...], ]);
Parameter Details
Members
- botAliasLocaleSettings
-
- Type: Associative array of custom strings keys (LocaleId) to BotAliasLocaleSettings structures
Maps configuration information to a specific locale. You can use this parameter to specify a specific Lambda function to run different functions in different locales.
- botAliasName
-
- Required: Yes
- Type: string
The alias to create. The name must be unique for the bot.
- botId
-
- Required: Yes
- Type: string
The unique identifier of the bot that the alias applies to.
- botVersion
-
- Type: string
The version of the bot that this alias points to. You can use the UpdateBotAlias operation to change the bot version associated with the alias.
- conversationLogSettings
-
- Type: ConversationLogSettings structure
Specifies whether Amazon Lex logs text and audio for a conversation with the bot. When you enable conversation logs, text logs store text input, transcripts of audio input, and associated metadata in Amazon CloudWatch Logs. Audio logs store audio input in Amazon S3.
- description
-
- Type: string
A description of the alias. Use this description to help identify the alias.
- sentimentAnalysisSettings
-
- Type: SentimentAnalysisSettings structure
Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A list of tags to add to the bot alias. You can only add tags when you create an alias, you can't use the
UpdateBotAlias
operation to update the tags on a bot alias. To update tags, use theTagResource
operation.
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, 'selectiveLoggingEnabled' => true || false, ], // ... ], 'textLogSettings' => [ [ 'destination' => [ 'cloudWatch' => [ 'cloudWatchLogGroupArn' => '<string>', 'logPrefix' => '<string>', ], ], 'enabled' => true || false, 'selectiveLoggingEnabled' => true || false, ], // ... ], ], 'creationDateTime' => <DateTime>, 'description' => '<string>', 'sentimentAnalysisSettings' => [ 'detectSentiment' => true || false, ], 'tags' => ['<string>', ...], ]
Result Details
Members
- botAliasId
-
- Type: string
The unique identifier of the bot alias.
- botAliasLocaleSettings
-
- Type: Associative array of custom strings keys (LocaleId) to BotAliasLocaleSettings structures
Configuration information for a specific locale.
- botAliasName
-
- Type: string
The name specified for the bot alias.
- botAliasStatus
-
- Type: string
The current status of the alias. The alias is first put into the
Creating
state. When the alias is ready to be used, it is put into theAvailable
state. You can use theDescribeBotAlias
operation to get the current state of an alias. - botId
-
- Type: string
The unique identifier of the bot that this alias applies to.
- botVersion
-
- Type: string
The version of the bot associated with this alias.
- conversationLogSettings
-
- Type: ConversationLogSettings structure
The conversation log settings specified for the alias.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A Unix timestamp indicating the date and time that the bot alias was created.
- description
-
- Type: string
The description specified for the bot alias.
- sentimentAnalysisSettings
-
- Type: SentimentAnalysisSettings structure
Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A list of tags associated with the bot alias.
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
([/* ... */]);
Creates a locale in the bot. The locale contains the intents and slot types that the bot uses in conversations with users in the specified language and locale. You must add a locale to a bot before you can add intents and slot types to the bot.
Parameter Syntax
$result = $client->createBotLocale([ 'botId' => '<string>', // REQUIRED 'botVersion' => '<string>', // REQUIRED 'description' => '<string>', 'generativeAISettings' => [ 'buildtimeSettings' => [ 'descriptiveBotBuilder' => [ 'bedrockModelSpecification' => [ 'customPrompt' => '<string>', 'guardrail' => [ 'identifier' => '<string>', // REQUIRED 'version' => '<string>', // REQUIRED ], 'modelArn' => '<string>', // REQUIRED 'traceStatus' => 'ENABLED|DISABLED', ], 'enabled' => true || false, // REQUIRED ], 'sampleUtteranceGeneration' => [ 'bedrockModelSpecification' => [ 'customPrompt' => '<string>', 'guardrail' => [ 'identifier' => '<string>', // REQUIRED 'version' => '<string>', // REQUIRED ], 'modelArn' => '<string>', // REQUIRED 'traceStatus' => 'ENABLED|DISABLED', ], 'enabled' => true || false, // REQUIRED ], ], 'runtimeSettings' => [ 'slotResolutionImprovement' => [ 'bedrockModelSpecification' => [ 'customPrompt' => '<string>', 'guardrail' => [ 'identifier' => '<string>', // REQUIRED 'version' => '<string>', // REQUIRED ], 'modelArn' => '<string>', // REQUIRED 'traceStatus' => 'ENABLED|DISABLED', ], 'enabled' => true || false, // REQUIRED ], ], ], 'localeId' => '<string>', // REQUIRED 'nluIntentConfidenceThreshold' => <float>, // REQUIRED 'voiceSettings' => [ 'engine' => 'standard|neural|long-form|generative', 'voiceId' => '<string>', // REQUIRED ], ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The identifier of the bot to create the locale for.
- botVersion
-
- Required: Yes
- Type: string
The version of the bot to create the locale for. This can only be the draft version of the bot.
- description
-
- Type: string
A description of the bot locale. Use this to help identify the bot locale in lists.
- generativeAISettings
-
- Type: GenerativeAISettings structure
Contains specifications about the generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
- localeId
-
- Required: Yes
- Type: string
The identifier of the language and locale that the bot will be used in. The string must match one of the supported locales. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages.
- nluIntentConfidenceThreshold
-
- Required: Yes
- Type: double
Determines the threshold where Amazon Lex will insert the
AMAZON.FallbackIntent
,AMAZON.KendraSearchIntent
, or both when returning alternative intents.AMAZON.FallbackIntent
andAMAZON.KendraSearchIntent
are only inserted if they are configured for the bot.For example, suppose a bot is configured with the confidence threshold of 0.80 and the
AMAZON.FallbackIntent
. Amazon Lex returns three alternative intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from theRecognizeText
operation would be:-
AMAZON.FallbackIntent
-
IntentA
-
IntentB
-
IntentC
- voiceSettings
-
- Type: VoiceSettings structure
The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.
Result Syntax
[ 'botId' => '<string>', 'botLocaleStatus' => 'Creating|Building|Built|ReadyExpressTesting|Failed|Deleting|NotBuilt|Importing|Processing', 'botVersion' => '<string>', 'creationDateTime' => <DateTime>, 'description' => '<string>', 'generativeAISettings' => [ 'buildtimeSettings' => [ 'descriptiveBotBuilder' => [ 'bedrockModelSpecification' => [ 'customPrompt' => '<string>', 'guardrail' => [ 'identifier' => '<string>', 'version' => '<string>', ], 'modelArn' => '<string>', 'traceStatus' => 'ENABLED|DISABLED', ], 'enabled' => true || false, ], 'sampleUtteranceGeneration' => [ 'bedrockModelSpecification' => [ 'customPrompt' => '<string>', 'guardrail' => [ 'identifier' => '<string>', 'version' => '<string>', ], 'modelArn' => '<string>', 'traceStatus' => 'ENABLED|DISABLED', ], 'enabled' => true || false, ], ], 'runtimeSettings' => [ 'slotResolutionImprovement' => [ 'bedrockModelSpecification' => [ 'customPrompt' => '<string>', 'guardrail' => [ 'identifier' => '<string>', 'version' => '<string>', ], 'modelArn' => '<string>', 'traceStatus' => 'ENABLED|DISABLED', ], 'enabled' => true || false, ], ], ], 'localeId' => '<string>', 'localeName' => '<string>', 'nluIntentConfidenceThreshold' => <float>, 'voiceSettings' => [ 'engine' => 'standard|neural|long-form|generative', 'voiceId' => '<string>', ], ]
Result Details
Members
- botId
-
- Type: string
The specified bot identifier.
- botLocaleStatus
-
- Type: string
The status of the bot.
When the status is
Creating
the bot locale is being configured. When the status isBuilding
Amazon Lex is building the bot for testing and use.If the status of the bot is
ReadyExpressTesting
, you can test the bot using the exact utterances specified in the bots' intents. When the bot is ready for full testing or to run, the status isBuilt
.If there was a problem with building the bot, the status is
Failed
. If the bot was saved but not built, the status isNotBuilt
. - botVersion
-
- Type: string
The specified bot version.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp specifying the date and time that the bot locale was created.
- description
-
- Type: string
The specified description of the bot locale.
- generativeAISettings
-
- Type: GenerativeAISettings structure
Contains specifications about the generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
- localeId
-
- Type: string
The specified locale identifier.
- localeName
-
- Type: string
The specified locale name.
- nluIntentConfidenceThreshold
-
- Type: double
The specified confidence threshold for inserting the
AMAZON.FallbackIntent
andAMAZON.KendraSearchIntent
intents. - voiceSettings
-
- Type: VoiceSettings structure
The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.
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.
CreateBotReplica
$result = $client->createBotReplica
([/* ... */]); $promise = $client->createBotReplicaAsync
([/* ... */]);
Action to create a replication of the source bot in the secondary region.
Parameter Syntax
$result = $client->createBotReplica([ 'botId' => '<string>', // REQUIRED 'replicaRegion' => '<string>', // REQUIRED ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The request for the unique bot ID of the source bot to be replicated in the secondary region.
- replicaRegion
-
- Required: Yes
- Type: string
The request for the secondary region that will be used in the replication of the source bot.
Result Syntax
[ 'botId' => '<string>', 'botReplicaStatus' => 'Enabling|Enabled|Deleting|Failed', 'creationDateTime' => <DateTime>, 'replicaRegion' => '<string>', 'sourceRegion' => '<string>', ]
Result Details
Members
- botId
-
- Type: string
The unique bot ID of the replicated bot generated.
- botReplicaStatus
-
- Type: string
The operational status of the replicated bot generated.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation date and time of the replicated bot generated.
- replicaRegion
-
- Type: string
The region of the replicated bot generated.
- sourceRegion
-
- Type: string
The source region for the source bot used for the replicated bot generated.
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
([/* ... */]);
Creates an immutable version of the bot. When you create the first version of a bot, Amazon Lex sets the version number to 1. Subsequent bot versions increase in an increment of 1. The version number will always represent the total number of versions created of the bot, not the current number of versions. If a bot version is deleted, that bot version number will not be reused.
Parameter Syntax
$result = $client->createBotVersion([ 'botId' => '<string>', // REQUIRED 'botVersionLocaleSpecification' => [ // REQUIRED '<LocaleId>' => [ 'sourceBotVersion' => '<string>', // REQUIRED ], // ... ], 'description' => '<string>', ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The identifier of the bot to create the version for.
- botVersionLocaleSpecification
-
- Required: Yes
- Type: Associative array of custom strings keys (LocaleId) to BotVersionLocaleDetails structures
Specifies the locales that Amazon Lex adds to this version. You can choose the
Draft
version or any other previously published version for each locale. When you specify a source version, the locale data is copied from the source version to the new version. - description
-
- Type: string
A description of the version. Use the description to help identify the version in lists.
Result Syntax
[ 'botId' => '<string>', 'botStatus' => 'Creating|Available|Inactive|Deleting|Failed|Versioning|Importing|Updating', 'botVersion' => '<string>', 'botVersionLocaleSpecification' => [ '<LocaleId>' => [ 'sourceBotVersion' => '<string>', ], // ... ], 'creationDateTime' => <DateTime>, 'description' => '<string>', ]
Result Details
Members
- botId
-
- Type: string
The bot identifier specified in the request.
- botStatus
-
- Type: string
When you send a request to create or update a bot, Amazon Lex sets the status response element to
Creating
. After Amazon Lex builds the bot, it sets status toAvailable
. If Amazon Lex can't build the bot, it sets status toFailed
. - botVersion
-
- Type: string
The version number assigned to the version.
- botVersionLocaleSpecification
-
- Type: Associative array of custom strings keys (LocaleId) to BotVersionLocaleDetails structures
The source versions used for each locale in the new version.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp of the date and time that the version was created.
- description
-
- Type: string
The description of the version specified in the request.
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
([/* ... */]);
Creates a zip archive containing the contents of a bot or a bot locale. The archive contains a directory structure that contains JSON files that define the bot.
You can create an archive that contains the complete definition of a bot, or you can specify that the archive contain only the definition of a single bot locale.
For more information about exporting bots, and about the structure of the export archive, see Importing and exporting bots
Parameter Syntax
$result = $client->createExport([ 'fileFormat' => 'LexJson|TSV|CSV', // 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 ], 'testSetExportSpecification' => [ 'testSetId' => '<string>', // REQUIRED ], ], ]);
Parameter Details
Members
- fileFormat
-
- Required: Yes
- Type: string
The file format of the bot or bot locale definition files.
- filePassword
-
- Type: string
An password to use to encrypt the exported archive. Using a password is optional, but you should encrypt the archive to protect the data in transit between Amazon Lex and your local computer.
- resourceSpecification
-
- Required: Yes
- Type: ExportResourceSpecification structure
Specifies the type of resource to export, either a bot or a bot locale. You can only specify one type of resource to export.
Result Syntax
[ 'creationDateTime' => <DateTime>, 'exportId' => '<string>', 'exportStatus' => 'InProgress|Completed|Failed|Deleting', 'fileFormat' => 'LexJson|TSV|CSV', 'resourceSpecification' => [ 'botExportSpecification' => [ 'botId' => '<string>', 'botVersion' => '<string>', ], 'botLocaleExportSpecification' => [ 'botId' => '<string>', 'botVersion' => '<string>', 'localeId' => '<string>', ], 'customVocabularyExportSpecification' => [ 'botId' => '<string>', 'botVersion' => '<string>', 'localeId' => '<string>', ], 'testSetExportSpecification' => [ 'testSetId' => '<string>', ], ], ]
Result Details
Members
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the request to export a bot was created.
- exportId
-
- Type: string
An identifier for a specific request to create an export.
- exportStatus
-
- Type: string
The status of the export. When the status is
Completed
, you can use the DescribeExport operation to get the pre-signed S3 URL link to your exported bot or bot locale. - fileFormat
-
- Type: string
The file format used for the bot or bot locale definition files.
- resourceSpecification
-
- Type: ExportResourceSpecification structure
A description of the type of resource that was exported, either a bot or a bot locale.
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
([/* ... */]);
Creates an intent.
To define the interaction between the user and your bot, you define one or more intents. For example, for a pizza ordering bot you would create an OrderPizza
intent.
When you create an intent, you must provide a name. You can optionally provide the following:
-
Sample utterances. For example, "I want to order a pizza" and "Can I order a pizza." You can't provide utterances for built-in intents.
-
Information to be gathered. You specify slots for the information that you bot requests from the user. You can specify standard slot types, such as date and time, or custom slot types for your application.
-
How the intent is fulfilled. You can provide a Lambda function or configure the intent to return the intent information to your client application. If you use a Lambda function, Amazon Lex invokes the function when all of the intent information is available.
-
A confirmation prompt to send to the user to confirm an intent. For example, "Shall I order your pizza?"
-
A conclusion statement to send to the user after the intent is fulfilled. For example, "I ordered your pizza."
-
A follow-up prompt that asks the user for additional activity. For example, "Do you want a drink with your pizza?"
Parameter Syntax
$result = $client->createIntent([ 'botId' => '<string>', // REQUIRED 'botVersion' => '<string>', // REQUIRED 'description' => '<string>', 'dialogCodeHook' => [ 'enabled' => true || false, // REQUIRED ], 'fulfillmentCodeHook' => [ 'active' => true || false, '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' => [ 'failureConditional' => [ 'active' => true || false, // REQUIRED 'conditionalBranches' => [ // REQUIRED [ 'condition' => [ // REQUIRED 'expressionString' => '<string>', // REQUIRED ], 'name' => '<string>', // REQUIRED 'nextStep' => [ // REQUIRED 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ // REQUIRED 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], ], 'failureNextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], '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 ], ], // ... ], ], // ... ], ], 'successConditional' => [ 'active' => true || false, // REQUIRED 'conditionalBranches' => [ // REQUIRED [ 'condition' => [ // REQUIRED 'expressionString' => '<string>', // REQUIRED ], 'name' => '<string>', // REQUIRED 'nextStep' => [ // REQUIRED 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ // REQUIRED 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], ], 'successNextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], '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 ], ], // ... ], ], // ... ], ], 'timeoutConditional' => [ 'active' => true || false, // REQUIRED 'conditionalBranches' => [ // REQUIRED [ 'condition' => [ // REQUIRED 'expressionString' => '<string>', // REQUIRED ], 'name' => '<string>', // REQUIRED 'nextStep' => [ // REQUIRED 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ // REQUIRED 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], ], 'timeoutNextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], '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 ], ], // ... ], ], // ... ], ], ], ], 'initialResponseSetting' => [ 'codeHook' => [ 'active' => true || false, // REQUIRED 'enableCodeHookInvocation' => true || false, // REQUIRED 'invocationLabel' => '<string>', 'postCodeHookSpecification' => [ // REQUIRED 'failureConditional' => [ 'active' => true || false, // REQUIRED 'conditionalBranches' => [ // REQUIRED [ 'condition' => [ // REQUIRED 'expressionString' => '<string>', // REQUIRED ], 'name' => '<string>', // REQUIRED 'nextStep' => [ // REQUIRED 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ // REQUIRED 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], ], 'failureNextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], '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 ], ], // ... ], ], // ... ], ], 'successConditional' => [ 'active' => true || false, // REQUIRED 'conditionalBranches' => [ // REQUIRED [ 'condition' => [ // REQUIRED 'expressionString' => '<string>', // REQUIRED ], 'name' => '<string>', // REQUIRED 'nextStep' => [ // REQUIRED 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ // REQUIRED 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], ], 'successNextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], '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 ], ], // ... ], ], // ... ], ], 'timeoutConditional' => [ 'active' => true || false, // REQUIRED 'conditionalBranches' => [ // REQUIRED [ 'condition' => [ // REQUIRED 'expressionString' => '<string>', // REQUIRED ], 'name' => '<string>', // REQUIRED 'nextStep' => [ // REQUIRED 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ // REQUIRED 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], ], 'timeoutNextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], '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 ], ], // ... ], ], // ... ], ], ], ], 'conditional' => [ 'active' => true || false, // REQUIRED 'conditionalBranches' => [ // REQUIRED [ 'condition' => [ // REQUIRED 'expressionString' => '<string>', // REQUIRED ], 'name' => '<string>', // REQUIRED 'nextStep' => [ // REQUIRED 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ // REQUIRED 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], ], 'initialResponse' => [ '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 ], ], // ... ], ], // ... ], ], 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], ], 'inputContexts' => [ [ 'name' => '<string>', // REQUIRED ], // ... ], 'intentClosingSetting' => [ 'active' => true || false, 'closingResponse' => [ '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 ], ], // ... ], ], // ... ], ], 'conditional' => [ 'active' => true || false, // REQUIRED 'conditionalBranches' => [ // REQUIRED [ 'condition' => [ // REQUIRED 'expressionString' => '<string>', // REQUIRED ], 'name' => '<string>', // REQUIRED 'nextStep' => [ // REQUIRED 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ // REQUIRED 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], ], 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], ], 'intentConfirmationSetting' => [ 'active' => true || false, 'codeHook' => [ 'active' => true || false, // REQUIRED 'enableCodeHookInvocation' => true || false, // REQUIRED 'invocationLabel' => '<string>', 'postCodeHookSpecification' => [ // REQUIRED 'failureConditional' => [ 'active' => true || false, // REQUIRED 'conditionalBranches' => [ // REQUIRED [ 'condition' => [ // REQUIRED 'expressionString' => '<string>', // REQUIRED ], 'name' => '<string>', // REQUIRED 'nextStep' => [ // REQUIRED 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ // REQUIRED 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], ], 'failureNextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], '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 ], ], // ... ], ], // ... ], ], 'successConditional' => [ 'active' => true || false, // REQUIRED 'conditionalBranches' => [ // REQUIRED [ 'condition' => [ // REQUIRED 'expressionString' => '<string>', // REQUIRED ], 'name' => '<string>', // REQUIRED 'nextStep' => [ // REQUIRED 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ // REQUIRED 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], ], 'successNextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], '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 ], ], // ... ], ], // ... ], ], 'timeoutConditional' => [ 'active' => true || false, // REQUIRED 'conditionalBranches' => [ // REQUIRED [ 'condition' => [ // REQUIRED 'expressionString' => '<string>', // REQUIRED ], 'name' => '<string>', // REQUIRED 'nextStep' => [ // REQUIRED 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ // REQUIRED 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], ], 'timeoutNextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], '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 ], ], // ... ], ], // ... ], ], ], ], 'confirmationConditional' => [ 'active' => true || false, // REQUIRED 'conditionalBranches' => [ // REQUIRED [ 'condition' => [ // REQUIRED 'expressionString' => '<string>', // REQUIRED ], 'name' => '<string>', // REQUIRED 'nextStep' => [ // REQUIRED 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ // REQUIRED 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], ], 'confirmationNextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'confirmationResponse' => [ '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 ], ], // ... ], ], // ... ], ], 'declinationConditional' => [ 'active' => true || false, // REQUIRED 'conditionalBranches' => [ // REQUIRED [ 'condition' => [ // REQUIRED 'expressionString' => '<string>', // REQUIRED ], 'name' => '<string>', // REQUIRED 'nextStep' => [ // REQUIRED 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ // REQUIRED 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], ], 'declinationNextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'declinationResponse' => [ '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 ], ], // ... ], ], // ... ], ], 'elicitationCodeHook' => [ 'enableCodeHookInvocation' => true || false, // REQUIRED 'invocationLabel' => '<string>', ], 'failureConditional' => [ 'active' => true || false, // REQUIRED 'conditionalBranches' => [ // REQUIRED [ 'condition' => [ // REQUIRED 'expressionString' => '<string>', // REQUIRED ], 'name' => '<string>', // REQUIRED 'nextStep' => [ // REQUIRED 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ // REQUIRED 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], ], 'failureNextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], '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 ], ], // ... ], ], // ... ], ], '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 ], ], // ... ], ], // ... ], 'messageSelectionStrategy' => 'Random|Ordered', 'promptAttemptsSpecification' => [ '<PromptAttempt>' => [ 'allowInterrupt' => true || false, 'allowedInputTypes' => [ // REQUIRED 'allowAudioInput' => true || false, // REQUIRED 'allowDTMFInput' => true || false, // REQUIRED ], 'audioAndDTMFInputSpecification' => [ 'audioSpecification' => [ 'endTimeoutMs' => <integer>, // REQUIRED 'maxLengthMs' => <integer>, // REQUIRED ], 'dtmfSpecification' => [ 'deletionCharacter' => '<string>', // REQUIRED 'endCharacter' => '<string>', // REQUIRED 'endTimeoutMs' => <integer>, // REQUIRED 'maxLength' => <integer>, // REQUIRED ], 'startTimeoutMs' => <integer>, // REQUIRED ], 'textInputSpecification' => [ 'startTimeoutMs' => <integer>, // 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>', 'qnAIntentConfiguration' => [ 'bedrockModelConfiguration' => [ 'customPrompt' => '<string>', 'guardrail' => [ 'identifier' => '<string>', // REQUIRED 'version' => '<string>', // REQUIRED ], 'modelArn' => '<string>', // REQUIRED 'traceStatus' => 'ENABLED|DISABLED', ], 'dataSourceConfiguration' => [ 'bedrockKnowledgeStoreConfiguration' => [ 'bedrockKnowledgeBaseArn' => '<string>', // REQUIRED 'exactResponse' => true || false, 'exactResponseFields' => [ 'answerField' => '<string>', ], ], 'kendraConfiguration' => [ 'exactResponse' => true || false, 'kendraIndex' => '<string>', // REQUIRED 'queryFilterString' => '<string>', 'queryFilterStringEnabled' => true || false, ], 'opensearchConfiguration' => [ 'domainEndpoint' => '<string>', // REQUIRED 'exactResponse' => true || false, 'exactResponseFields' => [ 'answerField' => '<string>', // REQUIRED 'questionField' => '<string>', // REQUIRED ], 'includeFields' => ['<string>', ...], 'indexName' => '<string>', // REQUIRED ], ], ], 'sampleUtterances' => [ [ 'utterance' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The identifier of the bot associated with this intent.
- botVersion
-
- Required: Yes
- Type: string
The version of the bot associated with this intent.
- description
-
- Type: string
A description of the intent. Use the description to help identify the intent in lists.
- dialogCodeHook
-
- Type: DialogCodeHookSettings structure
Specifies that Amazon Lex invokes the alias Lambda function for each user input. You can invoke this Lambda function to personalize user interaction.
For example, suppose that your bot determines that the user's name is John. You Lambda function might retrieve John's information from a backend database and prepopulate some of the values. For example, if you find that John is gluten intolerant, you might set the corresponding intent slot,
glutenIntolerant
totrue
. You might find John's phone number and set the corresponding session attribute. - fulfillmentCodeHook
-
- Type: FulfillmentCodeHookSettings structure
Specifies that Amazon Lex invokes the alias Lambda function when the intent is ready for fulfillment. You can invoke this function to complete the bot's transaction with the user.
For example, in a pizza ordering bot, the Lambda function can look up the closest pizza restaurant to the customer's location and then place an order on the customer's behalf.
- initialResponseSetting
-
- Type: InitialResponseSetting structure
Configuration settings for the response that is sent to the user at the beginning of a conversation, before eliciting slot values.
- inputContexts
-
- Type: Array of InputContext structures
A list of contexts that must be active for this intent to be considered by Amazon Lex.
When an intent has an input context list, Amazon Lex only considers using the intent in an interaction with the user when the specified contexts are included in the active context list for the session. If the contexts are not active, then Amazon Lex will not use the intent.
A context can be automatically activated using the
outputContexts
property or it can be set at runtime.For example, if there are two intents with different input contexts that respond to the same utterances, only the intent with the active context will respond.
An intent may have up to 5 input contexts. If an intent has multiple input contexts, all of the contexts must be active to consider the intent.
- intentClosingSetting
-
- Type: IntentClosingSetting structure
Sets the response that Amazon Lex sends to the user when the intent is closed.
- intentConfirmationSetting
-
- Type: IntentConfirmationSetting structure
Provides prompts that Amazon Lex sends to the user to confirm the completion of an intent. If the user answers "no," the settings contain a statement that is sent to the user to end the intent.
- intentName
-
- Required: Yes
- Type: string
The name of the intent. Intent names must be unique in the locale that contains the intent and cannot match the name of any built-in intent.
- kendraConfiguration
-
- Type: KendraConfiguration structure
Configuration information required to use the
AMAZON.KendraSearchIntent
intent to connect to an Amazon Kendra index. TheAMAZON.KendraSearchIntent
intent is called when Amazon Lex can't determine another intent to invoke. - localeId
-
- Required: Yes
- Type: string
The identifier of the language and locale where this intent is used. All of the bots, slot types, and slots used by the intent must have the same locale. For more information, see Supported languages.
- outputContexts
-
- Type: Array of OutputContext structures
A lists of contexts that the intent activates when it is fulfilled.
You can use an output context to indicate the intents that Amazon Lex should consider for the next turn of the conversation with a customer.
When you use the
outputContextsList
property, all of the contexts specified in the list are activated when the intent is fulfilled. You can set up to 10 output contexts. You can also set the number of conversation turns that the context should be active, or the length of time that the context should be active. - parentIntentSignature
-
- Type: string
A unique identifier for the built-in intent to base this intent on.
- qnAIntentConfiguration
-
- Type: QnAIntentConfiguration structure
Specifies the configuration of the built-in
Amazon.QnAIntent
. TheAMAZON.QnAIntent
intent is called when Amazon Lex can't determine another intent to invoke. If you specify this field, you can't specify thekendraConfiguration
field. - sampleUtterances
-
- Type: Array of SampleUtterance structures
An array of strings that a user might say to signal the intent. For example, "I want a pizza", or "I want a {PizzaSize} pizza".
In an utterance, slot names are enclosed in curly braces ("{", "}") to indicate where they should be displayed in the utterance shown to the user..
Result Syntax
[ 'botId' => '<string>', 'botVersion' => '<string>', 'creationDateTime' => <DateTime>, 'description' => '<string>', 'dialogCodeHook' => [ 'enabled' => true || false, ], 'fulfillmentCodeHook' => [ 'active' => true || false, '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' => [ 'failureConditional' => [ 'active' => true || false, 'conditionalBranches' => [ [ 'condition' => [ 'expressionString' => '<string>', ], 'name' => '<string>', 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], ], 'failureNextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], '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>', ], ], // ... ], ], // ... ], ], 'successConditional' => [ 'active' => true || false, 'conditionalBranches' => [ [ 'condition' => [ 'expressionString' => '<string>', ], 'name' => '<string>', 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], ], 'successNextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<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>', ], ], // ... ], ], // ... ], ], 'timeoutConditional' => [ 'active' => true || false, 'conditionalBranches' => [ [ 'condition' => [ 'expressionString' => '<string>', ], 'name' => '<string>', 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], ], 'timeoutNextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<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>', ], ], // ... ], ], // ... ], ], ], ], 'initialResponseSetting' => [ 'codeHook' => [ 'active' => true || false, 'enableCodeHookInvocation' => true || false, 'invocationLabel' => '<string>', 'postCodeHookSpecification' => [ 'failureConditional' => [ 'active' => true || false, 'conditionalBranches' => [ [ 'condition' => [ 'expressionString' => '<string>', ], 'name' => '<string>', 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], ], 'failureNextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], '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>', ], ], // ... ], ], // ... ], ], 'successConditional' => [ 'active' => true || false, 'conditionalBranches' => [ [ 'condition' => [ 'expressionString' => '<string>', ], 'name' => '<string>', 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], ], 'successNextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<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>', ], ], // ... ], ], // ... ], ], 'timeoutConditional' => [ 'active' => true || false, 'conditionalBranches' => [ [ 'condition' => [ 'expressionString' => '<string>', ], 'name' => '<string>', 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], ], 'timeoutNextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<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>', ], ], // ... ], ], // ... ], ], ], ], 'conditional' => [ 'active' => true || false, 'conditionalBranches' => [ [ 'condition' => [ 'expressionString' => '<string>', ], 'name' => '<string>', 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], ], 'initialResponse' => [ '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>', ], ], // ... ], ], // ... ], ], 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<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>', ], ], // ... ], ], // ... ], ], 'conditional' => [ 'active' => true || false, 'conditionalBranches' => [ [ 'condition' => [ 'expressionString' => '<string>', ], 'name' => '<string>', 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], ], 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], ], 'intentConfirmationSetting' => [ 'active' => true || false, 'codeHook' => [ 'active' => true || false, 'enableCodeHookInvocation' => true || false, 'invocationLabel' => '<string>', 'postCodeHookSpecification' => [ 'failureConditional' => [ 'active' => true || false, 'conditionalBranches' => [ [ 'condition' => [ 'expressionString' => '<string>', ], 'name' => '<string>', 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], ], 'failureNextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], '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>', ], ], // ... ], ], // ... ], ], 'successConditional' => [ 'active' => true || false, 'conditionalBranches' => [ [ 'condition' => [ 'expressionString' => '<string>', ], 'name' => '<string>', 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], ], 'successNextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<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>', ], ], // ... ], ], // ... ], ], 'timeoutConditional' => [ 'active' => true || false, 'conditionalBranches' => [ [ 'condition' => [ 'expressionString' => '<string>', ], 'name' => '<string>', 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], ], 'timeoutNextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<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>', ], ], // ... ], ], // ... ], ], ], ], 'confirmationConditional' => [ 'active' => true || false, 'conditionalBranches' => [ [ 'condition' => [ 'expressionString' => '<string>', ], 'name' => '<string>', 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], ], 'confirmationNextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'confirmationResponse' => [ '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>', ], ], // ... ], ], // ... ], ], 'declinationConditional' => [ 'active' => true || false, 'conditionalBranches' => [ [ 'condition' => [ 'expressionString' => '<string>', ], 'name' => '<string>', 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], ], 'declinationNextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], '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>', ], ], // ... ], ], // ... ], ], 'elicitationCodeHook' => [ 'enableCodeHookInvocation' => true || false, 'invocationLabel' => '<string>', ], 'failureConditional' => [ 'active' => true || false, 'conditionalBranches' => [ [ 'condition' => [ 'expressionString' => '<string>', ], 'name' => '<string>', 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], ], 'failureNextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], '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>', ], ], // ... ], ], // ... ], ], '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>', ], ], // ... ], ], // ... ], 'messageSelectionStrategy' => 'Random|Ordered', 'promptAttemptsSpecification' => [ '<PromptAttempt>' => [ 'allowInterrupt' => true || false, 'allowedInputTypes' => [ 'allowAudioInput' => true || false, 'allowDTMFInput' => true || false, ], 'audioAndDTMFInputSpecification' => [ 'audioSpecification' => [ 'endTimeoutMs' => <integer>, 'maxLengthMs' => <integer>, ], 'dtmfSpecification' => [ 'deletionCharacter' => '<string>', 'endCharacter' => '<string>', 'endTimeoutMs' => <integer>, 'maxLength' => <integer>, ], 'startTimeoutMs' => <integer>, ], 'textInputSpecification' => [ 'startTimeoutMs' => <integer>, ], ], // ... ], ], ], 'intentId' => '<string>', 'intentName' => '<string>', 'kendraConfiguration' => [ 'kendraIndex' => '<string>', 'queryFilterString' => '<string>', 'queryFilterStringEnabled' => true || false, ], 'localeId' => '<string>', 'outputContexts' => [ [ 'name' => '<string>', 'timeToLiveInSeconds' => <integer>, 'turnsToLive' => <integer>, ], // ... ], 'parentIntentSignature' => '<string>', 'qnAIntentConfiguration' => [ 'bedrockModelConfiguration' => [ 'customPrompt' => '<string>', 'guardrail' => [ 'identifier' => '<string>', 'version' => '<string>', ], 'modelArn' => '<string>', 'traceStatus' => 'ENABLED|DISABLED', ], 'dataSourceConfiguration' => [ 'bedrockKnowledgeStoreConfiguration' => [ 'bedrockKnowledgeBaseArn' => '<string>', 'exactResponse' => true || false, 'exactResponseFields' => [ 'answerField' => '<string>', ], ], 'kendraConfiguration' => [ 'exactResponse' => true || false, 'kendraIndex' => '<string>', 'queryFilterString' => '<string>', 'queryFilterStringEnabled' => true || false, ], 'opensearchConfiguration' => [ 'domainEndpoint' => '<string>', 'exactResponse' => true || false, 'exactResponseFields' => [ 'answerField' => '<string>', 'questionField' => '<string>', ], 'includeFields' => ['<string>', ...], 'indexName' => '<string>', ], ], ], 'sampleUtterances' => [ [ 'utterance' => '<string>', ], // ... ], ]
Result Details
Members
- botId
-
- Type: string
The identifier of the bot associated with the intent.
- botVersion
-
- Type: string
The version of the bot associated with the intent.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp of the date and time that the intent was created.
- description
-
- Type: string
The description specified for the intent.
- dialogCodeHook
-
- Type: DialogCodeHookSettings structure
The dialog Lambda function specified for the intent.
- fulfillmentCodeHook
-
- Type: FulfillmentCodeHookSettings structure
The fulfillment Lambda function specified for the intent.
- initialResponseSetting
-
- Type: InitialResponseSetting structure
Configuration settings for the response that is sent to the user at the beginning of a conversation, before eliciting slot values.
- inputContexts
-
- Type: Array of InputContext structures
The list of input contexts specified for the intent.
- intentClosingSetting
-
- Type: IntentClosingSetting structure
The closing setting specified for the intent.
- intentConfirmationSetting
-
- Type: IntentConfirmationSetting structure
The confirmation setting specified for the intent.
- intentId
-
- Type: string
A unique identifier for the intent.
- intentName
-
- Type: string
The name specified for the intent.
- kendraConfiguration
-
- Type: KendraConfiguration structure
Configuration for searching a Amazon Kendra index specified for the intent.
- localeId
-
- Type: string
The locale that the intent is specified to use.
- outputContexts
-
- Type: Array of OutputContext structures
The list of output contexts specified for the intent.
- parentIntentSignature
-
- Type: string
The signature of the parent intent specified for the intent.
- qnAIntentConfiguration
-
- Type: QnAIntentConfiguration structure
Details about the the configuration of the built-in
Amazon.QnAIntent
. - sampleUtterances
-
- Type: Array of SampleUtterance structures
The sample utterances specified for the intent.
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
([/* ... */]);
Creates a new resource policy with the specified policy statements.
Parameter Syntax
$result = $client->createResourcePolicy([ 'policy' => '<string>', // REQUIRED 'resourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- policy
-
- Required: Yes
- Type: string
A resource policy to add to the resource. The policy is a JSON structure that contains one or more statements that define the policy. The policy must follow the IAM syntax. For more information about the contents of a JSON policy document, see IAM JSON policy reference .
If the policy isn't valid, Amazon Lex returns a validation exception.
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
Result Syntax
[ 'resourceArn' => '<string>', 'revisionId' => '<string>', ]
Result Details
Members
- resourceArn
-
- Type: string
The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy was attached to.
- revisionId
-
- Type: string
The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.
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
([/* ... */]);
Adds a new resource policy statement to a bot or bot alias. If a resource policy exists, the statement is added to the current resource policy. If a policy doesn't exist, a new policy is created.
You can't create a resource policy statement that allows cross-account access.
You need to add the CreateResourcePolicy
or UpdateResourcePolicy
action to the bot role in order to call the API.
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
Members
- action
-
- Required: Yes
- Type: Array of strings
The Amazon Lex action that this policy either allows or denies. The action must apply to the resource type of the specified ARN. For more information, see Actions, resources, and condition keys for Amazon Lex V2.
- condition
-
- Type: Associative array of custom strings keys (ConditionOperator) to stringss
Specifies a condition when the policy is in effect. If the principal of the policy is a service principal, you must provide two condition blocks, one with a SourceAccount global condition key and one with a SourceArn global condition key.
For more information, see IAM JSON policy elements: Condition .
- effect
-
- Required: Yes
- Type: string
Determines whether the statement allows or denies access to the resource.
- expectedRevisionId
-
- Type: string
The identifier of the revision of the policy to edit. If this revision ID doesn't match the current revision ID, Amazon Lex throws an exception.
If you don't specify a revision, Amazon Lex overwrites the contents of the policy with the new values.
- principal
-
- Required: Yes
- Type: Array of Principal structures
An IAM principal, such as an IAM user, IAM role, or Amazon Web Services services that is allowed or denied access to a resource. For more information, see Amazon Web Services JSON policy elements: Principal.
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
- statementId
-
- Required: Yes
- Type: string
The name of the statement. The ID is the same as the
Sid
IAM property. The statement name must be unique within the policy. For more information, see IAM JSON policy elements: Sid.
Result Syntax
[ 'resourceArn' => '<string>', 'revisionId' => '<string>', ]
Result Details
Members
- resourceArn
-
- Type: string
The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
- revisionId
-
- Type: string
The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.
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
([/* ... */]);
Creates a slot in an intent. A slot is a variable needed to fulfill an intent. For example, an OrderPizza
intent might need slots for size, crust, and number of pizzas. For each slot, you define one or more utterances that Amazon Lex uses to elicit a response from the user.
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>', 'subSlotSetting' => [ 'expression' => '<string>', 'slotSpecifications' => [ '<Name>' => [ 'slotTypeId' => '<string>', // REQUIRED 'valueElicitationSetting' => [ // REQUIRED 'defaultValueSpecification' => [ 'defaultValueList' => [ // REQUIRED [ 'defaultValue' => '<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 ], ], // ... ], ], // ... ], 'messageSelectionStrategy' => 'Random|Ordered', 'promptAttemptsSpecification' => [ '<PromptAttempt>' => [ 'allowInterrupt' => true || false, 'allowedInputTypes' => [ // REQUIRED 'allowAudioInput' => true || false, // REQUIRED 'allowDTMFInput' => true || false, // REQUIRED ], 'audioAndDTMFInputSpecification' => [ 'audioSpecification' => [ 'endTimeoutMs' => <integer>, // REQUIRED 'maxLengthMs' => <integer>, // REQUIRED ], 'dtmfSpecification' => [ 'deletionCharacter' => '<string>', // REQUIRED 'endCharacter' => '<string>', // REQUIRED 'endTimeoutMs' => <integer>, // REQUIRED 'maxLength' => <integer>, // REQUIRED ], 'startTimeoutMs' => <integer>, // REQUIRED ], 'textInputSpecification' => [ 'startTimeoutMs' => <integer>, // REQUIRED ], ], // ... ], ], 'sampleUtterances' => [ [ 'utterance' => '<string>', // 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 ], ], // ... ], ], // ... ], ], ], ], ], // ... ], ], '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 ], ], // ... ], ], // ... ], 'messageSelectionStrategy' => 'Random|Ordered', 'promptAttemptsSpecification' => [ '<PromptAttempt>' => [ 'allowInterrupt' => true || false, 'allowedInputTypes' => [ // REQUIRED 'allowAudioInput' => true || false, // REQUIRED 'allowDTMFInput' => true || false, // REQUIRED ], 'audioAndDTMFInputSpecification' => [ 'audioSpecification' => [ 'endTimeoutMs' => <integer>, // REQUIRED 'maxLengthMs' => <integer>, // REQUIRED ], 'dtmfSpecification' => [ 'deletionCharacter' => '<string>', // REQUIRED 'endCharacter' => '<string>', // REQUIRED 'endTimeoutMs' => <integer>, // REQUIRED 'maxLength' => <integer>, // REQUIRED ], 'startTimeoutMs' => <integer>, // REQUIRED ], 'textInputSpecification' => [ 'startTimeoutMs' => <integer>, // REQUIRED ], ], // ... ], ], 'sampleUtterances' => [ [ 'utterance' => '<string>', // REQUIRED ], // ... ], 'slotCaptureSetting' => [ 'captureConditional' => [ 'active' => true || false, // REQUIRED 'conditionalBranches' => [ // REQUIRED [ 'condition' => [ // REQUIRED 'expressionString' => '<string>', // REQUIRED ], 'name' => '<string>', // REQUIRED 'nextStep' => [ // REQUIRED 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ // REQUIRED 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], ], 'captureNextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'captureResponse' => [ '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 ], ], // ... ], ], // ... ], ], 'codeHook' => [ 'active' => true || false, // REQUIRED 'enableCodeHookInvocation' => true || false, // REQUIRED 'invocationLabel' => '<string>', 'postCodeHookSpecification' => [ // REQUIRED 'failureConditional' => [ 'active' => true || false, // REQUIRED 'conditionalBranches' => [ // REQUIRED [ 'condition' => [ // REQUIRED 'expressionString' => '<string>', // REQUIRED ], 'name' => '<string>', // REQUIRED 'nextStep' => [ // REQUIRED 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ // REQUIRED 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], ], 'failureNextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], '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 ], ], // ... ], ], // ... ], ], 'successConditional' => [ 'active' => true || false, // REQUIRED 'conditionalBranches' => [ // REQUIRED [ 'condition' => [ // REQUIRED 'expressionString' => '<string>', // REQUIRED ], 'name' => '<string>', // REQUIRED 'nextStep' => [ // REQUIRED 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ // REQUIRED 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], ], 'successNextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], '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 ], ], // ... ], ], // ... ], ], 'timeoutConditional' => [ 'active' => true || false, // REQUIRED 'conditionalBranches' => [ // REQUIRED [ 'condition' => [ // REQUIRED 'expressionString' => '<string>', // REQUIRED ], 'name' => '<string>', // REQUIRED 'nextStep' => [ // REQUIRED 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ // REQUIRED 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], ], 'timeoutNextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], '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 ], ], // ... ], ], // ... ], ], ], ], 'elicitationCodeHook' => [ 'enableCodeHookInvocation' => true || false, // REQUIRED 'invocationLabel' => '<string>', ], 'failureConditional' => [ 'active' => true || false, // REQUIRED 'conditionalBranches' => [ // REQUIRED [ 'condition' => [ // REQUIRED 'expressionString' => '<string>', // REQUIRED ], 'name' => '<string>', // REQUIRED 'nextStep' => [ // REQUIRED 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ // REQUIRED 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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 ], ], // ... ], ], // ... ], ], ], ], 'failureNextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', // REQUIRED ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], '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 ], ], // ... ], ], // ... ], ], ], 'slotConstraint' => 'Required|Optional', // REQUIRED 'slotResolutionSetting' => [ 'slotResolutionStrategy' => 'EnhancedFallback|Default', // 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
Members
- botId
-
- Required: Yes
- Type: string
The identifier of the bot associated with the slot.
- botVersion
-
- Required: Yes
- Type: string
The version of the bot associated with the slot.
- description
-
- Type: string
A description of the slot. Use this to help identify the slot in lists.
- intentId
-
- Required: Yes
- Type: string
The identifier of the intent that contains the slot.
- localeId
-
- Required: Yes
- Type: string
The identifier of the language and locale that the slot will be used in. The string must match one of the supported locales. All of the bots, intents, slot types used by the slot must have the same locale. For more information, see Supported languages.
- multipleValuesSetting
-
- Type: MultipleValuesSetting structure
Indicates whether the slot returns multiple values in one response. Multi-value slots are only available in the
en-US
locale. If you set this value totrue
in any other locale, Amazon Lex throws aValidationException
.If the
multipleValuesSetting
is not set, the default value isfalse
. - obfuscationSetting
-
- Type: ObfuscationSetting structure
Determines how slot values are used in Amazon CloudWatch logs. If the value of the
obfuscationSetting
parameter isDefaultObfuscation
, slot values are obfuscated in the log output. If the value isNone
, the actual value is present in the log output.The default is to obfuscate values in the CloudWatch logs.
- slotName
-
- Required: Yes
- Type: string
The name of the slot. Slot names must be unique within the bot that contains the slot.
- slotTypeId
-
- Type: string
The unique identifier for the slot type associated with this slot. The slot type determines the values that can be entered into the slot.
- subSlotSetting
-
- Type: SubSlotSetting structure
Specifications for the constituent sub slots and the expression for the composite slot.
- valueElicitationSetting
-
- Required: Yes
- Type: SlotValueElicitationSetting structure
Specifies prompts that Amazon Lex sends to the user to elicit a response that provides the value for the slot.
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>', 'subSlotSetting' => [ 'expression' => '<string>', 'slotSpecifications' => [ '<Name>' => [ '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>', ], ], // ... ], ], // ... ], 'messageSelectionStrategy' => 'Random|Ordered', 'promptAttemptsSpecification' => [ '<PromptAttempt>' => [ 'allowInterrupt' => true || false, 'allowedInputTypes' => [ 'allowAudioInput' => true || false, 'allowDTMFInput' => true || false, ], 'audioAndDTMFInputSpecification' => [ 'audioSpecification' => [ 'endTimeoutMs' => <integer>, 'maxLengthMs' => <integer>, ], 'dtmfSpecification' => [ 'deletionCharacter' => '<string>', 'endCharacter' => '<string>', 'endTimeoutMs' => <integer>, 'maxLength' => <integer>, ], 'startTimeoutMs' => <integer>, ], 'textInputSpecification' => [ 'startTimeoutMs' => <integer>, ], ], // ... ], ], 'sampleUtterances' => [ [ 'utterance' => '<string>', ], // ... ], '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>', ], ], // ... ], ], // ... ], ], ], ], ], // ... ], ], '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>', ], ], // ... ], ], // ... ], 'messageSelectionStrategy' => 'Random|Ordered', 'promptAttemptsSpecification' => [ '<PromptAttempt>' => [ 'allowInterrupt' => true || false, 'allowedInputTypes' => [ 'allowAudioInput' => true || false, 'allowDTMFInput' => true || false, ], 'audioAndDTMFInputSpecification' => [ 'audioSpecification' => [ 'endTimeoutMs' => <integer>, 'maxLengthMs' => <integer>, ], 'dtmfSpecification' => [ 'deletionCharacter' => '<string>', 'endCharacter' => '<string>', 'endTimeoutMs' => <integer>, 'maxLength' => <integer>, ], 'startTimeoutMs' => <integer>, ], 'textInputSpecification' => [ 'startTimeoutMs' => <integer>, ], ], // ... ], ], 'sampleUtterances' => [ [ 'utterance' => '<string>', ], // ... ], 'slotCaptureSetting' => [ 'captureConditional' => [ 'active' => true || false, 'conditionalBranches' => [ [ 'condition' => [ 'expressionString' => '<string>', ], 'name' => '<string>', 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], ], 'captureNextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'captureResponse' => [ '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>', ], ], // ... ], ], // ... ], ], 'codeHook' => [ 'active' => true || false, 'enableCodeHookInvocation' => true || false, 'invocationLabel' => '<string>', 'postCodeHookSpecification' => [ 'failureConditional' => [ 'active' => true || false, 'conditionalBranches' => [ [ 'condition' => [ 'expressionString' => '<string>', ], 'name' => '<string>', 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], ], 'failureNextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], '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>', ], ], // ... ], ], // ... ], ], 'successConditional' => [ 'active' => true || false, 'conditionalBranches' => [ [ 'condition' => [ 'expressionString' => '<string>', ], 'name' => '<string>', 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], ], 'successNextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<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>', ], ], // ... ], ], // ... ], ], 'timeoutConditional' => [ 'active' => true || false, 'conditionalBranches' => [ [ 'condition' => [ 'expressionString' => '<string>', ], 'name' => '<string>', 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], ], 'timeoutNextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<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>', ], ], // ... ], ], // ... ], ], ], ], 'elicitationCodeHook' => [ 'enableCodeHookInvocation' => true || false, 'invocationLabel' => '<string>', ], 'failureConditional' => [ 'active' => true || false, 'conditionalBranches' => [ [ 'condition' => [ 'expressionString' => '<string>', ], 'name' => '<string>', 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], // ... ], 'defaultBranch' => [ 'nextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'response' => [ '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>', ], ], // ... ], ], // ... ], ], ], ], 'failureNextStep' => [ 'dialogAction' => [ 'slotToElicit' => '<string>', 'suppressNextMessage' => true || false, 'type' => 'ElicitIntent|StartIntent|ElicitSlot|EvaluateConditional|InvokeDialogCodeHook|ConfirmIntent|FulfillIntent|CloseIntent|EndConversation', ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'shape' => 'Scalar|List', 'value' => [ 'interpretedValue' => '<string>', ], 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], '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>', ], ], // ... ], ], // ... ], ], ], 'slotConstraint' => 'Required|Optional', 'slotResolutionSetting' => [ 'slotResolutionStrategy' => 'EnhancedFallback|Default', ], '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
Members
- botId
-
- Type: string
The unique identifier of the bot associated with the slot.
- botVersion
-
- Type: string
The version of the bot associated with the slot.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of the date and time that the slot was created.
- description
-
- Type: string
The description associated with the slot.
- intentId
-
- Type: string
The unique identifier of the intent associated with the slot.
- localeId
-
- Type: string
The language and local specified for the slot.
- multipleValuesSetting
-
- Type: MultipleValuesSetting structure
Indicates whether the slot returns multiple values in one response.
- obfuscationSetting
-
- Type: ObfuscationSetting structure
Indicates whether the slot is configured to obfuscate values in Amazon CloudWatch logs.
- slotId
-
- Type: string
The unique identifier associated with the slot. Use this to identify the slot when you update or delete it.
- slotName
-
- Type: string
The name specified for the slot.
- slotTypeId
-
- Type: string
The unique identifier of the slot type associated with this slot.
- subSlotSetting
-
- Type: SubSlotSetting structure
Specifications for the constituent sub slots and the expression for the composite slot.
- valueElicitationSetting
-
- Type: SlotValueElicitationSetting structure
The value elicitation settings specified for the slot.
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
([/* ... */]);
Creates a custom slot type
To create a custom slot type, specify a name for the slot type and a set of enumeration values, the values that a slot of this type can assume.
Parameter Syntax
$result = $client->createSlotType([ 'botId' => '<string>', // REQUIRED 'botVersion' => '<string>', // REQUIRED 'compositeSlotTypeSetting' => [ 'subSlots' => [ [ 'name' => '<string>', // REQUIRED 'slotTypeId' => '<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|Concatenation', // REQUIRED ], ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The identifier of the bot associated with this slot type.
- botVersion
-
- Required: Yes
- Type: string
The identifier of the bot version associated with this slot type.
- compositeSlotTypeSetting
-
- Type: CompositeSlotTypeSetting structure
Specifications for a composite slot type.
- description
-
- Type: string
A description of the slot type. Use the description to help identify the slot type in lists.
- externalSourceSetting
-
- Type: ExternalSourceSetting structure
Sets the type of external information used to create the slot type.
- localeId
-
- Required: Yes
- Type: string
The identifier of the language and locale that the slot type will be used in. The string must match one of the supported locales. All of the bots, intents, and slots used by the slot type must have the same locale. For more information, see Supported languages.
- parentSlotTypeSignature
-
- Type: string
The built-in slot type used as a parent of this slot type. When you define a parent slot type, the new slot type has the configuration of the parent slot type.
Only
AMAZON.AlphaNumeric
is supported. - slotTypeName
-
- Required: Yes
- Type: string
The name for the slot. A slot type name must be unique within the intent.
- slotTypeValues
-
- Type: Array of SlotTypeValue structures
A list of
SlotTypeValue
objects that defines the values that the slot type can take. Each value can have a list of synonyms, additional values that help train the machine learning model about the values that it resolves for a slot. - valueSelectionSetting
-
- Type: SlotValueSelectionSetting structure
Determines the strategy that Amazon Lex uses to select a value from the list of possible values. The field can be set to one of the following values:
-
ORIGINAL_VALUE
- Returns the value entered by the user, if the user value is similar to the slot value. -
TOP_RESOLUTION
- If there is a resolution list for the slot, return the first value in the resolution list. If there is no resolution list, return null.
If you don't specify the
valueSelectionSetting
parameter, the default isORIGINAL_VALUE
.
Result Syntax
[ 'botId' => '<string>', 'botVersion' => '<string>', 'compositeSlotTypeSetting' => [ 'subSlots' => [ [ 'name' => '<string>', 'slotTypeId' => '<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|Concatenation', ], ]
Result Details
Members
- botId
-
- Type: string
The identifier for the bot associated with the slot type.
- botVersion
-
- Type: string
The version of the bot associated with the slot type.
- compositeSlotTypeSetting
-
- Type: CompositeSlotTypeSetting structure
Specifications for a composite slot type.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp of the date and time that the slot type was created.
- description
-
- Type: string
The description specified for the slot type.
- externalSourceSetting
-
- Type: ExternalSourceSetting structure
The type of external information used to create the slot type.
- localeId
-
- Type: string
The specified language and local specified for the slot type.
- parentSlotTypeSignature
-
- Type: string
The signature of the base slot type specified for the slot type.
- slotTypeId
-
- Type: string
The unique identifier assigned to the slot type. Use this to identify the slot type in the
UpdateSlotType
andDeleteSlotType
operations. - slotTypeName
-
- Type: string
The name specified for the slot type.
- slotTypeValues
-
- Type: Array of SlotTypeValue structures
The list of values that the slot type can assume.
- valueSelectionSetting
-
- Type: SlotValueSelectionSetting structure
The strategy that Amazon Lex uses to select a value from the list of possible values.
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.
CreateTestSetDiscrepancyReport
$result = $client->createTestSetDiscrepancyReport
([/* ... */]); $promise = $client->createTestSetDiscrepancyReportAsync
([/* ... */]);
Create a report that describes the differences between the bot and the test set.
Parameter Syntax
$result = $client->createTestSetDiscrepancyReport([ 'target' => [ // REQUIRED 'botAliasTarget' => [ 'botAliasId' => '<string>', // REQUIRED 'botId' => '<string>', // REQUIRED 'localeId' => '<string>', // REQUIRED ], ], 'testSetId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- target
-
- Required: Yes
- Type: TestSetDiscrepancyReportResourceTarget structure
The target bot for the test set discrepancy report.
- testSetId
-
- Required: Yes
- Type: string
The test set Id for the test set discrepancy report.
Result Syntax
[ 'creationDateTime' => <DateTime>, 'target' => [ 'botAliasTarget' => [ 'botAliasId' => '<string>', 'botId' => '<string>', 'localeId' => '<string>', ], ], 'testSetDiscrepancyReportId' => '<string>', 'testSetId' => '<string>', ]
Result Details
Members
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation date and time for the test set discrepancy report.
- target
-
- Type: TestSetDiscrepancyReportResourceTarget structure
The target bot for the test set discrepancy report.
- testSetDiscrepancyReportId
-
- Type: string
The unique identifier of the test set discrepancy report to describe.
- testSetId
-
- Type: string
The test set Id for the test set discrepancy report.
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.
- InternalServerException:
The service encountered an unexpected condition. 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.
CreateUploadUrl
$result = $client->createUploadUrl
([/* ... */]); $promise = $client->createUploadUrlAsync
([/* ... */]);
Gets a pre-signed S3 write URL that you use to upload the zip archive when importing a bot or a bot locale.
Parameter Syntax
$result = $client->createUploadUrl([ ]);
Parameter Details
Members
Result Syntax
[ 'importId' => '<string>', 'uploadUrl' => '<string>', ]
Result Details
Members
- importId
-
- Type: string
An identifier for a unique import job. Use it when you call the StartImport operation.
- uploadUrl
-
- Type: string
A pre-signed S3 write URL. Upload the zip archive file that contains the definition of your bot or bot locale.
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
([/* ... */]);
Deletes all versions of a bot, including the Draft
version. To delete a specific version, use the DeleteBotVersion
operation.
When you delete a bot, all of the resources contained in the bot are also deleted. Deleting a bot removes all locales, intents, slot, and slot types defined for the bot.
If a bot has an alias, the DeleteBot
operation returns a ResourceInUseException
exception. If you want to delete the bot and the alias, set the skipResourceInUseCheck
parameter to true
.
Parameter Syntax
$result = $client->deleteBot([ 'botId' => '<string>', // REQUIRED 'skipResourceInUseCheck' => true || false, ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The identifier of the bot to delete.
- skipResourceInUseCheck
-
- Type: boolean
By default, Amazon Lex checks if any other resource, such as an alias or bot network, is using the bot version before it is deleted and throws a
ResourceInUseException
exception if the bot is being used by another resource. Set this parameter totrue
to skip this check and remove the bot even if it is being used by another resource.
Result Syntax
[ 'botId' => '<string>', 'botStatus' => 'Creating|Available|Inactive|Deleting|Failed|Versioning|Importing|Updating', ]
Result Details
Members
- botId
-
- Type: string
The unique identifier of the bot that Amazon Lex is deleting.
- botStatus
-
- Type: string
The current status of the bot. The status is
Deleting
while the bot and its associated resources are being deleted.
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
([/* ... */]);
Deletes the specified bot alias.
Parameter Syntax
$result = $client->deleteBotAlias([ 'botAliasId' => '<string>', // REQUIRED 'botId' => '<string>', // REQUIRED 'skipResourceInUseCheck' => true || false, ]);
Parameter Details
Members
- botAliasId
-
- Required: Yes
- Type: string
The unique identifier of the bot alias to delete.
- botId
-
- Required: Yes
- Type: string
The unique identifier of the bot associated with the alias to delete.
- skipResourceInUseCheck
-
- Type: boolean
By default, Amazon Lex checks if any other resource, such as a bot network, is using the bot alias before it is deleted and throws a
ResourceInUseException
exception if the alias is being used by another resource. Set this parameter totrue
to skip this check and remove the alias even if it is being used by another resource.
Result Syntax
[ 'botAliasId' => '<string>', 'botAliasStatus' => 'Creating|Available|Deleting|Failed', 'botId' => '<string>', ]
Result Details
Members
- botAliasId
-
- Type: string
The unique identifier of the bot alias to delete.
- botAliasStatus
-
- Type: string
The current status of the alias. The status is
Deleting
while the alias is in the process of being deleted. Once the alias is deleted, it will no longer appear in the list of aliases returned by theListBotAliases
operation. - botId
-
- Type: string
The unique identifier of the bot that contains the alias to delete.
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
([/* ... */]);
Removes a locale from a bot.
When you delete a locale, all intents, slots, and slot types defined for the locale are also deleted.
Parameter Syntax
$result = $client->deleteBotLocale([ 'botId' => '<string>', // REQUIRED 'botVersion' => '<string>', // REQUIRED 'localeId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The unique identifier of the bot that contains the locale.
- botVersion
-
- Required: Yes
- Type: string
The version of the bot that contains the locale.
- localeId
-
- Required: Yes
- Type: string
The identifier of the language and locale that will be deleted. The string must match one of the supported locales. For more information, see Supported languages.
Result Syntax
[ 'botId' => '<string>', 'botLocaleStatus' => 'Creating|Building|Built|ReadyExpressTesting|Failed|Deleting|NotBuilt|Importing|Processing', 'botVersion' => '<string>', 'localeId' => '<string>', ]
Result Details
Members
- botId
-
- Type: string
The identifier of the bot that contained the deleted locale.
- botLocaleStatus
-
- Type: string
The status of deleting the bot locale. The locale first enters the
Deleting
status. Once the locale is deleted it no longer appears in the list of locales for the bot. - botVersion
-
- Type: string
The version of the bot that contained the deleted locale.
- localeId
-
- Type: string
The language and locale of the deleted locale.
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.
DeleteBotReplica
$result = $client->deleteBotReplica
([/* ... */]); $promise = $client->deleteBotReplicaAsync
([/* ... */]);
The action to delete the replicated bot in the secondary region.
Parameter Syntax
$result = $client->deleteBotReplica([ 'botId' => '<string>', // REQUIRED 'replicaRegion' => '<string>', // REQUIRED ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The unique ID of the replicated bot to be deleted from the secondary region
- replicaRegion
-
- Required: Yes
- Type: string
The secondary region of the replicated bot that will be deleted.
Result Syntax
[ 'botId' => '<string>', 'botReplicaStatus' => 'Enabling|Enabled|Deleting|Failed', 'replicaRegion' => '<string>', ]
Result Details
Members
- botId
-
- Type: string
The unique bot ID of the replicated bot generated.
- botReplicaStatus
-
- Type: string
The operational status of the replicated bot generated.
- replicaRegion
-
- Type: string
The region of the replicated bot generated.
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
([/* ... */]);
Deletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot operation.
Parameter Syntax
$result = $client->deleteBotVersion([ 'botId' => '<string>', // REQUIRED 'botVersion' => '<string>', // REQUIRED 'skipResourceInUseCheck' => true || false, ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The identifier of the bot that contains the version.
- botVersion
-
- Required: Yes
- Type: string
The version of the bot to delete.
- skipResourceInUseCheck
-
- Type: boolean
By default, Amazon Lex checks if any other resource, such as an alias or bot network, is using the bot version before it is deleted and throws a
ResourceInUseException
exception if the version is being used by another resource. Set this parameter totrue
to skip this check and remove the version even if it is being used by another resource.
Result Syntax
[ 'botId' => '<string>', 'botStatus' => 'Creating|Available|Inactive|Deleting|Failed|Versioning|Importing|Updating', 'botVersion' => '<string>', ]
Result Details
Members
- botId
-
- Type: string
The identifier of the bot that is being deleted.
- botStatus
-
- Type: string
The current status of the bot.
- botVersion
-
- Type: string
The version of the bot that is being deleted.
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
([/* ... */]);
Removes a custom vocabulary from the specified locale in the specified bot.
Parameter Syntax
$result = $client->deleteCustomVocabulary([ 'botId' => '<string>', // REQUIRED 'botVersion' => '<string>', // REQUIRED 'localeId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The unique identifier of the bot to remove the custom vocabulary from.
- botVersion
-
- Required: Yes
- Type: string
The version of the bot to remove the custom vocabulary from.
- localeId
-
- Required: Yes
- Type: string
The locale identifier for the locale that contains the custom vocabulary to remove.
Result Syntax
[ 'botId' => '<string>', 'botVersion' => '<string>', 'customVocabularyStatus' => 'Ready|Deleting|Exporting|Importing|Creating', 'localeId' => '<string>', ]
Result Details
Members
- botId
-
- Type: string
The identifier of the bot that the custom vocabulary was removed from.
- botVersion
-
- Type: string
The version of the bot that the custom vocabulary was removed from.
- customVocabularyStatus
-
- Type: string
The status of removing the custom vocabulary.
- localeId
-
- Type: string
The locale identifier for the locale that the custom vocabulary was removed from.
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
([/* ... */]);
Removes a previous export and the associated files stored in an S3 bucket.
Parameter Syntax
$result = $client->deleteExport([ 'exportId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- exportId
-
- Required: Yes
- Type: string
The unique identifier of the export to delete.
Result Syntax
[ 'exportId' => '<string>', 'exportStatus' => 'InProgress|Completed|Failed|Deleting', ]
Result Details
Members
- exportId
-
- Type: string
The unique identifier of the deleted export.
- exportStatus
-
- Type: string
The current status of the deletion. When the deletion is complete, the export will no longer be returned by the ListExports operation and calls to the DescribeExport operation with the export identifier will fail.
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