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.
DeleteImport
$result = $client->deleteImport
([/* ... */]); $promise = $client->deleteImportAsync
([/* ... */]);
Removes a previous import and the associated file stored in an S3 bucket.
Parameter Syntax
$result = $client->deleteImport([ 'importId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- importId
-
- Required: Yes
- Type: string
The unique identifier of the import to delete.
Result Syntax
[ 'importId' => '<string>', 'importStatus' => 'InProgress|Completed|Failed|Deleting', ]
Result Details
Members
- importId
-
- Type: string
The unique identifier of the deleted import.
- importStatus
-
- Type: string
The current status of the deletion. When the deletion is complete, the import will no longer be returned by the ListImports operation and calls to the DescribeImport operation with the import 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.
DeleteIntent
$result = $client->deleteIntent
([/* ... */]); $promise = $client->deleteIntentAsync
([/* ... */]);
Removes the specified intent.
Deleting an intent also deletes the slots associated with the intent.
Parameter Syntax
$result = $client->deleteIntent([ 'botId' => '<string>', // REQUIRED 'botVersion' => '<string>', // REQUIRED 'intentId' => '<string>', // REQUIRED 'localeId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The identifier of the bot associated with the intent.
- botVersion
-
- Required: Yes
- Type: string
The version of the bot associated with the intent.
- intentId
-
- Required: Yes
- Type: string
The unique identifier of the intent to delete.
- localeId
-
- Required: Yes
- Type: string
The identifier of the language and locale where the bot will be deleted. The string must match one of the supported locales. For more information, see Supported languages.
Result Syntax
[]
Result Details
Errors
- ThrottlingException:
Your request rate is too high. Reduce the frequency of requests.
- ServiceQuotaExceededException:
You have reached a quota for your bot.
- ValidationException:
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
- ConflictException:
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
- PreconditionFailedException:
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
DeleteResourcePolicy
$result = $client->deleteResourcePolicy
([/* ... */]); $promise = $client->deleteResourcePolicyAsync
([/* ... */]);
Removes an existing policy from a bot or bot alias. If the resource doesn't have a policy attached, Amazon Lex returns an exception.
Parameter Syntax
$result = $client->deleteResourcePolicy([ 'expectedRevisionId' => '<string>', 'resourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- expectedRevisionId
-
- Type: string
The identifier of the revision to edit. If this ID doesn't match the current revision number, Amazon Lex returns an exception
If you don't specify a revision ID, Amazon Lex will delete the current policy.
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the bot or bot alias that has the resource policy attached.
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 deleted from.
- 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.
- PreconditionFailedException:
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
- ThrottlingException:
Your request rate is too high. Reduce the frequency of requests.
DeleteResourcePolicyStatement
$result = $client->deleteResourcePolicyStatement
([/* ... */]); $promise = $client->deleteResourcePolicyStatementAsync
([/* ... */]);
Deletes a policy statement from a resource policy. If you delete the last statement from a policy, the policy is deleted. If you specify a statement ID that doesn't exist in the policy, or if the bot or bot alias doesn't have a policy attached, Amazon Lex returns an exception.
You need to add the DeleteResourcePolicy
or UpdateResourcePolicy
action to the bot role in order to call the API.
Parameter Syntax
$result = $client->deleteResourcePolicyStatement([ 'expectedRevisionId' => '<string>', 'resourceArn' => '<string>', // REQUIRED 'statementId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- expectedRevisionId
-
- Type: string
The identifier of the revision of the policy to delete the statement from. 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 removes the current contents of the statement.
- 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 (SID) to delete from the policy.
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 statement was removed from.
- 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.
- PreconditionFailedException:
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
- ThrottlingException:
Your request rate is too high. Reduce the frequency of requests.
DeleteSlot
$result = $client->deleteSlot
([/* ... */]); $promise = $client->deleteSlotAsync
([/* ... */]);
Deletes the specified slot from an intent.
Parameter Syntax
$result = $client->deleteSlot([ 'botId' => '<string>', // REQUIRED 'botVersion' => '<string>', // REQUIRED 'intentId' => '<string>', // REQUIRED 'localeId' => '<string>', // REQUIRED 'slotId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The identifier of the bot associated with the slot to delete.
- botVersion
-
- Required: Yes
- Type: string
The version of the bot associated with the slot to delete.
- intentId
-
- Required: Yes
- Type: string
The identifier of the intent associated with the slot.
- localeId
-
- Required: Yes
- Type: string
The identifier of the language and locale that the slot will be deleted from. The string must match one of the supported locales. For more information, see Supported languages.
- slotId
-
- Required: Yes
- Type: string
The identifier of the slot to delete.
Result Syntax
[]
Result Details
Errors
- ThrottlingException:
Your request rate is too high. Reduce the frequency of requests.
- ServiceQuotaExceededException:
You have reached a quota for your bot.
- ValidationException:
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
- ConflictException:
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
- PreconditionFailedException:
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
DeleteSlotType
$result = $client->deleteSlotType
([/* ... */]); $promise = $client->deleteSlotTypeAsync
([/* ... */]);
Deletes a slot type from a bot locale.
If a slot is using the slot type, Amazon Lex throws a ResourceInUseException
exception. To avoid the exception, set the skipResourceInUseCheck
parameter to true
.
Parameter Syntax
$result = $client->deleteSlotType([ 'botId' => '<string>', // REQUIRED 'botVersion' => '<string>', // REQUIRED 'localeId' => '<string>', // REQUIRED 'skipResourceInUseCheck' => true || false, 'slotTypeId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The identifier of the bot associated with the slot type.
- botVersion
-
- Required: Yes
- Type: string
The version of the bot associated with the slot type.
- localeId
-
- Required: Yes
- Type: string
The identifier of the language and locale that the slot type will be deleted from. The string must match one of the supported locales. For more information, see Supported languages.
- skipResourceInUseCheck
-
- Type: boolean
By default, the
DeleteSlotType
operations throws aResourceInUseException
exception if you try to delete a slot type used by a slot. Set theskipResourceInUseCheck
parameter totrue
to skip this check and remove the slot type even if a slot uses it. - slotTypeId
-
- Required: Yes
- Type: string
The identifier of the slot type to delete.
Result Syntax
[]
Result Details
Errors
- ThrottlingException:
Your request rate is too high. Reduce the frequency of requests.
- ServiceQuotaExceededException:
You have reached a quota for your bot.
- ValidationException:
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
- ConflictException:
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
- PreconditionFailedException:
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
DeleteTestSet
$result = $client->deleteTestSet
([/* ... */]); $promise = $client->deleteTestSetAsync
([/* ... */]);
The action to delete the selected test set.
Parameter Syntax
$result = $client->deleteTestSet([ 'testSetId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- testSetId
-
- Required: Yes
- Type: string
The test set Id of the test set to be deleted.
Result Syntax
[]
Result Details
Errors
- ThrottlingException:
Your request rate is too high. Reduce the frequency of requests.
- ServiceQuotaExceededException:
You have reached a quota for your bot.
- ValidationException:
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
- ConflictException:
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
- PreconditionFailedException:
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
DeleteUtterances
$result = $client->deleteUtterances
([/* ... */]); $promise = $client->deleteUtterancesAsync
([/* ... */]);
Deletes stored utterances.
Amazon Lex stores the utterances that users send to your bot. Utterances are stored for 15 days for use with the ListAggregatedUtterances operation, and then stored indefinitely for use in improving the ability of your bot to respond to user input..
Use the DeleteUtterances
operation to manually delete utterances for a specific session. When you use the DeleteUtterances
operation, utterances stored for improving your bot's ability to respond to user input are deleted immediately. Utterances stored for use with the ListAggregatedUtterances
operation are deleted after 15 days.
Parameter Syntax
$result = $client->deleteUtterances([ 'botId' => '<string>', // REQUIRED 'localeId' => '<string>', 'sessionId' => '<string>', ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The unique identifier of the bot that contains the utterances.
- localeId
-
- Type: string
The identifier of the language and locale where the utterances were collected. The string must match one of the supported locales. For more information, see Supported languages.
- sessionId
-
- Type: string
The unique identifier of the session with the user. The ID is returned in the response from the RecognizeText and RecognizeUtterance operations.
Result Syntax
[]
Result Details
Errors
- ValidationException:
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
- ThrottlingException:
Your request rate is too high. Reduce the frequency of requests.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
DescribeBot
$result = $client->describeBot
([/* ... */]); $promise = $client->describeBotAsync
([/* ... */]);
Provides metadata information about a bot.
Parameter Syntax
$result = $client->describeBot([ 'botId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The unique identifier of the bot to describe.
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', 'botType' => 'Bot|BotNetwork', 'creationDateTime' => <DateTime>, 'dataPrivacy' => [ 'childDirected' => true || false, ], 'description' => '<string>', 'failureReasons' => ['<string>', ...], 'idleSessionTTLInSeconds' => <integer>, 'lastUpdatedDateTime' => <DateTime>, 'roleArn' => '<string>', ]
Result Details
Members
- botId
-
- Type: string
The unique identifier of the bot.
- botMembers
-
- Type: Array of BotMember structures
The list of bots in the network that was described.
- botName
-
- Type: string
The name of the bot.
- botStatus
-
- Type: string
The current status of the bot. When the status is
Available
the bot is ready to be used in conversations with users. - botType
-
- Type: string
The type of the bot that was described.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp of the date and time that the bot was created.
- dataPrivacy
-
- Type: DataPrivacy structure
Settings for managing data privacy of the bot and its conversations with users.
- description
-
- Type: string
The description of the bot.
- failureReasons
-
- Type: Array of strings
If the
botStatus
isFailed
, this contains a list of reasons that the bot couldn't be built. - idleSessionTTLInSeconds
-
- Type: int
The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp of the date and time that the bot was last updated.
- roleArn
-
- Type: string
The Amazon Resource Name (ARN) of an IAM role that has permission to access 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.
- 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.
DescribeBotAlias
$result = $client->describeBotAlias
([/* ... */]); $promise = $client->describeBotAliasAsync
([/* ... */]);
Get information about a specific bot alias.
Parameter Syntax
$result = $client->describeBotAlias([ 'botAliasId' => '<string>', // REQUIRED 'botId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- botAliasId
-
- Required: Yes
- Type: string
The identifier of the bot alias to describe.
- botId
-
- Required: Yes
- Type: string
The identifier of the bot associated with the bot alias to describe.
Result Syntax
[ 'botAliasHistoryEvents' => [ [ 'botVersion' => '<string>', 'endDate' => <DateTime>, 'startDate' => <DateTime>, ], // ... ], '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>', 'lastUpdatedDateTime' => <DateTime>, 'parentBotNetworks' => [ [ 'botId' => '<string>', 'botVersion' => '<string>', ], // ... ], 'sentimentAnalysisSettings' => [ 'detectSentiment' => true || false, ], ]
Result Details
Members
- botAliasHistoryEvents
-
- Type: Array of BotAliasHistoryEvent structures
A list of events that affect a bot alias. For example, an event is recorded when the version that the alias points to changes.
- botAliasId
-
- Type: string
The identifier of the bot alias.
- botAliasLocaleSettings
-
- Type: Associative array of custom strings keys (LocaleId) to BotAliasLocaleSettings structures
The locale settings that are unique to the alias.
- botAliasName
-
- Type: string
The name of the bot alias.
- botAliasStatus
-
- Type: string
The current status of the alias. When the alias is
Available
, the alias is ready for use with your bot. - botId
-
- Type: string
The identifier of the bot associated with the bot alias.
- botVersion
-
- Type: string
The version of the bot associated with the bot alias.
- conversationLogSettings
-
- Type: ConversationLogSettings structure
Specifics of how Amazon Lex logs text and audio conversations with the bot associated with the alias.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp of the date and time that the alias was created.
- description
-
- Type: string
The description of the bot alias.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp of the date and time that the alias was last updated.
- parentBotNetworks
-
- Type: Array of ParentBotNetwork structures
A list of the networks to which the bot alias you described belongs.
- sentimentAnalysisSettings
-
- Type: SentimentAnalysisSettings structure
Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
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.
DescribeBotLocale
$result = $client->describeBotLocale
([/* ... */]); $promise = $client->describeBotLocaleAsync
([/* ... */]);
Describes the settings that a bot has for a specific locale.
Parameter Syntax
$result = $client->describeBotLocale([ 'botId' => '<string>', // REQUIRED 'botVersion' => '<string>', // REQUIRED 'localeId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The identifier of the bot associated with the locale.
- botVersion
-
- Required: Yes
- Type: string
The version of the bot associated with the locale.
- localeId
-
- Required: Yes
- Type: string
The unique identifier of the locale to describe. The string must match one of the supported locales. For more information, see Supported languages.
Result Syntax
[ 'botId' => '<string>', 'botLocaleHistoryEvents' => [ [ 'event' => '<string>', 'eventDate' => <DateTime>, ], // ... ], 'botLocaleStatus' => 'Creating|Building|Built|ReadyExpressTesting|Failed|Deleting|NotBuilt|Importing|Processing', 'botVersion' => '<string>', 'creationDateTime' => <DateTime>, 'description' => '<string>', 'failureReasons' => ['<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, ], ], ], 'intentsCount' => <integer>, 'lastBuildSubmittedDateTime' => <DateTime>, 'lastUpdatedDateTime' => <DateTime>, 'localeId' => '<string>', 'localeName' => '<string>', 'nluIntentConfidenceThreshold' => <float>, 'recommendedActions' => ['<string>', ...], 'slotTypesCount' => <integer>, 'voiceSettings' => [ 'engine' => 'standard|neural|long-form|generative', 'voiceId' => '<string>', ], ]
Result Details
Members
- botId
-
- Type: string
The identifier of the bot associated with the locale.
- botLocaleHistoryEvents
-
- Type: Array of BotLocaleHistoryEvent structures
History of changes, such as when a locale is used in an alias, that have taken place for the locale.
- botLocaleStatus
-
- Type: string
The status of the bot. If the status is
Failed
, the reasons for the failure are listed in thefailureReasons
field. - botVersion
-
- Type: string
The version of the bot associated with the locale.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the locale was created.
- description
-
- Type: string
The description of the locale.
- failureReasons
-
- Type: Array of strings
if
botLocaleStatus
isFailed
, Amazon Lex explains why it failed to build the bot. - generativeAISettings
-
- Type: GenerativeAISettings structure
Contains settings for Amazon Bedrock's generative AI features for your bot locale.
- intentsCount
-
- Type: int
The number of intents defined for the locale.
- lastBuildSubmittedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the locale was last submitted for building.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the locale was last updated.
- localeId
-
- Type: string
The unique identifier of the described locale.
- localeName
-
- Type: string
The name of the locale.
- nluIntentConfidenceThreshold
-
- Type: double
The confidence threshold where Amazon Lex inserts the
AMAZON.FallbackIntent
andAMAZON.KendraSearchIntent
intents in the list of possible intents for an utterance. - recommendedActions
-
- Type: Array of strings
Recommended actions to take to resolve an error in the
failureReasons
field. - slotTypesCount
-
- Type: int
The number of slot types defined for the locale.
- voiceSettings
-
- Type: VoiceSettings structure
The Amazon Polly voice 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.
- 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.
DescribeBotRecommendation
$result = $client->describeBotRecommendation
([/* ... */]); $promise = $client->describeBotRecommendationAsync
([/* ... */]);
Provides metadata information about a bot recommendation. This information will enable you to get a description on the request inputs, to download associated transcripts after processing is complete, and to download intents and slot-types generated by the bot recommendation.
Parameter Syntax
$result = $client->describeBotRecommendation([ 'botId' => '<string>', // REQUIRED 'botRecommendationId' => '<string>', // REQUIRED 'botVersion' => '<string>', // REQUIRED 'localeId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The unique identifier of the bot associated with the bot recommendation.
- botRecommendationId
-
- Required: Yes
- Type: string
The identifier of the bot recommendation to describe.
- botVersion
-
- Required: Yes
- Type: string
The version of the bot associated with the bot recommendation.
- localeId
-
- Required: Yes
- Type: string
The identifier of the language and locale of the bot recommendation to describe. The string must match one of the supported locales. For more information, see Supported languages.
Result Syntax
[ 'botId' => '<string>', 'botRecommendationId' => '<string>', 'botRecommendationResults' => [ 'associatedTranscriptsUrl' => '<string>', 'botLocaleExportUrl' => '<string>', 'statistics' => [ 'intents' => [ 'discoveredIntentCount' => <integer>, ], 'slotTypes' => [ 'discoveredSlotTypeCount' => <integer>, ], ], ], 'botRecommendationStatus' => 'Processing|Deleting|Deleted|Downloading|Updating|Available|Failed|Stopping|Stopped', 'botVersion' => '<string>', 'creationDateTime' => <DateTime>, 'encryptionSetting' => [ 'associatedTranscriptsPassword' => '<string>', 'botLocaleExportPassword' => '<string>', 'kmsKeyArn' => '<string>', ], 'failureReasons' => ['<string>', ...], 'lastUpdatedDateTime' => <DateTime>, 'localeId' => '<string>', 'transcriptSourceSetting' => [ 's3BucketTranscriptSource' => [ 'kmsKeyArn' => '<string>', 'pathFormat' => [ 'objectPrefixes' => ['<string>', ...], ], 's3BucketName' => '<string>', 'transcriptFilter' => [ 'lexTranscriptFilter' => [ 'dateRangeFilter' => [ 'endDateTime' => <DateTime>, 'startDateTime' => <DateTime>, ], ], ], 'transcriptFormat' => 'Lex', ], ], ]
Result Details
Members
- botId
-
- Type: string
The identifier of the bot associated with the bot recommendation.
- botRecommendationId
-
- Type: string
The identifier of the bot recommendation being described.
- botRecommendationResults
-
- Type: BotRecommendationResults structure
The object representing the URL of the bot definition, the URL of the associated transcript and a statistical summary of the bot recommendation results.
- botRecommendationStatus
-
- Type: string
The status of the bot recommendation. If the status is Failed, then the reasons for the failure are listed in the failureReasons field.
- botVersion
-
- Type: string
The version of the bot associated with the bot recommendation.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the bot recommendation was created.
- encryptionSetting
-
- Type: EncryptionSetting structure
The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.
- failureReasons
-
- Type: Array of strings
If botRecommendationStatus is Failed, Amazon Lex explains why.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the bot recommendation was last updated.
- localeId
-
- Type: string
The identifier of the language and locale of the bot recommendation to describe.
- transcriptSourceSetting
-
- Type: TranscriptSourceSetting structure
The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.
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.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
DescribeBotReplica
$result = $client->describeBotReplica
([/* ... */]); $promise = $client->describeBotReplicaAsync
([/* ... */]);
Monitors the bot replication status through the UI console.
Parameter Syntax
$result = $client->describeBotReplica([ 'botId' => '<string>', // REQUIRED 'replicaRegion' => '<string>', // REQUIRED ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The request for the unique bot ID of the replicated bot being monitored.
- replicaRegion
-
- Required: Yes
- Type: string
The request for the region of the replicated bot being monitored.
Result Syntax
[ 'botId' => '<string>', 'botReplicaStatus' => 'Enabling|Enabled|Deleting|Failed', 'creationDateTime' => <DateTime>, 'failureReasons' => ['<string>', ...], 'replicaRegion' => '<string>', 'sourceRegion' => '<string>', ]
Result Details
Members
- botId
-
- Type: string
The unique bot ID of the replicated bot being monitored.
- botReplicaStatus
-
- Type: string
The operational status of the replicated bot being monitored.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation date and time of the replicated bot being monitored.
- failureReasons
-
- Type: Array of strings
The failure reasons the bot being monitored failed to replicate.
- replicaRegion
-
- Type: string
The region of the replicated bot being monitored.
- sourceRegion
-
- Type: string
The source region of the replicated bot being monitored.
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.
DescribeBotResourceGeneration
$result = $client->describeBotResourceGeneration
([/* ... */]); $promise = $client->describeBotResourceGenerationAsync
([/* ... */]);
Returns information about a request to generate a bot through natural language description, made through the StartBotResource
API. Use the generatedBotLocaleUrl
to retrieve the Amazon S3 object containing the bot locale configuration. You can then modify and import this configuration.
Parameter Syntax
$result = $client->describeBotResourceGeneration([ 'botId' => '<string>', // REQUIRED 'botVersion' => '<string>', // REQUIRED 'generationId' => '<string>', // REQUIRED 'localeId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The unique identifier of the bot for which to return the generation details.
- botVersion
-
- Required: Yes
- Type: string
The version of the bot for which to return the generation details.
- generationId
-
- Required: Yes
- Type: string
The unique identifier of the generation request for which to return the generation details.
- localeId
-
- Required: Yes
- Type: string
The locale of the bot for which to return the generation details.
Result Syntax
[ 'botId' => '<string>', 'botVersion' => '<string>', 'creationDateTime' => <DateTime>, 'failureReasons' => ['<string>', ...], 'generatedBotLocaleUrl' => '<string>', 'generationId' => '<string>', 'generationInputPrompt' => '<string>', 'generationStatus' => 'Failed|Complete|InProgress', 'lastUpdatedDateTime' => <DateTime>, 'localeId' => '<string>', 'modelArn' => '<string>', ]
Result Details
Members
- botId
-
- Type: string
The unique identifier of the bot for which the generation request was made.
- botVersion
-
- Type: string
The version of the bot for which the generation request was made.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time at which the item was generated.
- failureReasons
-
- Type: Array of strings
A list of reasons why the generation of bot resources through natural language description failed.
- generatedBotLocaleUrl
-
- Type: string
The Amazon S3 location of the generated bot locale configuration.
- generationId
-
- Type: string
The generation ID for which to return the generation details.
- generationInputPrompt
-
- Type: string
The prompt used in the generation request.
- generationStatus
-
- Type: string
The status of the generation request.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time at which the generated item was updated.
- localeId
-
- Type: string
The locale of the bot for which the generation request was made.
- modelArn
-
- Type: string
The ARN of the model used to generate the bot resources.
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.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
DescribeBotVersion
$result = $client->describeBotVersion
([/* ... */]); $promise = $client->describeBotVersionAsync
([/* ... */]);
Provides metadata about a version of a bot.
Parameter Syntax
$result = $client->describeBotVersion([ 'botId' => '<string>', // REQUIRED 'botVersion' => '<string>', // REQUIRED ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The identifier of the bot containing the version to return metadata for.
- botVersion
-
- Required: Yes
- Type: string
The version of the bot to return metadata for.
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', 'botType' => 'Bot|BotNetwork', 'botVersion' => '<string>', 'creationDateTime' => <DateTime>, 'dataPrivacy' => [ 'childDirected' => true || false, ], 'description' => '<string>', 'failureReasons' => ['<string>', ...], 'idleSessionTTLInSeconds' => <integer>, 'parentBotNetworks' => [ [ 'botId' => '<string>', 'botVersion' => '<string>', ], // ... ], 'roleArn' => '<string>', ]
Result Details
Members
- botId
-
- Type: string
The identifier of the bot that contains the version.
- botMembers
-
- Type: Array of BotMember structures
The members of bot network in the version that was described.
- botName
-
- Type: string
The name of the bot that contains the version.
- botStatus
-
- Type: string
The current status of the bot. When the status is
Available
, the bot version is ready for use. - botType
-
- Type: string
The type of the bot in the version that was described.
- botVersion
-
- Type: string
The version of the bot that was described.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp of the date and time that the bot version was created.
- dataPrivacy
-
- Type: DataPrivacy structure
Data privacy settings for the bot version.
- description
-
- Type: string
The description specified for the bot.
- failureReasons
-
- Type: Array of strings
If the
botStatus
isFailed
, this contains a list of reasons that the version couldn't be built. - idleSessionTTLInSeconds
-
- Type: int
The number of seconds that a session with the bot remains active before it is discarded by Amazon Lex.
- parentBotNetworks
-
- Type: Array of ParentBotNetwork structures
A list of the networks to which the bot version you described belongs.
- roleArn
-
- Type: string
The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot version.
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.
DescribeCustomVocabularyMetadata
$result = $client->describeCustomVocabularyMetadata
([/* ... */]); $promise = $client->describeCustomVocabularyMetadataAsync
([/* ... */]);
Provides metadata information about a custom vocabulary.
Parameter Syntax
$result = $client->describeCustomVocabularyMetadata([ '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 custom vocabulary.
- botVersion
-
- Required: Yes
- Type: string
The bot version of the bot to return metadata for.
- localeId
-
- Required: Yes
- Type: string
The locale to return the custom vocabulary information for. The locale must be
en_GB
.
Result Syntax
[ 'botId' => '<string>', 'botVersion' => '<string>', 'creationDateTime' => <DateTime>, 'customVocabularyStatus' => 'Ready|Deleting|Exporting|Importing|Creating', 'lastUpdatedDateTime' => <DateTime>, 'localeId' => '<string>', ]
Result Details
Members
- botId
-
- Type: string
The identifier of the bot that contains the custom vocabulary.
- botVersion
-
- Type: string
The version of the bot that contains the custom vocabulary to describe.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the custom vocabulary was created.
- customVocabularyStatus
-
- Type: string
The status of the custom vocabulary. If the status is
Ready
the custom vocabulary is ready to use. - lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the custom vocabulary was last updated.
- localeId
-
- Type: string
The locale that contains the custom vocabulary to describe.
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.
DescribeExport
$result = $client->describeExport
([/* ... */]); $promise = $client->describeExportAsync
([/* ... */]);
Gets information about a specific export.
Parameter Syntax
$result = $client->describeExport([ 'exportId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- exportId
-
- Required: Yes
- Type: string
The unique identifier of the export to describe.
Result Syntax
[ 'creationDateTime' => <DateTime>, 'downloadUrl' => '<string>', 'exportId' => '<string>', 'exportStatus' => 'InProgress|Completed|Failed|Deleting', 'failureReasons' => ['<string>', ...], 'fileFormat' => 'LexJson|TSV|CSV', 'lastUpdatedDateTime' => <DateTime>, '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 export was created.
- downloadUrl
-
- Type: string
A pre-signed S3 URL that points to the bot or bot locale archive. The URL is only available for 5 minutes after calling the
DescribeExport
operation. - exportId
-
- Type: string
The unique identifier of the described export.
- exportStatus
-
- Type: string
The status of the export. When the status is
Complete
the export archive file is available for download. - failureReasons
-
- Type: Array of strings
If the
exportStatus
is failed, contains one or more reasons why the export could not be completed. - fileFormat
-
- Type: string
The file format used in the files that describe the resource.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last date and time that the export was updated.
- resourceSpecification
-
- Type: ExportResourceSpecification structure
The bot, bot ID, and optional locale ID of the exported 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.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
DescribeImport
$result = $client->describeImport
([/* ... */]); $promise = $client->describeImportAsync
([/* ... */]);
Gets information about a specific import.
Parameter Syntax
$result = $client->describeImport([ 'importId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- importId
-
- Required: Yes
- Type: string
The unique identifier of the import to describe.
Result Syntax
[ 'creationDateTime' => <DateTime>, 'failureReasons' => ['<string>', ...], 'importId' => '<string>', 'importStatus' => 'InProgress|Completed|Failed|Deleting', 'importedResourceId' => '<string>', 'importedResourceName' => '<string>', 'lastUpdatedDateTime' => <DateTime>, 'mergeStrategy' => 'Overwrite|FailOnConflict|Append', 'resourceSpecification' => [ 'botImportSpecification' => [ 'botName' => '<string>', 'botTags' => ['<string>', ...], 'dataPrivacy' => [ 'childDirected' => true || false, ], 'idleSessionTTLInSeconds' => <integer>, 'roleArn' => '<string>', 'testBotAliasTags' => ['<string>', ...], ], 'botLocaleImportSpecification' => [ 'botId' => '<string>', 'botVersion' => '<string>', 'localeId' => '<string>', 'nluIntentConfidenceThreshold' => <float>, 'voiceSettings' => [ 'engine' => 'standard|neural|long-form|generative', 'voiceId' => '<string>', ], ], 'customVocabularyImportSpecification' => [ 'botId' => '<string>', 'botVersion' => '<string>', 'localeId' => '<string>', ], 'testSetImportResourceSpecification' => [ 'description' => '<string>', 'importInputLocation' => [ 's3BucketName' => '<string>', 's3Path' => '<string>', ], 'modality' => 'Text|Audio', 'roleArn' => '<string>', 'storageLocation' => [ 'kmsKeyArn' => '<string>', 's3BucketName' => '<string>', 's3Path' => '<string>', ], 'testSetName' => '<string>', 'testSetTags' => ['<string>', ...], ], ], ]
Result Details
Members
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the import was created.
- failureReasons
-
- Type: Array of strings
If the
importStatus
field isFailed
, this provides one or more reasons for the failure. - importId
-
- Type: string
The unique identifier of the described import.
- importStatus
-
- Type: string
The status of the import process. When the status is
Completed
the resource is imported and ready for use. - importedResourceId
-
- Type: string
The unique identifier that Amazon Lex assigned to the resource created by the import.
- importedResourceName
-
- Type: string
The name of the imported resource.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the import was last updated.
- mergeStrategy
-
- Type: string
The strategy used when there was a name conflict between the imported resource and an existing resource. When the merge strategy is
FailOnConflict
existing resources are not overwritten and the import fails. - resourceSpecification
-
- Type: ImportResourceSpecification structure
The specifications of the imported bot, bot locale, or custom vocabulary.
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.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
DescribeIntent
$result = $client->describeIntent
([/* ... */]); $promise = $client->describeIntentAsync
([/* ... */]);
Returns metadata about an intent.
Parameter Syntax
$result = $client->describeIntent([ 'botId' => '<string>', // REQUIRED 'botVersion' => '<string>', // REQUIRED 'intentId' => '<string>', // REQUIRED 'localeId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The identifier of the bot associated with the intent.
- botVersion
-
- Required: Yes
- Type: string
The version of the bot associated with the intent.
- intentId
-
- Required: Yes
- Type: string
The identifier of the intent to describe.
- localeId
-
- Required: Yes
- Type: string
The identifier of the language and locale of the intent to describe. The string must match one of the supported locales. For more information, see Supported languages.
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, ], 'lastUpdatedDateTime' => <DateTime>, '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>', ], // ... ], 'slotPriorities' => [ [ 'priority' => <integer>, 'slotId' => '<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 of the intent.
- dialogCodeHook
-
- Type: DialogCodeHookSettings structure
The Lambda function called during each turn of a conversation with the intent.
- fulfillmentCodeHook
-
- Type: FulfillmentCodeHookSettings structure
The Lambda function called when the intent is complete and ready for fulfillment.
- initialResponseSetting
-
- Type: InitialResponseSetting structure
Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.
- inputContexts
-
- Type: Array of InputContext structures
A list of contexts that must be active for the intent to be considered for sending to the user.
- intentClosingSetting
-
- Type: IntentClosingSetting structure
The response that Amazon Lex sends to when the intent is closed.
- intentConfirmationSetting
-
- Type: IntentConfirmationSetting structure
Prompts that Amazon Lex sends to the user to confirm completion of an intent.
- intentId
-
- Type: string
The unique identifier assigned to the intent when it was created.
- intentName
-
- Type: string
The name specified for the intent.
- kendraConfiguration
-
- Type: KendraConfiguration structure
Configuration information required to use the
AMAZON.KendraSearchIntent
intent. - lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp of the date and time that the intent was last updated.
- localeId
-
- Type: string
The language and locale specified for the intent.
- outputContexts
-
- Type: Array of OutputContext structures
A list of contexts that are activated when the intent is fulfilled.
- parentIntentSignature
-
- Type: string
The identifier of the built-in intent that this intent is derived from, if any.
- qnAIntentConfiguration
-
- Type: QnAIntentConfiguration structure
Details about the configuration of the built-in
Amazon.QnAIntent
. - sampleUtterances
-
- Type: Array of SampleUtterance structures
User utterances that trigger this intent.
- slotPriorities
-
- Type: Array of SlotPriority structures
The list that determines the priority that slots should be elicited from 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.
- 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.
DescribeResourcePolicy
$result = $client->describeResourcePolicy
([/* ... */]); $promise = $client->describeResourcePolicyAsync
([/* ... */]);
Gets the resource policy and policy revision for a bot or bot alias.
Parameter Syntax
$result = $client->describeResourcePolicy([ 'resourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- 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
[ 'policy' => '<string>', 'resourceArn' => '<string>', 'revisionId' => '<string>', ]
Result Details
Members
- policy
-
- Type: string
The JSON structure that contains the resource policy. For more information about the contents of a JSON policy document, see IAM JSON policy reference .
- 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.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
- ThrottlingException:
Your request rate is too high. Reduce the frequency of requests.
DescribeSlot
$result = $client->describeSlot
([/* ... */]); $promise = $client->describeSlotAsync
([/* ... */]);
Gets metadata information about a slot.
Parameter Syntax
$result = $client->describeSlot([ 'botId' => '<string>', // REQUIRED 'botVersion' => '<string>', // REQUIRED 'intentId' => '<string>', // REQUIRED 'localeId' => '<string>', // REQUIRED 'slotId' => '<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.
- 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 of the slot to describe. The string must match one of the supported locales. For more information, see Supported languages.
- slotId
-
- Required: Yes
- Type: string
The unique identifier for the slot.
Result Syntax
[ 'botId' => '<string>', 'botVersion' => '<string>', 'creationDateTime' => <DateTime>, 'description' => '<string>', 'intentId' => '<string>', 'lastUpdatedDateTime' => <DateTime>, '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 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)
A timestamp of the date and time that the slot was created.
- description
-
- Type: string
The description specified for the slot.
- intentId
-
- Type: string
The identifier of the intent associated with the slot.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp of the date and time that the slot was last updated.
- localeId
-
- Type: string
The language and locale specified for the slot.
- multipleValuesSetting
-
- Type: MultipleValuesSetting structure
Indicates whether the slot accepts multiple values in a single utterance.
If the
multipleValuesSetting
is not set, the default value isfalse
. - obfuscationSetting
-
- Type: ObfuscationSetting structure
Whether slot values are shown in Amazon CloudWatch logs. If the value is
None
, the actual value of the slot is shown in logs. - slotId
-
- Type: string
The unique identifier generated for the slot.
- slotName
-
- Type: string
The name specified for the slot.
- slotTypeId
-
- Type: string
The identifier of the slot type that determines the values entered into the slot.
- subSlotSetting
-
- Type: SubSlotSetting structure
Specifications for the constituent sub slots and the expression for the composite slot.
- valueElicitationSetting
-
- Type: SlotValueElicitationSetting structure
Prompts that Amazon Lex uses to elicit a value 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.
- 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.
DescribeSlotType
$result = $client->describeSlotType
([/* ... */]); $promise = $client->describeSlotTypeAsync
([/* ... */]);
Gets metadata information about a slot type.
Parameter Syntax
$result = $client->describeSlotType([ 'botId' => '<string>', // REQUIRED 'botVersion' => '<string>', // REQUIRED 'localeId' => '<string>', // REQUIRED 'slotTypeId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The identifier of the bot associated with the slot type.
- botVersion
-
- Required: Yes
- Type: string
The version of the bot associated with the slot type.
- localeId
-
- Required: Yes
- Type: string
The identifier of the language and locale of the slot type to describe. The string must match one of the supported locales. For more information, see Supported languages.
- slotTypeId
-
- Required: Yes
- Type: string
The identifier of the slot type.
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>', ], ], ], 'lastUpdatedDateTime' => <DateTime>, '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 of 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
Provides information about the external source of the slot type's definition.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp of the date and time that the slot type was last updated.
- localeId
-
- Type: string
The language and locale specified for the slot type.
- parentSlotTypeSignature
-
- Type: string
The built in slot type used as a parent to this slot type.
- slotTypeId
-
- Type: string
The unique identifier for the slot type.
- slotTypeName
-
- Type: string
The name specified for the slot type.
- slotTypeValues
-
- Type: Array of SlotTypeValue structures
The values that the slot type can take. Includes any synonyms for the slot type values.
- valueSelectionSetting
-
- Type: SlotValueSelectionSetting structure
The strategy that Amazon Lex uses to choose a value from a 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.
- 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.
DescribeTestExecution
$result = $client->describeTestExecution
([/* ... */]); $promise = $client->describeTestExecutionAsync
([/* ... */]);
Gets metadata information about the test execution.
Parameter Syntax
$result = $client->describeTestExecution([ 'testExecutionId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- testExecutionId
-
- Required: Yes
- Type: string
The execution Id of the test set execution.
Result Syntax
[ 'apiMode' => 'Streaming|NonStreaming', 'creationDateTime' => <DateTime>, 'failureReasons' => ['<string>', ...], 'lastUpdatedDateTime' => <DateTime>, 'target' => [ 'botAliasTarget' => [ 'botAliasId' => '<string>', 'botId' => '<string>', 'localeId' => '<string>', ], ], 'testExecutionId' => '<string>', 'testExecutionModality' => 'Text|Audio', 'testExecutionStatus' => 'Pending|Waiting|InProgress|Completed|Failed|Stopping|Stopped', 'testSetId' => '<string>', 'testSetName' => '<string>', ]
Result Details
Members
- apiMode
-
- Type: string
Indicates whether we use streaming or non-streaming APIs are used for the test set execution. For streaming,
StartConversation
Amazon Lex Runtime API is used. Whereas for non-streaming,RecognizeUtterance
andRecognizeText
Amazon Lex Runtime API is used. - creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The execution creation date and time for the test set execution.
- failureReasons
-
- Type: Array of strings
Reasons for the failure of the test set execution.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time of the last update for the execution.
- target
-
- Type: TestExecutionTarget structure
The target bot for the test set execution details.
- testExecutionId
-
- Type: string
The execution Id for the test set execution.
- testExecutionModality
-
- Type: string
Indicates whether test set is audio or text.
- testExecutionStatus
-
- Type: string
The test execution status for the test execution.
- testSetId
-
- Type: string
The test set Id for the test set execution.
- testSetName
-
- Type: string
The test set name of the test set execution.
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.
DescribeTestSet
$result = $client->describeTestSet
([/* ... */]); $promise = $client->describeTestSetAsync
([/* ... */]);
Gets metadata information about the test set.
Parameter Syntax
$result = $client->describeTestSet([ 'testSetId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- testSetId
-
- Required: Yes
- Type: string
The test set Id for the test set request.
Result Syntax
[ 'creationDateTime' => <DateTime>, 'description' => '<string>', 'lastUpdatedDateTime' => <DateTime>, 'modality' => 'Text|Audio', 'numTurns' => <integer>, 'roleArn' => '<string>', 'status' => 'Importing|PendingAnnotation|Deleting|ValidationError|Ready', 'storageLocation' => [ 'kmsKeyArn' => '<string>', 's3BucketName' => '<string>', 's3Path' => '<string>', ], 'testSetId' => '<string>', 'testSetName' => '<string>', ]
Result Details
Members
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation date and time for the test set data.
- description
-
- Type: string
The description of the test set.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time for the last update of the test set data.
- modality
-
- Type: string
Indicates whether the test set is audio or text data.
- numTurns
-
- Type: int
The total number of agent and user turn in the test set.
- roleArn
-
- Type: string
The roleARN used for any operation in the test set to access resources in the Amazon Web Services account.
- status
-
- Type: string
The status of the test set.
- storageLocation
-
- Type: TestSetStorageLocation structure
The Amazon S3 storage location for the test set data.
- testSetId
-
- Type: string
The test set Id for the test set response.
- testSetName
-
- Type: string
The test set name of the test set.
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.
DescribeTestSetDiscrepancyReport
$result = $client->describeTestSetDiscrepancyReport
([/* ... */]); $promise = $client->describeTestSetDiscrepancyReportAsync
([/* ... */]);
Gets metadata information about the test set discrepancy report.
Parameter Syntax
$result = $client->describeTestSetDiscrepancyReport([ 'testSetDiscrepancyReportId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- testSetDiscrepancyReportId
-
- Required: Yes
- Type: string
The unique identifier of the test set discrepancy report.
Result Syntax
[ 'creationDateTime' => <DateTime>, 'failureReasons' => ['<string>', ...], 'lastUpdatedDataTime' => <DateTime>, 'target' => [ 'botAliasTarget' => [ 'botAliasId' => '<string>', 'botId' => '<string>', 'localeId' => '<string>', ], ], 'testSetDiscrepancyRawOutputUrl' => '<string>', 'testSetDiscrepancyReportId' => '<string>', 'testSetDiscrepancyReportStatus' => 'InProgress|Completed|Failed', 'testSetDiscrepancyTopErrors' => [ 'intentDiscrepancies' => [ [ 'errorMessage' => '<string>', 'intentName' => '<string>', ], // ... ], 'slotDiscrepancies' => [ [ 'errorMessage' => '<string>', 'intentName' => '<string>', 'slotName' => '<string>', ], // ... ], ], 'testSetId' => '<string>', ]
Result Details
Members
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time and date of creation for the test set discrepancy report.
- failureReasons
-
- Type: Array of strings
The failure report for the test set discrepancy report generation action.
- lastUpdatedDataTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time of the last update for the test set discrepancy report.
- target
-
- Type: TestSetDiscrepancyReportResourceTarget structure
The target bot location for the test set discrepancy report.
- testSetDiscrepancyRawOutputUrl
-
- Type: string
Pre-signed Amazon S3 URL to download the test set discrepancy report.
- testSetDiscrepancyReportId
-
- Type: string
The unique identifier of the test set discrepancy report to describe.
- testSetDiscrepancyReportStatus
-
- Type: string
The status for the test set discrepancy report.
- testSetDiscrepancyTopErrors
-
- Type: TestSetDiscrepancyErrors structure
The top 200 error results from the test set discrepancy report.
- 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.
- 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.
DescribeTestSetGeneration
$result = $client->describeTestSetGeneration
([/* ... */]); $promise = $client->describeTestSetGenerationAsync
([/* ... */]);
Gets metadata information about the test set generation.
Parameter Syntax
$result = $client->describeTestSetGeneration([ 'testSetGenerationId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- testSetGenerationId
-
- Required: Yes
- Type: string
The unique identifier of the test set generation.
Result Syntax
[ 'creationDateTime' => <DateTime>, 'description' => '<string>', 'failureReasons' => ['<string>', ...], 'generationDataSource' => [ 'conversationLogsDataSource' => [ 'botAliasId' => '<string>', 'botId' => '<string>', 'filter' => [ 'endTime' => <DateTime>, 'inputMode' => 'Speech|Text', 'startTime' => <DateTime>, ], 'localeId' => '<string>', ], ], 'lastUpdatedDateTime' => <DateTime>, 'roleArn' => '<string>', 'storageLocation' => [ 'kmsKeyArn' => '<string>', 's3BucketName' => '<string>', 's3Path' => '<string>', ], 'testSetGenerationId' => '<string>', 'testSetGenerationStatus' => 'Generating|Ready|Failed|Pending', 'testSetId' => '<string>', 'testSetName' => '<string>', ]
Result Details
Members
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation date and time for the test set generation.
- description
-
- Type: string
The test set description for the test set generation.
- failureReasons
-
- Type: Array of strings
The reasons the test set generation failed.
- generationDataSource
-
- Type: TestSetGenerationDataSource structure
The data source of the test set used for the test set generation.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time of the last update for the test set generation.
- roleArn
-
- Type: string
The roleARN of the test set used for the test set generation.
- storageLocation
-
- Type: TestSetStorageLocation structure
The Amazon S3 storage location for the test set generation.
- testSetGenerationId
-
- Type: string
The unique identifier of the test set generation.
- testSetGenerationStatus
-
- Type: string
The status for the test set generation.
- testSetId
-
- Type: string
The unique identifier for the test set created for the generated test set.
- testSetName
-
- Type: string
The test set name for the generated test set.
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.
GenerateBotElement
$result = $client->generateBotElement
([/* ... */]); $promise = $client->generateBotElementAsync
([/* ... */]);
Generates sample utterances for an intent.
Parameter Syntax
$result = $client->generateBotElement([ 'botId' => '<string>', // REQUIRED 'botVersion' => '<string>', // REQUIRED 'intentId' => '<string>', // REQUIRED 'localeId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The bot unique Id for the bot request to generate utterances.
- botVersion
-
- Required: Yes
- Type: string
The bot version for the bot request to generate utterances.
- intentId
-
- Required: Yes
- Type: string
The intent unique Id for the bot request to generate utterances.
- localeId
-
- Required: Yes
- Type: string
The unique locale Id for the bot request to generate utterances.
Result Syntax
[ 'botId' => '<string>', 'botVersion' => '<string>', 'intentId' => '<string>', 'localeId' => '<string>', 'sampleUtterances' => [ [ 'utterance' => '<string>', ], // ... ], ]
Result Details
Members
- botId
-
- Type: string
The unique bot Id for the bot which received the response.
- botVersion
-
- Type: string
The unique bot version for the bot which received the response.
- intentId
-
- Type: string
The unique intent Id for the bot which received the response.
- localeId
-
- Type: string
The unique locale Id for the bot which received the response.
- sampleUtterances
-
- Type: Array of SampleUtterance structures
The sample utterances for the bot which received the response.
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.
- 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.
GetTestExecutionArtifactsUrl
$result = $client->getTestExecutionArtifactsUrl
([/* ... */]); $promise = $client->getTestExecutionArtifactsUrlAsync
([/* ... */]);
The pre-signed Amazon S3 URL to download the test execution result artifacts.
Parameter Syntax
$result = $client->getTestExecutionArtifactsUrl([ 'testExecutionId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- testExecutionId
-
- Required: Yes
- Type: string
The unique identifier of the completed test execution.
Result Syntax
[ 'downloadArtifactsUrl' => '<string>', 'testExecutionId' => '<string>', ]
Result Details
Members
- downloadArtifactsUrl
-
- Type: string
The pre-signed Amazon S3 URL to download completed test execution.
- testExecutionId
-
- Type: string
The unique identifier of the completed test execution.
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.
ListAggregatedUtterances
$result = $client->listAggregatedUtterances
([/* ... */]); $promise = $client->listAggregatedUtterancesAsync
([/* ... */]);
Provides a list of utterances that users have sent to the bot.
Utterances are aggregated by the text of the utterance. For example, all instances where customers used the phrase "I want to order pizza" are aggregated into the same line in the response.
You can see both detected utterances and missed utterances. A detected utterance is where the bot properly recognized the utterance and activated the associated intent. A missed utterance was not recognized by the bot and didn't activate an intent.
Utterances can be aggregated for a bot alias or for a bot version, but not both at the same time.
Utterances statistics are not generated under the following conditions:
-
The
childDirected
field was set to true when the bot was created. -
You are using slot obfuscation with one or more slots.
-
You opted out of participating in improving Amazon Lex.
Parameter Syntax
$result = $client->listAggregatedUtterances([ 'aggregationDuration' => [ // REQUIRED 'relativeAggregationDuration' => [ // REQUIRED 'timeDimension' => 'Hours|Days|Weeks', // REQUIRED 'timeValue' => <integer>, // REQUIRED ], ], 'botAliasId' => '<string>', 'botId' => '<string>', // REQUIRED 'botVersion' => '<string>', 'filters' => [ [ 'name' => 'Utterance', // REQUIRED 'operator' => 'CO|EQ', // REQUIRED 'values' => ['<string>', ...], // REQUIRED ], // ... ], 'localeId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', 'sortBy' => [ 'attribute' => 'HitCount|MissedCount', // REQUIRED 'order' => 'Ascending|Descending', // REQUIRED ], ]);
Parameter Details
Members
- aggregationDuration
-
- Required: Yes
- Type: UtteranceAggregationDuration structure
The time window for aggregating the utterance information. You can specify a time between one hour and two weeks.
- botAliasId
-
- Type: string
The identifier of the bot alias associated with this request. If you specify the bot alias, you can't specify the bot version.
- botId
-
- Required: Yes
- Type: string
The unique identifier of the bot associated with this request.
- botVersion
-
- Type: string
The identifier of the bot version associated with this request. If you specify the bot version, you can't specify the bot alias.
- filters
-
- Type: Array of AggregatedUtterancesFilter structures
Provides the specification of a filter used to limit the utterances in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.
- localeId
-
- Required: Yes
- Type: string
The identifier of the language and locale where the utterances were collected. For more information, see Supported languages.
- maxResults
-
- Type: int
The maximum number of utterances to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned. If you don't specify the
maxResults
parameter, 1,000 results are returned. - nextToken
-
- Type: string
If the response from the
ListAggregatedUtterances
operation contains more results that specified in themaxResults
parameter, a token is returned in the response. Use that token in thenextToken
parameter to return the next page of results. - sortBy
-
- Type: AggregatedUtterancesSortBy structure
Specifies sorting parameters for the list of utterances. You can sort by the hit count, the missed count, or the number of distinct sessions the utterance appeared in.
Result Syntax
[ 'aggregatedUtterancesSummaries' => [ [ 'containsDataFromDeletedResources' => true || false, 'hitCount' => <integer>, 'missedCount' => <integer>, 'utterance' => '<string>', 'utteranceFirstRecordedInAggregationDuration' => <DateTime>, 'utteranceLastRecordedInAggregationDuration' => <DateTime>, ], // ... ], 'aggregationDuration' => [ 'relativeAggregationDuration' => [ 'timeDimension' => 'Hours|Days|Weeks', 'timeValue' => <integer>, ], ], 'aggregationLastRefreshedDateTime' => <DateTime>, 'aggregationWindowEndTime' => <DateTime>, 'aggregationWindowStartTime' => <DateTime>, 'botAliasId' => '<string>', 'botId' => '<string>', 'botVersion' => '<string>', 'localeId' => '<string>', 'nextToken' => '<string>', ]
Result Details
Members
- aggregatedUtterancesSummaries
-
- Type: Array of AggregatedUtterancesSummary structures
Summaries of the aggregated utterance data. Each response contains information about the number of times that the utterance was seen during the time period, whether it was detected or missed, and when it was seen during the time period.
- aggregationDuration
-
- Type: UtteranceAggregationDuration structure
The time period used to aggregate the utterance data.
- aggregationLastRefreshedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last date and time that the aggregated data was collected. The time period depends on the length of the aggregation window.
-
Hours - for 1 hour time window, every half hour; otherwise every hour.
-
Days - every 6 hours
-
Weeks - for a one week time window, every 12 hours; otherwise, every day
- aggregationWindowEndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the aggregation window ends. Only data collected between the start time and the end time are returned in the results.
- aggregationWindowStartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the aggregation window begins. Only data collected after this time is returned in the results.
- botAliasId
-
- Type: string
The identifier of the bot alias that contains the utterances. If you specified the bot version, the bot alias ID isn't returned.
- botId
-
- Type: string
The identifier of the bot that contains the utterances.
- botVersion
-
- Type: string
The identifier of the bot version that contains the utterances. If you specified the bot alias, the bot version isn't returned.
- localeId
-
- Type: string
The identifier of the language and locale that the utterances are in.
- nextToken
-
- Type: string
A token that indicates whether there are more results to return in a response to the
ListAggregatedUtterances
operation. If thenextToken
field is present, you send the contents as thenextToken
parameter of aListAggregatedUtterances
operation request to get the next page of results.
Errors
- 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.
- ThrottlingException:
Your request rate is too high. Reduce the frequency of requests.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
ListBotAliasReplicas
$result = $client->listBotAliasReplicas
([/* ... */]); $promise = $client->listBotAliasReplicasAsync
([/* ... */]);
The action to list the replicated bots created from the source bot alias.
Parameter Syntax
$result = $client->listBotAliasReplicas([ 'botId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', 'replicaRegion' => '<string>', // REQUIRED ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The request for the unique bot ID of the replicated bot created from the source bot alias.
- maxResults
-
- Type: int
The request for maximum results to list the replicated bots created from the source bot alias.
- nextToken
-
- Type: string
The request for the next token for the replicated bot created from the source bot alias.
- replicaRegion
-
- Required: Yes
- Type: string
The request for the secondary region of the replicated bot created from the source bot alias.
Result Syntax
[ 'botAliasReplicaSummaries' => [ [ 'botAliasId' => '<string>', 'botAliasReplicationStatus' => 'Creating|Updating|Available|Deleting|Failed', 'botVersion' => '<string>', 'creationDateTime' => <DateTime>, 'failureReasons' => ['<string>', ...], 'lastUpdatedDateTime' => <DateTime>, ], // ... ], 'botId' => '<string>', 'nextToken' => '<string>', 'replicaRegion' => '<string>', 'sourceRegion' => '<string>', ]
Result Details
Members
- botAliasReplicaSummaries
-
- Type: Array of BotAliasReplicaSummary structures
The summary information of the replicated bot created from the source bot alias.
- botId
-
- Type: string
The unique bot ID of the replicated bot created from the source bot alias.
- nextToken
-
- Type: string
The next token for the replicated bots created from the source bot alias.
- replicaRegion
-
- Type: string
The secondary region of the replicated bot created from the source bot alias.
- sourceRegion
-
- Type: string
The source region of the replicated bot created from the source 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.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
ListBotAliases
$result = $client->listBotAliases
([/* ... */]); $promise = $client->listBotAliasesAsync
([/* ... */]);
Gets a list of aliases for the specified bot.
Parameter Syntax
$result = $client->listBotAliases([ 'botId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The identifier of the bot to list aliases for.
- maxResults
-
- Type: int
The maximum number of aliases to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
- nextToken
-
- Type: string
If the response from the
ListBotAliases
operation contains more results than specified in themaxResults
parameter, a token is returned in the response. Use that token in thenextToken
parameter to return the next page of results.
Result Syntax
[ 'botAliasSummaries' => [ [ 'botAliasId' => '<string>', 'botAliasName' => '<string>', 'botAliasStatus' => 'Creating|Available|Deleting|Failed', 'botVersion' => '<string>', 'creationDateTime' => <DateTime>, 'description' => '<string>', 'lastUpdatedDateTime' => <DateTime>, ], // ... ], 'botId' => '<string>', 'nextToken' => '<string>', ]
Result Details
Members
- botAliasSummaries
-
- Type: Array of BotAliasSummary structures
Summary information for the bot aliases that meet the filter criteria specified in the request. The length of the list is specified in the
maxResults
parameter of the request. If there are more aliases available, thenextToken
field contains a token to get the next page of results. - botId
-
- Type: string
The identifier of the bot associated with the aliases.
- nextToken
-
- Type: string
A token that indicates whether there are more results to return in a response to the
ListBotAliases
operation. If thenextToken
field is present, you send the contents as thenextToken
parameter of aListBotAliases
operation request to get the next page of results.
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.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
ListBotLocales
$result = $client->listBotLocales
([/* ... */]); $promise = $client->listBotLocalesAsync
([/* ... */]);
Gets a list of locales for the specified bot.
Parameter Syntax
$result = $client->listBotLocales([ 'botId' => '<string>', // REQUIRED 'botVersion' => '<string>', // REQUIRED 'filters' => [ [ 'name' => 'BotLocaleName', // REQUIRED 'operator' => 'CO|EQ', // REQUIRED 'values' => ['<string>', ...], // REQUIRED ], // ... ], 'maxResults' => <integer>, 'nextToken' => '<string>', 'sortBy' => [ 'attribute' => 'BotLocaleName', // REQUIRED 'order' => 'Ascending|Descending', // REQUIRED ], ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The identifier of the bot to list locales for.
- botVersion
-
- Required: Yes
- Type: string
The version of the bot to list locales for.
- filters
-
- Type: Array of BotLocaleFilter structures
Provides the specification for a filter used to limit the response to only those locales that match the filter specification. You can only specify one filter and one value to filter on.
- maxResults
-
- Type: int
The maximum number of aliases to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
- nextToken
-
- Type: string
If the response from the
ListBotLocales
operation contains more results than specified in themaxResults
parameter, a token is returned in the response. Use that token as thenextToken
parameter to return the next page of results. - sortBy
-
- Type: BotLocaleSortBy structure
Specifies sorting parameters for the list of locales. You can sort by locale name in ascending or descending order.
Result Syntax
[ 'botId' => '<string>', 'botLocaleSummaries' => [ [ 'botLocaleStatus' => 'Creating|Building|Built|ReadyExpressTesting|Failed|Deleting|NotBuilt|Importing|Processing', 'description' => '<string>', 'lastBuildSubmittedDateTime' => <DateTime>, 'lastUpdatedDateTime' => <DateTime>, 'localeId' => '<string>', 'localeName' => '<string>', ], // ... ], 'botVersion' => '<string>', 'nextToken' => '<string>', ]
Result Details
Members
- botId
-
- Type: string
The identifier of the bot to list locales for.
- botLocaleSummaries
-
- Type: Array of BotLocaleSummary structures
Summary information for the locales that meet the filter criteria specified in the request. The length of the list is specified in the
maxResults
parameter of the request. If there are more locales available, thenextToken
field contains a token to get the next page of results. - botVersion
-
- Type: string
The version of the bot.
- nextToken
-
- Type: string
A token that indicates whether there are more results to return in a response to the
ListBotLocales
operation. If thenextToken
field is present, you send the contents as thenextToken
parameter of aListBotLocales
operation request to get the next page of results.
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.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
ListBotRecommendations
$result = $client->listBotRecommendations
([/* ... */]); $promise = $client->listBotRecommendationsAsync
([/* ... */]);
Get a list of bot recommendations that meet the specified criteria.
Parameter Syntax
$result = $client->listBotRecommendations([ 'botId' => '<string>', // REQUIRED 'botVersion' => '<string>', // REQUIRED 'localeId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The unique identifier of the bot that contains the bot recommendation list.
- botVersion
-
- Required: Yes
- Type: string
The version of the bot that contains the bot recommendation list.
- localeId
-
- Required: Yes
- Type: string
The identifier of the language and locale of the bot recommendation list.
- maxResults
-
- Type: int
The maximum number of bot recommendations to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
- nextToken
-
- Type: string
If the response from the ListBotRecommendation operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
Result Syntax
[ 'botId' => '<string>', 'botRecommendationSummaries' => [ [ 'botRecommendationId' => '<string>', 'botRecommendationStatus' => 'Processing|Deleting|Deleted|Downloading|Updating|Available|Failed|Stopping|Stopped', 'creationDateTime' => <DateTime>, 'lastUpdatedDateTime' => <DateTime>, ], // ... ], 'botVersion' => '<string>', 'localeId' => '<string>', 'nextToken' => '<string>', ]
Result Details
Members
- botId
-
- Type: string
The unique identifier of the bot that contains the bot recommendation list.
- botRecommendationSummaries
-
- Type: Array of BotRecommendationSummary structures
Summary information for the bot recommendations that meet the filter specified in this request. The length of the list is specified in the maxResults parameter of the request. If there are more bot recommendations available, the nextToken field contains a token to get the next page of results.
- botVersion
-
- Type: string
The version of the bot that contains the bot recommendation list.
- localeId
-
- Type: string
The identifier of the language and locale of the bot recommendation list.
- nextToken
-
- Type: string
A token that indicates whether there are more results to return in a response to the ListBotRecommendations operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotRecommendations operation request to get the next page of results.
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.
- 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.
ListBotReplicas
$result = $client->listBotReplicas
([/* ... */]); $promise = $client->listBotReplicasAsync
([/* ... */]);
The action to list the replicated bots.
Parameter Syntax
$result = $client->listBotReplicas([ 'botId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The request for the unique bot IDs in the list of replicated bots.
Result Syntax
[ 'botId' => '<string>', 'botReplicaSummaries' => [ [ 'botReplicaStatus' => 'Enabling|Enabled|Deleting|Failed', 'creationDateTime' => <DateTime>, 'failureReasons' => ['<string>', ...], 'replicaRegion' => '<string>', ], // ... ], 'sourceRegion' => '<string>', ]
Result Details
Members
- botId
-
- Type: string
the unique bot IDs in the list of replicated bots.
- botReplicaSummaries
-
- Type: Array of BotReplicaSummary structures
The summary details for the replicated bots.
- sourceRegion
-
- Type: string
The source region of the source bots in the list of replicated bots.
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.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
ListBotResourceGenerations
$result = $client->listBotResourceGenerations
([/* ... */]); $promise = $client->listBotResourceGenerationsAsync
([/* ... */]);
Lists the generation requests made for a bot locale.
Parameter Syntax
$result = $client->listBotResourceGenerations([ 'botId' => '<string>', // REQUIRED 'botVersion' => '<string>', // REQUIRED 'localeId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', 'sortBy' => [ 'attribute' => 'creationStartTime|lastUpdatedTime', // REQUIRED 'order' => 'Ascending|Descending', // REQUIRED ], ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The unique identifier of the bot whose generation requests you want to view.
- botVersion
-
- Required: Yes
- Type: string
The version of the bot whose generation requests you want to view.
- localeId
-
- Required: Yes
- Type: string
The locale of the bot whose generation requests you want to view.
- maxResults
-
- Type: int
The maximum number of results to return in the response.
- nextToken
-
- Type: string
If the total number of results is greater than the number specified in the
maxResults
, the response returns a token in thenextToken
field. Use this token when making a request to return the next batch of results. - sortBy
-
- Type: GenerationSortBy structure
An object containing information about the attribute and the method by which to sort the results
Result Syntax
[ 'botId' => '<string>', 'botVersion' => '<string>', 'generationSummaries' => [ [ 'creationDateTime' => <DateTime>, 'generationId' => '<string>', 'generationStatus' => 'Failed|Complete|InProgress', 'lastUpdatedDateTime' => <DateTime>, ], // ... ], 'localeId' => '<string>', 'nextToken' => '<string>', ]
Result Details
Members
- botId
-
- Type: string
The unique identifier of the bot for which the generation requests were made.
- botVersion
-
- Type: string
The version of the bot for which the generation requests were made.
- generationSummaries
-
- Type: Array of GenerationSummary structures
A list of objects, each containing information about a generation request for the bot locale.
- localeId
-
- Type: string
The locale of the bot for which the generation requests were made.
- nextToken
-
- Type: string
If the total number of results is greater than the number specified in the
maxResults
, the response returns a token in thenextToken
field. Use this token when making a request to return the next batch of results.
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.
- 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.
ListBotVersionReplicas
$result = $client->listBotVersionReplicas
([/* ... */]); $promise = $client->listBotVersionReplicasAsync
([/* ... */]);
Contains information about all the versions replication statuses applicable for Global Resiliency.
Parameter Syntax
$result = $client->listBotVersionReplicas([ 'botId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', 'replicaRegion' => '<string>', // REQUIRED 'sortBy' => [ 'attribute' => 'BotVersion', // REQUIRED 'order' => 'Ascending|Descending', // REQUIRED ], ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The request for the unique ID in the list of replicated bots.
- maxResults
-
- Type: int
The maximum results given in the list of replicated bots.
- nextToken
-
- Type: string
The next token given in the list of replicated bots.
- replicaRegion
-
- Required: Yes
- Type: string
The request for the region used in the list of replicated bots.
- sortBy
-
- Type: BotVersionReplicaSortBy structure
The requested sort category for the list of replicated bots.
Result Syntax
[ 'botId' => '<string>', 'botVersionReplicaSummaries' => [ [ 'botVersion' => '<string>', 'botVersionReplicationStatus' => 'Creating|Available|Deleting|Failed', 'creationDateTime' => <DateTime>, 'failureReasons' => ['<string>', ...], ], // ... ], 'nextToken' => '<string>', 'replicaRegion' => '<string>', 'sourceRegion' => '<string>', ]
Result Details
Members
- botId
-
- Type: string
The unique ID of the bots in the list of replicated bots.
- botVersionReplicaSummaries
-
- Type: Array of BotVersionReplicaSummary structures
The information summary used for the replicated bots in the list of replicated bots.
- nextToken
-
- Type: string
The next token used for the replicated bots in the list of replicated bots.
- replicaRegion
-
- Type: string
The region used for the replicated bots in the list of replicated bots.
- sourceRegion
-
- Type: string
The source region used for the bots in the list of replicated bots.
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.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
ListBotVersions
$result = $client->listBotVersions
([/* ... */]); $promise = $client->listBotVersionsAsync
([/* ... */]);
Gets information about all of the versions of a bot.
The ListBotVersions
operation returns a summary of each version of a bot. For example, if a bot has three numbered versions, the ListBotVersions
operation returns for summaries, one for each numbered version and one for the DRAFT
version.
The ListBotVersions
operation always returns at least one version, the DRAFT
version.
Parameter Syntax
$result = $client->listBotVersions([ 'botId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', 'sortBy' => [ 'attribute' => 'BotVersion', // REQUIRED 'order' => 'Ascending|Descending', // REQUIRED ], ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The identifier of the bot to list versions for.
- maxResults
-
- Type: int
The maximum number of versions to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
- nextToken
-
- Type: string
If the response to the
ListBotVersion
operation contains more results than specified in themaxResults
parameter, a token is returned in the response. Use that token in thenextToken
parameter to return the next page of results. - sortBy
-
- Type: BotVersionSortBy structure
Specifies sorting parameters for the list of versions. You can specify that the list be sorted by version name in either ascending or descending order.
Result Syntax
[ 'botId' => '<string>', 'botVersionSummaries' => [ [ 'botName' => '<string>', 'botStatus' => 'Creating|Available|Inactive|Deleting|Failed|Versioning|Importing|Updating', 'botVersion' => '<string>', 'creationDateTime' => <DateTime>, 'description' => '<string>', ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- botId
-
- Type: string
The identifier of the bot to list versions for.
- botVersionSummaries
-
- Type: Array of BotVersionSummary structures
Summary information for the bot versions that meet the filter criteria specified in the request. The length of the list is specified in the
maxResults
parameter of the request. If there are more versions available, thenextToken
field contains a token to get the next page of results. - nextToken
-
- Type: string
A token that indicates whether there are more results to return in a response to the
ListBotVersions
operation. If thenextToken
field is present, you send the contents as thenextToken
parameter of aListBotAliases
operation request to get the next page of results.
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.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
ListBots
$result = $client->listBots
([/* ... */]); $promise = $client->listBotsAsync
([/* ... */]);
Gets a list of available bots.
Parameter Syntax
$result = $client->listBots([ 'filters' => [ [ 'name' => 'BotName|BotType', // REQUIRED 'operator' => 'CO|EQ|NE', // REQUIRED 'values' => ['<string>', ...], // REQUIRED ], // ... ], 'maxResults' => <integer>, 'nextToken' => '<string>', 'sortBy' => [ 'attribute' => 'BotName', // REQUIRED 'order' => 'Ascending|Descending', // REQUIRED ], ]);
Parameter Details
Members
- filters
-
- Type: Array of BotFilter structures
Provides the specification of a filter used to limit the bots in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.
- maxResults
-
- Type: int
The maximum number of bots to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
- nextToken
-
- Type: string
If the response from the
ListBots
operation contains more results than specified in themaxResults
parameter, a token is returned in the response.Use the returned token in the
nextToken
parameter of aListBots
request to return the next page of results. For a complete set of results, call theListBots
operation until thenextToken
returned in the response is null. - sortBy
-
- Type: BotSortBy structure
Specifies sorting parameters for the list of bots. You can specify that the list be sorted by bot name in ascending or descending order.
Result Syntax
[ 'botSummaries' => [ [ 'botId' => '<string>', 'botName' => '<string>', 'botStatus' => 'Creating|Available|Inactive|Deleting|Failed|Versioning|Importing|Updating', 'botType' => 'Bot|BotNetwork', 'description' => '<string>', 'lastUpdatedDateTime' => <DateTime>, 'latestBotVersion' => '<string>', ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- botSummaries
-
- Type: Array of BotSummary structures
Summary information for the bots that meet the filter criteria specified in the request. The length of the list is specified in the
maxResults
parameter of the request. If there are more bots available, thenextToken
field contains a token to the next page of results. - nextToken
-
- Type: string
A token that indicates whether there are more results to return in a response to the
ListBots
operation. If thenextToken
field is present, you send the contents as thenextToken
parameter of aListBots
operation request to get the next page of results.
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.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
ListBuiltInIntents
$result = $client->listBuiltInIntents
([/* ... */]); $promise = $client->listBuiltInIntentsAsync
([/* ... */]);
Gets a list of built-in intents provided by Amazon Lex that you can use in your bot.
To use a built-in intent as a the base for your own intent, include the built-in intent signature in the parentIntentSignature
parameter when you call the CreateIntent
operation. For more information, see CreateIntent.
Parameter Syntax
$result = $client->listBuiltInIntents([ 'localeId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', 'sortBy' => [ 'attribute' => 'IntentSignature', // REQUIRED 'order' => 'Ascending|Descending', // REQUIRED ], ]);
Parameter Details
Members
- localeId
-
- Required: Yes
- Type: string
The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see Supported languages.
- maxResults
-
- Type: int
The maximum number of built-in intents to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
- nextToken
-
- Type: string
If the response from the
ListBuiltInIntents
operation contains more results than specified in themaxResults
parameter, a token is returned in the response. Use that token in thenextToken
parameter to return the next page of results. - sortBy
-
- Type: BuiltInIntentSortBy structure
Specifies sorting parameters for the list of built-in intents. You can specify that the list be sorted by the built-in intent signature in either ascending or descending order.
Result Syntax
[ 'builtInIntentSummaries' => [ [ 'description' => '<string>', 'intentSignature' => '<string>', ], // ... ], 'localeId' => '<string>', 'nextToken' => '<string>', ]
Result Details
Members
- builtInIntentSummaries
-
- Type: Array of BuiltInIntentSummary structures
Summary information for the built-in intents that meet the filter criteria specified in the request. The length of the list is specified in the
maxResults
parameter of the request. If there are more intents available, thenextToken
field contains a token to get the next page of results. - localeId
-
- Type: string
The language and locale of the intents in the list.
- nextToken
-
- Type: string
A token that indicates whether there are more results to return in a response to the
ListBuiltInIntents
operation. If thenextToken
field is present, you send the contents as thenextToken
parameter of aListBotAliases
operation request to get the next page of results.
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.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
ListBuiltInSlotTypes
$result = $client->listBuiltInSlotTypes
([/* ... */]); $promise = $client->listBuiltInSlotTypesAsync
([/* ... */]);
Gets a list of built-in slot types that meet the specified criteria.
Parameter Syntax
$result = $client->listBuiltInSlotTypes([ 'localeId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', 'sortBy' => [ 'attribute' => 'SlotTypeSignature', // REQUIRED 'order' => 'Ascending|Descending', // REQUIRED ], ]);
Parameter Details
Members
- localeId
-
- Required: Yes
- Type: string
The identifier of the language and locale of the slot types to list. The string must match one of the supported locales. For more information, see Supported languages.
- maxResults
-
- Type: int
The maximum number of built-in slot types to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
- nextToken
-
- Type: string
If the response from the
ListBuiltInSlotTypes
operation contains more results than specified in themaxResults
parameter, a token is returned in the response. Use that token in thenextToken
parameter to return the next page of results. - sortBy
-
- Type: BuiltInSlotTypeSortBy structure
Determines the sort order for the response from the
ListBuiltInSlotTypes
operation. You can choose to sort by the slot type signature in either ascending or descending order.
Result Syntax
[ 'builtInSlotTypeSummaries' => [ [ 'description' => '<string>', 'slotTypeSignature' => '<string>', ], // ... ], 'localeId' => '<string>', 'nextToken' => '<string>', ]
Result Details
Members
- builtInSlotTypeSummaries
-
- Type: Array of BuiltInSlotTypeSummary structures
Summary information for the built-in slot types that meet the filter criteria specified in the request. The length of the list is specified in the
maxResults
parameter of the request. If there are more slot types available, thenextToken
field contains a token to get the next page of results. - localeId
-
- Type: string
The language and locale of the slot types in the list.
- nextToken
-
- Type: string
A token that indicates whether there are more results to return in a response to the
ListBuiltInSlotTypes
operation. If thenextToken
field is present, you send the contents as thenextToken
parameter of aLIstBuiltInSlotTypes
operation request to get the next page of results.
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.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
ListCustomVocabularyItems
$result = $client->listCustomVocabularyItems
([/* ... */]); $promise = $client->listCustomVocabularyItemsAsync
([/* ... */]);
Paginated list of custom vocabulary items for a given bot locale's custom vocabulary.
Parameter Syntax
$result = $client->listCustomVocabularyItems([ 'botId' => '<string>', // REQUIRED 'botVersion' => '<string>', // REQUIRED 'localeId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The identifier of the version of the bot associated with this custom vocabulary.
- botVersion
-
- Required: Yes
- Type: string
The bot version of the bot to the list custom vocabulary request.
- 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 (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
- maxResults
-
- Type: int
The maximum number of items returned by the list operation.
- nextToken
-
- Type: string
The nextToken identifier to the list custom vocabulary request.
Result Syntax
[ 'botId' => '<string>', 'botVersion' => '<string>', 'customVocabularyItems' => [ [ 'displayAs' => '<string>', 'itemId' => '<string>', 'phrase' => '<string>', 'weight' => <integer>, ], // ... ], 'localeId' => '<string>', 'nextToken' => '<string>', ]
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.
- customVocabularyItems
-
- Type: Array of CustomVocabularyItem structures
The custom vocabulary items from the list custom vocabulary response.
- 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 .
- nextToken
-
- Type: string
The nextToken identifier to the list custom vocabulary response.
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.
ListExports
$result = $client->listExports
([/* ... */]); $promise = $client->listExportsAsync
([/* ... */]);
Lists the exports for a bot, bot locale, or custom vocabulary. Exports are kept in the list for 7 days.
Parameter Syntax
$result = $client->listExports([ 'botId' => '<string>', 'botVersion' => '<string>', 'filters' => [ [ 'name' => 'ExportResourceType', // REQUIRED 'operator' => 'CO|EQ', // REQUIRED 'values' => ['<string>', ...], // REQUIRED ], // ... ], 'localeId' => '<string>', 'maxResults' => <integer>, 'nextToken' => '<string>', 'sortBy' => [ 'attribute' => 'LastUpdatedDateTime', // REQUIRED 'order' => 'Ascending|Descending', // REQUIRED ], ]);
Parameter Details
Members
- botId
-
- Type: string
The unique identifier that Amazon Lex assigned to the bot.
- botVersion
-
- Type: string
The version of the bot to list exports for.
- filters
-
- Type: Array of ExportFilter structures
Provides the specification of a filter used to limit the exports in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.
- localeId
-
- Type: string
Specifies the resources that should be exported. If you don't specify a resource type in the
filters
parameter, both bot locales and custom vocabularies are exported. - maxResults
-
- Type: int
The maximum number of exports to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
- nextToken
-
- Type: string
If the response from the
ListExports
operation contains more results that specified in themaxResults
parameter, a token is returned in the response.Use the returned token in the
nextToken
parameter of aListExports
request to return the next page of results. For a complete set of results, call theListExports
operation until thenextToken
returned in the response is null. - sortBy
-
- Type: ExportSortBy structure
Determines the field that the list of exports is sorted by. You can sort by the
LastUpdatedDateTime
field in ascending or descending order.
Result Syntax
[ 'botId' => '<string>', 'botVersion' => '<string>', 'exportSummaries' => [ [ 'creationDateTime' => <DateTime>, 'exportId' => '<string>', 'exportStatus' => 'InProgress|Completed|Failed|Deleting', 'fileFormat' => 'LexJson|TSV|CSV', 'lastUpdatedDateTime' => <DateTime>, 'resourceSpecification' => [ 'botExportSpecification' => [ 'botId' => '<string>', 'botVersion' => '<string>', ], 'botLocaleExportSpecification' => [ 'botId' => '<string>', 'botVersion' => '<string>', 'localeId' => '<string>', ], 'customVocabularyExportSpecification' => [ 'botId' => '<string>', 'botVersion' => '<string>', 'localeId' => '<string>', ], 'testSetExportSpecification' => [ 'testSetId' => '<string>', ], ], ], // ... ], 'localeId' => '<string>', 'nextToken' => '<string>', ]
Result Details
Members
- botId
-
- Type: string
The unique identifier assigned to the bot by Amazon Lex.
- botVersion
-
- Type: string
The version of the bot that was exported.
- exportSummaries
-
- Type: Array of ExportSummary structures
Summary information for the exports that meet the filter criteria specified in the request. The length of the list is specified in the
maxResults
parameter. If there are more exports available, thenextToken
field contains a token to get the next page of results. - localeId
-
- Type: string
The locale specified in the request.
- nextToken
-
- Type: string
A token that indicates whether there are more results to return in a response to the
ListExports
operation. If thenextToken
field is present, you send the contents as thenextToken
parameter of aListExports
operation request to get the next page of results.
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.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
ListImports
$result = $client->listImports
([/* ... */]); $promise = $client->listImportsAsync
([/* ... */]);
Lists the imports for a bot, bot locale, or custom vocabulary. Imports are kept in the list for 7 days.
Parameter Syntax
$result = $client->listImports([ 'botId' => '<string>', 'botVersion' => '<string>', 'filters' => [ [ 'name' => 'ImportResourceType', // REQUIRED 'operator' => 'CO|EQ', // REQUIRED 'values' => ['<string>', ...], // REQUIRED ], // ... ], 'localeId' => '<string>', 'maxResults' => <integer>, 'nextToken' => '<string>', 'sortBy' => [ 'attribute' => 'LastUpdatedDateTime', // REQUIRED 'order' => 'Ascending|Descending', // REQUIRED ], ]);
Parameter Details
Members
- botId
-
- Type: string
The unique identifier that Amazon Lex assigned to the bot.
- botVersion
-
- Type: string
The version of the bot to list imports for.
- filters
-
- Type: Array of ImportFilter structures
Provides the specification of a filter used to limit the bots in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.
- localeId
-
- Type: string
Specifies the locale that should be present in the list. If you don't specify a resource type in the
filters
parameter, the list contains both bot locales and custom vocabularies. - maxResults
-
- Type: int
The maximum number of imports to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
- nextToken
-
- Type: string
If the response from the
ListImports
operation contains more results than specified in themaxResults
parameter, a token is returned in the response.Use the returned token in the
nextToken
parameter of aListImports
request to return the next page of results. For a complete set of results, call theListImports
operation until thenextToken
returned in the response is null. - sortBy
-
- Type: ImportSortBy structure
Determines the field that the list of imports is sorted by. You can sort by the
LastUpdatedDateTime
field in ascending or descending order.
Result Syntax
[ 'botId' => '<string>', 'botVersion' => '<string>', 'importSummaries' => [ [ 'creationDateTime' => <DateTime>, 'importId' => '<string>', 'importStatus' => 'InProgress|Completed|Failed|Deleting', 'importedResourceId' => '<string>', 'importedResourceName' => '<string>', 'importedResourceType' => 'Bot|BotLocale|CustomVocabulary|TestSet', 'lastUpdatedDateTime' => <DateTime>, 'mergeStrategy' => 'Overwrite|FailOnConflict|Append', ], // ... ], 'localeId' => '<string>', 'nextToken' => '<string>', ]
Result Details
Members
- botId
-
- Type: string
The unique identifier assigned by Amazon Lex to the bot.
- botVersion
-
- Type: string
The version of the bot that was imported. It will always be
DRAFT
. - importSummaries
-
- Type: Array of ImportSummary structures
Summary information for the imports that meet the filter criteria specified in the request. The length of the list is specified in the
maxResults
parameter. If there are more imports available, thenextToken
field contains a token to get the next page of results. - localeId
-
- Type: string
The locale specified in the request.
- nextToken
-
- Type: string
A token that indicates whether there are more results to return in a response to the
ListImports
operation. If thenextToken
field is present, you send the contents as thenextToken
parameter of aListImports
operation request to get the next page of results.
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.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
ListIntentMetrics
$result = $client->listIntentMetrics
([/* ... */]); $promise = $client->listIntentMetricsAsync
([/* ... */]);
Retrieves summary metrics for the intents in your bot. The following fields are required:
-
metrics
– A list of AnalyticsIntentMetric objects. In each object, use thename
field to specify the metric to calculate, thestatistic
field to specify whether to calculate theSum
,Average
, orMax
number, and theorder
field to specify whether to sort the results inAscending
orDescending
order. -
startDateTime
andendDateTime
– Define a time range for which you want to retrieve results.
Of the optional fields, you can organize the results in the following ways:
-
Use the
filters
field to filter the results, thegroupBy
field to specify categories by which to group the results, and thebinBy
field to specify time intervals by which to group the results. -
Use the
maxResults
field to limit the number of results to return in a single response and thenextToken
field to return the next batch of results if the response does not return the full set of results.
Note that an order
field exists in both binBy
and metrics
. You can specify only one order
in a given request.
Parameter Syntax
$result = $client->listIntentMetrics([ 'binBy' => [ [ 'interval' => 'OneHour|OneDay', // REQUIRED 'name' => 'ConversationStartTime|UtteranceTimestamp', // REQUIRED 'order' => 'Ascending|Descending', ], // ... ], 'botId' => '<string>', // REQUIRED 'endDateTime' => <integer || string || DateTime>, // REQUIRED 'filters' => [ [ 'name' => 'BotAliasId|BotVersion|LocaleId|Modality|Channel|SessionId|OriginatingRequestId|IntentName|IntentEndState', // REQUIRED 'operator' => 'EQ|GT|LT', // REQUIRED 'values' => ['<string>', ...], // REQUIRED ], // ... ], 'groupBy' => [ [ 'name' => 'IntentName|IntentEndState|IntentLevel', // REQUIRED ], // ... ], 'maxResults' => <integer>, 'metrics' => [ // REQUIRED [ 'name' => 'Count|Success|Failure|Switched|Dropped', // REQUIRED 'order' => 'Ascending|Descending', 'statistic' => 'Sum|Avg|Max', // REQUIRED ], // ... ], 'nextToken' => '<string>', 'startDateTime' => <integer || string || DateTime>, // REQUIRED ]);
Parameter Details
Members
- binBy
-
- Type: Array of AnalyticsBinBySpecification structures
A list of objects, each of which contains specifications for organizing the results by time.
- botId
-
- Required: Yes
- Type: string
The identifier for the bot for which you want to retrieve intent metrics.
- endDateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that marks the end of the range of time for which you want to see intent metrics.
- filters
-
- Type: Array of AnalyticsIntentFilter structures
A list of objects, each of which describes a condition by which you want to filter the results.
- groupBy
-
- Type: Array of AnalyticsIntentGroupBySpecification structures
A list of objects, each of which specifies how to group the results. You can group by the following criteria:
-
IntentName
– The name of the intent. -
IntentEndState
– The final state of the intent. The possible end states are detailed in Key definitions in the user guide.
- maxResults
-
- Type: int
The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
- metrics
-
- Required: Yes
- Type: Array of AnalyticsIntentMetric structures
A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the order by which to organize the results.
- nextToken
-
- Type: string
If the response from the ListIntentMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListIntentMetrics request to return the next page of results. For a complete set of results, call the ListIntentMetrics operation until the nextToken returned in the response is null.
- startDateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp that marks the beginning of the range of time for which you want to see intent metrics.
Result Syntax
[ 'botId' => '<string>', 'nextToken' => '<string>', 'results' => [ [ 'binKeys' => [ [ 'name' => 'ConversationStartTime|UtteranceTimestamp', 'value' => <integer>, ], // ... ], 'groupByKeys' => [ [ 'name' => 'IntentName|IntentEndState|IntentLevel', 'value' => '<string>', ], // ... ], 'metricsResults' => [ [ 'name' => 'Count|Success|Failure|Switched|Dropped', 'statistic' => 'Sum|Avg|Max', 'value' => <float>, ], // ... ], ], // ... ], ]
Result Details
Members
- botId
-
- Type: string
The identifier for the bot for which you retrieved intent metrics.
- nextToken
-
- Type: string
If the response from the ListIntentMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListIntentMetrics request to return the next page of results. For a complete set of results, call the ListIntentMetrics operation until the nextToken returned in the response is null.
- results
-
- Type: Array of AnalyticsIntentResult structures
The results for the intent metrics.
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.
- 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.
- ServiceQuotaExceededException:
You have reached a quota for your bot.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
ListIntentPaths
$result = $client->listIntentPaths
([/* ... */]); $promise = $client->listIntentPathsAsync
([/* ... */]);
Retrieves summary statistics for a path of intents that users take over sessions with your bot. The following fields are required:
-
startDateTime
andendDateTime
– Define a time range for which you want to retrieve results. -
intentPath
– Define an order of intents for which you want to retrieve metrics. Separate intents in the path with a forward slash. For example, populate theintentPath
field with/BookCar/BookHotel
to see details about how many times users invoked theBookCar
andBookHotel
intents in that order.
Use the optional filters
field to filter the results.
Parameter Syntax
$result = $client->listIntentPaths([ 'botId' => '<string>', // REQUIRED 'endDateTime' => <integer || string || DateTime>, // REQUIRED 'filters' => [ [ 'name' => 'BotAliasId|BotVersion|LocaleId|Modality|Channel', // REQUIRED 'operator' => 'EQ|GT|LT', // REQUIRED 'values' => ['<string>', ...], // REQUIRED ], // ... ], 'intentPath' => '<string>', // REQUIRED 'startDateTime' => <integer || string || DateTime>, // REQUIRED ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The identifier for the bot for which you want to retrieve intent path metrics.
- endDateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that marks the end of the range of time for which you want to see intent path metrics.
- filters
-
- Type: Array of AnalyticsPathFilter structures
A list of objects, each describes a condition by which you want to filter the results.
- intentPath
-
- Required: Yes
- Type: string
The intent path for which you want to retrieve metrics. Use a forward slash to separate intents in the path. For example:
-
/BookCar
-
/BookCar/BookHotel
-
/BookHotel/BookCar
- startDateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that marks the beginning of the range of time for which you want to see intent path metrics.
Result Syntax
[ 'nodeSummaries' => [ [ 'intentCount' => <integer>, 'intentLevel' => <integer>, 'intentName' => '<string>', 'intentPath' => '<string>', 'nodeType' => 'Inner|Exit', ], // ... ], ]
Result Details
Members
- nodeSummaries
-
- Type: Array of AnalyticsIntentNodeSummary structures
A list of objects, each of which contains information about a node in the intent path for which you requested metrics.
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.
- 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.
- ServiceQuotaExceededException:
You have reached a quota for your bot.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
ListIntentStageMetrics
$result = $client->listIntentStageMetrics
([/* ... */]); $promise = $client->listIntentStageMetricsAsync
([/* ... */]);
Retrieves summary metrics for the stages within intents in your bot. The following fields are required:
-
metrics
– A list of AnalyticsIntentStageMetric objects. In each object, use thename
field to specify the metric to calculate, thestatistic
field to specify whether to calculate theSum
,Average
, orMax
number, and theorder
field to specify whether to sort the results inAscending
orDescending
order. -
startDateTime
andendDateTime
– Define a time range for which you want to retrieve results.
Of the optional fields, you can organize the results in the following ways:
-
Use the
filters
field to filter the results, thegroupBy
field to specify categories by which to group the results, and thebinBy
field to specify time intervals by which to group the results. -
Use the
maxResults
field to limit the number of results to return in a single response and thenextToken
field to return the next batch of results if the response does not return the full set of results.
Note that an order
field exists in both binBy
and metrics
. You can only specify one order
in a given request.
Parameter Syntax
$result = $client->listIntentStageMetrics([ 'binBy' => [ [ 'interval' => 'OneHour|OneDay', // REQUIRED 'name' => 'ConversationStartTime|UtteranceTimestamp', // REQUIRED 'order' => 'Ascending|Descending', ], // ... ], 'botId' => '<string>', // REQUIRED 'endDateTime' => <integer || string || DateTime>, // REQUIRED 'filters' => [ [ 'name' => 'BotAliasId|BotVersion|LocaleId|Modality|Channel|SessionId|OriginatingRequestId|IntentName|IntentStageName', // REQUIRED 'operator' => 'EQ|GT|LT', // REQUIRED 'values' => ['<string>', ...], // REQUIRED ], // ... ], 'groupBy' => [ [ 'name' => 'IntentStageName|SwitchedToIntent', // REQUIRED ], // ... ], 'maxResults' => <integer>, 'metrics' => [ // REQUIRED [ 'name' => 'Count|Success|Failed|Dropped|Retry', // REQUIRED 'order' => 'Ascending|Descending', 'statistic' => 'Sum|Avg|Max', // REQUIRED ], // ... ], 'nextToken' => '<string>', 'startDateTime' => <integer || string || DateTime>, // REQUIRED ]);
Parameter Details
Members
- binBy
-
- Type: Array of AnalyticsBinBySpecification structures
A list of objects, each of which contains specifications for organizing the results by time.
- botId
-
- Required: Yes
- Type: string
The identifier for the bot for which you want to retrieve intent stage metrics.
- endDateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that marks the end of the range of time for which you want to see intent stage metrics.
- filters
-
- Type: Array of AnalyticsIntentStageFilter structures
A list of objects, each of which describes a condition by which you want to filter the results.
- groupBy
-
- Type: Array of AnalyticsIntentStageGroupBySpecification structures
A list of objects, each of which specifies how to group the results. You can group by the following criteria:
-
IntentStageName
– The name of the intent stage. -
SwitchedToIntent
– The intent to which the conversation was switched (if any).
- maxResults
-
- Type: int
The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
- metrics
-
- Required: Yes
- Type: Array of AnalyticsIntentStageMetric structures
A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
- nextToken
-
- Type: string
If the response from the ListIntentStageMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListIntentStageMetrics request to return the next page of results. For a complete set of results, call the ListIntentStageMetrics operation until the nextToken returned in the response is null.
- startDateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that marks the beginning of the range of time for which you want to see intent stage metrics.
Result Syntax
[ 'botId' => '<string>', 'nextToken' => '<string>', 'results' => [ [ 'binKeys' => [ [ 'name' => 'ConversationStartTime|UtteranceTimestamp', 'value' => <integer>, ], // ... ], 'groupByKeys' => [ [ 'name' => 'IntentStageName|SwitchedToIntent', 'value' => '<string>', ], // ... ], 'metricsResults' => [ [ 'name' => 'Count|Success|Failed|Dropped|Retry', 'statistic' => 'Sum|Avg|Max', 'value' => <float>, ], // ... ], ], // ... ], ]
Result Details
Members
- botId
-
- Type: string
The identifier for the bot for which you retrieved intent stage metrics.
- nextToken
-
- Type: string
If the response from the ListIntentStageMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListIntentStageMetrics request to return the next page of results. For a complete set of results, call the ListIntentStageMetrics operation until the nextToken returned in the response is null.
- results
-
- Type: Array of AnalyticsIntentStageResult structures
The results for the intent stage metrics.
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.
- 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.
- ServiceQuotaExceededException:
You have reached a quota for your bot.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
ListIntents
$result = $client->listIntents
([/* ... */]); $promise = $client->listIntentsAsync
([/* ... */]);
Get a list of intents that meet the specified criteria.
Parameter Syntax
$result = $client->listIntents([ 'botId' => '<string>', // REQUIRED 'botVersion' => '<string>', // REQUIRED 'filters' => [ [ 'name' => 'IntentName', // REQUIRED 'operator' => 'CO|EQ', // REQUIRED 'values' => ['<string>', ...], // REQUIRED ], // ... ], 'localeId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', 'sortBy' => [ 'attribute' => 'IntentName|LastUpdatedDateTime', // REQUIRED 'order' => 'Ascending|Descending', // REQUIRED ], ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The unique identifier of the bot that contains the intent.
- botVersion
-
- Required: Yes
- Type: string
The version of the bot that contains the intent.
- filters
-
- Type: Array of IntentFilter structures
Provides the specification of a filter used to limit the intents in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.
- localeId
-
- Required: Yes
- Type: string
The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see Supported languages.
- maxResults
-
- Type: int
The maximum number of intents to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
- nextToken
-
- Type: string
If the response from the
ListIntents
operation contains more results than specified in themaxResults
parameter, a token is returned in the response.Use the returned token in the
nextToken
parameter of aListIntents
request to return the next page of results. For a complete set of results, call theListIntents
operation until thenextToken
returned in the response is null. - sortBy
-
- Type: IntentSortBy structure
Determines the sort order for the response from the
ListIntents
operation. You can choose to sort by the intent name or last updated date in either ascending or descending order.
Result Syntax
[ 'botId' => '<string>', 'botVersion' => '<string>', 'intentSummaries' => [ [ 'description' => '<string>', 'inputContexts' => [ [ 'name' => '<string>', ], // ... ], 'intentId' => '<string>', 'intentName' => '<string>', 'lastUpdatedDateTime' => <DateTime>, 'outputContexts' => [ [ 'name' => '<string>', 'timeToLiveInSeconds' => <integer>, 'turnsToLive' => <integer>, ], // ... ], 'parentIntentSignature' => '<string>', ], // ... ], 'localeId' => '<string>', 'nextToken' => '<string>', ]
Result Details
Members
- botId
-
- Type: string
The identifier of the bot that contains the intent.
- botVersion
-
- Type: string
The version of the bot that contains the intent.
- intentSummaries
-
- Type: Array of IntentSummary structures
Summary information for the intents that meet the filter criteria specified in the request. The length of the list is specified in the
maxResults
parameter of the request. If there are more intents available, thenextToken
field contains a token to get the next page of results. - localeId
-
- Type: string
The language and locale of the intents in the list.
- nextToken
-
- Type: string
A token that indicates whether there are more results to return in a response to the
ListIntents
operation. If thenextToken
field is present, you send the contents as thenextToken
parameter of aListIntents
operation request to get the next page of results.
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.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
ListRecommendedIntents
$result = $client->listRecommendedIntents
([/* ... */]); $promise = $client->listRecommendedIntentsAsync
([/* ... */]);
Gets a list of recommended intents provided by the bot recommendation that you can use in your bot. Intents in the response are ordered by relevance.
Parameter Syntax
$result = $client->listRecommendedIntents([ 'botId' => '<string>', // REQUIRED 'botRecommendationId' => '<string>', // REQUIRED 'botVersion' => '<string>', // REQUIRED 'localeId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The unique identifier of the bot associated with the recommended intents.
- botRecommendationId
-
- Required: Yes
- Type: string
The identifier of the bot recommendation that contains the recommended intents.
- botVersion
-
- Required: Yes
- Type: string
The version of the bot that contains the recommended intents.
- localeId
-
- Required: Yes
- Type: string
The identifier of the language and locale of the recommended intents.
- maxResults
-
- Type: int
The maximum number of bot recommendations to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
- nextToken
-
- Type: string
If the response from the ListRecommendedIntents operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
Result Syntax
[ 'botId' => '<string>', 'botRecommendationId' => '<string>', 'botVersion' => '<string>', 'localeId' => '<string>', 'nextToken' => '<string>', 'summaryList' => [ [ 'intentId' => '<string>', 'intentName' => '<string>', 'sampleUtterancesCount' => <integer>, ], // ... ], ]
Result Details
Members
- botId
-
- Type: string
The unique identifier of the bot associated with the recommended intent.
- botRecommendationId
-
- Type: string
The identifier of the bot recommendation that contains the recommended intent.
- botVersion
-
- Type: string
The version of the bot that contains the intent.
- localeId
-
- Type: string
The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see Supported languages.
- nextToken
-
- Type: string
A token that indicates whether there are more results to return in a response to the ListRecommendedIntents operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListRecommendedIntents operation request to get the next page of results.
- summaryList
-
- Type: Array of RecommendedIntentSummary structures
Summary information for the intents that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more intents available, the nextToken field contains a token to get the next page of results.
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.
- 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.
ListSessionAnalyticsData
$result = $client->listSessionAnalyticsData
([/* ... */]); $promise = $client->listSessionAnalyticsDataAsync
([/* ... */]);
Retrieves a list of metadata for individual user sessions with your bot. The startDateTime
and endDateTime
fields are required. These fields define a time range for which you want to retrieve results. Of the optional fields, you can organize the results in the following ways:
-
Use the
filters
field to filter the results and thesortBy
field to specify the values by which to sort the results. -
Use the
maxResults
field to limit the number of results to return in a single response and thenextToken
field to return the next batch of results if the response does not return the full set of results.
Parameter Syntax
$result = $client->listSessionAnalyticsData([ 'botId' => '<string>', // REQUIRED 'endDateTime' => <integer || string || DateTime>, // REQUIRED 'filters' => [ [ 'name' => 'BotAliasId|BotVersion|LocaleId|Modality|Channel|Duration|ConversationEndState|SessionId|OriginatingRequestId|IntentPath', // REQUIRED 'operator' => 'EQ|GT|LT', // REQUIRED 'values' => ['<string>', ...], // REQUIRED ], // ... ], 'maxResults' => <integer>, 'nextToken' => '<string>', 'sortBy' => [ 'name' => 'ConversationStartTime|NumberOfTurns|Duration', // REQUIRED 'order' => 'Ascending|Descending', // REQUIRED ], 'startDateTime' => <integer || string || DateTime>, // REQUIRED ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The identifier for the bot for which you want to retrieve session analytics.
- endDateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that marks the end of the range of time for which you want to see session analytics.
- filters
-
- Type: Array of AnalyticsSessionFilter structures
A list of objects, each of which describes a condition by which you want to filter the results.
- maxResults
-
- Type: int
The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
- nextToken
-
- Type: string
If the response from the ListSessionAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListSessionAnalyticsData request to return the next page of results. For a complete set of results, call the ListSessionAnalyticsData operation until the nextToken returned in the response is null.
- sortBy
-
- Type: SessionDataSortBy structure
An object specifying the measure and method by which to sort the session analytics data.
- startDateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that marks the beginning of the range of time for which you want to see session analytics.
Result Syntax
[ 'botId' => '<string>', 'nextToken' => '<string>', 'sessions' => [ [ 'botAliasId' => '<string>', 'botVersion' => '<string>', 'channel' => '<string>', 'conversationDurationSeconds' => <integer>, 'conversationEndState' => 'Success|Failure|Dropped', 'conversationEndTime' => <DateTime>, 'conversationStartTime' => <DateTime>, 'invokedIntentSamples' => [ [ 'intentName' => '<string>', ], // ... ], 'localeId' => '<string>', 'mode' => 'Speech|Text|DTMF|MultiMode', 'numberOfTurns' => <integer>, 'originatingRequestId' => '<string>', 'sessionId' => '<string>', ], // ... ], ]
Result Details
Members
- botId
-
- Type: string
The unique identifier of the bot that the sessions belong to.
- nextToken
-
- Type: string
If the response from the ListSessionAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListSessionAnalyticsData request to return the next page of results. For a complete set of results, call the ListSessionAnalyticsData operation until the nextToken returned in the response is null.
- sessions
-
- Type: Array of SessionSpecification structures
A list of objects, each of which contains information about a session with the bot.
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.
- 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.
- ServiceQuotaExceededException:
You have reached a quota for your bot.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
ListSessionMetrics
$result = $client->listSessionMetrics
([/* ... */]); $promise = $client->listSessionMetricsAsync
([/* ... */]);
Retrieves summary metrics for the user sessions with your bot. The following fields are required:
-
metrics
– A list of AnalyticsSessionMetric objects. In each object, use thename
field to specify the metric to calculate, thestatistic
field to specify whether to calculate theSum
,Average
, orMax
number, and theorder
field to specify whether to sort the results inAscending
orDescending
order. -
startDateTime
andendDateTime
– Define a time range for which you want to retrieve results.
Of the optional fields, you can organize the results in the following ways:
-
Use the
filters
field to filter the results, thegroupBy
field to specify categories by which to group the results, and thebinBy
field to specify time intervals by which to group the results. -
Use the
maxResults
field to limit the number of results to return in a single response and thenextToken
field to return the next batch of results if the response does not return the full set of results.
Note that an order
field exists in both binBy
and metrics
. Currently, you can specify it in either field, but not in both.
Parameter Syntax
$result = $client->listSessionMetrics([ 'binBy' => [ [ 'interval' => 'OneHour|OneDay', // REQUIRED 'name' => 'ConversationStartTime|UtteranceTimestamp', // REQUIRED 'order' => 'Ascending|Descending', ], // ... ], 'botId' => '<string>', // REQUIRED 'endDateTime' => <integer || string || DateTime>, // REQUIRED 'filters' => [ [ 'name' => 'BotAliasId|BotVersion|LocaleId|Modality|Channel|Duration|ConversationEndState|SessionId|OriginatingRequestId|IntentPath', // REQUIRED 'operator' => 'EQ|GT|LT', // REQUIRED 'values' => ['<string>', ...], // REQUIRED ], // ... ], 'groupBy' => [ [ 'name' => 'ConversationEndState|LocaleId', // REQUIRED ], // ... ], 'maxResults' => <integer>, 'metrics' => [ // REQUIRED [ 'name' => 'Count|Success|Failure|Dropped|Duration|TurnsPerConversation|Concurrency', // REQUIRED 'order' => 'Ascending|Descending', 'statistic' => 'Sum|Avg|Max', // REQUIRED ], // ... ], 'nextToken' => '<string>', 'startDateTime' => <integer || string || DateTime>, // REQUIRED ]);
Parameter Details
Members
- binBy
-
- Type: Array of AnalyticsBinBySpecification structures
A list of objects, each of which contains specifications for organizing the results by time.
- botId
-
- Required: Yes
- Type: string
The identifier for the bot for which you want to retrieve session metrics.
- endDateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that marks the end of the range of time for which you want to see session metrics.
- filters
-
- Type: Array of AnalyticsSessionFilter structures
A list of objects, each of which describes a condition by which you want to filter the results.
- groupBy
-
- Type: Array of AnalyticsSessionGroupBySpecification structures
A list of objects, each of which specifies how to group the results. You can group by the following criteria:
-
ConversationEndState
– The final state of the conversation. The possible end states are detailed in Key definitions in the user guide. -
LocaleId
– The unique identifier of the bot locale.
- maxResults
-
- Type: int
The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
- metrics
-
- Required: Yes
- Type: Array of AnalyticsSessionMetric structures
A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
- nextToken
-
- Type: string
If the response from the ListSessionMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListSessionMetrics request to return the next page of results. For a complete set of results, call the ListSessionMetrics operation until the nextToken returned in the response is null.
- startDateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that marks the beginning of the range of time for which you want to see session metrics.
Result Syntax
[ 'botId' => '<string>', 'nextToken' => '<string>', 'results' => [ [ 'binKeys' => [ [ 'name' => 'ConversationStartTime|UtteranceTimestamp', 'value' => <integer>, ], // ... ], 'groupByKeys' => [ [ 'name' => 'ConversationEndState|LocaleId', 'value' => '<string>', ], // ... ], 'metricsResults' => [ [ 'name' => 'Count|Success|Failure|Dropped|Duration|TurnsPerConversation|Concurrency', 'statistic' => 'Sum|Avg|Max', 'value' => <float>, ], // ... ], ], // ... ], ]
Result Details
Members
- botId
-
- Type: string
The identifier for the bot for which you retrieved session metrics.
- nextToken
-
- Type: string
If the response from the ListSessionMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListSessionMetrics request to return the next page of results. For a complete set of results, call the ListSessionMetrics operation until the nextToken returned in the response is null.
- results
-
- Type: Array of AnalyticsSessionResult structures
The results for the session metrics.
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.
- 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.
- ServiceQuotaExceededException:
You have reached a quota for your bot.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
ListSlotTypes
$result = $client->listSlotTypes
([/* ... */]); $promise = $client->listSlotTypesAsync
([/* ... */]);
Gets a list of slot types that match the specified criteria.
Parameter Syntax
$result = $client->listSlotTypes([ 'botId' => '<string>', // REQUIRED 'botVersion' => '<string>', // REQUIRED 'filters' => [ [ 'name' => 'SlotTypeName|ExternalSourceType', // REQUIRED 'operator' => 'CO|EQ', // REQUIRED 'values' => ['<string>', ...], // REQUIRED ], // ... ], 'localeId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', 'sortBy' => [ 'attribute' => 'SlotTypeName|LastUpdatedDateTime', // REQUIRED 'order' => 'Ascending|Descending', // REQUIRED ], ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The unique identifier of the bot that contains the slot types.
- botVersion
-
- Required: Yes
- Type: string
The version of the bot that contains the slot type.
- filters
-
- Type: Array of SlotTypeFilter structures
Provides the specification of a filter used to limit the slot types in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.
- localeId
-
- Required: Yes
- Type: string
The identifier of the language and locale of the slot types to list. The string must match one of the supported locales. For more information, see Supported languages.
- maxResults
-
- Type: int
The maximum number of slot types to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
- nextToken
-
- Type: string
If the response from the
ListSlotTypes
operation contains more results than specified in themaxResults
parameter, a token is returned in the response. Use that token in thenextToken
parameter to return the next page of results. - sortBy
-
- Type: SlotTypeSortBy structure
Determines the sort order for the response from the
ListSlotTypes
operation. You can choose to sort by the slot type name or last updated date in either ascending or descending order.
Result Syntax
[ 'botId' => '<string>', 'botVersion' => '<string>', 'localeId' => '<string>', 'nextToken' => '<string>', 'slotTypeSummaries' => [ [ 'description' => '<string>', 'lastUpdatedDateTime' => <DateTime>, 'parentSlotTypeSignature' => '<string>', 'slotTypeCategory' => 'Custom|Extended|ExternalGrammar|Composite', 'slotTypeId' => '<string>', 'slotTypeName' => '<string>', ], // ... ], ]
Result Details
Members
- botId
-
- Type: string
The identifier of the bot that contains the slot types.
- botVersion
-
- Type: string
The version of the bot that contains the slot types.
- localeId
-
- Type: string
The language and local of the slot types in the list.
- nextToken
-
- Type: string
A token that indicates whether there are more results to return in a response to the
ListSlotTypes
operation. If thenextToken
field is present, you send the contents as thenextToken
parameter of aListSlotTypes
operation request to get the next page of results. - slotTypeSummaries
-
- Type: Array of SlotTypeSummary structures
Summary information for the slot types that meet the filter criteria specified in the request. The length of the list is specified in the
maxResults
parameter of the request. If there are more slot types available, thenextToken
field contains a token to get the next page of results.
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.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
ListSlots
$result = $client->listSlots
([/* ... */]); $promise = $client->listSlotsAsync
([/* ... */]);
Gets a list of slots that match the specified criteria.
Parameter Syntax
$result = $client->listSlots([ 'botId' => '<string>', // REQUIRED 'botVersion' => '<string>', // REQUIRED 'filters' => [ [ 'name' => 'SlotName', // REQUIRED 'operator' => 'CO|EQ', // REQUIRED 'values' => ['<string>', ...], // REQUIRED ], // ... ], 'intentId' => '<string>', // REQUIRED 'localeId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', 'sortBy' => [ 'attribute' => 'SlotName|LastUpdatedDateTime', // REQUIRED 'order' => 'Ascending|Descending', // REQUIRED ], ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The identifier of the bot that contains the slot.
- botVersion
-
- Required: Yes
- Type: string
The version of the bot that contains the slot.
- filters
-
- Type: Array of SlotFilter structures
Provides the specification of a filter used to limit the slots in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.
- intentId
-
- Required: Yes
- Type: string
The unique identifier of the intent that contains the slot.
- localeId
-
- Required: Yes
- Type: string
The identifier of the language and locale of the slots to list. The string must match one of the supported locales. For more information, see Supported languages.
- maxResults
-
- Type: int
The maximum number of slots to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
- nextToken
-
- Type: string
If the response from the
ListSlots
operation contains more results than specified in themaxResults
parameter, a token is returned in the response. Use that token in thenextToken
parameter to return the next page of results. - sortBy
-
- Type: SlotSortBy structure
Determines the sort order for the response from the
ListSlots
operation. You can choose to sort by the slot name or last updated date in either ascending or descending order.
Result Syntax
[ 'botId' => '<string>', 'botVersion' => '<string>', 'intentId' => '<string>', 'localeId' => '<string>', 'nextToken' => '<string>', 'slotSummaries' => [ [ 'description' => '<string>', 'lastUpdatedDateTime' => <DateTime>, 'slotConstraint' => 'Required|Optional', 'slotId' => '<string>', 'slotName' => '<string>', 'slotTypeId' => '<string>', 'valueElicitationPromptSpecification' => [ '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>, ], ], // ... ], ], ], // ... ], ]
Result Details
Members
- botId
-
- Type: string
The identifier of the bot that contains the slots.
- botVersion
-
- Type: string
The version of the bot that contains the slots.
- intentId
-
- Type: string
The identifier of the intent that contains the slots.
- localeId
-
- Type: string
The language and locale of the slots in the list.
- nextToken
-
- Type: string
A token that indicates whether there are more results to return in a response to the
ListSlots
operation. If thenextToken
field is present, you send the contents as thenextToken
parameter of aListSlots
operation request to get the next page of results. - slotSummaries
-
- Type: Array of SlotSummary structures
Summary information for the slots that meet the filter criteria specified in the request. The length of the list is specified in the
maxResults
parameter of the request. If there are more slots available, thenextToken
field contains a token to get the next page of results.
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.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
ListTagsForResource
$result = $client->listTagsForResource
([/* ... */]); $promise = $client->listTagsForResourceAsync
([/* ... */]);
Gets a list of tags associated with a resource. Only bots, bot aliases, and bot channels can have tags associated with them.
Parameter Syntax
$result = $client->listTagsForResource([ 'resourceARN' => '<string>', // REQUIRED ]);
Parameter Details
Members
- resourceARN
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource to get a list of tags for.
Result Syntax
[ 'tags' => ['<string>', ...], ]
Result Details
Members
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags associated with a resource.
Errors
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
- ThrottlingException:
Your request rate is too high. Reduce the frequency of requests.
- ResourceNotFoundException:
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
- ValidationException:
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
ListTestExecutionResultItems
$result = $client->listTestExecutionResultItems
([/* ... */]); $promise = $client->listTestExecutionResultItemsAsync
([/* ... */]);
Gets a list of test execution result items.
Parameter Syntax
$result = $client->listTestExecutionResultItems([ 'maxResults' => <integer>, 'nextToken' => '<string>', 'resultFilterBy' => [ // REQUIRED 'conversationLevelTestResultsFilterBy' => [ 'endToEndResult' => 'Matched|Mismatched|ExecutionError', ], 'resultTypeFilter' => 'OverallTestResults|ConversationLevelTestResults|IntentClassificationTestResults|SlotResolutionTestResults|UtteranceLevelResults', // REQUIRED ], 'testExecutionId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of test execution result items to return in each page. If there are fewer results than the max page size, only the actual number of results are returned.
- nextToken
-
- Type: string
If the response from the
ListTestExecutionResultItems
operation contains more results than specified in themaxResults
parameter, a token is returned in the response. Use that token in thenextToken
parameter to return the next page of results. - resultFilterBy
-
- Required: Yes
- Type: TestExecutionResultFilterBy structure
The filter for the list of results from the test set execution.
- testExecutionId
-
- Required: Yes
- Type: string
The unique identifier of the test execution to list the result items.
Result Syntax
[ 'nextToken' => '<string>', 'testExecutionResults' => [ 'conversationLevelTestResults' => [ 'items' => [ [ 'conversationId' => '<string>', 'endToEndResult' => 'Matched|Mismatched|ExecutionError', 'intentClassificationResults' => [ [ 'intentName' => '<string>', 'matchResult' => 'Matched|Mismatched|ExecutionError', ], // ... ], 'slotResolutionResults' => [ [ 'intentName' => '<string>', 'matchResult' => 'Matched|Mismatched|ExecutionError', 'slotName' => '<string>', ], // ... ], 'speechTranscriptionResult' => 'Matched|Mismatched|ExecutionError', ], // ... ], ], 'intentClassificationTestResults' => [ 'items' => [ [ 'intentName' => '<string>', 'multiTurnConversation' => true || false, 'resultCounts' => [ 'intentMatchResultCounts' => [<integer>, ...], 'speechTranscriptionResultCounts' => [<integer>, ...], 'totalResultCount' => <integer>, ], ], // ... ], ], 'intentLevelSlotResolutionTestResults' => [ 'items' => [ [ 'intentName' => '<string>', 'multiTurnConversation' => true || false, 'slotResolutionResults' => [ [ 'resultCounts' => [ 'slotMatchResultCounts' => [<integer>, ...], 'speechTranscriptionResultCounts' => [<integer>, ...], 'totalResultCount' => <integer>, ], 'slotName' => '<string>', ], // ... ], ], // ... ], ], 'overallTestResults' => [ 'items' => [ [ 'endToEndResultCounts' => [<integer>, ...], 'multiTurnConversation' => true || false, 'speechTranscriptionResultCounts' => [<integer>, ...], 'totalResultCount' => <integer>, ], // ... ], ], 'utteranceLevelTestResults' => [ 'items' => [ [ 'conversationId' => '<string>', 'recordNumber' => <integer>, 'turnResult' => [ 'agent' => [ 'actualAgentPrompt' => '<string>', 'actualElicitedSlot' => '<string>', 'actualIntent' => '<string>', 'errorDetails' => [ 'errorCode' => '<string>', 'errorMessage' => '<string>', ], 'expectedAgentPrompt' => '<string>', ], 'user' => [ 'actualOutput' => [ 'activeContexts' => [ [ 'name' => '<string>', ], // ... ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'subSlots' => [...], // RECURSIVE 'value' => '<string>', 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'transcript' => '<string>', ], 'conversationLevelResult' => [ 'endToEndResult' => 'Matched|Mismatched|ExecutionError', 'speechTranscriptionResult' => 'Matched|Mismatched|ExecutionError', ], 'endToEndResult' => 'Matched|Mismatched|ExecutionError', 'errorDetails' => [ 'errorCode' => '<string>', 'errorMessage' => '<string>', ], 'expectedOutput' => [ 'activeContexts' => [ [ 'name' => '<string>', ], // ... ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'subSlots' => [...], // RECURSIVE 'value' => '<string>', 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'transcript' => '<string>', ], 'input' => [ 'requestAttributes' => ['<string>', ...], 'sessionState' => [ 'activeContexts' => [ [ 'name' => '<string>', ], // ... ], 'runtimeHints' => [ 'slotHints' => [ '<Name>' => [ '<Name>' => [ 'runtimeHintValues' => [ [ 'phrase' => '<string>', ], // ... ], 'subSlotHints' => [...], // RECURSIVE ], // ... ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'utteranceInput' => [ 'audioInput' => [ 'audioFileS3Location' => '<string>', ], 'textInput' => '<string>', ], ], 'intentMatchResult' => 'Matched|Mismatched|ExecutionError', 'slotMatchResult' => 'Matched|Mismatched|ExecutionError', 'speechTranscriptionResult' => 'Matched|Mismatched|ExecutionError', ], ], ], // ... ], ], ], ]
Result Details
Members
- nextToken
-
- Type: string
A token that indicates whether there are more results to return in a response to the
ListTestExecutionResultItems
operation. If thenextToken
field is present, you send the contents as thenextToken
parameter of aListTestExecutionResultItems
operation request to get the next page of results. - testExecutionResults
-
- Type: TestExecutionResultItems structure
The list of results from the test execution.
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.
ListTestExecutions
$result = $client->listTestExecutions
([/* ... */]); $promise = $client->listTestExecutionsAsync
([/* ... */]);
The list of test set executions.
Parameter Syntax
$result = $client->listTestExecutions([ 'maxResults' => <integer>, 'nextToken' => '<string>', 'sortBy' => [ 'attribute' => 'TestSetName|CreationDateTime', // REQUIRED 'order' => 'Ascending|Descending', // REQUIRED ], ]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of test executions to return in each page. If there are fewer results than the max page size, only the actual number of results are returned.
- nextToken
-
- Type: string
If the response from the ListTestExecutions operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
- sortBy
-
- Type: TestExecutionSortBy structure
The sort order of the test set executions.
Result Syntax
[ 'nextToken' => '<string>', 'testExecutions' => [ [ 'apiMode' => 'Streaming|NonStreaming', 'creationDateTime' => <DateTime>, 'lastUpdatedDateTime' => <DateTime>, 'target' => [ 'botAliasTarget' => [ 'botAliasId' => '<string>', 'botId' => '<string>', 'localeId' => '<string>', ], ], 'testExecutionId' => '<string>', 'testExecutionModality' => 'Text|Audio', 'testExecutionStatus' => 'Pending|Waiting|InProgress|Completed|Failed|Stopping|Stopped', 'testSetId' => '<string>', 'testSetName' => '<string>', ], // ... ], ]
Result Details
Members
- nextToken
-
- Type: string
A token that indicates whether there are more results to return in a response to the ListTestExecutions operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListTestExecutions operation request to get the next page of results.
- testExecutions
-
- Type: Array of TestExecutionSummary structures
The list of test executions.
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.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
ListTestSetRecords
$result = $client->listTestSetRecords
([/* ... */]); $promise = $client->listTestSetRecordsAsync
([/* ... */]);
The list of test set records.
Parameter Syntax
$result = $client->listTestSetRecords([ 'maxResults' => <integer>, 'nextToken' => '<string>', 'testSetId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of test set records to return in each page. If there are fewer records than the max page size, only the actual number of records are returned.
- nextToken
-
- Type: string
If the response from the ListTestSetRecords operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
- testSetId
-
- Required: Yes
- Type: string
The identifier of the test set to list its test set records.
Result Syntax
[ 'nextToken' => '<string>', 'testSetRecords' => [ [ 'conversationId' => '<string>', 'recordNumber' => <integer>, 'turnNumber' => <integer>, 'turnSpecification' => [ 'agentTurn' => [ 'agentPrompt' => '<string>', ], 'userTurn' => [ 'expected' => [ 'activeContexts' => [ [ 'name' => '<string>', ], // ... ], 'intent' => [ 'name' => '<string>', 'slots' => [ '<Name>' => [ 'subSlots' => [...], // RECURSIVE 'value' => '<string>', 'values' => [ [...], // RECURSIVE // ... ], ], // ... ], ], 'transcript' => '<string>', ], 'input' => [ 'requestAttributes' => ['<string>', ...], 'sessionState' => [ 'activeContexts' => [ [ 'name' => '<string>', ], // ... ], 'runtimeHints' => [ 'slotHints' => [ '<Name>' => [ '<Name>' => [ 'runtimeHintValues' => [ [ 'phrase' => '<string>', ], // ... ], 'subSlotHints' => [...], // RECURSIVE ], // ... ], // ... ], ], 'sessionAttributes' => ['<string>', ...], ], 'utteranceInput' => [ 'audioInput' => [ 'audioFileS3Location' => '<string>', ], 'textInput' => '<string>', ], ], ], ], ], // ... ], ]
Result Details
Members
- nextToken
-
- Type: string
A token that indicates whether there are more records to return in a response to the ListTestSetRecords operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListTestSetRecords operation request to get the next page of records.
- testSetRecords
-
- Type: Array of TestSetTurnRecord structures
The list of records from the test set.
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.
ListTestSets
$result = $client->listTestSets
([/* ... */]); $promise = $client->listTestSetsAsync
([/* ... */]);
The list of the test sets
Parameter Syntax
$result = $client->listTestSets([ 'maxResults' => <integer>, 'nextToken' => '<string>', 'sortBy' => [ 'attribute' => 'TestSetName|LastUpdatedDateTime', // REQUIRED 'order' => 'Ascending|Descending', // REQUIRED ], ]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of test sets to return in each page. If there are fewer results than the max page size, only the actual number of results are returned.
- nextToken
-
- Type: string
If the response from the ListTestSets operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
- sortBy
-
- Type: TestSetSortBy structure
The sort order for the list of test sets.
Result Syntax
[ 'nextToken' => '<string>', 'testSets' => [ [ 'creationDateTime' => <DateTime>, 'description' => '<string>', 'lastUpdatedDateTime' => <DateTime>, 'modality' => 'Text|Audio', 'numTurns' => <integer>, 'roleArn' => '<string>', 'status' => 'Importing|PendingAnnotation|Deleting|ValidationError|Ready', 'storageLocation' => [ 'kmsKeyArn' => '<string>', 's3BucketName' => '<string>', 's3Path' => '<string>', ], 'testSetId' => '<string>', 'testSetName' => '<string>', ], // ... ], ]
Result Details
Members
- nextToken
-
- Type: string
A token that indicates whether there are more results to return in a response to the ListTestSets operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListTestSets operation request to get the next page of results.
- testSets
-
- Type: Array of TestSetSummary structures
The selected test sets in a list of test sets.
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.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
ListUtteranceAnalyticsData
$result = $client->listUtteranceAnalyticsData
([/* ... */]); $promise = $client->listUtteranceAnalyticsDataAsync
([/* ... */]);
To use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances operation, which provides access to utterance-related analytics. See Viewing utterance statistics for the IAM policy to apply to the IAM role.
Retrieves a list of metadata for individual user utterances to your bot. The following fields are required:
-
startDateTime
andendDateTime
– Define a time range for which you want to retrieve results.
Of the optional fields, you can organize the results in the following ways:
-
Use the
filters
field to filter the results and thesortBy
field to specify the values by which to sort the results. -
Use the
maxResults
field to limit the number of results to return in a single response and thenextToken
field to return the next batch of results if the response does not return the full set of results.
Parameter Syntax
$result = $client->listUtteranceAnalyticsData([ 'botId' => '<string>', // REQUIRED 'endDateTime' => <integer || string || DateTime>, // REQUIRED 'filters' => [ [ 'name' => 'BotAliasId|BotVersion|LocaleId|Modality|Channel|SessionId|OriginatingRequestId|UtteranceState|UtteranceText', // REQUIRED 'operator' => 'EQ|GT|LT', // REQUIRED 'values' => ['<string>', ...], // REQUIRED ], // ... ], 'maxResults' => <integer>, 'nextToken' => '<string>', 'sortBy' => [ 'name' => 'UtteranceTimestamp', // REQUIRED 'order' => 'Ascending|Descending', // REQUIRED ], 'startDateTime' => <integer || string || DateTime>, // REQUIRED ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The identifier for the bot for which you want to retrieve utterance analytics.
- endDateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that marks the end of the range of time for which you want to see utterance analytics.
- filters
-
- Type: Array of AnalyticsUtteranceFilter structures
A list of objects, each of which describes a condition by which you want to filter the results.
- maxResults
-
- Type: int
The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
- nextToken
-
- Type: string
If the response from the ListUtteranceAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListUtteranceAnalyticsData request to return the next page of results. For a complete set of results, call the ListUtteranceAnalyticsData operation until the nextToken returned in the response is null.
- sortBy
-
- Type: UtteranceDataSortBy structure
An object specifying the measure and method by which to sort the utterance analytics data.
- startDateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that marks the beginning of the range of time for which you want to see utterance analytics.
Result Syntax
[ 'botId' => '<string>', 'nextToken' => '<string>', 'utterances' => [ [ 'associatedIntentName' => '<string>', 'associatedSlotName' => '<string>', 'audioVoiceDurationMillis' => <integer>, 'botAliasId' => '<string>', 'botResponseAudioVoiceId' => '<string>', 'botResponses' => [ [ 'content' => '<string>', 'contentType' => 'PlainText|CustomPayload|SSML|ImageResponseCard', 'imageResponseCard' => [ 'buttons' => [ [ 'text' => '<string>', 'value' => '<string>', ], // ... ], 'imageUrl' => '<string>', 'subtitle' => '<string>', 'title' => '<string>', ], ], // ... ], 'botVersion' => '<string>', 'channel' => '<string>', 'conversationEndTime' => <DateTime>, 'conversationStartTime' => <DateTime>, 'dialogActionType' => '<string>', 'inputType' => '<string>', 'intentState' => 'Failed|Fulfilled|InProgress|ReadyForFulfillment|Waiting|FulfillmentInProgress', 'localeId' => '<string>', 'mode' => 'Speech|Text|DTMF|MultiMode', 'outputType' => '<string>', 'sessionId' => '<string>', 'slotsFilledInSession' => '<string>', 'utterance' => '<string>', 'utteranceRequestId' => '<string>', 'utteranceTimestamp' => <DateTime>, 'utteranceUnderstood' => true || false, ], // ... ], ]
Result Details
Members
- botId
-
- Type: string
The unique identifier of the bot that the utterances belong to.
- nextToken
-
- Type: string
If the response from the ListUtteranceAnalyticsData operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListUtteranceAnalyticsData request to return the next page of results. For a complete set of results, call the ListUtteranceAnalyticsData operation until the nextToken returned in the response is null.
- utterances
-
- Type: Array of UtteranceSpecification structures
A list of objects, each of which contains information about an utterance in a user session with your bot.
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.
- 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.
- ServiceQuotaExceededException:
You have reached a quota for your bot.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
ListUtteranceMetrics
$result = $client->listUtteranceMetrics
([/* ... */]); $promise = $client->listUtteranceMetricsAsync
([/* ... */]);
To use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances operation, which provides access to utterance-related analytics. See Viewing utterance statistics for the IAM policy to apply to the IAM role.
Retrieves summary metrics for the utterances in your bot. The following fields are required:
-
metrics
– A list of AnalyticsUtteranceMetric objects. In each object, use thename
field to specify the metric to calculate, thestatistic
field to specify whether to calculate theSum
,Average
, orMax
number, and theorder
field to specify whether to sort the results inAscending
orDescending
order. -
startDateTime
andendDateTime
– Define a time range for which you want to retrieve results.
Of the optional fields, you can organize the results in the following ways:
-
Use the
filters
field to filter the results, thegroupBy
field to specify categories by which to group the results, and thebinBy
field to specify time intervals by which to group the results. -
Use the
maxResults
field to limit the number of results to return in a single response and thenextToken
field to return the next batch of results if the response does not return the full set of results.
Note that an order
field exists in both binBy
and metrics
. Currently, you can specify it in either field, but not in both.
Parameter Syntax
$result = $client->listUtteranceMetrics([ 'attributes' => [ [ 'name' => 'LastUsedIntent', // REQUIRED ], // ... ], 'binBy' => [ [ 'interval' => 'OneHour|OneDay', // REQUIRED 'name' => 'ConversationStartTime|UtteranceTimestamp', // REQUIRED 'order' => 'Ascending|Descending', ], // ... ], 'botId' => '<string>', // REQUIRED 'endDateTime' => <integer || string || DateTime>, // REQUIRED 'filters' => [ [ 'name' => 'BotAliasId|BotVersion|LocaleId|Modality|Channel|SessionId|OriginatingRequestId|UtteranceState|UtteranceText', // REQUIRED 'operator' => 'EQ|GT|LT', // REQUIRED 'values' => ['<string>', ...], // REQUIRED ], // ... ], 'groupBy' => [ [ 'name' => 'UtteranceText|UtteranceState', // REQUIRED ], // ... ], 'maxResults' => <integer>, 'metrics' => [ // REQUIRED [ 'name' => 'Count|Missed|Detected|UtteranceTimestamp', // REQUIRED 'order' => 'Ascending|Descending', 'statistic' => 'Sum|Avg|Max', // REQUIRED ], // ... ], 'nextToken' => '<string>', 'startDateTime' => <integer || string || DateTime>, // REQUIRED ]);
Parameter Details
Members
- attributes
-
- Type: Array of AnalyticsUtteranceAttribute structures
A list containing attributes related to the utterance that you want the response to return. The following attributes are possible:
-
LastUsedIntent
– The last used intent at the time of the utterance.
- binBy
-
- Type: Array of AnalyticsBinBySpecification structures
A list of objects, each of which contains specifications for organizing the results by time.
- botId
-
- Required: Yes
- Type: string
The identifier for the bot for which you want to retrieve utterance metrics.
- endDateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that marks the end of the range of time for which you want to see utterance metrics.
- filters
-
- Type: Array of AnalyticsUtteranceFilter structures
A list of objects, each of which describes a condition by which you want to filter the results.
- groupBy
-
- Type: Array of AnalyticsUtteranceGroupBySpecification structures
A list of objects, each of which specifies how to group the results. You can group by the following criteria:
-
UtteranceText
– The transcription of the utterance. -
UtteranceState
– The state of the utterance. The possible states are detailed in Key definitions in the user guide.
- maxResults
-
- Type: int
The maximum number of results to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
- metrics
-
- Required: Yes
- Type: Array of AnalyticsUtteranceMetric structures
A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
- nextToken
-
- Type: string
If the response from the ListUtteranceMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListUtteranceMetrics request to return the next page of results. For a complete set of results, call the ListUtteranceMetrics operation until the nextToken returned in the response is null.
- startDateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that marks the beginning of the range of time for which you want to see utterance metrics.
Result Syntax
[ 'botId' => '<string>', 'nextToken' => '<string>', 'results' => [ [ 'attributeResults' => [ [ 'lastUsedIntent' => '<string>', ], // ... ], 'binKeys' => [ [ 'name' => 'ConversationStartTime|UtteranceTimestamp', 'value' => <integer>, ], // ... ], 'groupByKeys' => [ [ 'name' => 'UtteranceText|UtteranceState', 'value' => '<string>', ], // ... ], 'metricsResults' => [ [ 'name' => 'Count|Missed|Detected|UtteranceTimestamp', 'statistic' => 'Sum|Avg|Max', 'value' => <float>, ], // ... ], ], // ... ], ]
Result Details
Members
- botId
-
- Type: string
The identifier for the bot for which you retrieved utterance metrics.
- nextToken
-
- Type: string
If the response from the ListUtteranceMetrics operation contains more results than specified in the maxResults parameter, a token is returned in the response.
Use the returned token in the nextToken parameter of a ListUtteranceMetrics request to return the next page of results. For a complete set of results, call the ListUtteranceMetrics operation until the nextToken returned in the response is null.
- results
-
- Type: Array of AnalyticsUtteranceResult structures
The results for the utterance metrics.
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.
- 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.
- ServiceQuotaExceededException:
You have reached a quota for your bot.
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
SearchAssociatedTranscripts
$result = $client->searchAssociatedTranscripts
([/* ... */]); $promise = $client->searchAssociatedTranscriptsAsync
([/* ... */]);
Search for associated transcripts that meet the specified criteria.
Parameter Syntax
$result = $client->searchAssociatedTranscripts([ 'botId' => '<string>', // REQUIRED 'botRecommendationId' => '<string>', // REQUIRED 'botVersion' => '<string>', // REQUIRED 'filters' => [ // REQUIRED [ 'name' => 'IntentId|SlotTypeId', // REQUIRED 'values' => ['<string>', ...], // REQUIRED ], // ... ], 'localeId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextIndex' => <integer>, 'searchOrder' => 'Ascending|Descending', ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The unique identifier of the bot associated with the transcripts that you are searching.
- botRecommendationId
-
- Required: Yes
- Type: string
The unique identifier of the bot recommendation associated with the transcripts to search.
- botVersion
-
- Required: Yes
- Type: string
The version of the bot containing the transcripts that you are searching.
- filters
-
- Required: Yes
- Type: Array of AssociatedTranscriptFilter structures
A list of filter objects.
- localeId
-
- Required: Yes
- Type: string
The identifier of the language and locale of the transcripts to search. The string must match one of the supported locales. For more information, see Supported languages
- maxResults
-
- Type: int
The maximum number of bot recommendations to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
- nextIndex
-
- Type: int
If the response from the SearchAssociatedTranscriptsRequest operation contains more results than specified in the maxResults parameter, an index is returned in the response. Use that index in the nextIndex parameter to return the next page of results.
- searchOrder
-
- Type: string
How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.
Result Syntax
[ 'associatedTranscripts' => [ [ 'transcript' => '<string>', ], // ... ], 'botId' => '<string>', 'botRecommendationId' => '<string>', 'botVersion' => '<string>', 'localeId' => '<string>', 'nextIndex' => <integer>, 'totalResults' => <integer>, ]
Result Details
Members
- associatedTranscripts
-
- Type: Array of AssociatedTranscript structures
The object that contains the associated transcript that meet the criteria you specified.
- botId
-
- Type: string
The unique identifier of the bot associated with the transcripts that you are searching.
- botRecommendationId
-
- Type: string
The unique identifier of the bot recommendation associated with the transcripts to search.
- botVersion
-
- Type: string
The version of the bot containing the transcripts that you are searching.
- localeId
-
- Type: string
The identifier of the language and locale of the transcripts to search. The string must match one of the supported locales. For more information, see Supported languages
- nextIndex
-
- Type: int
A index that indicates whether there are more results to return in a response to the SearchAssociatedTranscripts operation. If the nextIndex field is present, you send the contents as the nextIndex parameter of a SearchAssociatedTranscriptsRequest operation to get the next page of results.
- totalResults
-
- Type: int
The total number of transcripts returned by the search.
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.
- 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.
StartBotRecommendation
$result = $client->startBotRecommendation
([/* ... */]); $promise = $client->startBotRecommendationAsync
([/* ... */]);
Use this to provide your transcript data, and to start the bot recommendation process.
Parameter Syntax
$result = $client->startBotRecommendation([ 'botId' => '<string>', // REQUIRED 'botVersion' => '<string>', // REQUIRED 'encryptionSetting' => [ 'associatedTranscriptsPassword' => '<string>', 'botLocaleExportPassword' => '<string>', 'kmsKeyArn' => '<string>', ], 'localeId' => '<string>', // REQUIRED 'transcriptSourceSetting' => [ // REQUIRED 's3BucketTranscriptSource' => [ 'kmsKeyArn' => '<string>', 'pathFormat' => [ 'objectPrefixes' => ['<string>', ...], ], 's3BucketName' => '<string>', // REQUIRED 'transcriptFilter' => [ 'lexTranscriptFilter' => [ 'dateRangeFilter' => [ 'endDateTime' => <integer || string || DateTime>, // REQUIRED 'startDateTime' => <integer || string || DateTime>, // REQUIRED ], ], ], 'transcriptFormat' => 'Lex', // REQUIRED ], ], ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The unique identifier of the bot containing the bot recommendation.
- botVersion
-
- Required: Yes
- Type: string
The version of the bot containing the bot recommendation.
- encryptionSetting
-
- Type: EncryptionSetting structure
The object representing the passwords that will be used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.
- localeId
-
- Required: Yes
- Type: string
The identifier of the language and locale of the bot recommendation to start. The string must match one of the supported locales. For more information, see Supported languages
- transcriptSourceSetting
-
- Required: Yes
- Type: TranscriptSourceSetting structure
The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.
Result Syntax
[ 'botId' => '<string>', 'botRecommendationId' => '<string>', 'botRecommendationStatus' => 'Processing|Deleting|Deleted|Downloading|Updating|Available|Failed|Stopping|Stopped', 'botVersion' => '<string>', 'creationDateTime' => <DateTime>, 'encryptionSetting' => [ 'associatedTranscriptsPassword' => '<string>', 'botLocaleExportPassword' => '<string>', 'kmsKeyArn' => '<string>', ], 'localeId' => '<string>', 'transcriptSourceSetting' => [ 's3BucketTranscriptSource' => [ 'kmsKeyArn' => '<string>', 'pathFormat' => [ 'objectPrefixes' => ['<string>', ...], ], 's3BucketName' => '<string>', 'transcriptFilter' => [ 'lexTranscriptFilter' => [ 'dateRangeFilter' => [ 'endDateTime' => <DateTime>, 'startDateTime' => <DateTime>, ], ], ], 'transcriptFormat' => 'Lex', ], ], ]
Result Details
Members
- botId
-
- Type: string
The unique identifier of the bot containing the bot recommendation.
- botRecommendationId
-
- Type: string
The identifier of the bot recommendation that you have created.
- botRecommendationStatus
-
- Type: string
The status of the bot recommendation.
If the status is Failed, then the reasons for the failure are listed in the failureReasons field.
- botVersion
-
- Type: string
The version of the bot containing the bot recommendation.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp of the date and time that the bot recommendation was created.
- encryptionSetting
-
- Type: EncryptionSetting structure
The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.
- localeId
-
- Type: string
The identifier of the language and locale of the bot recommendation to start. The string must match one of the supported locales. For more information, see Supported languages
- transcriptSourceSetting
-
- Type: TranscriptSourceSetting structure
The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.
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.
- 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.
StartBotResourceGeneration
$result = $client->startBotResourceGeneration
([/* ... */]); $promise = $client->startBotResourceGenerationAsync
([/* ... */]);
Starts a request for the descriptive bot builder to generate a bot locale configuration based on the prompt you provide it. After you make this call, use the DescribeBotResourceGeneration
operation to check on the status of the generation and for the generatedBotLocaleUrl
when the generation is complete. Use that value to retrieve the Amazon S3 object containing the bot locale configuration. You can then modify and import this configuration.
Parameter Syntax
$result = $client->startBotResourceGeneration([ 'botId' => '<string>', // REQUIRED 'botVersion' => '<string>', // REQUIRED 'generationInputPrompt' => '<string>', // REQUIRED 'localeId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The unique identifier of the bot for which to generate intents and slot types.
- botVersion
-
- Required: Yes
- Type: string
The version of the bot for which to generate intents and slot types.
- generationInputPrompt
-
- Required: Yes
- Type: string
The prompt to generate intents and slot types for the bot locale. Your description should be both detailed and precise to help generate appropriate and sufficient intents for your bot. Include a list of actions to improve the intent creation process.
- localeId
-
- Required: Yes
- Type: string
The locale of the bot for which to generate intents and slot types.
Result Syntax
[ 'botId' => '<string>', 'botVersion' => '<string>', 'creationDateTime' => <DateTime>, 'generationId' => '<string>', 'generationInputPrompt' => '<string>', 'generationStatus' => 'Failed|Complete|InProgress', 'localeId' => '<string>', ]
Result Details
Members
- botId
-
- Type: string
The unique identifier of the bot for which the generation request was made.
- botVersion
-
- Type: string
The version of the bot for which the generation request was made.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time at which the generation request was made.
- generationId
-
- Type: string
The unique identifier of the generation request.
- generationInputPrompt
-
- Type: string
The prompt that was used generate intents and slot types for the bot locale.
- generationStatus
-
- Type: string
The status of the generation request.
- localeId
-
- Type: string
The locale of the bot for which the generation request was made.
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.
StartImport
$result = $client->startImport
([/* ... */]); $promise = $client->startImportAsync
([/* ... */]);
Starts importing a bot, bot locale, or custom vocabulary from a zip archive that you uploaded to an S3 bucket.
Parameter Syntax
$result = $client->startImport([ 'filePassword' => '<string>', 'importId' => '<string>', // REQUIRED 'mergeStrategy' => 'Overwrite|FailOnConflict|Append', // REQUIRED 'resourceSpecification' => [ // REQUIRED 'botImportSpecification' => [ 'botName' => '<string>', // REQUIRED 'botTags' => ['<string>', ...], 'dataPrivacy' => [ // REQUIRED 'childDirected' => true || false, // REQUIRED ], 'idleSessionTTLInSeconds' => <integer>, 'roleArn' => '<string>', // REQUIRED 'testBotAliasTags' => ['<string>', ...], ], 'botLocaleImportSpecification' => [ 'botId' => '<string>', // REQUIRED 'botVersion' => '<string>', // REQUIRED 'localeId' => '<string>', // REQUIRED 'nluIntentConfidenceThreshold' => <float>, 'voiceSettings' => [ 'engine' => 'standard|neural|long-form|generative', 'voiceId' => '<string>', // REQUIRED ], ], 'customVocabularyImportSpecification' => [ 'botId' => '<string>', // REQUIRED 'botVersion' => '<string>', // REQUIRED 'localeId' => '<string>', // REQUIRED ], 'testSetImportResourceSpecification' => [ 'description' => '<string>', 'importInputLocation' => [ // REQUIRED 's3BucketName' => '<string>', // REQUIRED 's3Path' => '<string>', // REQUIRED ], 'modality' => 'Text|Audio', // REQUIRED 'roleArn' => '<string>', // REQUIRED 'storageLocation' => [ // REQUIRED 'kmsKeyArn' => '<string>', 's3BucketName' => '<string>', // REQUIRED 's3Path' => '<string>', // REQUIRED ], 'testSetName' => '<string>', // REQUIRED 'testSetTags' => ['<string>', ...], ], ], ]);
Parameter Details
Members
- filePassword
-
- Type: string
The password used to encrypt the zip archive that contains the resource definition. You should always encrypt the zip archive to protect it during transit between your site and Amazon Lex.
- importId
-
- Required: Yes
- Type: string
The unique identifier for the import. It is included in the response from the CreateUploadUrl operation.
- mergeStrategy
-
- Required: Yes
- Type: string
The strategy to use when there is a name conflict between the imported resource and an existing resource. When the merge strategy is
FailOnConflict
existing resources are not overwritten and the import fails. - resourceSpecification
-
- Required: Yes
- Type: ImportResourceSpecification structure
Parameters for creating the bot, bot locale or custom vocabulary.
Result Syntax
[ 'creationDateTime' => <DateTime>, 'importId' => '<string>', 'importStatus' => 'InProgress|Completed|Failed|Deleting', 'mergeStrategy' => 'Overwrite|FailOnConflict|Append', 'resourceSpecification' => [ 'botImportSpecification' => [ 'botName' => '<string>', 'botTags' => ['<string>', ...], 'dataPrivacy' => [ 'childDirected' => true || false, ], 'idleSessionTTLInSeconds' => <integer>, 'roleArn' => '<string>', 'testBotAliasTags' => ['<string>', ...], ], 'botLocaleImportSpecification' => [ 'botId' => '<string>', 'botVersion' => '<string>', 'localeId' => '<string>', 'nluIntentConfidenceThreshold' => <float>, 'voiceSettings' => [ 'engine' => 'standard|neural|long-form|generative', 'voiceId' => '<string>', ], ], 'customVocabularyImportSpecification' => [ 'botId' => '<string>', 'botVersion' => '<string>', 'localeId' => '<string>', ], 'testSetImportResourceSpecification' => [ 'description' => '<string>', 'importInputLocation' => [ 's3BucketName' => '<string>', 's3Path' => '<string>', ], 'modality' => 'Text|Audio', 'roleArn' => '<string>', 'storageLocation' => [ 'kmsKeyArn' => '<string>', 's3BucketName' => '<string>', 's3Path' => '<string>', ], 'testSetName' => '<string>', 'testSetTags' => ['<string>', ...], ], ], ]
Result Details
Members
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the import request was created.
- importId
-
- Type: string
A unique identifier for the import.
- importStatus
-
- Type: string
The current status of the import. When the status is
Complete
the bot, bot alias, or custom vocabulary is ready to use. - mergeStrategy
-
- Type: string
The strategy used when there was a name conflict between the imported resource and an existing resource. When the merge strategy is
FailOnConflict
existing resources are not overwritten and the import fails. - resourceSpecification
-
- Type: ImportResourceSpecification structure
The parameters used when importing the resource.
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.
StartTestExecution
$result = $client->startTestExecution
([/* ... */]); $promise = $client->startTestExecutionAsync
([/* ... */]);
The action to start test set execution.
Parameter Syntax
$result = $client->startTestExecution([ 'apiMode' => 'Streaming|NonStreaming', // REQUIRED 'target' => [ // REQUIRED 'botAliasTarget' => [ 'botAliasId' => '<string>', // REQUIRED 'botId' => '<string>', // REQUIRED 'localeId' => '<string>', // REQUIRED ], ], 'testExecutionModality' => 'Text|Audio', 'testSetId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- apiMode
-
- Required: Yes
- Type: string
Indicates whether we use streaming or non-streaming APIs for the test set execution. For streaming, StartConversation Runtime API is used. Whereas, for non-streaming, RecognizeUtterance and RecognizeText Amazon Lex Runtime API are used.
- target
-
- Required: Yes
- Type: TestExecutionTarget structure
The target bot for the test set execution.
- testExecutionModality
-
- Type: string
Indicates whether audio or text is used.
- testSetId
-
- Required: Yes
- Type: string
The test set Id for the test set execution.
Result Syntax
[ 'apiMode' => 'Streaming|NonStreaming', 'creationDateTime' => <DateTime>, 'target' => [ 'botAliasTarget' => [ 'botAliasId' => '<string>', 'botId' => '<string>', 'localeId' => '<string>', ], ], 'testExecutionId' => '<string>', 'testExecutionModality' => 'Text|Audio', 'testSetId' => '<string>', ]
Result Details
Members
- apiMode
-
- Type: string
Indicates whether we use streaming or non-streaming APIs for the test set execution. For streaming, StartConversation Amazon Lex Runtime API is used. Whereas for non-streaming, RecognizeUtterance and RecognizeText Amazon Lex Runtime API are used.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation date and time for the test set execution.
- target
-
- Type: TestExecutionTarget structure
The target bot for the test set execution.
- testExecutionId
-
- Type: string
The unique identifier of the test set execution.
- testExecutionModality
-
- Type: string
Indicates whether audio or text is used.
- testSetId
-
- Type: string
The test set Id for the test set execution.
Errors
- ThrottlingException:
Your request rate is too high. Reduce the frequency of requests.
- ServiceQuotaExceededException:
You have reached a quota for your bot.
- ResourceNotFoundException:
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
- 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.
StartTestSetGeneration
$result = $client->startTestSetGeneration
([/* ... */]); $promise = $client->startTestSetGenerationAsync
([/* ... */]);
The action to start the generation of test set.
Parameter Syntax
$result = $client->startTestSetGeneration([ 'description' => '<string>', 'generationDataSource' => [ // REQUIRED 'conversationLogsDataSource' => [ 'botAliasId' => '<string>', // REQUIRED 'botId' => '<string>', // REQUIRED 'filter' => [ // REQUIRED 'endTime' => <integer || string || DateTime>, // REQUIRED 'inputMode' => 'Speech|Text', // REQUIRED 'startTime' => <integer || string || DateTime>, // REQUIRED ], 'localeId' => '<string>', // REQUIRED ], ], 'roleArn' => '<string>', // REQUIRED 'storageLocation' => [ // REQUIRED 'kmsKeyArn' => '<string>', 's3BucketName' => '<string>', // REQUIRED 's3Path' => '<string>', // REQUIRED ], 'testSetName' => '<string>', // REQUIRED 'testSetTags' => ['<string>', ...], ]);
Parameter Details
Members
- description
-
- Type: string
The test set description for the test set generation request.
- generationDataSource
-
- Required: Yes
- Type: TestSetGenerationDataSource structure
The data source for the test set generation.
- roleArn
-
- Required: Yes
- Type: string
The roleARN used for any operation in the test set to access resources in the Amazon Web Services account.
- storageLocation
-
- Required: Yes
- Type: TestSetStorageLocation structure
The Amazon S3 storage location for the test set generation.
- testSetName
-
- Required: Yes
- Type: string
The test set name for the test set generation request.
- testSetTags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A list of tags to add to the test set. You can only add tags when you import/generate a new test set. You can't use the
UpdateTestSet
operation to update tags. To update tags, use theTagResource
operation.
Result Syntax
[ 'creationDateTime' => <DateTime>, 'description' => '<string>', 'generationDataSource' => [ 'conversationLogsDataSource' => [ 'botAliasId' => '<string>', 'botId' => '<string>', 'filter' => [ 'endTime' => <DateTime>, 'inputMode' => 'Speech|Text', 'startTime' => <DateTime>, ], 'localeId' => '<string>', ], ], 'roleArn' => '<string>', 'storageLocation' => [ 'kmsKeyArn' => '<string>', 's3BucketName' => '<string>', 's3Path' => '<string>', ], 'testSetGenerationId' => '<string>', 'testSetGenerationStatus' => 'Generating|Ready|Failed|Pending', 'testSetName' => '<string>', 'testSetTags' => ['<string>', ...], ]
Result Details
Members
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation date and time for the test set generation.
- description
-
- Type: string
The description used for the test set generation.
- generationDataSource
-
- Type: TestSetGenerationDataSource structure
The data source for the test set generation.
- roleArn
-
- Type: string
The roleARN used for any operation in the test set to access resources in the Amazon Web Services account.
- storageLocation
-
- Type: TestSetStorageLocation structure
The Amazon S3 storage location for the test set generation.
- testSetGenerationId
-
- Type: string
The unique identifier of the test set generation to describe.
- testSetGenerationStatus
-
- Type: string
The status for the test set generation.
- testSetName
-
- Type: string
The test set name used for the test set generation.
- testSetTags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A list of tags that was used for the test set that is being 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.
- 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.
- 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.
StopBotRecommendation
$result = $client->stopBotRecommendation
([/* ... */]); $promise = $client->stopBotRecommendationAsync
([/* ... */]);
Stop an already running Bot Recommendation request.
Parameter Syntax
$result = $client->stopBotRecommendation([ 'botId' => '<string>', // REQUIRED 'botRecommendationId' => '<string>', // REQUIRED 'botVersion' => '<string>', // REQUIRED 'localeId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The unique identifier of the bot containing the bot recommendation to be stopped.
- botRecommendationId
-
- Required: Yes
- Type: string
The unique identifier of the bot recommendation to be stopped.
- botVersion
-
- Required: Yes
- Type: string
The version of the bot containing the bot recommendation.
- localeId
-
- Required: Yes
- Type: string
The identifier of the language and locale of the bot recommendation to stop. The string must match one of the supported locales. For more information, see Supported languages
Result Syntax
[ 'botId' => '<string>', 'botRecommendationId' => '<string>', 'botRecommendationStatus' => 'Processing|Deleting|Deleted|Downloading|Updating|Available|Failed|Stopping|Stopped', 'botVersion' => '<string>', 'localeId' => '<string>', ]
Result Details
Members
- botId
-
- Type: string
The unique identifier of the bot containing the bot recommendation that is being stopped.
- botRecommendationId
-
- Type: string
The unique identifier of the bot recommendation that is being stopped.
- botRecommendationStatus
-
- Type: string
The status of the bot recommendation. If the status is Failed, then the reasons for the failure are listed in the failureReasons field.
- botVersion
-
- Type: string
The version of the bot containing the recommendation that is being stopped.
- localeId
-
- Type: string
The identifier of the language and locale of the bot response to stop. The string must match one of the supported locales. For more information, see Supported languages
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.
- 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.
TagResource
$result = $client->tagResource
([/* ... */]); $promise = $client->tagResourceAsync
([/* ... */]);
Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value.
Parameter Syntax
$result = $client->tagResource([ 'resourceARN' => '<string>', // REQUIRED 'tags' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- resourceARN
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the bot, bot alias, or bot channel to tag.
- tags
-
- Required: Yes
- Type: Associative array of custom strings keys (TagKey) to strings
A list of tag keys to add to the resource. If a tag key already exists, the existing value is replaced with the new value.
Result Syntax
[]
Result Details
Errors
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
- ThrottlingException:
Your request rate is too high. Reduce the frequency of requests.
- ResourceNotFoundException:
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
- ValidationException:
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
UntagResource
$result = $client->untagResource
([/* ... */]); $promise = $client->untagResourceAsync
([/* ... */]);
Removes tags from a bot, bot alias, or bot channel.
Parameter Syntax
$result = $client->untagResource([ 'resourceARN' => '<string>', // REQUIRED 'tagKeys' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- resourceARN
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource to remove the tags from.
- tagKeys
-
- Required: Yes
- Type: Array of strings
A list of tag keys to remove from the resource. If a tag key does not exist on the resource, it is ignored.
Result Syntax
[]
Result Details
Errors
- InternalServerException:
The service encountered an unexpected condition. Try your request again.
- ThrottlingException:
Your request rate is too high. Reduce the frequency of requests.
- ResourceNotFoundException:
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
- ValidationException:
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
UpdateBot
$result = $client->updateBot
([/* ... */]); $promise = $client->updateBotAsync
([/* ... */]);
Updates the configuration of an existing bot.
Parameter Syntax
$result = $client->updateBot([ 'botId' => '<string>', // REQUIRED 'botMembers' => [ [ 'botMemberAliasId' => '<string>', // REQUIRED 'botMemberAliasName' => '<string>', // REQUIRED 'botMemberId' => '<string>', // REQUIRED 'botMemberName' => '<string>', // REQUIRED 'botMemberVersion' => '<string>', // REQUIRED ], // ... ], 'botName' => '<string>', // REQUIRED 'botType' => 'Bot|BotNetwork', 'dataPrivacy' => [ // REQUIRED 'childDirected' => true || false, // REQUIRED ], 'description' => '<string>', 'idleSessionTTLInSeconds' => <integer>, // REQUIRED 'roleArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The unique identifier of the bot to update. This identifier is returned by the CreateBot operation.
- botMembers
-
- Type: Array of BotMember structures
The list of bot members in the network associated with the update action.
- botName
-
- Required: Yes
- Type: string
The new name of the bot. The name must be unique in the account that creates the bot.
- botType
-
- Type: string
The type of the bot to be updated.
- 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.
- 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 permissions to access the bot.
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', 'botType' => 'Bot|BotNetwork', 'creationDateTime' => <DateTime>, 'dataPrivacy' => [ 'childDirected' => true || false, ], 'description' => '<string>', 'idleSessionTTLInSeconds' => <integer>, 'lastUpdatedDateTime' => <DateTime>, 'roleArn' => '<string>', ]
Result Details
Members
- botId
-
- Type: string
The unique identifier of the bot that was updated.
- botMembers
-
- Type: Array of BotMember structures
The list of bot members in the network that was updated.
- botName
-
- Type: string
The name of the bot after the update.
- 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. - botType
-
- Type: string
The type of the bot that was updated.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp of the date and time that the bot was created.
- dataPrivacy
-
- Type: DataPrivacy structure
The data privacy settings for the bot after the update.
- description
-
- Type: string
The description of the bot after the update.
- idleSessionTTLInSeconds
-
- Type: int
The session timeout, in seconds, for the bot after the update.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp of the date and time that the bot was last updated.
- roleArn
-
- Type: string
The Amazon Resource Name (ARN) of the IAM role used by the bot after the update.
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.
UpdateBotAlias
$result = $client->updateBotAlias
([/* ... */]); $promise = $client->updateBotAliasAsync
([/* ... */]);
Updates the configuration of an existing bot alias.
Parameter Syntax
$result = $client->updateBotAlias([ 'botAliasId' => '<string>', // REQUIRED '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 ], ]);
Parameter Details
Members
- botAliasId
-
- Required: Yes
- Type: string
The unique identifier of the bot alias.
- botAliasLocaleSettings
-
- Type: Associative array of custom strings keys (LocaleId) to BotAliasLocaleSettings structures
The new Lambda functions to use in each locale for the bot alias.
- botAliasName
-
- Required: Yes
- Type: string
The new name to assign to the bot alias.
- botId
-
- Required: Yes
- Type: string
The identifier of the bot with the updated alias.
- botVersion
-
- Type: string
The new bot version to assign to the bot alias.
- conversationLogSettings
-
- Type: ConversationLogSettings structure
The new settings for storing conversation logs in Amazon CloudWatch Logs and Amazon S3 buckets.
- description
-
- Type: string
The new description to assign to the bot alias.
- sentimentAnalysisSettings
-
- Type: SentimentAnalysisSettings structure
Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
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>', 'lastUpdatedDateTime' => <DateTime>, 'sentimentAnalysisSettings' => [ 'detectSentiment' => true || false, ], ]
Result Details
Members
- botAliasId
-
- Type: string
The identifier of the updated bot alias.
- botAliasLocaleSettings
-
- Type: Associative array of custom strings keys (LocaleId) to BotAliasLocaleSettings structures
The updated Lambda functions to use in each locale for the bot alias.
- botAliasName
-
- Type: string
The updated name of the bot alias.
- botAliasStatus
-
- Type: string
The current status of the bot alias. When the status is
Available
the alias is ready for use. - botId
-
- Type: string
The identifier of the bot with the updated alias.
- botVersion
-
- Type: string
The updated version of the bot that the alias points to.
- conversationLogSettings
-
- Type: ConversationLogSettings structure
The updated settings for storing conversation logs in Amazon CloudWatch Logs and Amazon S3 buckets.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp of the date and time that the bot was created.
- description
-
- Type: string
The updated description of the bot alias.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp of the date and time that the bot was last updated.
- sentimentAnalysisSettings
-
- Type: SentimentAnalysisSettings structure
Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
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.
UpdateBotLocale
$result = $client->updateBotLocale
([/* ... */]); $promise = $client->updateBotLocaleAsync
([/* ... */]);
Updates the settings that a bot has for a specific locale.
Parameter Syntax
$result = $client->updateBotLocale([ '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 unique identifier of the bot that contains the locale.
- botVersion
-
- Required: Yes
- Type: string
The version of the bot that contains the locale to be updated. The version can only be the
DRAFT
version. - description
-
- Type: string
The new description of the locale.
- generativeAISettings
-
- Type: GenerativeAISettings structure
Contains settings for generative AI features powered by Amazon Bedrock for your bot locale. Use this object to turn generative AI features on and off. Pricing may differ if you turn a feature on. For more information, see LINK.
- localeId
-
- Required: Yes
- Type: string
The identifier of the language and locale to update. The string must match one of the supported locales. For more information, see Supported languages.
- nluIntentConfidenceThreshold
-
- Required: Yes
- Type: double
The new confidence threshold where Amazon Lex inserts the
AMAZON.FallbackIntent
andAMAZON.KendraSearchIntent
intents in the list of possible intents for an utterance. - voiceSettings
-
- Type: VoiceSettings structure
The new Amazon Polly voice Amazon Lex should use 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>', 'failureReasons' => ['<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, ], ], ], 'lastUpdatedDateTime' => <DateTime>, 'localeId' => '<string>', 'localeName' => '<string>', 'nluIntentConfidenceThreshold' => <float>, 'recommendedActions' => ['<string>', ...], 'voiceSettings' => [ 'engine' => 'standard|neural|long-form|generative', 'voiceId' => '<string>', ], ]
Result Details
Members
- botId
-
- Type: string
The identifier of the bot that contains the updated locale.
- botLocaleStatus
-
- Type: string
The current status of the locale. When the bot status is
Built
the locale is ready for use. - botVersion
-
- Type: string
The version of the bot that contains the updated locale.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp of the date and time that the locale was created.
- description
-
- Type: string
The updated description of the locale.
- failureReasons
-
- Type: Array of strings
If the
botLocaleStatus
isFailed
, thefailureReasons
field lists the errors that occurred while building the bot. - generativeAISettings
-
- Type: GenerativeAISettings structure
Contains settings for generative AI features powered by Amazon Bedrock for your bot locale.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp of the date and time that the locale was last updated.
- localeId
-
- Type: string
The language and locale of the updated bot locale.
- localeName
-
- Type: string
The updated locale name for the locale.
- nluIntentConfidenceThreshold
-
- Type: double
The updated confidence threshold for inserting the
AMAZON.FallbackIntent
andAMAZON.KendraSearchIntent
intents in the list of possible intents for an utterance. - recommendedActions
-
- Type: Array of strings
Recommended actions to take to resolve an error in the
failureReasons
field. - voiceSettings
-
- Type: VoiceSettings structure
The updated Amazon Polly voice to use 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.
UpdateBotRecommendation
$result = $client->updateBotRecommendation
([/* ... */]); $promise = $client->updateBotRecommendationAsync
([/* ... */]);
Updates an existing bot recommendation request.
Parameter Syntax
$result = $client->updateBotRecommendation([ 'botId' => '<string>', // REQUIRED 'botRecommendationId' => '<string>', // REQUIRED 'botVersion' => '<string>', // REQUIRED 'encryptionSetting' => [ // REQUIRED 'associatedTranscriptsPassword' => '<string>', 'botLocaleExportPassword' => '<string>', 'kmsKeyArn' => '<string>', ], 'localeId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The unique identifier of the bot containing the bot recommendation to be updated.
- botRecommendationId
-
- Required: Yes
- Type: string
The unique identifier of the bot recommendation to be updated.
- botVersion
-
- Required: Yes
- Type: string
The version of the bot containing the bot recommendation to be updated.
- encryptionSetting
-
- Required: Yes
- Type: EncryptionSetting structure
The object representing the passwords that will be used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.
- localeId
-
- Required: Yes
- Type: string
The identifier of the language and locale of the bot recommendation to update. The string must match one of the supported locales. For more information, see Supported languages
Result Syntax
[ 'botId' => '<string>', 'botRecommendationId' => '<string>', 'botRecommendationStatus' => 'Processing|Deleting|Deleted|Downloading|Updating|Available|Failed|Stopping|Stopped', 'botVersion' => '<string>', 'creationDateTime' => <DateTime>, 'encryptionSetting' => [ 'associatedTranscriptsPassword' => '<string>', 'botLocaleExportPassword' => '<string>', 'kmsKeyArn' => '<string>', ], 'lastUpdatedDateTime' => <DateTime>, 'localeId' => '<string>', 'transcriptSourceSetting' => [ 's3BucketTranscriptSource' => [ 'kmsKeyArn' => '<string>', 'pathFormat' => [ 'objectPrefixes' => ['<string>', ...], ], 's3BucketName' => '<string>', 'transcriptFilter' => [ 'lexTranscriptFilter' => [ 'dateRangeFilter' => [ 'endDateTime' => <DateTime>, 'startDateTime' => <DateTime>, ], ], ], 'transcriptFormat' => 'Lex', ], ], ]
Result Details
Members
- botId
-
- Type: string
The unique identifier of the bot containing the bot recommendation that has been updated.
- botRecommendationId
-
- Type: string
The unique identifier of the bot recommendation to be updated.
- botRecommendationStatus
-
- Type: string
The status of the bot recommendation.
If the status is Failed, then the reasons for the failure are listed in the failureReasons field.
- botVersion
-
- Type: string
The version of the bot containing the bot recommendation that has been updated.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp of the date and time that the bot recommendation was created.
- encryptionSetting
-
- Type: EncryptionSetting structure
The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp of the date and time that the bot recommendation was last updated.
- localeId
-
- Type: string
The identifier of the language and locale of the bot recommendation to update. The string must match one of the supported locales. For more information, see Supported languages
- transcriptSourceSetting
-
- Type: TranscriptSourceSetting structure
The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.
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.
- 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.
UpdateExport
$result = $client->updateExport
([/* ... */]); $promise = $client->updateExportAsync
([/* ... */]);
Updates the password used to protect an export zip archive.
The password is not required. If you don't supply a password, Amazon Lex generates a zip file that is not protected by a password. This is the archive that is available at the pre-signed S3 URL provided by the DescribeExport operation.
Parameter Syntax
$result = $client->updateExport([ 'exportId' => '<string>', // REQUIRED 'filePassword' => '<string>', ]);
Parameter Details
Members
- exportId
-
- Required: Yes
- Type: string
The unique identifier Amazon Lex assigned to the export.
- filePassword
-
- Type: string
The new password to use to encrypt the export zip archive.
Result Syntax
[ 'creationDateTime' => <DateTime>, 'exportId' => '<string>', 'exportStatus' => 'InProgress|Completed|Failed|Deleting', 'fileFormat' => 'LexJson|TSV|CSV', 'lastUpdatedDateTime' => <DateTime>, '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 export was created.
- exportId
-
- Type: string
The unique identifier Amazon Lex assigned to the export.
- exportStatus
-
- Type: string
The status of the export. When the status is
Completed
the export archive is available for download. - fileFormat
-
- Type: string
The file format used for the files that define the resource. The
TSV
format is required to export a custom vocabulary only; otherwise useLexJson
format. - lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the export was last updated.
- 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.
UpdateIntent
$result = $client->updateIntent
([/* ... */]); $promise = $client->updateIntentAsync
([/* ... */]);
Updates the settings for an intent.
Parameter Syntax
$result = $client->updateIntent([ '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 ], ], // ... ], ], ], 'intentId' => '<string>', // REQUIRED 'intentName' => '<string>', // REQUIRED 'kendraConfiguration' => [ 'kendraIndex' => '<string>', // REQUIRED 'queryFilterString' => '<string>', 'queryFilterStringEnabled' => true || false, ], 'localeId' => '<string>', // REQUIRED 'outputContexts' => [ [ 'name' => '<string>', // REQUIRED 'timeToLiveInSeconds' => <integer>, // REQUIRED 'turnsToLive' => <integer>, // REQUIRED ], // ... ], 'parentIntentSignature' => '<string>', '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 ], // ... ], 'slotPriorities' => [ [ 'priority' => <integer>, // REQUIRED 'slotId' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- botId
-
- Required: Yes
- Type: string
The identifier of the bot that contains the intent.
- botVersion
-
- Required: Yes
- Type: string
The version of the bot that contains the intent. Must be
DRAFT
. - description
-
- Type: string
The new description of the intent.
- dialogCodeHook
-
- Type: DialogCodeHookSettings structure
The new Lambda function to use between each turn of the conversation with the bot.
- fulfillmentCodeHook
-
- Type: FulfillmentCodeHookSettings structure
The new Lambda function to call when all of the intents required slots are provided and the intent is ready for fulfillment.
- initialResponseSetting
-
- Type: InitialResponseSetting structure
Configuration settings for a response sent to the user before Amazon Lex starts eliciting slots.
- inputContexts
-
- Type: Array of InputContext structures
A new list of contexts that must be active in order for Amazon Lex to consider the intent.
- intentClosingSetting
-
- Type: IntentClosingSetting structure
The new response that Amazon Lex sends the user when the intent is closed.
- intentConfirmationSetting
-
- Type: IntentConfirmationSetting structure
New prompts that Amazon Lex sends to the user to confirm the completion of an intent.
- intentId
-
- Required: Yes
- Type: string
The unique identifier of the intent to update.
- intentName
-
- Required: Yes
- Type: string
The new name for the intent.
- kendraConfiguration
-
- Type: KendraConfiguration structure
New configuration settings for connecting to an Amazon Kendra index.
- localeId
-
- Required: Yes
- Type: string
The identifier of the language and locale where this intent is used. The string must match one of the supported locales. For more information, see Supported languages.
- outputContexts
-
- Type: Array of OutputContext structures
A new list of contexts that Amazon Lex activates when the intent is fulfilled.
- parentIntentSignature
-
- Type: string
The signature of the new built-in intent to use as the parent of this intent.
- 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
New utterances used to invoke the intent.
- slotPriorities
-
- Type: Array of SlotPriority structures
A new list of slots and their priorities that are contained by the intent.
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, ], 'lastUpdatedDateTime' => <DateTime>, '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>', ], // ... ], 'slotPriorities' => [ [ 'priority' => <integer>, 'slotId' => '<string>', ], // ... ], ]
Result Details
Members
- botId
-
- Type: string
The identifier of the bot that contains the intent.
- botVersion
-
- Type: string
The version of the bot that contains the intent. Will always be
DRAFT
. - creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp of when the intent was created.
- description
-
- Type: string
The updated description of the intent.
- dialogCodeHook
-
- Type: DialogCodeHookSettings structure
The updated Lambda function called during each turn of the conversation with the user.
- fulfillmentCodeHook
-
- Type: FulfillmentCodeHookSettings structure
The updated Lambda function called when the intent is ready for fulfillment.
- initialResponseSetting
-
- Type: InitialResponseSetting structure
Configuration settings for a response sent to the user before Amazon Lex starts eliciting slots.
- inputContexts
-
- Type: Array of InputContext structures
The updated list of contexts that must be active for the intent to be considered by Amazon Lex.
- intentClosingSetting
-
- Type: IntentClosingSetting structure
The updated response that Amazon Lex sends the user when the intent is closed.
- intentConfirmationSetting
-
- Type: IntentConfirmationSetting structure
The updated prompts that Amazon Lex sends to the user to confirm the completion of an intent.
- intentId
-
- Type: string
The identifier of the intent that was updated.
- intentName
-
- Type: string
The updated name of the intent.
- kendraConfiguration
-
- Type: KendraConfiguration structure
The updated configuration for connecting to an Amazon Kendra index with the
AMAZON.KendraSearchIntent
intent. - lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp of the last time that the intent was modified.
- localeId
-
- Type: string
The updated language and locale of the intent.
- outputContexts
-
- Type: Array of OutputContext structures
The updated list of contexts that Amazon Lex activates when the intent is fulfilled.
- parentIntentSignature
-
- Type: string
The updated built-in intent that is the parent of this intent.
- qnAIntentConfiguration
-
- Type: QnAIntentConfiguration structure
Details about the configuration of the built-in
Amazon.QnAIntent
. - sampleUtterances
-
- Type: Array of SampleUtterance structures
The updated list of sample utterances for the intent.
- slotPriorities
-
- Type: Array of SlotPriority structures
The updated list of slots and their priorities that are elicited from the user 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.
UpdateResourcePolicy
$result = $client->updateResourcePolicy
([/* ... */]); $promise = $client->updateResourcePolicyAsync
([/* ... */]);
Replaces the existing resource policy for a bot or bot alias with a new one. If the policy doesn't exist, Amazon Lex returns an exception.
Parameter Syntax
$result = $client->updateResourcePolicy([ 'expectedRevisionId' => '<string>', 'policy' => '<string>', // REQUIRED 'resourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- expectedRevisionId
-
- Type: string
The identifier of the revision of the policy to update. 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.
- 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 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.
- 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.
UpdateSlot
$result = $client->updateSlot
([/* ... */]); $promise = $client->updateSlotAsync
([/* ... */]);
Updates the settings for a slot.
Parameter Syntax
$result = $client->updateSlot([ 'botId' => '<string>', // REQUIRED 'botVersion' => '<string>', // REQUIRED 'description' => '<string>', 'intentId' => '<string>', // REQUIRED 'localeId' => '<string>', // REQUIRED 'multipleValuesSetting' => [ 'allowMultipleValues' => true || false, ], 'obfuscationSetting' => [ 'obfuscationSettingType' => 'None|DefaultObfuscation', // REQUIRED ], 'slotId' => '<string>', // 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 unique identifier of the bot that contains the slot.
- botVersion
-
- Required: Yes
- Type: string
The version of the bot that contains the slot. Must always be
DRAFT
. - description
-
- Type: string
The new description for the slot.
- 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 contains the slot. The string must match one of the supported locales. For more information, see Supported languages.
- multipleValuesSetting
-
- Type: MultipleValuesSetting structure
Determines whether the slot accepts multiple values in one response. Multiple value slots are only available in the en-US locale. If you set this value to
true
in any other locale, Amazon Lex throws aValidationException
.If the
multipleValuesSetting
is not set, the default value isfalse
. - obfuscationSetting
-
- Type: ObfuscationSetting structure
New settings that determine how slot values are formatted in Amazon CloudWatch logs.
- slotId
-
- Required: Yes
- Type: string
The unique identifier for the slot to update.
- slotName
-
- Required: Yes
- Type: string
The new name for the slot.
- slotTypeId
-
- Type: string
The unique identifier of the new slot type to associate with this slot.
- subSlotSetting
-
- Type: SubSlotSetting structure
Specifications for the constituent sub slots and the expression for the composite slot.
- valueElicitationSetting
-
- Required: Yes
- Type: SlotValueElicitationSetting structure
A new set of prompts that Amazon Lex sends to the user to elicit a response the provides a value for the slot.
Result Syntax
[ 'botId' => '<string>', 'botVersion' => '<string>', 'creationDateTime' => <DateTime>, 'description' => '<string>', 'intentId' => '<string>', 'lastUpdatedDateTime' => <DateTime>, '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 identifier of the bot that contains the slot.
- botVersion
-
- Type: string
The version of the bot that contains the slot. Will always be
DRAFT
. - 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 updated description of the bot.
- intentId
-
- Type: string
The intent that contains the slot.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of the date and time that the slot was last updated.
- localeId
-
- Type: string
The locale that contains the slot.
- multipleValuesSetting
-
- Type: MultipleValuesSetting structure
Indicates whether the slot accepts multiple values in one response.
- obfuscationSetting
-
- Type: ObfuscationSetting structure
The updated setting that determines whether the slot value is obfuscated in the Amazon CloudWatch logs.
- slotId
-
- Type: string
The unique identifier of the slot that was updated.
- slotName
-
- Type: string
The updated name of the slot.
- slotTypeId
-
- Type: string
The updated identifier of the slot type that provides values for the slot.
- subSlotSetting
-
- Type: SubSlotSetting structure
Specifications for the constituent sub slots and the expression for the composite slot.
- valueElicitationSetting
-
- Type: SlotValueElicitationSetting structure
The updated prompts that Amazon Lex sends to the user to elicit a response that provides a value 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.
UpdateSlotType
$result = $client->updateSlotType
([/* ... */]); $promise = $client->updateSlotTypeAsync
([/* ... */]);
Updates the configuration of an existing slot type.
Parameter Syntax
$result = $client->updateSlotType([ '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>', 'slotTypeId' => '<string>', // REQUIRED '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 that contains the slot type.
- botVersion
-
- Required: Yes
- Type: string
The version of the bot that contains the slot type. Must be
DRAFT
. - compositeSlotTypeSetting
-
- Type: CompositeSlotTypeSetting structure
Specifications for a composite slot type.
- description
-
- Type: string
The new description of the slot type.
- externalSourceSetting
-
- Type: ExternalSourceSetting structure
Provides information about the external source of the slot type's definition.
- localeId
-
- Required: Yes
- Type: string
The identifier of the language and locale that contains the slot type. The string must match one of the supported locales. For more information, see Supported languages.
- parentSlotTypeSignature
-
- Type: string
The new built-in slot type that should be used as the parent of this slot type.
- slotTypeId
-
- Required: Yes
- Type: string
The unique identifier of the slot type to update.
- slotTypeName
-
- Required: Yes
- Type: string
The new name of the slot type.
- slotTypeValues
-
- Type: Array of SlotTypeValue structures
A new list of values and their optional synonyms that define the values that the slot type can take.
- valueSelectionSetting
-
- Type: SlotValueSelectionSetting structure
The strategy that Amazon Lex should use when deciding on a value from the list of slot type values.
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>', ], ], ], 'lastUpdatedDateTime' => <DateTime>, '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 of the bot that contains the slot type.
- botVersion
-
- Type: string
The version of the bot that contains the slot type. This is always
DRAFT
. - compositeSlotTypeSetting
-
- Type: CompositeSlotTypeSetting structure
Specifications for a composite slot type.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of the date and time that the slot type was created.
- description
-
- Type: string
The updated description of the slot type.
- externalSourceSetting
-
- Type: ExternalSourceSetting structure
Provides information about the external source of the slot type's definition.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp of the date and time that the slot type was last updated.
- localeId
-
- Type: string
The language and locale of the updated slot type.
- parentSlotTypeSignature
-
- Type: string
The updated signature of the built-in slot type that is the parent of this slot type.
- slotTypeId
-
- Type: string
The unique identifier of the updated slot type.
- slotTypeName
-
- Type: string
The updated name of the slot type.
- slotTypeValues
-
- Type: Array of SlotTypeValue structures
The updated values that the slot type provides.
- valueSelectionSetting
-
- Type: SlotValueSelectionSetting structure
The updated strategy that Amazon Lex uses to determine which value to select from the slot type.
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.
UpdateTestSet
$result = $client->updateTestSet
([/* ... */]); $promise = $client->updateTestSetAsync
([/* ... */]);
The action to update the test set.
Parameter Syntax
$result = $client->updateTestSet([ 'description' => '<string>', 'testSetId' => '<string>', // REQUIRED 'testSetName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- description
-
- Type: string
The new test set description.
- testSetId
-
- Required: Yes
- Type: string
The test set Id for which update test operation to be performed.
- testSetName
-
- Required: Yes
- Type: string
The new test set name.
Result Syntax
[ 'creationDateTime' => <DateTime>, 'description' => '<string>', 'lastUpdatedDateTime' => <DateTime>, 'modality' => 'Text|Audio', 'numTurns' => <integer>, 'roleArn' => '<string>', 'status' => 'Importing|PendingAnnotation|Deleting|ValidationError|Ready', 'storageLocation' => [ 'kmsKeyArn' => '<string>', 's3BucketName' => '<string>', 's3Path' => '<string>', ], 'testSetId' => '<string>', 'testSetName' => '<string>', ]
Result Details
Members
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation date and time for the updated test set.
- description
-
- Type: string
The test set description for the updated test set.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time of the last update for the updated test set.
- modality
-
- Type: string
Indicates whether audio or text is used for the updated test set.
- numTurns
-
- Type: int
The number of conversation turns from the updated test set.
- roleArn
-
- Type: string
The roleARN used for any operation in the test set to access resources in the Amazon Web Services account.
- status
-
- Type: string
The status for the updated test set.
- storageLocation
-
- Type: TestSetStorageLocation structure
The Amazon S3 storage location for the updated test set.
- testSetId
-
- Type: string
The test set Id for which update test operation to be performed.
- testSetName
-
- Type: string
The test set name for the updated test set.
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.
Shapes
ActiveContext
Description
The active context used in the test execution.
Members
- name
-
- Required: Yes
- Type: string
The name of active context.
AdvancedRecognitionSetting
Description
Provides settings that enable advanced recognition settings for slot values.
Members
- audioRecognitionStrategy
-
- Type: string
Enables using the slot values as a custom vocabulary for recognizing user utterances.
AgentTurnResult
Description
The information about the agent turn in a test set execution.
Members
- actualAgentPrompt
-
- Type: string
The actual agent prompt for the agent turn in a test set execution.
- actualElicitedSlot
-
- Type: string
The actual elicited slot for the agent turn in a test set execution.
- actualIntent
-
- Type: string
The actual intent for the agent turn in a test set execution.
- errorDetails
-
- Type: ExecutionErrorDetails structure
Details about an error in an execution of a test set.
- expectedAgentPrompt
-
- Required: Yes
- Type: string
The expected agent prompt for the agent turn in a test set execution.
AgentTurnSpecification
Description
The specification of an agent turn.
Members
- agentPrompt
-
- Required: Yes
- Type: string
The agent prompt for the agent turn in a test set.
AggregatedUtterancesFilter
Description
Filters responses returned by the ListAggregatedUtterances
operation.
Members
- name
-
- Required: Yes
- Type: string
The name of the field to filter the utterance list.
- operator
-
- Required: Yes
- Type: string
The operator to use for the filter. Specify
EQ
when theListAggregatedUtterances
operation should return only utterances that equal the specified value. SpecifyCO
when theListAggregatedUtterances
operation should return utterances that contain the specified value. - values
-
- Required: Yes
- Type: Array of strings
The value to use for filtering the list of bots.
AggregatedUtterancesSortBy
Description
Specifies attributes for sorting a list of utterances.
Members
- attribute
-
- Required: Yes
- Type: string
The utterance attribute to sort by.
- order
-
- Required: Yes
- Type: string
Specifies whether to sort the aggregated utterances in ascending or descending order.
AggregatedUtterancesSummary
Description
Provides summary information for aggregated utterances. The ListAggregatedUtterances
operations combines all instances of the same utterance into a single aggregated summary.
Members
- containsDataFromDeletedResources
-
- Type: boolean
Aggregated utterance data may contain utterances from versions of your bot that have since been deleted. When the aggregated contains this kind of data, this field is set to true.
- hitCount
-
- Type: int
The number of times that the utterance was detected by Amazon Lex during the time period. When an utterance is detected, it activates an intent or a slot.
- missedCount
-
- Type: int
The number of times that the utterance was missed by Amazon Lex An utterance is missed when it doesn't activate an intent or slot.
- utterance
-
- Type: string
The text of the utterance. If the utterance was used with the
RecognizeUtterance
operation, the text is the transcription of the audio utterance. - utteranceFirstRecordedInAggregationDuration
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the utterance was first recorded in the time window for aggregation. An utterance may have been sent to Amazon Lex before that time, but only utterances within the time window are counted.
- utteranceLastRecordedInAggregationDuration
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last date and time that an utterance was recorded in the time window for aggregation. An utterance may be sent to Amazon Lex after that time, but only utterances within the time window are counted.
AllowedInputTypes
Description
Specifies the allowed input types.
Members
- allowAudioInput
-
- Required: Yes
- Type: boolean
Indicates whether audio input is allowed.
- allowDTMFInput
-
- Required: Yes
- Type: boolean
Indicates whether DTMF input is allowed.
AnalyticsBinBySpecification
Description
Contains the time metric, interval, and method by which to bin the analytics data.
Members
- interval
-
- Required: Yes
- Type: string
Specifies the interval of time by which to bin the analytics data.
- name
-
- Required: Yes
- Type: string
Specifies the time metric by which to bin the analytics data.
- order
-
- Type: string
Specifies whether to bin the analytics data in ascending or descending order. If this field is left blank, the default order is by the key of the bin in descending order.
AnalyticsBinKey
Description
An object containing the criterion by which to bin the results and the value that defines that bin.
Members
- name
-
- Type: string
The criterion by which to bin the results.
- value
-
- Type: long (int|float)
The value of the criterion that defines the bin.
AnalyticsIntentFilter
Description
Contains fields describing a condition by which to filter the intents. The expression may be understood as name
operator
values
. For example:
-
IntentName CO Book
– The intent name contains the string "Book." -
BotVersion EQ 2
– The bot version is equal to two.
The operators that each filter supports are listed below:
-
BotAlias
–EQ
. -
BotVersion
–EQ
. -
LocaleId
–EQ
. -
Modality
–EQ
. -
Channel
–EQ
. -
SessionId
–EQ
. -
OriginatingRequestId
–EQ
. -
IntentName
–EQ
,CO
. -
IntentEndState
–EQ
,CO
.
Members
- name
-
- Required: Yes
- Type: string
The category by which to filter the intents. The descriptions for each option are as follows:
-
BotAlias
– The name of the bot alias. -
BotVersion
– The version of the bot. -
LocaleId
– The locale of the bot. -
Modality
– The modality of the session with the bot (audio, DTMF, or text). -
Channel
– The channel that the bot is integrated with. -
SessionId
– The identifier of the session with the bot. -
OriginatingRequestId
– The identifier of the first request in a session. -
IntentName
– The name of the intent. -
IntentEndState
– The final state of the intent.
- operator
-
- Required: Yes
- Type: string
The operation by which to filter the category. The following operations are possible:
-
CO
– Contains -
EQ
– Equals -
GT
– Greater than -
LT
– Less than
The operators that each filter supports are listed below:
-
BotAlias
–EQ
. -
BotVersion
–EQ
. -
LocaleId
–EQ
. -
Modality
–EQ
. -
Channel
–EQ
. -
SessionId
–EQ
. -
OriginatingRequestId
–EQ
. -
IntentName
–EQ
,CO
. -
IntentEndState
–EQ
,CO
.
- values
-
- Required: Yes
- Type: Array of strings
An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is
EQ
orCO
. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if thename
,operator
, andvalues
fields areModality
,EQ
, and[Speech, Text]
, the operation filters for results where the modality was eitherSpeech
orText
.
AnalyticsIntentGroupByKey
Description
Contains the category by which the intent analytics were grouped and a member of that category.
Members
- name
-
- Type: string
A category by which the intent analytics were grouped.
- value
-
- Type: string
A member of the category by which the intent analytics were grouped.
AnalyticsIntentGroupBySpecification
Description
Contains the category by which to group the intents.
Members
- name
-
- Required: Yes
- Type: string
Specifies whether to group the intent stages by their name or their end state.
AnalyticsIntentMetric
Description
Contains the metric and the summary statistic you want to calculate, and the order in which to sort the results, for the intents in the bot.
Members
- name
-
- Required: Yes
- Type: string
The metric for which you want to get intent summary statistics.
-
Count
– The number of times the intent was invoked. -
Success
– The number of times the intent succeeded. -
Failure
– The number of times the intent failed. -
Switched
– The number of times there was a switch to a different intent. -
Dropped
– The number of times the user dropped the intent.
- order
-
- Type: string
Specifies whether to sort the results in ascending or descending order.
- statistic
-
- Required: Yes
- Type: string
The summary statistic to calculate.
-
Sum
– The total count for the category you provide inname
. -
Average
– The total count divided by the number of intents in the category you provide inname
. -
Max
– The highest count in the category you provide inname
.
AnalyticsIntentMetricResult
Description
An object containing the results for the intent metric you requested.
Members
- name
-
- Type: string
The metric that you requested. See Key definitions for more details about these metrics.
-
Count
– The number of times the intent was invoked. -
Success
– The number of times the intent succeeded. -
Failure
– The number of times the intent failed. -
Switched
– The number of times there was a switch to a different intent. -
Dropped
– The number of times the user dropped the intent.
- statistic
-
- Type: string
The statistic that you requested to calculate.
-
Sum
– The total count for the category you provide inname
. -
Average
– The total count divided by the number of intents in the category you provide inname
. -
Max
– The highest count in the category you provide inname
.
- value
-
- Type: double
The value of the summary statistic for the metric that you requested.
AnalyticsIntentNodeSummary
Description
An object containing information about the requested path.
Members
- intentCount
-
- Type: int
The total number of sessions that follow the given path to the given intent.
- intentLevel
-
- Type: int
The number of intents up to and including the requested path.
- intentName
-
- Type: string
The name of the intent at the end of the requested path.
- intentPath
-
- Type: string
The path.
- nodeType
-
- Type: string
Specifies whether the node is the end of a path (
Exit
) or not (Inner
).
AnalyticsIntentResult
Description
An object containing the results for the intent metrics you requested and the bin and/or group(s) they refer to, if applicable.
Members
- binKeys
-
- Type: Array of AnalyticsBinKey structures
A list of objects containing the criteria you requested for binning results and the values of the bins.
- groupByKeys
-
- Type: Array of AnalyticsIntentGroupByKey structures
A list of objects containing the criteria you requested for grouping results and the values of the groups.
- metricsResults
-
- Type: Array of AnalyticsIntentMetricResult structures
A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
AnalyticsIntentStageFilter
Description
Contains fields describing a condition by which to filter the intent stages. The expression may be understood as name
operator
values
. For example:
-
IntentName CO Book
– The intent name contains the string "Book." -
BotVersion EQ 2
– The bot version is equal to two.
The operators that each filter supports are listed below:
-
BotAlias
–EQ
. -
BotVersion
–EQ
. -
LocaleId
–EQ
. -
Modality
–EQ
. -
Channel
–EQ
. -
SessionId
–EQ
. -
OriginatingRequestId
–EQ
. -
IntentName
–EQ
,CO
. -
IntentStageName
–EQ
,CO
.
Members
- name
-
- Required: Yes
- Type: string
The category by which to filter the intent stages. The descriptions for each option are as follows:
-
BotAlias
– The name of the bot alias. -
BotVersion
– The version of the bot. -
LocaleId
– The locale of the bot. -
Modality
– The modality of the session with the bot (audio, DTMF, or text). -
Channel
– The channel that the bot is integrated with. -
SessionId
– The identifier of the session with the bot. -
OriginatingRequestId
– The identifier of the first request in a session. -
IntentName
– The name of the intent. -
IntentStageName
– The stage in the intent.
- operator
-
- Required: Yes
- Type: string
The operation by which to filter the category. The following operations are possible:
-
CO
– Contains -
EQ
– Equals -
GT
– Greater than -
LT
– Less than
The operators that each filter supports are listed below:
-
BotAlias
–EQ
. -
BotVersion
–EQ
. -
LocaleId
–EQ
. -
Modality
–EQ
. -
Channel
–EQ
. -
SessionId
–EQ
. -
OriginatingRequestId
–EQ
. -
IntentName
–EQ
,CO
. -
IntentStageName
–EQ
,CO
.
- values
-
- Required: Yes
- Type: Array of strings
An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is
EQ
orCO
. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if thename
,operator
, andvalues
fields areModality
,EQ
, and[Speech, Text]
, the operation filters for results where the modality was eitherSpeech
orText
.
AnalyticsIntentStageGroupByKey
Description
Contains the category by which the intent stage analytics and the values for that category were grouped.
Members
- name
-
- Type: string
A category by which the intent stage analytics were grouped.
- value
-
- Type: string
A member of the category by which the intent stage analytics were grouped.
AnalyticsIntentStageGroupBySpecification
Description
Contains the category by which to group the intent stages.
Members
- name
-
- Required: Yes
- Type: string
Specifies whether to group the intent stages by their name or the intent to which the session was switched.
AnalyticsIntentStageMetric
Description
Contains the metric and the summary statistic you want to calculate, and the order in which to sort the results, for the intent stages across the user sessions with the bot.
Members
- name
-
- Required: Yes
- Type: string
The metric for which you want to get intent stage summary statistics. See Key definitions for more details about these metrics.
-
Count
– The number of times the intent stage occurred. -
Success
– The number of times the intent stage succeeded. -
Failure
– The number of times the intent stage failed. -
Dropped
– The number of times the user dropped the intent stage. -
Retry
– The number of times the bot tried to elicit a response from the user at this stage.
- order
-
- Type: string
Specifies whether to sort the results in ascending or descending order of the summary statistic (
value
in the response). - statistic
-
- Required: Yes
- Type: string
The summary statistic to calculate.
-
Sum
– The total count for the category you provide inname
. -
Average
– The total count divided by the number of intent stages in the category you provide inname
. -
Max
– The highest count in the category you provide inname
.
AnalyticsIntentStageMetricResult
Description
An object containing the results for an intent stage metric you requested.
Members
- name
-
- Type: string
The metric that you requested.
-
Count
– The number of times the intent stage occurred. -
Success
– The number of times the intent stage succeeded. -
Failure
– The number of times the intent stage failed. -
Dropped
– The number of times the user dropped the intent stage. -
Retry
– The number of times the bot tried to elicit a response from the user at this stage.
- statistic
-
- Type: string
The summary statistic that you requested to calculate.
-
Sum
– The total count for the category you provide inname
. -
Average
– The total count divided by the number of intent stages in the category you provide inname
. -
Max
– The highest count in the category you provide inname
.
- value
-
- Type: double
The value of the summary statistic for the metric that you requested.
AnalyticsIntentStageResult
Description
An object containing the results for the intent stage metrics you requested and the bin and/or group they refer to, if applicable.
Members
- binKeys
-
- Type: Array of AnalyticsBinKey structures
A list of objects containing the criteria you requested for binning results and the values of the bins.
- groupByKeys
-
- Type: Array of AnalyticsIntentStageGroupByKey structures
A list of objects containing the criteria you requested for grouping results and the values of the bins.
- metricsResults
-
- Type: Array of AnalyticsIntentStageMetricResult structures
A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
AnalyticsPathFilter
Description
Contains fields describing a condition by which to filter the paths. The expression may be understood as name
operator
values
. For example:
-
LocaleId EQ en
– The locale is "en". -
BotVersion EQ 2
– The bot version is equal to two.
The operators that each filter supports are listed below:
-
BotAlias
–EQ
. -
BotVersion
–EQ
. -
LocaleId
–EQ
. -
Modality
–EQ
. -
Channel
–EQ
.
Members
- name
-
- Required: Yes
- Type: string
The category by which to filter the intent paths. The descriptions for each option are as follows:
-
BotAlias
– The name of the bot alias. -
BotVersion
– The version of the bot. -
LocaleId
– The locale of the bot. -
Modality
– The modality of the session with the bot (audio, DTMF, or text). -
Channel
– The channel that the bot is integrated with.
- operator
-
- Required: Yes
- Type: string
The operation by which to filter the category. The following operations are possible:
-
CO
– Contains -
EQ
– Equals -
GT
– Greater than -
LT
– Less than
The operators that each filter supports are listed below:
-
BotAlias
–EQ
. -
BotVersion
–EQ
. -
LocaleId
–EQ
. -
Modality
–EQ
. -
Channel
–EQ
.
- values
-
- Required: Yes
- Type: Array of strings
An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is
EQ
orCO
. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if thename
,operator
, andvalues
fields areModality
,EQ
, and[Speech, Text]
, the operation filters for results where the modality was eitherSpeech
orText
.
AnalyticsSessionFilter
Description
Contains fields describing a condition by which to filter the sessions. The expression may be understood as name
operator
values
. For example:
-
LocaleId EQ en
– The locale is "en". -
Duration GT 200
– The duration is greater than 200 seconds.
The operators that each filter supports are listed below:
-
BotAlias
–EQ
. -
BotVersion
–EQ
. -
LocaleId
–EQ
. -
Modality
–EQ
. -
Channel
–EQ
. -
Duration
–EQ
,GT
,LT
. -
conversationEndState
–EQ
,CO
. -
SessionId
–EQ
. -
OriginatingRequestId
–EQ
. -
IntentPath
–EQ
.
Members
- name
-
- Required: Yes
- Type: string
The category by which to filter the sessions. The descriptions for each option are as follows:
-
BotAlias
– The name of the bot alias. -
BotVersion
– The version of the bot. -
LocaleId
– The locale of the bot. -
Modality
– The modality of the session with the bot (audio, DTMF, or text). -
Channel
– The channel that the bot is integrated with. -
Duration
– The duration of the session. -
conversationEndState
– The final state of the session. -
SessionId
– The identifier of the session with the bot. -
OriginatingRequestId
– The identifier of the first request in a session. -
IntentPath
– The order of intents taken in a session.
- operator
-
- Required: Yes
- Type: string
The operation by which to filter the category. The following operations are possible:
-
CO
– Contains -
EQ
– Equals -
GT
– Greater than -
LT
– Less than
The operators that each filter supports are listed below:
-
BotAlias
–EQ
. -
BotVersion
–EQ
. -
LocaleId
–EQ
. -
Modality
–EQ
. -
Channel
–EQ
. -
Duration
–EQ
,GT
,LT
. -
conversationEndState
–EQ
,CO
. -
SessionId
–EQ
. -
OriginatingRequestId
–EQ
. -
IntentPath
–EQ
.
- values
-
- Required: Yes
- Type: Array of strings
An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is
EQ
orCO
. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if thename
,operator
, andvalues
fields areModality
,EQ
, and[Speech, Text]
, the operation filters for results where the modality was eitherSpeech
orText
.
AnalyticsSessionGroupByKey
Description
Contains the category by which the session analytics were grouped and a member of that category.
Members
- name
-
- Type: string
The category by which the session analytics were grouped.
- value
-
- Type: string
A member of the category by which the session analytics were grouped.
AnalyticsSessionGroupBySpecification
Description
Contains the category by which to group the sessions.
Members
- name
-
- Required: Yes
- Type: string
Specifies whether to group the session by their end state or their locale.
AnalyticsSessionMetric
Description
Contains the metric and the summary statistic you want to calculate, and the order in which to sort the results, for the user sessions with the bot.
Members
- name
-
- Required: Yes
- Type: string
The metric for which you want to get session summary statistics.
-
Count
– The number of sessions. -
Success
– The number of sessions that succeeded. -
Failure
– The number of sessions that failed. -
Dropped
– The number of sessions that the user dropped. -
Duration
– The duration of sessions. -
TurnsPerSession
– The number of turns in the sessions. -
Concurrency
– The number of sessions occurring in the same period of time.
- order
-
- Type: string
Specifies whether to sort the results in ascending or descending order.
- statistic
-
- Required: Yes
- Type: string
The summary statistic to calculate.
-
Sum
– The total count for the category you provide inname
. -
Average
– The total count divided by the number of sessions in the category you provide inname
. -
Max
– The highest count in the category you provide inname
.
AnalyticsSessionMetricResult
Description
An object containing the results for a session metric you requested.
Members
- name
-
- Type: string
The metric that you requested.
-
Count
– The number of sessions. -
Success
– The number of sessions that succeeded. -
Failure
– The number of sessions that failed. -
Dropped
– The number of sessions that the user dropped. -
Duration
– The duration of sessions. -
TurnPersession
– The number of turns in the sessions. -
Concurrency
– The number of sessions occurring in the same period of time.
- statistic
-
- Type: string
The summary statistic that you requested to calculate.
-
Sum
– The total count for the category you provide inname
. -
Average
– The total count divided by the number of sessions in the category you provide inname
. -
Max
– The highest count in the category you provide inname
.
- value
-
- Type: double
The value of the summary statistic for the metric that you requested.
AnalyticsSessionResult
Description
An object containing the results for the session metrics you requested and the bin and/or group(s) they refer to, if applicable.
Members
- binKeys
-
- Type: Array of AnalyticsBinKey structures
A list of objects containing the criteria you requested for binning results and the values of the bins.
- groupByKeys
-
- Type: Array of AnalyticsSessionGroupByKey structures
A list of objects containing the criteria you requested for grouping results and the values of the bins.
- metricsResults
-
- Type: Array of AnalyticsSessionMetricResult structures
A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
AnalyticsUtteranceAttribute
Description
An object that specifies the last used intent at the time of the utterance as an attribute to return.
Members
- name
-
- Required: Yes
- Type: string
An attribute to return. The only available attribute is the intent that the bot mapped the utterance to.
AnalyticsUtteranceAttributeResult
Description
An object containing the intent that the bot mapped the utterance to.
Members
- lastUsedIntent
-
- Type: string
The intent that the bot mapped the utterance to.
AnalyticsUtteranceFilter
Description
Contains fields describing a condition by which to filter the utterances. The expression may be understood as name
operator
values
. For example:
-
LocaleId EQ Book
– The locale is the string "en". -
UtteranceText CO help
– The text of the utterance contains the string "help".
The operators that each filter supports are listed below:
-
BotAlias
–EQ
. -
BotVersion
–EQ
. -
LocaleId
–EQ
. -
Modality
–EQ
. -
Channel
–EQ
. -
SessionId
–EQ
. -
OriginatingRequestId
–EQ
. -
UtteranceState
–EQ
. -
UtteranceText
–EQ
,CO
.
Members
- name
-
- Required: Yes
- Type: string
The category by which to filter the utterances. The descriptions for each option are as follows:
-
BotAlias
– The name of the bot alias. -
BotVersion
– The version of the bot. -
LocaleId
– The locale of the bot. -
Modality
– The modality of the session with the bot (audio, DTMF, or text). -
Channel
– The channel that the bot is integrated with. -
SessionId
– The identifier of the session with the bot. -
OriginatingRequestId
– The identifier of the first request in a session. -
UtteranceState
– The state of the utterance. -
UtteranceText
– The text in the utterance.
- operator
-
- Required: Yes
- Type: string
The operation by which to filter the category. The following operations are possible:
-
CO
– Contains -
EQ
– Equals -
GT
– Greater than -
LT
– Less than
The operators that each filter supports are listed below:
-
BotAlias
–EQ
. -
BotVersion
–EQ
. -
LocaleId
–EQ
. -
Modality
–EQ
. -
Channel
–EQ
. -
SessionId
–EQ
. -
OriginatingRequestId
–EQ
. -
UtteranceState
–EQ
. -
UtteranceText
–EQ
,CO
.
- values
-
- Required: Yes
- Type: Array of strings
An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is
EQ
orCO
. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if thename
,operator
, andvalues
fields areModality
,EQ
, and[Speech, Text]
, the operation filters for results where the modality was eitherSpeech
orText
.
AnalyticsUtteranceGroupByKey
Description
Contains the category by which the utterance analytics were grouped and the values for that category.
Members
- name
-
- Type: string
The category by which the utterance analytics were grouped.
- value
-
- Type: string
A member of the category by which the utterance analytics were grouped.
AnalyticsUtteranceGroupBySpecification
Description
Contains the category by which to group the utterances.
Members
- name
-
- Required: Yes
- Type: string
Specifies whether to group the utterances by their text or their state.
AnalyticsUtteranceMetric
Description
Contains the metric and the summary statistic you want to calculate, and the order in which to sort the results, for the utterances across the user sessions with the bot.
Members
- name
-
- Required: Yes
- Type: string
The metric for which you want to get utterance summary statistics.
-
Count
– The number of utterances. -
Missed
– The number of utterances that Amazon Lex failed to recognize. -
Detected
– The number of utterances that Amazon Lex managed to detect. -
UtteranceTimestamp
– The date and time of the utterance.
- order
-
- Type: string
Specifies whether to sort the results in ascending or descending order.
- statistic
-
- Required: Yes
- Type: string
The summary statistic to calculate.
-
Sum
– The total count for the category you provide inname
. -
Average
– The total count divided by the number of utterances in the category you provide inname
. -
Max
– The highest count in the category you provide inname
.
AnalyticsUtteranceMetricResult
Description
An object containing the results for the utterance metric you requested.
Members
- name
-
- Type: string
The metric that you requested.
-
Count
– The number of utterances. -
Missed
– The number of utterances that Amazon Lex failed to recognize. -
Detected
– The number of utterances that Amazon Lex managed to detect. -
UtteranceTimestamp
– The date and time of the utterance.
- statistic
-
- Type: string
The summary statistic that you requested to calculate.
-
Sum
– The total count for the category you provide inname
. -
Average
– The total count divided by the number of utterances in the category you provide inname
. -
Max
– The highest count in the category you provide inname
.
- value
-
- Type: double
The value of the summary statistic for the metric that you requested.
AnalyticsUtteranceResult
Description
An object containing the results for the utterance metrics you requested and the bin and/or group(s) they refer to, if applicable.
Members
- attributeResults
-
- Type: Array of AnalyticsUtteranceAttributeResult structures
A list of objects containing information about the last used intent at the time of an utterance.
- binKeys
-
- Type: Array of AnalyticsBinKey structures
A list of objects containing the criteria you requested for binning results and the values of the bins.
- groupByKeys
-
- Type: Array of AnalyticsUtteranceGroupByKey structures
A list of objects containing the criteria you requested for grouping results and the values of the bins.
- metricsResults
-
- Type: Array of AnalyticsUtteranceMetricResult structures
A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.
AssociatedTranscript
Description
The object containing information that associates the recommended intent/slot type with a conversation.
Members
- transcript
-
- Type: string
The content of the transcript that meets the search filter criteria. For the JSON format of the transcript, see Output transcript format.
AssociatedTranscriptFilter
Description
Filters to search for the associated transcript.
Members
- name
-
- Required: Yes
- Type: string
The name of the field to use for filtering. The allowed names are IntentId and SlotTypeId.
- values
-
- Required: Yes
- Type: Array of strings
The values to use to filter the transcript.
AudioAndDTMFInputSpecification
Description
Specifies the audio and DTMF input specification.
Members
- audioSpecification
-
- Type: AudioSpecification structure
Specifies the settings on audio input.
- dtmfSpecification
-
- Type: DTMFSpecification structure
Specifies the settings on DTMF input.
- startTimeoutMs
-
- Required: Yes
- Type: int
Time for which a bot waits before assuming that the customer isn't going to speak or press a key. This timeout is shared between Audio and DTMF inputs.
AudioLogDestination
Description
The location of audio log files collected when conversation logging is enabled for a bot.
Members
- s3Bucket
-
- Required: Yes
- Type: S3BucketLogDestination structure
The Amazon S3 bucket where the audio log files are stored. The IAM role specified in the
roleArn
parameter of the CreateBot operation must have permission to write to this bucket.
AudioLogSetting
Description
Settings for logging audio of conversations between Amazon Lex and a user. You specify whether to log audio and the Amazon S3 bucket where the audio file is stored.
Members
- destination
-
- Required: Yes
- Type: AudioLogDestination structure
The location of audio log files collected when conversation logging is enabled for a bot.
- enabled
-
- Required: Yes
- Type: boolean
Determines whether audio logging in enabled for the bot.
- selectiveLoggingEnabled
-
- Type: boolean
The option to enable selective conversation log capture for audio.
AudioSpecification
Description
Specifies the audio input specifications.
Members
- endTimeoutMs
-
- Required: Yes
- Type: int
Time for which a bot waits after the customer stops speaking to assume the utterance is finished.
- maxLengthMs
-
- Required: Yes
- Type: int
Time for how long Amazon Lex waits before speech input is truncated and the speech is returned to application.
BedrockGuardrailConfiguration
Description
The details on the Bedrock guardrail configuration.
Members
- identifier
-
- Required: Yes
- Type: string
The unique guardrail id for the Bedrock guardrail configuration.
- version
-
- Required: Yes
- Type: string
The guardrail version for the Bedrock guardrail configuration.
BedrockKnowledgeStoreConfiguration
Description
Contains details about the configuration of a Amazon Bedrock knowledge base.
Members
- bedrockKnowledgeBaseArn
-
- Required: Yes
- Type: string
The base ARN of the knowledge base used.
- exactResponse
-
- Type: boolean
Specifies whether to return an exact response, or to return an answer generated by the model, using the fields you specify from the database.
- exactResponseFields
-
- Type: BedrockKnowledgeStoreExactResponseFields structure
Contains the names of the fields used for an exact response to the user.
BedrockKnowledgeStoreExactResponseFields
Description
The exact response fields given by the Bedrock knowledge store.
Members
- answerField
-
- Type: string
The answer field used for an exact response from Bedrock Knowledge Store.
BedrockModelSpecification
Description
Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
Members
- customPrompt
-
- Type: string
The custom prompt used in the Bedrock model specification details.
- guardrail
-
- Type: BedrockGuardrailConfiguration structure
The guardrail configuration in the Bedrock model specification details.
- modelArn
-
- Required: Yes
- Type: string
The ARN of the foundation model used in descriptive bot building.
- traceStatus
-
- Type: string
The Bedrock trace status in the Bedrock model specification details.
BotAliasHistoryEvent
Description
Provides a record of an event that affects a bot alias. For example, when the version of a bot that the alias points to changes.
Members
- botVersion
-
- Type: string
The version of the bot that was used in the event.
- endDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the event ended.
- startDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the event started.
BotAliasLocaleSettings
Description
Specifies settings that are unique to a locale. For example, you can use different Lambda function depending on the bot's locale.
Members
- codeHookSpecification
-
- Type: CodeHookSpecification structure
Specifies the Lambda function that should be used in the locale.
- enabled
-
- Required: Yes
- Type: boolean
Determines whether the locale is enabled for the bot. If the value is
false
, the locale isn't available for use.
BotAliasReplicaSummary
Description
Contains information about all the aliases replication statuses applicable for global resiliency.
Members
- botAliasId
-
- Type: string
The bot alias ID for all the alias bot replications.
- botAliasReplicationStatus
-
- Type: string
The replication statuses for all the alias bot replications.
- botVersion
-
- Type: string
The bot version for all the alias bot replications.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation time and date for all the alias bot replications.
- failureReasons
-
- Type: Array of strings
The reasons for failure for the aliases bot replications.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time and date updated for all the alias bot replications.
BotAliasSummary
Description
Summary information about bot aliases returned from the ListBotAliases operation.
Members
- botAliasId
-
- Type: string
The unique identifier assigned to the bot alias. You can use this ID to get detailed information about the alias using the DescribeBotAlias operation.
- botAliasName
-
- Type: string
The name of the bot alias.
- botAliasStatus
-
- Type: string
The current state of the bot alias. If the status is
Available
, the alias is ready for use. - botVersion
-
- Type: string
The version of the bot that the bot alias references.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp of the date and time that the bot alias was created.
- description
-
- Type: string
The description of the bot alias.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp of the date and time that the bot alias was last updated.
BotAliasTestExecutionTarget
Description
The target Amazon S3 location for the test set execution using a bot alias.
Members
- botAliasId
-
- Required: Yes
- Type: string
The bot alias Id of the bot alias used in the test set execution.
- botId
-
- Required: Yes
- Type: string
The bot Id of the bot alias used in the test set execution.
- localeId
-
- Required: Yes
- Type: string
The locale Id of the bot alias used in the test set execution.
BotExportSpecification
Description
Provides the identity of a the bot that was exported.
Members
- botId
-
- Required: Yes
- Type: string
The identifier of the bot assigned by Amazon Lex.
- botVersion
-
- Required: Yes
- Type: string
The version of the bot that was exported. This will be either
DRAFT
or the version number.
BotFilter
Description
Filters the responses returned by the ListBots
operation.
Members
- name
-
- Required: Yes
- Type: string
The name of the field to filter the list of bots.
- operator
-
- Required: Yes
- Type: string
The operator to use for the filter. Specify
EQ
when theListBots
operation should return only aliases that equal the specified value. SpecifyCO
when theListBots
operation should return aliases that contain the specified value. - values
-
- Required: Yes
- Type: Array of strings
The value to use for filtering the list of bots.
BotImportSpecification
Description
Provides the bot parameters required for importing a bot.
Members
- botName
-
- Required: Yes
- Type: string
The name that Amazon Lex should use for 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 import a bot. You can't use the
UpdateBot
operation to update tags. To update tags, use theTagResource
operation. - dataPrivacy
-
- Required: Yes
- Type: DataPrivacy structure
By default, data stored by Amazon Lex is encrypted. The
DataPrivacy
structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot. - idleSessionTTLInSeconds
-
- 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 the IAM role used to build and run 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 import a bot. You can't use the
UpdateAlias
operation to update tags. To update tags on the test alias, use theTagResource
operation.
BotLocaleExportSpecification
Description
Provides the bot locale parameters required for exporting a bot locale.
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 export.
- localeId
-
- Required: Yes
- Type: string
The identifier of the language and locale to export. The string must match one of the locales in the bot.
BotLocaleFilter
Description
Filters responses returned by the ListBotLocales
operation.
Members
- name
-
- Required: Yes
- Type: string
The name of the field to filter the list of bots.
- operator
-
- Required: Yes
- Type: string
The operator to use for the filter. Specify
EQ
when theListBotLocales
operation should return only aliases that equal the specified value. SpecifyCO
when theListBotLocales
operation should return aliases that contain the specified value. - values
-
- Required: Yes
- Type: Array of strings
The value to use for filtering the list of bots.
BotLocaleHistoryEvent
Description
Provides information about an event that occurred affecting the bot locale.
Members
- event
-
- Required: Yes
- Type: string
A description of the event that occurred.
- eventDate
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp of the date and time that the event occurred.
BotLocaleImportSpecification
Description
Provides the bot locale parameters required for importing a bot locale.
Members
- botId
-
- Required: Yes
- Type: string
The identifier of the bot to import the locale to.
- botVersion
-
- Required: Yes
- Type: string
The version of the bot to import the locale to. 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.
- nluIntentConfidenceThreshold
-
- 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 thePostText
operation would be:-
AMAZON.FallbackIntent
-
IntentA
-
IntentB
-
IntentC
- voiceSettings
-
- Type: VoiceSettings structure
Defines settings for using an Amazon Polly voice to communicate with a user.
Valid values include:
-
standard
-
neural
-
long-form
-
generative
BotLocaleSortBy
Description
Specifies attributes for sorting a list of bot locales.
Members
- attribute
-
- Required: Yes
- Type: string
The bot locale attribute to sort by.
- order
-
- Required: Yes
- Type: string
Specifies whether to sort the bot locales in ascending or descending order.
BotLocaleSummary
Description
Summary information about bot locales returned by the ListBotLocales operation.
Members
- botLocaleStatus
-
- Type: string
The current status of the bot locale. When the status is
Built
the locale is ready for use. - description
-
- Type: string
The description of the bot locale.
- lastBuildSubmittedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp of the date and time that the bot locale was last built.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp of the date and time that the bot locale was last updated.
- localeId
-
- Type: string
The language and locale of the bot locale.
- localeName
-
- Type: string
The name of the bot locale.
BotMember
Description
A bot that is a member of a network of bots.
Members
- botMemberAliasId
-
- Required: Yes
- Type: string
The alias ID of a bot that is a member of this network of bots.
- botMemberAliasName
-
- Required: Yes
- Type: string
The alias name of a bot that is a member of this network of bots.
- botMemberId
-
- Required: Yes
- Type: string
The unique ID of a bot that is a member of this network of bots.
- botMemberName
-
- Required: Yes
- Type: string
The unique name of a bot that is a member of this network of bots.
- botMemberVersion
-
- Required: Yes
- Type: string
The version of a bot that is a member of this network of bots.
BotRecommendationResultStatistics
Description
A statistical summary of the bot recommendation results.
Members
- intents
-
- Type: IntentStatistics structure
Statistical information about about the intents associated with the bot recommendation results.
- slotTypes
-
- Type: SlotTypeStatistics structure
Statistical information about the slot types associated with the bot recommendation results.
BotRecommendationResults
Description
The object representing the URL of the bot definition, the URL of the associated transcript, and a statistical summary of the bot recommendation results.
Members
- associatedTranscriptsUrl
-
- Type: string
The presigned url link of the associated transcript.
- botLocaleExportUrl
-
- Type: string
The presigned URL link of the recommended bot definition.
- statistics
-
- Type: BotRecommendationResultStatistics structure
The statistical summary of the bot recommendation results.
BotRecommendationSummary
Description
A summary of the bot recommendation.
Members
- botRecommendationId
-
- Required: Yes
- Type: string
The unique identifier of the bot recommendation to be updated.
- botRecommendationStatus
-
- Required: Yes
- Type: string
The status of the bot recommendation.
If the status is Failed, then the reasons for the failure are listed in the failureReasons field.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp of the date and time that the bot recommendation was created.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp of the date and time that the bot recommendation was last updated.
BotReplicaSummary
Description
Contains summary information about all the replication statuses applicable for global resiliency.
Members
- botReplicaStatus
-
- Type: string
The operation status for the replicated bot applicable.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation time and date for the replicated bots.
- failureReasons
-
- Type: Array of strings
The reasons for the failure for the replicated bot.
- replicaRegion
-
- Type: string
The replica region used in the replication statuses summary.
BotSortBy
Description
Specifies attributes for sorting a list of bots.
Members
- attribute
-
- Required: Yes
- Type: string
The attribute to use to sort the list of bots.
- order
-
- Required: Yes
- Type: string
The order to sort the list. You can choose ascending or descending.
BotSummary
Description
Summary information about a bot returned by the ListBots operation.
Members
- botId
-
- Type: string
The unique identifier assigned to the bot. Use this ID to get detailed information about the bot with the DescribeBot operation.
- botName
-
- Type: string
The name of the bot.
- botStatus
-
- Type: string
The current status of the bot. When the status is
Available
the bot is ready for use. - botType
-
- Type: string
The type of the bot.
- description
-
- Type: string
The description of the bot.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the bot was last updated.
- latestBotVersion
-
- Type: string
The latest numerical version in use for the bot.
BotVersionLocaleDetails
Description
The version of a bot used for a bot locale.
Members
- sourceBotVersion
-
- Required: Yes
- Type: string
The version of a bot used for a bot locale.
BotVersionReplicaSortBy
Description
The sort category for the version replicated bots.
Members
- attribute
-
- Required: Yes
- Type: string
The attribute of the sort category for the version replicated bots.
- order
-
- Required: Yes
- Type: string
The order of the sort category for the version replicated bots.
BotVersionReplicaSummary
Description
Contains summary information for all the version replication statuses applicable for Global resiliency.
Members
- botVersion
-
- Type: string
The bot version for the summary information for all the version replication statuses.
- botVersionReplicationStatus
-
- Type: string
The version replication status for all the replicated bots.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The creation date and time of the replication status for all the replicated bots.
- failureReasons
-
- Type: Array of strings
The reasons for replication failure for all the replicated bots.
BotVersionSortBy
Description
Specifies attributes for sorting a list of bot versions.
Members
- attribute
-
- Required: Yes
- Type: string
The attribute to use to sort the list of versions.
- order
-
- Required: Yes
- Type: string
The order to sort the list. You can specify ascending or descending order.
BotVersionSummary
Description
Summary information about a bot version returned by the ListBotVersions operation.
Members
- botName
-
- Type: string
The name of the bot associated with the version.
- botStatus
-
- Type: string
The status of the bot. When the status is available, the version of the bot is ready for use.
- botVersion
-
- Type: string
The numeric version of the bot, or
DRAFT
to indicate that this is the version of the bot that can be updated.. - 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.
BuildtimeSettings
Description
Contains specifications about the Amazon Lex build time generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
Members
- descriptiveBotBuilder
-
- Type: DescriptiveBotBuilderSpecification structure
An object containing specifications for the descriptive bot building feature.
- sampleUtteranceGeneration
-
- Type: SampleUtteranceGenerationSpecification structure
Contains specifications for the sample utterance generation feature.
BuiltInIntentSortBy
Description
Specifies attributes for sorting a list of built-in intents.
Members
- attribute
-
- Required: Yes
- Type: string
The attribute to use to sort the list of built-in intents.
- order
-
- Required: Yes
- Type: string
The order to sort the list. You can specify ascending or descending order.
BuiltInIntentSummary
Description
Provides summary information about a built-in intent for the ListBuiltInIntents operation.
Members
- description
-
- Type: string
The description of the intent.
- intentSignature
-
- Type: string
The signature of the built-in intent. Use this to specify the parent intent of a derived intent.
BuiltInSlotTypeSortBy
Description
Specifies attributes for sorting a list of built-in slot types.
Members
- attribute
-
- Required: Yes
- Type: string
The attribute to use to sort the list of built-in intents.
- order
-
- Required: Yes
- Type: string
The order to sort the list. You can choose ascending or descending.
BuiltInSlotTypeSummary
Description
Provides summary information about a built-in slot type for the ListBuiltInSlotTypes operation.
Members
- description
-
- Type: string
The description of the built-in slot type.
- slotTypeSignature
-
- Type: string
The signature of the built-in slot type. Use this to specify the parent slot type of a derived slot type.
Button
Description
Describes a button to use on a response card used to gather slot values from a user.
Members
- text
-
- Required: Yes
- Type: string
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
- value
-
- Required: Yes
- Type: string
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
CloudWatchLogGroupLogDestination
Description
The Amazon CloudWatch Logs log group where the text and metadata logs are delivered. The log group must exist before you enable logging.
Members
- cloudWatchLogGroupArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the log group where text and metadata logs are delivered.
- logPrefix
-
- Required: Yes
- Type: string
The prefix of the log stream name within the log group that you specified
CodeHookSpecification
Description
Contains information about code hooks that Amazon Lex calls during a conversation.
Members
- lambdaCodeHook
-
- Required: Yes
- Type: LambdaCodeHook structure
Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot.
CompositeSlotTypeSetting
Description
A composite slot is a combination of two or more slots that capture multiple pieces of information in a single user input.
Members
- subSlots
-
- Type: Array of SubSlotTypeComposition structures
Subslots in the composite slot.
Condition
Description
Provides an expression that evaluates to true or false.
Members
- expressionString
-
- Required: Yes
- Type: string
The expression string that is evaluated.
ConditionalBranch
Description
A set of actions that Amazon Lex should run if the condition is matched.
Members
- condition
-
- Required: Yes
- Type: Condition structure
Contains the expression to evaluate. If the condition is true, the branch's actions are taken.
- name
-
- Required: Yes
- Type: string
The name of the branch.
- nextStep
-
- Required: Yes
- Type: DialogState structure
The next step in the conversation.
- response
-
- Type: ResponseSpecification structure
Specifies a list of message groups that Amazon Lex uses to respond the user input.
ConditionalSpecification
Description
Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.
Members
- active
-
- Required: Yes
- Type: boolean
Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated. - conditionalBranches
-
- Required: Yes
- Type: Array of ConditionalBranch structures
A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
- defaultBranch
-
- Required: Yes
- Type: DefaultConditionalBranch structure
The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
ConflictException
Description
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.
Members
- message
-
- Type: string
ConversationLevelIntentClassificationResultItem
Description
The item listing the evaluation of intent level success or failure.
Members
- intentName
-
- Required: Yes
- Type: string
The intent name used in the evaluation of intent level success or failure.
- matchResult
-
- Required: Yes
- Type: string
The number of times the specific intent is used in the evaluation of intent level success or failure.
ConversationLevelResultDetail
Description
The conversation level details of the conversation used in the test set.
Members
- endToEndResult
-
- Required: Yes
- Type: string
The success or failure of the streaming of the conversation.
- speechTranscriptionResult
-
- Type: string
The speech transcription success or failure details of the conversation.
ConversationLevelSlotResolutionResultItem
Description
The slots used for the slot resolution in the conversation.
Members
- intentName
-
- Required: Yes
- Type: string
The intents used in the slots list for the slot resolution details.
- matchResult
-
- Required: Yes
- Type: string
The number of matching slots used in the slots listings for the slot resolution evaluation.
- slotName
-
- Required: Yes
- Type: string
The slot name in the slots list for the slot resolution details.
ConversationLevelTestResultItem
Description
The test result evaluation item at the conversation level.
Members
- conversationId
-
- Required: Yes
- Type: string
The conversation Id of the test result evaluation item.
- endToEndResult
-
- Required: Yes
- Type: string
The end-to-end success or failure of the test result evaluation item.
- intentClassificationResults
-
- Required: Yes
- Type: Array of ConversationLevelIntentClassificationResultItem structures
The intent classification of the test result evaluation item.
- slotResolutionResults
-
- Required: Yes
- Type: Array of ConversationLevelSlotResolutionResultItem structures
The slot success or failure of the test result evaluation item.
- speechTranscriptionResult
-
- Type: string
The speech transcription success or failure of the test result evaluation item.
ConversationLevelTestResults
Description
The test set results data at the conversation level.
Members
- items
-
- Required: Yes
- Type: Array of ConversationLevelTestResultItem structures
The item list in the test set results data at the conversation level.
ConversationLevelTestResultsFilterBy
Description
The selection to filter the test set results data at the conversation level.
Members
- endToEndResult
-
- Type: string
The selection of matched or mismatched end-to-end status to filter test set results data at the conversation level.
ConversationLogSettings
Description
Configures conversation logging that saves audio, text, and metadata for the conversations with your users.
Members
- audioLogSettings
-
- Type: Array of AudioLogSetting structures
The Amazon S3 settings for logging audio to an S3 bucket.
- textLogSettings
-
- Type: Array of TextLogSetting structures
The Amazon CloudWatch Logs settings for logging text and metadata.
ConversationLogsDataSource
Description
The data source that uses conversation logs.
Members
- botAliasId
-
- Required: Yes
- Type: string
The bot alias Id from the conversation logs.
- botId
-
- Required: Yes
- Type: string
The bot Id from the conversation logs.
- filter
-
- Required: Yes
- Type: ConversationLogsDataSourceFilterBy structure
The filter for the data source of the conversation log.
- localeId
-
- Required: Yes
- Type: string
The locale Id of the conversation log.
ConversationLogsDataSourceFilterBy
Description
The selected data source to filter the conversation log.
Members
- endTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The end time for the conversation log.
- inputMode
-
- Required: Yes
- Type: string
The selection to filter by input mode for the conversation logs.
- startTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The start time for the conversation log.
CustomPayload
Description
A custom response string that Amazon Lex sends to your application. You define the content and structure the string.
Members
- value
-
- Required: Yes
- Type: string
The string that is sent to your application.
CustomVocabularyEntryId
Description
The unique entry identifier for the custom vocabulary items.
Members
- itemId
-
- Required: Yes
- Type: string
The unique item identifier for the custom vocabulary items.
CustomVocabularyExportSpecification
Description
Provides the parameters required for exporting a custom vocabulary.
Members
- botId
-
- Required: Yes
- Type: string
The identifier of the bot that contains the custom vocabulary to export.
- botVersion
-
- Required: Yes
- Type: string
The version of the bot that contains the custom vocabulary to export.
- localeId
-
- Required: Yes
- Type: string
The locale of the bot that contains the custom vocabulary to export.
CustomVocabularyImportSpecification
Description
Provides the parameters required for importing a custom vocabulary.
Members
- botId
-
- Required: Yes
- Type: string
The identifier of the bot to import the custom vocabulary to.
- botVersion
-
- Required: Yes
- Type: string
The version of the bot to import the custom vocabulary to.
- localeId
-
- Required: Yes
- Type: string
The identifier of the local to import the custom vocabulary to. The value must be
en_GB
.
CustomVocabularyItem
Description
The unique custom vocabulary item from the custom vocabulary list.
Members
- displayAs
-
- Type: string
The DisplayAs value for the custom vocabulary item from the custom vocabulary list.
- itemId
-
- Required: Yes
- Type: string
The unique item identifer for the custom vocabulary item from the custom vocabulary list.
- phrase
-
- Required: Yes
- Type: string
The unique phrase for the custom vocabulary item from the custom vocabulary list.
- weight
-
- Type: int
The weight assigned for the custom vocabulary item from the custom vocabulary list.
DTMFSpecification
Description
Specifies the DTMF input specifications.
Members
- deletionCharacter
-
- Required: Yes
- Type: string
The DTMF character that clears the accumulated DTMF digits and immediately ends the input.
- endCharacter
-
- Required: Yes
- Type: string
The DTMF character that immediately ends input. If the user does not press this character, the input ends after the end timeout.
- endTimeoutMs
-
- Required: Yes
- Type: int
How long the bot should wait after the last DTMF character input before assuming that the input has concluded.
- maxLength
-
- Required: Yes
- Type: int
The maximum number of DTMF digits allowed in an utterance.
DataPrivacy
Description
By default, data stored by Amazon Lex is encrypted. The DataPrivacy
structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.
Members
- childDirected
-
- Required: Yes
- Type: boolean
For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying
true
orfalse
in thechildDirected
field. By specifyingtrue
in thechildDirected
field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifyingfalse
in thechildDirected
field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for thechildDirected
field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
DataSourceConfiguration
Description
Contains details about the configuration of the knowledge store used for the AMAZON.QnAIntent
. You must have already created the knowledge store and indexed the documents within it.
Members
- bedrockKnowledgeStoreConfiguration
-
- Type: BedrockKnowledgeStoreConfiguration structure
Contains details about the configuration of the Amazon Bedrock knowledge base used for the
AMAZON.QnAIntent
. To set up a knowledge base, follow the steps at Building a knowledge base. - kendraConfiguration
-
- Type: QnAKendraConfiguration structure
Contains details about the configuration of the Amazon Kendra index used for the
AMAZON.QnAIntent
. To create a Amazon Kendra index, follow the steps at Creating an index. - opensearchConfiguration
-
- Type: OpensearchConfiguration structure
Contains details about the configuration of the Amazon OpenSearch Service database used for the
AMAZON.QnAIntent
. To create a domain, follow the steps at Creating and managing Amazon OpenSearch Service domains.
DateRangeFilter
Description
The object used for specifying the data range that the customer wants Amazon Lex to read through in the input transcripts.
Members
- endDateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp indicating the end date for the date range filter.
- startDateTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp indicating the start date for the date range filter.
DefaultConditionalBranch
Description
A set of actions that Amazon Lex should run if none of the other conditions are met.
Members
- nextStep
-
- Type: DialogState structure
The next step in the conversation.
- response
-
- Type: ResponseSpecification structure
Specifies a list of message groups that Amazon Lex uses to respond the user input.
DescriptiveBotBuilderSpecification
Description
Contains specifications for the descriptive bot building feature.
Members
- bedrockModelSpecification
-
- Type: BedrockModelSpecification structure
An object containing information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
- enabled
-
- Required: Yes
- Type: boolean
Specifies whether the descriptive bot building feature is activated or not.
DialogAction
Description
Defines the action that the bot executes at runtime when the conversation reaches this step.
Members
- slotToElicit
-
- Type: string
If the dialog action is
ElicitSlot
, defines the slot to elicit from the user. - suppressNextMessage
-
- Type: boolean
When true the next message for the intent is not used.
- type
-
- Required: Yes
- Type: string
The action that the bot should execute.
DialogCodeHookInvocationSetting
Description
Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation.
Members
- active
-
- Required: Yes
- Type: boolean
Determines whether a dialog code hook is used when the intent is activated.
- enableCodeHookInvocation
-
- Required: Yes
- Type: boolean
Indicates whether a Lambda function should be invoked for the dialog.
- invocationLabel
-
- Type: string
A label that indicates the dialog step from which the dialog code hook is happening.
- postCodeHookSpecification
-
- Required: Yes
- Type: PostDialogCodeHookInvocationSpecification structure
Contains the responses and actions that Amazon Lex takes after the Lambda function is complete.
DialogCodeHookSettings
Description
Settings that determine the Lambda function that Amazon Lex uses for processing user responses.
Members
- enabled
-
- Required: Yes
- Type: boolean
Enables the dialog code hook so that it processes user requests.
DialogState
Description
The current state of the conversation with the user.
Members
- dialogAction
-
- Type: DialogAction structure
Defines the action that the bot executes at runtime when the conversation reaches this step.
- intent
-
- Type: IntentOverride structure
Override settings to configure the intent state.
- sessionAttributes
-
- Type: Associative array of custom strings keys (NonEmptyString) to strings
Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
ElicitationCodeHookInvocationSetting
Description
Settings that specify the dialog code hook that is called by Amazon Lex between eliciting slot values.
Members
- enableCodeHookInvocation
-
- Required: Yes
- Type: boolean
Indicates whether a Lambda function should be invoked for the dialog.
- invocationLabel
-
- Type: string
A label that indicates the dialog step from which the dialog code hook is happening.
EncryptionSetting
Description
The object representing the passwords that were used to encrypt the data related to the bot recommendation, as well as the KMS key ARN used to encrypt the associated metadata.
Members
- associatedTranscriptsPassword
-
- Type: string
The password used to encrypt the associated transcript file.
- botLocaleExportPassword
-
- Type: string
The password used to encrypt the recommended bot recommendation file.
- kmsKeyArn
-
- Type: string
The KMS key ARN used to encrypt the metadata associated with the bot recommendation.
ExactResponseFields
Description
Contains the names of the fields used for an exact response to the user.
Members
- answerField
-
- Required: Yes
- Type: string
The name of the field that contains the answer to the query made to the OpenSearch Service database.
- questionField
-
- Required: Yes
- Type: string
The name of the field that contains the query made to the OpenSearch Service database.
ExecutionErrorDetails
Description
Details about an error in an execution of a test set.
Members
- errorCode
-
- Required: Yes
- Type: string
The error code for the error.
- errorMessage
-
- Required: Yes
- Type: string
The message describing the error.
ExportFilter
Description
Filters the response form the ListExports operation
Members
- name
-
- Required: Yes
- Type: string
The name of the field to use for filtering.
- operator
-
- Required: Yes
- Type: string
The operator to use for the filter. Specify EQ when the
ListExports
operation should return only resource types that equal the specified value. Specify CO when theListExports
operation should return resource types that contain the specified value. - values
-
- Required: Yes
- Type: Array of strings
The values to use to filter the response. The values must be
Bot
,BotLocale
, orCustomVocabulary
.
ExportResourceSpecification
Description
Provides information about the bot or bot locale that you want to export. You can specify the botExportSpecification
or the botLocaleExportSpecification
, but not both.
Members
- botExportSpecification
-
- Type: BotExportSpecification structure
Parameters for exporting a bot.
- botLocaleExportSpecification
-
- Type: BotLocaleExportSpecification structure
Parameters for exporting a bot locale.
- customVocabularyExportSpecification
-
- Type: CustomVocabularyExportSpecification structure
The parameters required to export a custom vocabulary.
- testSetExportSpecification
-
- Type: TestSetExportSpecification structure
Specifications for the test set that is exported as a resource.
ExportSortBy
Description
Provides information about sorting a list of exports.
Members
- attribute
-
- Required: Yes
- Type: string
The export field to use for sorting.
- order
-
- Required: Yes
- Type: string
The order to sort the list.
ExportSummary
Description
Provides summary information about an export in an export list.
Members
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the export was created.
- exportId
-
- Type: string
The unique identifier that Amazon Lex assigned to the export.
- exportStatus
-
- Type: string
The status of the export. When the status is
Completed
the export is ready to download. - fileFormat
-
- Type: string
The file format used in the export files.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the export was last updated.
- resourceSpecification
-
- Type: ExportResourceSpecification structure
Information about the bot or bot locale that was exported.
ExternalSourceSetting
Description
Provides information about the external source of the slot type's definition.
Members
- grammarSlotTypeSetting
-
- Type: GrammarSlotTypeSetting structure
Settings required for a slot type based on a grammar that you provide.
FailedCustomVocabularyItem
Description
The unique failed custom vocabulary item from the custom vocabulary list.
Members
- errorCode
-
- Type: string
The unique error code for the failed custom vocabulary item from the custom vocabulary list.
- errorMessage
-
- Type: string
The error message for the failed custom vocabulary item from the custom vocabulary list.
- itemId
-
- Type: string
The unique item identifer for the failed custom vocabulary item from the custom vocabulary list.
FulfillmentCodeHookSettings
Description
Determines if a Lambda function should be invoked for a specific intent.
Members
- active
-
- Type: boolean
Determines whether the fulfillment code hook is used. When
active
is false, the code hook doesn't run. - enabled
-
- Required: Yes
- Type: boolean
Indicates whether a Lambda function should be invoked to fulfill a specific intent.
- fulfillmentUpdatesSpecification
-
- Type: FulfillmentUpdatesSpecification structure
Provides settings for update messages sent to the user for long-running Lambda fulfillment functions. Fulfillment updates can be used only with streaming conversations.
- postFulfillmentStatusSpecification
-
- Type: PostFulfillmentStatusSpecification structure
Provides settings for messages sent to the user for after the Lambda fulfillment function completes. Post-fulfillment messages can be sent for both streaming and non-streaming conversations.
FulfillmentStartResponseSpecification
Description
Provides settings for a message that is sent to the user when a fulfillment Lambda function starts running.
Members
- allowInterrupt
-
- Type: boolean
Determines whether the user can interrupt the start message while it is playing.
- delayInSeconds
-
- Required: Yes
- Type: int
The delay between when the Lambda fulfillment function starts running and the start message is played. If the Lambda function returns before the delay is over, the start message isn't played.
- messageGroups
-
- Required: Yes
- Type: Array of MessageGroup structures
1 - 5 message groups that contain start messages. Amazon Lex chooses one of the messages to play to the user.
FulfillmentUpdateResponseSpecification
Description
Provides settings for a message that is sent periodically to the user while a fulfillment Lambda function is running.
Members
- allowInterrupt
-
- Type: boolean
Determines whether the user can interrupt an update message while it is playing.
- frequencyInSeconds
-
- Required: Yes
- Type: int
The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user.
- messageGroups
-
- Required: Yes
- Type: Array of MessageGroup structures
1 - 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.
FulfillmentUpdatesSpecification
Description
Provides information for updating the user on the progress of fulfilling an intent.
Members
- active
-
- Required: Yes
- Type: boolean
Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent.
If the
active
field is set to true, thestartResponse
,updateResponse
, andtimeoutInSeconds
fields are required. - startResponse
-
- Type: FulfillmentStartResponseSpecification structure
Provides configuration information for the message sent to users when the fulfillment Lambda functions starts running.
- timeoutInSeconds
-
- Type: int
The length of time that the fulfillment Lambda function should run before it times out.
- updateResponse
-
- Type: FulfillmentUpdateResponseSpecification structure
Provides configuration information for messages sent periodically to the user while the fulfillment Lambda function is running.
GenerationSortBy
Description
Specifies the attribute and method by which to sort the generation request information.
Members
- attribute
-
- Required: Yes
- Type: string
The attribute by which to sort the generation request information. You can sort by the following attributes.
-
creationStartTime
– The time at which the generation request was created. -
lastUpdatedTime
– The time at which the generation request was last updated.
- order
-
- Required: Yes
- Type: string
The order by which to sort the generation request information.
GenerationSummary
Description
Contains information about a generation request made for the bot locale.
Members
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time at which the generation request was made.
- generationId
-
- Type: string
The unique identifier of the generation request.
- generationStatus
-
- Type: string
The status of the generation request.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time at which the generation request was last updated.
GenerativeAISettings
Description
Contains specifications about the generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
Members
- buildtimeSettings
-
- Type: BuildtimeSettings structure
Contains specifications about the Amazon Lex build time generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
- runtimeSettings
-
- Type: RuntimeSettings structure
Contains specifications about the Amazon Lex runtime generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
GrammarSlotTypeSetting
Description
Settings requried for a slot type based on a grammar that you provide.
Members
- source
-
- Type: GrammarSlotTypeSource structure
The source of the grammar used to create the slot type.
GrammarSlotTypeSource
Description
Describes the Amazon S3 bucket name and location for the grammar that is the source for the slot type.
Members
- kmsKeyArn
-
- Type: string
The KMS key required to decrypt the contents of the grammar, if any.
- s3BucketName
-
- Required: Yes
- Type: string
The name of the Amazon S3 bucket that contains the grammar source.
- s3ObjectKey
-
- Required: Yes
- Type: string
The path to the grammar in the Amazon S3 bucket.
ImageResponseCard
Description
A card that is shown to the user by a messaging platform. You define the contents of the card, the card is displayed by the platform.
When you use a response card, the response from the user is constrained to the text associated with a button on the card.
Members
- buttons
-
- Type: Array of Button structures
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
- imageUrl
-
- Type: string
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
- subtitle
-
- Type: string
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
- title
-
- Required: Yes
- Type: string
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
ImportFilter
Description
Filters the response from the ListImports operation.
Members
- name
-
- Required: Yes
- Type: string
The name of the field to use for filtering.
- operator
-
- Required: Yes
- Type: string
The operator to use for the filter. Specify EQ when the
ListImports
operation should return only resource types that equal the specified value. Specify CO when theListImports
operation should return resource types that contain the specified value. - values
-
- Required: Yes
- Type: Array of strings
The values to use to filter the response. The values must be
Bot
,BotLocale
, orCustomVocabulary
.
ImportResourceSpecification
Description
Provides information about the bot or bot locale that you want to import. You can specify the botImportSpecification
or the botLocaleImportSpecification
, but not both.
Members
- botImportSpecification
-
- Type: BotImportSpecification structure
Parameters for importing a bot.
- botLocaleImportSpecification
-
- Type: BotLocaleImportSpecification structure
Parameters for importing a bot locale.
- customVocabularyImportSpecification
-
- Type: CustomVocabularyImportSpecification structure
Provides the parameters required for importing a custom vocabulary.
- testSetImportResourceSpecification
-
- Type: TestSetImportResourceSpecification structure
Specifications for the test set that is imported.
ImportSortBy
Description
Provides information for sorting a list of imports.
Members
- attribute
-
- Required: Yes
- Type: string
The export field to use for sorting.
- order
-
- Required: Yes
- Type: string
The order to sort the list.
ImportSummary
Description
Provides summary information about an import in an import list.
Members
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the import was created.
- importId
-
- Type: string
The unique identifier that Amazon Lex assigned to the import.
- importStatus
-
- Type: string
The status of the resource. When the status is
Completed
the resource is ready to build. - importedResourceId
-
- Type: string
The unique identifier that Amazon Lex assigned to the imported resource.
- importedResourceName
-
- Type: string
The name that you gave the imported resource.
- importedResourceType
-
- Type: string
The type of resource that was imported.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the import was last updated.
- mergeStrategy
-
- Type: string
The strategy used to merge existing bot or bot locale definitions with the imported definition.
InitialResponseSetting
Description
Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.
Members
- codeHook
-
- Type: DialogCodeHookInvocationSetting structure
Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation.
- conditional
-
- Type: ConditionalSpecification structure
Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.
- initialResponse
-
- Type: ResponseSpecification structure
Specifies a list of message groups that Amazon Lex uses to respond the user input.
- nextStep
-
- Type: DialogState structure
The next step in the conversation.
InputContext
Description
A context that must be active for an intent to be selected by Amazon Lex.
Members
- name
-
- Required: Yes
- Type: string
The name of the context.
InputSessionStateSpecification
Description
Specifications for the current state of the dialog between the user and the bot in the test set.
Members
- activeContexts
-
- Type: Array of ActiveContext structures
Active contexts for the session state.
- runtimeHints
-
- Type: RuntimeHints structure
Runtime hints for the session state.
- sessionAttributes
-
- Type: Associative array of custom strings keys (NonEmptyString) to strings
Session attributes for the session state.
IntentClassificationTestResultItem
Description
Information for an intent that is classified by the test workbench.
Members
- intentName
-
- Required: Yes
- Type: string
The name of the intent.
- multiTurnConversation
-
- Required: Yes
- Type: boolean
Indicates whether the conversation involves multiple turns or not.
- resultCounts
-
- Required: Yes
- Type: IntentClassificationTestResultItemCounts structure
The result of the intent classification test.
IntentClassificationTestResultItemCounts
Description
The number of items in the intent classification test.
Members
- intentMatchResultCounts
-
- Required: Yes
- Type: Associative array of custom strings keys (TestResultMatchStatus) to ints
The number of matched and mismatched results for intent recognition for the intent.
- speechTranscriptionResultCounts
-
- Type: Associative array of custom strings keys (TestResultMatchStatus) to ints
The number of matched, mismatched, and execution error results for speech transcription for the intent.
- totalResultCount
-
- Required: Yes
- Type: int
The total number of results in the intent classification test.
IntentClassificationTestResults
Description
Information for the results of the intent classification test.
Members
- items
-
- Required: Yes
- Type: Array of IntentClassificationTestResultItem structures
A list of the results for the intent classification test.
IntentClosingSetting
Description
Provides a statement the Amazon Lex conveys to the user when the intent is successfully fulfilled.
Members
- active
-
- Type: boolean
Specifies whether an intent's closing response is used. When this field is false, the closing response isn't sent to the user. If the
active
field isn't specified, the default is true. - closingResponse
-
- Type: ResponseSpecification structure
The response that Amazon Lex sends to the user when the intent is complete.
- conditional
-
- Type: ConditionalSpecification structure
A list of conditional branches associated with the intent's closing response. These branches are executed when the
nextStep
attribute is set toEvalutateConditional
. - nextStep
-
- Type: DialogState structure
Specifies the next step that the bot executes after playing the intent's closing response.
IntentConfirmationSetting
Description
Provides a prompt for making sure that the user is ready for the intent to be fulfilled.
Members
- active
-
- Type: boolean
Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the
active
field isn't specified, the default is true. - codeHook
-
- Type: DialogCodeHookInvocationSetting structure
The
DialogCodeHookInvocationSetting
object associated with intent's confirmation step. The dialog code hook is triggered based on these invocation settings when the confirmation next step or declination next step or failure next step isInvokeDialogCodeHook
. - confirmationConditional
-
- Type: ConditionalSpecification structure
A list of conditional branches to evaluate after the intent is closed.
- confirmationNextStep
-
- Type: DialogState structure
Specifies the next step that the bot executes when the customer confirms the intent.
- confirmationResponse
-
- Type: ResponseSpecification structure
Specifies a list of message groups that Amazon Lex uses to respond the user input.
- declinationConditional
-
- Type: ConditionalSpecification structure
A list of conditional branches to evaluate after the intent is declined.
- declinationNextStep
-
- Type: DialogState structure
Specifies the next step that the bot executes when the customer declines the intent.
- declinationResponse
-
- Type: ResponseSpecification structure
When the user answers "no" to the question defined in
promptSpecification
, Amazon Lex responds with this response to acknowledge that the intent was canceled. - elicitationCodeHook
-
- Type: ElicitationCodeHookInvocationSetting structure
The
DialogCodeHookInvocationSetting
used when the code hook is invoked during confirmation prompt retries. - failureConditional
-
- Type: ConditionalSpecification structure
Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.
- failureNextStep
-
- Type: DialogState structure
The next step to take in the conversation if the confirmation step fails.
- failureResponse
-
- Type: ResponseSpecification structure
Specifies a list of message groups that Amazon Lex uses to respond the user input.
- promptSpecification
-
- Required: Yes
- Type: PromptSpecification structure
Prompts the user to confirm the intent. This question should have a yes or no answer.
Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the
OrderPizza
intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.
IntentFilter
Description
Filters the response from the ListIntents
operation.
Members
- name
-
- Required: Yes
- Type: string
The name of the field to use for the filter.
- operator
-
- Required: Yes
- Type: string
The operator to use for the filter. Specify
EQ
when theListIntents
operation should return only aliases that equal the specified value. SpecifyCO
when theListIntents
operation should return aliases that contain the specified value. - values
-
- Required: Yes
- Type: Array of strings
The value to use for the filter.
IntentLevelSlotResolutionTestResultItem
Description
Information about intent-level slot resolution in a test result.
Members
- intentName
-
- Required: Yes
- Type: string
The name of the intent that was recognized.
- multiTurnConversation
-
- Required: Yes
- Type: boolean
Indicates whether the conversation involves multiple turns or not.
- slotResolutionResults
-
- Required: Yes
- Type: Array of SlotResolutionTestResultItem structures
The results for the slot resolution in the test execution result.
IntentLevelSlotResolutionTestResults
Description
Indicates the success or failure of slots at the intent level.
Members
- items
-
- Required: Yes
- Type: Array of IntentLevelSlotResolutionTestResultItem structures
Indicates the items for the slot level resolution for the intents.
IntentOverride
Description
Override settings to configure the intent state.
Members
- name
-
- Type: string
The name of the intent. Only required when you're switching intents.
- slots
-
- Type: Associative array of custom strings keys (Name) to SlotValueOverride structures
A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren't overridden.
IntentSortBy
Description
Specifies attributes for sorting a list of intents.
Members
- attribute
-
- Required: Yes
- Type: string
The attribute to use to sort the list of intents.
- order
-
- Required: Yes
- Type: string
The order to sort the list. You can choose ascending or descending.
IntentStatistics
Description
The object that contains the statistical summary of recommended intents associated with the bot recommendation.
Members
- discoveredIntentCount
-
- Type: int
The number of recommended intents associated with the bot recommendation.
IntentSummary
Description
Summary information about an intent returned by the ListIntents
operation.
Members
- description
-
- Type: string
The description of the intent.
- inputContexts
-
- Type: Array of InputContext structures
The input contexts that must be active for this intent to be considered for recognition.
- intentId
-
- Type: string
The unique identifier assigned to the intent. Use this ID to get detailed information about the intent with the
DescribeIntent
operation. - intentName
-
- Type: string
The name of the intent.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of the date and time that the intent was last updated.
- outputContexts
-
- Type: Array of OutputContext structures
The output contexts that are activated when this intent is fulfilled.
- parentIntentSignature
-
- Type: string
If this intent is derived from a built-in intent, the name of the parent intent.
InternalServerException
Description
The service encountered an unexpected condition. Try your request again.
Members
- message
-
- Type: string
InvokedIntentSample
Description
An object containing the name of an intent that was invoked.
Members
- intentName
-
- Type: string
The name of an intent that was invoked.
KendraConfiguration
Description
Provides configuration information for the AMAZON.KendraSearchIntent
intent. When you use this intent, Amazon Lex searches the specified Amazon Kendra index and returns documents from the index that match the user's utterance.
Members
- kendraIndex
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the
AMAZON.KendraSearchIntent
intent to search. The index must be in the same account and Region as the Amazon Lex bot. - queryFilterString
-
- Type: string
A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.
- queryFilterStringEnabled
-
- Type: boolean
Determines whether the
AMAZON.KendraSearchIntent
intent uses a custom query string to query the Amazon Kendra index.
LambdaCodeHook
Description
Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot.
Members
- codeHookInterfaceVersion
-
- Required: Yes
- Type: string
The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.
- lambdaARN
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the Lambda function.
LexTranscriptFilter
Description
The object that contains transcript filter details that are associated with a bot recommendation.
Members
- dateRangeFilter
-
- Type: DateRangeFilter structure
The object that contains a date range filter that will be applied to the transcript. Specify this object if you want Amazon Lex to only read the files that are within the date range.
Message
Description
The object that provides message text and its type.
Members
- customPayload
-
- Type: CustomPayload structure
A message in a custom format defined by the client application.
- imageResponseCard
-
- Type: ImageResponseCard structure
A message that defines a response card that the client application can show to the user.
- plainTextMessage
-
- Type: PlainTextMessage structure
A message in plain text format.
- ssmlMessage
-
- Type: SSMLMessage structure
A message in Speech Synthesis Markup Language (SSML).
MessageGroup
Description
Provides one or more messages that Amazon Lex should send to the user.
Members
- message
-
- Required: Yes
- Type: Message structure
The primary message that Amazon Lex should send to the user.
- variations
-
- Type: Array of Message structures
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
MultipleValuesSetting
Description
Indicates whether a slot can return multiple values.
Members
- allowMultipleValues
-
- Type: boolean
Indicates whether a slot can return multiple values. When
true
, the slot may return more than one value in a response. Whenfalse
, the slot returns only a single value.Multi-value slots are only available in the en-US locale. If you set this value to
true
in any other locale, Amazon Lex throws aValidationException
.If the
allowMutlipleValues
is not set, the default value isfalse
.
NewCustomVocabularyItem
Description
The new custom vocabulary item from the custom vocabulary list.
Members
- displayAs
-
- Type: string
The display as value assigned to the new custom vocabulary item from the custom vocabulary list.
- phrase
-
- Required: Yes
- Type: string
The unique phrase for the new custom vocabulary item from the custom vocabulary list.
- weight
-
- Type: int
The weight assigned to the new custom vocabulary item from the custom vocabulary list.
ObfuscationSetting
Description
Determines whether Amazon Lex obscures slot values in conversation logs.
Members
- obfuscationSettingType
-
- Required: Yes
- Type: string
Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values.
OpensearchConfiguration
Description
Contains details about the configuration of the Amazon OpenSearch Service database used for the AMAZON.QnAIntent
.
Members
- domainEndpoint
-
- Required: Yes
- Type: string
The endpoint of the Amazon OpenSearch Service domain.
- exactResponse
-
- Type: boolean
Specifies whether to return an exact response or to return an answer generated by the model using the fields you specify from the database.
- exactResponseFields
-
- Type: ExactResponseFields structure
Contains the names of the fields used for an exact response to the user.
- includeFields
-
- Type: Array of strings
Contains a list of fields from the Amazon OpenSearch Service that the model can use to generate the answer to the query.
- indexName
-
- Required: Yes
- Type: string
The name of the Amazon OpenSearch Service index.
OutputContext
Description
Describes a session context that is activated when an intent is fulfilled.
Members
- name
-
- Required: Yes
- Type: string
The name of the output context.
- timeToLiveInSeconds
-
- Required: Yes
- Type: int
The amount of time, in seconds, that the output context should remain active. The time is figured from the first time the context is sent to the user.
- turnsToLive
-
- Required: Yes
- Type: int
The number of conversation turns that the output context should remain active. The number of turns is counted from the first time that the context is sent to the user.
OverallTestResultItem
Description
Information about the overall results for a test execution result.
Members
- endToEndResultCounts
-
- Required: Yes
- Type: Associative array of custom strings keys (TestResultMatchStatus) to ints
The number of results that succeeded.
- multiTurnConversation
-
- Required: Yes
- Type: boolean
Indicates whether the conversation contains multiple turns or not.
- speechTranscriptionResultCounts
-
- Type: Associative array of custom strings keys (TestResultMatchStatus) to ints
The number of speech transcription results in the overall test.
- totalResultCount
-
- Required: Yes
- Type: int
The total number of overall results in the result of the test execution.
OverallTestResults
Description
Information about the overall test results.
Members
- items
-
- Required: Yes
- Type: Array of OverallTestResultItem structures
A list of the overall test results.
ParentBotNetwork
Description
A network of bots.
Members
- botId
-
- Required: Yes
- Type: string
The identifier of the network of bots assigned by Amazon Lex.
- botVersion
-
- Required: Yes
- Type: string
The version of the network of bots.
PathFormat
Description
The object that contains a path format that will be applied when Amazon Lex reads the transcript file in the bucket you provide. Specify this object if you only want Lex to read a subset of files in your Amazon S3 bucket.
Members
- objectPrefixes
-
- Type: Array of strings
A list of Amazon S3 prefixes that points to sub-folders in the Amazon S3 bucket. Specify this list if you only want Lex to read the files under this set of sub-folders.
PlainTextMessage
Description
Defines an ASCII text message to send to the user.
Members
- value
-
- Required: Yes
- Type: string
The message to send to the user.
PostDialogCodeHookInvocationSpecification
Description
Specifies next steps to run after the dialog code hook finishes.
Members
- failureConditional
-
- Type: ConditionalSpecification structure
A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
. - failureNextStep
-
- Type: DialogState structure
Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
. - failureResponse
-
- Type: ResponseSpecification structure
Specifies a list of message groups that Amazon Lex uses to respond the user input.
- successConditional
-
- Type: ConditionalSpecification structure
A list of conditional branches to evaluate after the dialog code hook finishes successfully.
- successNextStep
-
- Type: DialogState structure
Specifics the next step the bot runs after the dialog code hook finishes successfully.
- successResponse
-
- Type: ResponseSpecification structure
Specifies a list of message groups that Amazon Lex uses to respond the user input.
- timeoutConditional
-
- Type: ConditionalSpecification structure
A list of conditional branches to evaluate if the code hook times out.
- timeoutNextStep
-
- Type: DialogState structure
Specifies the next step that the bot runs when the code hook times out.
- timeoutResponse
-
- Type: ResponseSpecification structure
Specifies a list of message groups that Amazon Lex uses to respond the user input.
PostFulfillmentStatusSpecification
Description
Provides a setting that determines whether the post-fulfillment response is sent to the user. For more information, see https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-complete
Members
- failureConditional
-
- Type: ConditionalSpecification structure
A list of conditional branches to evaluate after the fulfillment code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
. - failureNextStep
-
- Type: DialogState structure
Specifies the next step the bot runs after the fulfillment code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
. - failureResponse
-
- Type: ResponseSpecification structure
Specifies a list of message groups that Amazon Lex uses to respond the user input.
- successConditional
-
- Type: ConditionalSpecification structure
A list of conditional branches to evaluate after the fulfillment code hook finishes successfully.
- successNextStep
-
- Type: DialogState structure
Specifies the next step in the conversation that Amazon Lex invokes when the fulfillment code hook completes successfully.
- successResponse
-
- Type: ResponseSpecification structure
Specifies a list of message groups that Amazon Lex uses to respond the user input.
- timeoutConditional
-
- Type: ConditionalSpecification structure
A list of conditional branches to evaluate if the fulfillment code hook times out.
- timeoutNextStep
-
- Type: DialogState structure
Specifies the next step that the bot runs when the fulfillment code hook times out.
- timeoutResponse
-
- Type: ResponseSpecification structure
Specifies a list of message groups that Amazon Lex uses to respond the user input.
PreconditionFailedException
Description
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
Members
- message
-
- Type: string
Principal
Description
The IAM principal that you allowing or denying access to an Amazon Lex action. You must provide a service
or an arn
, but not both in the same statement. For more information, see AWS JSON policy elements: Principal .
Members
- arn
-
- Type: string
The Amazon Resource Name (ARN) of the principal.
- service
-
- Type: string
The name of the Amazon Web Services service that should allowed or denied access to an Amazon Lex action.
PromptAttemptSpecification
Description
Specifies the settings on a prompt attempt.
Members
- allowInterrupt
-
- Type: boolean
Indicates whether the user can interrupt a speech prompt attempt from the bot.
- allowedInputTypes
-
- Required: Yes
- Type: AllowedInputTypes structure
Indicates the allowed input types of the prompt attempt.
- audioAndDTMFInputSpecification
-
- Type: AudioAndDTMFInputSpecification structure
Specifies the settings on audio and DTMF input.
- textInputSpecification
-
- Type: TextInputSpecification structure
Specifies the settings on text input.
PromptSpecification
Description
Specifies a list of message groups that Amazon Lex sends to a user to elicit a response.
Members
- allowInterrupt
-
- Type: boolean
Indicates whether the user can interrupt a speech prompt from the bot.
- maxRetries
-
- Required: Yes
- Type: int
The maximum number of times the bot tries to elicit a response from the user using this prompt.
- messageGroups
-
- Required: Yes
- Type: Array of MessageGroup structures
A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
- messageSelectionStrategy
-
- Type: string
Indicates how a message is selected from a message group among retries.
- promptAttemptsSpecification
-
- Type: Associative array of custom strings keys (PromptAttempt) to PromptAttemptSpecification structures
Specifies the advanced settings on each attempt of the prompt.
QnAIntentConfiguration
Description
Details about the the configuration of the built-in Amazon.QnAIntent
.
Members
- bedrockModelConfiguration
-
- Type: BedrockModelSpecification structure
Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
- dataSourceConfiguration
-
- Type: DataSourceConfiguration structure
Contains details about the configuration of the data source used for the
AMAZON.QnAIntent
.
QnAKendraConfiguration
Description
Contains details about the configuration of the Amazon Kendra index used for the AMAZON.QnAIntent
.
Members
- exactResponse
-
- Type: boolean
Specifies whether to return an exact response from the Amazon Kendra index or to let the Amazon Bedrock model you select generate a response based on the results. To use this feature, you must first add FAQ questions to your index by following the steps at Adding frequently asked questions (FAQs) to an index.
- kendraIndex
-
- Required: Yes
- Type: string
The ARN of the Amazon Kendra index to use.
- queryFilterString
-
- Type: string
Contains the Amazon Kendra filter string to use if enabled. For more information on the Amazon Kendra search filter JSON format, see Using document attributes to filter search results.
- queryFilterStringEnabled
-
- Type: boolean
Specifies whether to enable an Amazon Kendra filter string or not.
RecommendedIntentSummary
Description
An object that contains a summary of a recommended intent.
Members
- intentId
-
- Type: string
The unique identifier of a recommended intent associated with the bot recommendation.
- intentName
-
- Type: string
The name of a recommended intent associated with the bot recommendation.
- sampleUtterancesCount
-
- Type: int
The count of sample utterances of a recommended intent that is associated with a bot recommendation.
RelativeAggregationDuration
Description
Specifies the time window that utterance statistics are returned for. The time window is always relative to the last time that the that utterances were aggregated. For example, if the ListAggregatedUtterances
operation is called at 1600, the time window is set to 1 hour, and the last refresh time was 1530, only utterances made between 1430 and 1530 are returned.
You can choose the time window that statistics should be returned for.
-
Hours - You can request utterance statistics for 1, 3, 6, 12, or 24 hour time windows. Statistics are refreshed every half hour for 1 hour time windows, and hourly for the other time windows.
-
Days - You can request utterance statistics for 3 days. Statistics are refreshed every 6 hours.
-
Weeks - You can see statistics for one or two weeks. Statistics are refreshed every 12 hours for one week time windows, and once per day for two week time windows.
Members
- timeDimension
-
- Required: Yes
- Type: string
The type of time period that the
timeValue
field represents. - timeValue
-
- Required: Yes
- Type: int
The period of the time window to gather statistics for. The valid value depends on the setting of the
timeDimension
field.-
Hours
- 1/3/6/12/24 -
Days
- 3 -
Weeks
- 1/2
ResourceNotFoundException
Description
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
Members
- message
-
- Type: string
ResponseSpecification
Description
Specifies a list of message groups that Amazon Lex uses to respond the user input.
Members
- allowInterrupt
-
- Type: boolean
Indicates whether the user can interrupt a speech response from Amazon Lex.
- messageGroups
-
- Required: Yes
- Type: Array of MessageGroup structures
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
RuntimeHintDetails
Description
Provides an array of phrases that should be given preference when resolving values for a slot.
Members
- runtimeHintValues
-
- Type: Array of RuntimeHintValue structures
One or more strings that Amazon Lex should look for in the input to the bot. Each phrase is given preference when deciding on slot values.
- subSlotHints
-
- Type: Associative array of custom strings keys (Name) to RuntimeHintDetails structures
A map of constituent sub slot names inside a composite slot in the intent and the phrases that should be added for each sub slot. Inside each composite slot hints, this structure provides a mechanism to add granular sub slot phrases. Only sub slot hints are supported for composite slots. The intent name, composite slot name and the constituent sub slot names must exist.
RuntimeHintValue
Description
Provides the phrase that Amazon Lex should look for in the user's input to the bot.
Members
- phrase
-
- Required: Yes
- Type: string
The phrase that Amazon Lex should look for in the user's input to the bot.
RuntimeHints
Description
You can provide Amazon Lex with hints to the phrases that a customer is likely to use for a slot. When a slot with hints is resolved, the phrases in the runtime hints are preferred in the resolution. You can provide hints for a maximum of 100 intents. You can provide a maximum of 100 slots.
Before you can use runtime hints with an existing bot, you must first rebuild the bot.
For more information, see Using runtime hints to improve recognition of slot values.
Members
- slotHints
-
- Type: Associative array of custom strings keys (Name) to RuntimeHintDetails structuress
A list of the slots in the intent that should have runtime hints added, and the phrases that should be added for each slot.
The first level of the
slotHints
map is the name of the intent. The second level is the name of the slot within the intent. For more information, see Using hints to improve accuracy.The intent name and slot name must exist.
RuntimeSettings
Description
Contains specifications about the Amazon Lex runtime generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
Members
- slotResolutionImprovement
-
- Type: SlotResolutionImprovementSpecification structure
An object containing specifications for the assisted slot resolution feature.
S3BucketLogDestination
Description
Specifies an Amazon S3 bucket for logging audio conversations
Members
- kmsKeyArn
-
- Type: string
The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.
- logPrefix
-
- Required: Yes
- Type: string
The S3 prefix to assign to audio log files.
- s3BucketArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.
S3BucketTranscriptSource
Description
The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.
Members
- kmsKeyArn
-
- Type: string
The ARN of the KMS key that customer use to encrypt their Amazon S3 bucket. Only use this field if your bucket is encrypted using a customer managed KMS key.
- pathFormat
-
- Type: PathFormat structure
The object that contains a path format that will be applied when Amazon Lex reads the transcript file in the bucket you provide. Specify this object if you only want Lex to read a subset of files in your Amazon S3 bucket.
- s3BucketName
-
- Required: Yes
- Type: string
The name of the bucket containing the transcript and the associated metadata.
- transcriptFilter
-
- Type: TranscriptFilter structure
The object that contains the filter which will be applied when Amazon Lex reads through the Amazon S3 bucket. Specify this object if you want Amazon Lex to read only a subset of the Amazon S3 bucket based on the filter you provide.
- transcriptFormat
-
- Required: Yes
- Type: string
The format of the transcript content. Currently, Genie only supports the Amazon Lex transcript format.
SSMLMessage
Description
Defines a Speech Synthesis Markup Language (SSML) prompt.
Members
- value
-
- Required: Yes
- Type: string
The SSML text that defines the prompt.
SampleUtterance
Description
A sample utterance that invokes an intent or respond to a slot elicitation prompt.
Members
- utterance
-
- Required: Yes
- Type: string
The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.
SampleUtteranceGenerationSpecification
Description
Contains specifications for the sample utterance generation feature.
Members
- bedrockModelSpecification
-
- Type: BedrockModelSpecification structure
Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.
- enabled
-
- Required: Yes
- Type: boolean
Specifies whether to enable sample utterance generation or not.
SampleValue
Description
Defines one of the values for a slot type.
Members
- value
-
- Required: Yes
- Type: string
The value that can be used for a slot type.
SentimentAnalysisSettings
Description
Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
Members
- detectSentiment
-
- Required: Yes
- Type: boolean
Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user utterances.
ServiceQuotaExceededException
Description
You have reached a quota for your bot.
Members
- message
-
- Type: string
SessionDataSortBy
Description
An object specifying the measure and method by which to sort the session analytics data.
Members
- name
-
- Required: Yes
- Type: string
The measure by which to sort the session analytics data.
-
conversationStartTime
– The date and time when the conversation began. A conversation is defined as a unique combination of asessionId
and anoriginatingRequestId
. -
numberOfTurns
– The number of turns that the session took. -
conversationDurationSeconds
– The duration of the conversation in seconds.
- order
-
- Required: Yes
- Type: string
Specifies whether to sort the results in ascending or descending order.
SessionSpecification
Description
An object containing information about a specific session.
Members
- botAliasId
-
- Type: string
The identifier of the alias of the bot that the session was held with.
- botVersion
-
- Type: string
The version of the bot that the session was held with.
- channel
-
- Type: string
The channel that is integrated with the bot that the session was held with.
- conversationDurationSeconds
-
- Type: long (int|float)
The duration of the conversation in seconds. A conversation is defined as a unique combination of a
sessionId
and anoriginatingRequestId
. - conversationEndState
-
- Type: string
The final state of the conversation. A conversation is defined as a unique combination of a
sessionId
and anoriginatingRequestId
. - conversationEndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time when the conversation ended. A conversation is defined as a unique combination of a
sessionId
and anoriginatingRequestId
. - conversationStartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time when the conversation began. A conversation is defined as a unique combination of a
sessionId
and anoriginatingRequestId
. - invokedIntentSamples
-
- Type: Array of InvokedIntentSample structures
A list of objects containing the name of an intent that was invoked.
- localeId
-
- Type: string
The locale of the bot that the session was held with.
- mode
-
- Type: string
The mode of the session. The possible values are as follows:
-
Speech
– The session was spoken. -
Text
– The session was written. -
DTMF
– The session used a touch-tone keypad (Dual Tone Multi-Frequency). -
MultiMode
– The session used multiple modes.
- numberOfTurns
-
- Type: long (int|float)
The number of turns that the session took.
- originatingRequestId
-
- Type: string
The identifier of the first request in a session.
- sessionId
-
- Type: string
The identifier of the session.
SlotCaptureSetting
Description
Settings used when Amazon Lex successfully captures a slot value from a user.
Members
- captureConditional
-
- Type: ConditionalSpecification structure
A list of conditional branches to evaluate after the slot value is captured.
- captureNextStep
-
- Type: DialogState structure
Specifies the next step that the bot runs when the slot value is captured before the code hook times out.
- captureResponse
-
- Type: ResponseSpecification structure
Specifies a list of message groups that Amazon Lex uses to respond the user input.
- codeHook
-
- Type: DialogCodeHookInvocationSetting structure
Code hook called after Amazon Lex successfully captures a slot value.
- elicitationCodeHook
-
- Type: ElicitationCodeHookInvocationSetting structure
Code hook called when Amazon Lex doesn't capture a slot value.
- failureConditional
-
- Type: ConditionalSpecification structure
A list of conditional branches to evaluate when the slot value isn't captured.
- failureNextStep
-
- Type: DialogState structure
Specifies the next step that the bot runs when the slot value code is not recognized.
- failureResponse
-
- Type: ResponseSpecification structure
Specifies a list of message groups that Amazon Lex uses to respond the user input.
SlotDefaultValue
Description
Specifies the default value to use when a user doesn't provide a value for a slot.
Members
- defaultValue
-
- Required: Yes
- Type: string
The default value to use when a user doesn't provide a value for a slot.
SlotDefaultValueSpecification
Description
Defines a list of values that Amazon Lex should use as the default value for a slot.
Members
- defaultValueList
-
- Required: Yes
- Type: Array of SlotDefaultValue structures
A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list.
SlotFilter
Description
Filters the response from the ListSlots
operation.
Members
- name
-
- Required: Yes
- Type: string
The name of the field to use for filtering.
- operator
-
- Required: Yes
- Type: string
The operator to use for the filter. Specify
EQ
when theListSlots
operation should return only aliases that equal the specified value. SpecifyCO
when theListSlots
operation should return aliases that contain the specified value. - values
-
- Required: Yes
- Type: Array of strings
The value to use to filter the response.
SlotPriority
Description
Sets the priority that Amazon Lex should use when eliciting slot values from a user.
Members
- priority
-
- Required: Yes
- Type: int
The priority that Amazon Lex should apply to the slot.
- slotId
-
- Required: Yes
- Type: string
The unique identifier of the slot.
SlotResolutionImprovementSpecification
Description
Contains specifications for the assisted slot resolution feature.
Members
- bedrockModelSpecification
-
- Type: BedrockModelSpecification structure
An object containing information about the Amazon Bedrock model used to assist slot resolution.
- enabled
-
- Required: Yes
- Type: boolean
Specifies whether assisted slot resolution is turned on or off.
SlotResolutionSetting
Description
Contains information about whether assisted slot resolution is turned on for the slot or not.
Members
- slotResolutionStrategy
-
- Required: Yes
- Type: string
Specifies whether assisted slot resolution is turned on for the slot or not. If the value is
EnhancedFallback
, assisted slot resolution is activated when Amazon Lex defaults to theAMAZON.FallbackIntent
. If the value isDefault
, assisted slot resolution is turned off.
SlotResolutionTestResultItem
Description
Information about the success and failure rate of slot resolution in the results of a test execution.
Members
- resultCounts
-
- Required: Yes
- Type: SlotResolutionTestResultItemCounts structure
A result for slot resolution in the results of a test execution.
- slotName
-
- Required: Yes
- Type: string
The name of the slot.
SlotResolutionTestResultItemCounts
Description
Information about the counts for a slot resolution in the results of a test execution.
Members
- slotMatchResultCounts
-
- Required: Yes
- Type: Associative array of custom strings keys (TestResultMatchStatus) to ints
The number of matched and mismatched results for slot resolution for the slot.
- speechTranscriptionResultCounts
-
- Type: Associative array of custom strings keys (TestResultMatchStatus) to ints
The number of matched, mismatched and execution error results for speech transcription for the slot.
- totalResultCount
-
- Required: Yes
- Type: int
The total number of results.
SlotSortBy
Description
Specifies attributes for sorting a list of bots.
Members
- attribute
-
- Required: Yes
- Type: string
The attribute to use to sort the list.
- order
-
- Required: Yes
- Type: string
The order to sort the list. You can choose ascending or descending.
SlotSummary
Description
Summary information about a slot, a value that the bot elicits from the user.
Members
- description
-
- Type: string
The description of the slot.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of the last date and time that the slot was updated.
- slotConstraint
-
- Type: string
Whether the slot is required or optional. An intent is complete when all required slots are filled.
- slotId
-
- Type: string
The unique identifier of the slot.
- slotName
-
- Type: string
The name given to the slot.
- slotTypeId
-
- Type: string
The unique identifier for the slot type that defines the values for the slot.
- valueElicitationPromptSpecification
-
- Type: PromptSpecification structure
Prompts that are sent to the user to elicit a value for the slot.
SlotTypeFilter
Description
Filters the response from the ListSlotTypes
operation.
Members
- name
-
- Required: Yes
- Type: string
The name of the field to use for filtering.
- operator
-
- Required: Yes
- Type: string
The operator to use for the filter. Specify
EQ
when theListSlotTypes
operation should return only aliases that equal the specified value. SpecifyCO
when theListSlotTypes
operation should return aliases that contain the specified value. - values
-
- Required: Yes
- Type: Array of strings
The value to use to filter the response.
SlotTypeSortBy
Description
Specifies attributes for sorting a list of slot types.
Members
- attribute
-
- Required: Yes
- Type: string
The attribute to use to sort the list of slot types.
- order
-
- Required: Yes
- Type: string
The order to sort the list. You can say ascending or descending.
SlotTypeStatistics
Description
The object that contains the statistical summary of the recommended slot type associated with the bot recommendation.
Members
- discoveredSlotTypeCount
-
- Type: int
The number of recommended slot types associated with the bot recommendation.
SlotTypeSummary
Description
Provides summary information about a slot type.
Members
- description
-
- Type: string
The description of the slot type.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
A timestamp of the date and time that the slot type was last updated.
- parentSlotTypeSignature
-
- Type: string
If the slot type is derived from a built-on slot type, the name of the parent slot type.
- slotTypeCategory
-
- Type: string
Indicates the type of the slot type.
-
Custom
- A slot type that you created using custom values. For more information, see Creating custom slot types. -
Extended
- A slot type created by extending theAMAZON.AlphaNumeric
built-in slot type. For more information, seeAMAZON.AlphaNumeric
. -
ExternalGrammar
- A slot type using a custom GRXML grammar to define values. For more information, see Using a custom grammar slot type.
- slotTypeId
-
- Type: string
The unique identifier assigned to the slot type.
- slotTypeName
-
- Type: string
The name of the slot type.
SlotTypeValue
Description
Each slot type can have a set of values. Each SlotTypeValue
represents a value that the slot type can take.
Members
- sampleValue
-
- Type: SampleValue structure
The value of the slot type entry.
- synonyms
-
- Type: Array of SampleValue structures
Additional values related to the slot type entry.
SlotValue
Description
The value to set in a slot.
Members
- interpretedValue
-
- Type: string
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.
SlotValueElicitationSetting
Description
Specifies the elicitation setting details eliciting a slot.
Members
- defaultValueSpecification
-
- Type: SlotDefaultValueSpecification structure
A list of default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, session attributes, and defined values.
- promptSpecification
-
- Type: PromptSpecification structure
The prompt that Amazon Lex uses to elicit the slot value from the user.
- sampleUtterances
-
- Type: Array of SampleUtterance structures
If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.
- slotCaptureSetting
-
- Type: SlotCaptureSetting structure
Specifies the settings that Amazon Lex uses when a slot value is successfully entered by a user.
- slotConstraint
-
- Required: Yes
- Type: string
Specifies whether the slot is required or optional.
- slotResolutionSetting
-
- Type: SlotResolutionSetting structure
An object containing information about whether assisted slot resolution is turned on for the slot or not.
- waitAndContinueSpecification
-
- Type: WaitAndContinueSpecification structure
Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.
SlotValueOverride
Description
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
Members
- shape
-
- Type: string
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value. - value
-
- Type: SlotValue structure
The current value of the slot.
- values
-
- Type: Array of SlotValueOverride structures
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be "pepperoni" and "pineapple."
SlotValueRegexFilter
Description
Provides a regular expression used to validate the value of a slot.
Members
- pattern
-
- Required: Yes
- Type: string
A regular expression used to validate the value of a slot.
Use a standard regular expression. Amazon Lex supports the following characters in the regular expression:
-
A-Z, a-z
-
0-9
-
Unicode characters ("\u<Unicode>")
Represent Unicode characters with four digits, for example "\u0041" or "\u005A".
The following regular expression operators are not supported:
-
Infinite repeaters: *, +, or {x,} with no upper bound.
-
Wild card (.)
SlotValueSelectionSetting
Description
Contains settings used by Amazon Lex to select a slot value.
Members
- advancedRecognitionSetting
-
- Type: AdvancedRecognitionSetting structure
Provides settings that enable advanced recognition settings for slot values. You can use this to enable using slot values as a custom vocabulary for recognizing user utterances.
- regexFilter
-
- Type: SlotValueRegexFilter structure
A regular expression used to validate the value of a slot.
- resolutionStrategy
-
- Required: Yes
- Type: string
Determines the slot resolution strategy that Amazon Lex uses to return slot type 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 as the slot type value. If there is no resolution list, null is returned.
If you don't specify the
valueSelectionStrategy
, the default isORIGINAL_VALUE
.
Specifications
Description
Subslot specifications.
Members
- slotTypeId
-
- Required: Yes
- Type: string
The unique identifier assigned to the slot type.
- valueElicitationSetting
-
- Required: Yes
- Type: SubSlotValueElicitationSetting structure
Specifies the elicitation setting details for constituent sub slots of a composite slot.
StillWaitingResponseSpecification
Description
Defines the messages that Amazon Lex sends to a user to remind them that the bot is waiting for a response.
Members
- allowInterrupt
-
- Type: boolean
Indicates that the user can interrupt the response by speaking while the message is being played.
- frequencyInSeconds
-
- Required: Yes
- Type: int
How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.
- messageGroups
-
- Required: Yes
- Type: Array of MessageGroup structures
One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.
- timeoutInSeconds
-
- Required: Yes
- Type: int
If Amazon Lex waits longer than this length of time for a response, it will stop sending messages.
SubSlotSetting
Description
Specifications for the constituent sub slots and the expression for the composite slot.
Members
- expression
-
- Type: string
The expression text for defining the constituent sub slots in the composite slot using logical AND and OR operators.
- slotSpecifications
-
- Type: Associative array of custom strings keys (Name) to Specifications structures
Specifications for the constituent sub slots of a composite slot.
SubSlotTypeComposition
Description
Subslot type composition.
Members
- name
-
- Required: Yes
- Type: string
Name of a constituent sub slot inside a composite slot.
- slotTypeId
-
- Required: Yes
- Type: string
The unique identifier assigned to a slot type. This refers to either a built-in slot type or the unique slotTypeId of a custom slot type.
SubSlotValueElicitationSetting
Description
Subslot elicitation settings.
DefaultValueSpecification
is a list of default values for a constituent sub slot in a composite slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, session attributes, and defined values. This is similar to DefaultValueSpecification
for slots.
PromptSpecification
is the prompt that Amazon Lex uses to elicit the sub slot value from the user. This is similar to PromptSpecification
for slots.
Members
- defaultValueSpecification
-
- Type: SlotDefaultValueSpecification structure
Defines a list of values that Amazon Lex should use as the default value for a slot.
- promptSpecification
-
- Required: Yes
- Type: PromptSpecification structure
Specifies a list of message groups that Amazon Lex sends to a user to elicit a response.
- sampleUtterances
-
- Type: Array of SampleUtterance structures
If you know a specific pattern that users might respond to an Amazon Lex request for a sub slot value, you can provide those utterances to improve accuracy. This is optional. In most cases Amazon Lex is capable of understanding user utterances. This is similar to
SampleUtterances
for slots. - waitAndContinueSpecification
-
- Type: WaitAndContinueSpecification structure
Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.
TestExecutionResultFilterBy
Description
Contains information about the method by which to filter the results of the test execution.
Members
- conversationLevelTestResultsFilterBy
-
- Type: ConversationLevelTestResultsFilterBy structure
Contains information about the method for filtering Conversation level test results.
- resultTypeFilter
-
- Required: Yes
- Type: string
Specifies which results to filter. See Test result details">Test results details for details about different types of results.
TestExecutionResultItems
Description
Contains the results of the test execution, grouped by type of results. See Test result details">Test results details for details about different types of results.
Members
- conversationLevelTestResults
-
- Type: ConversationLevelTestResults structure
Results related to conversations in the test set, including metrics about success and failure of conversations and intent and slot failures.
- intentClassificationTestResults
-
- Type: IntentClassificationTestResults structure
Intent recognition results aggregated by intent name. The aggregated results contain success and failure rates of intent recognition, speech transcriptions, and end-to-end conversations.
- intentLevelSlotResolutionTestResults
-
- Type: IntentLevelSlotResolutionTestResults structure
Slot resolution results aggregated by intent and slot name. The aggregated results contain success and failure rates of slot resolution, speech transcriptions, and end-to-end conversations
- overallTestResults
-
- Type: OverallTestResults structure
Overall results for the test execution, including the breakdown of conversations and single-input utterances.
- utteranceLevelTestResults
-
- Type: UtteranceLevelTestResults structure
Results related to utterances in the test set.
TestExecutionSortBy
Description
Contains information about the method by which to sort the instances of test executions you have carried out.
Members
- attribute
-
- Required: Yes
- Type: string
Specifies whether to sort the test set executions by the date and time at which the test sets were created.
- order
-
- Required: Yes
- Type: string
Specifies whether to sort in ascending or descending order.
TestExecutionSummary
Description
Summarizes metadata about the test execution.
Members
- apiMode
-
- Type: string
Specifies whether the API mode for the test execution is streaming or non-streaming.
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time at which the test execution was created.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time at which the test execution was last updated.
- target
-
- Type: TestExecutionTarget structure
Contains information about the bot used for the test execution..
- testExecutionId
-
- Type: string
The unique identifier of the test execution.
- testExecutionModality
-
- Type: string
Specifies whether the data used for the test execution is written or spoken.
- testExecutionStatus
-
- Type: string
The current status of the test execution.
- testSetId
-
- Type: string
The unique identifier of the test set used in the test execution.
- testSetName
-
- Type: string
The name of the test set used in the test execution.
TestExecutionTarget
Description
Contains information about the bot used for the test execution.
Members
- botAliasTarget
-
- Type: BotAliasTestExecutionTarget structure
Contains information about the bot alias used for the test execution.
TestSetDiscrepancyErrors
Description
Contains details about the errors in the test set discrepancy report
Members
- intentDiscrepancies
-
- Required: Yes
- Type: Array of TestSetIntentDiscrepancyItem structures
Contains information about discrepancies found for intents between the test set and the bot.
- slotDiscrepancies
-
- Required: Yes
- Type: Array of TestSetSlotDiscrepancyItem structures
Contains information about discrepancies found for slots between the test set and the bot.
TestSetDiscrepancyReportBotAliasTarget
Description
Contains information about the bot alias used for the test set discrepancy report.
Members
- botAliasId
-
- Required: Yes
- Type: string
The unique identifier for the bot associated with the bot alias.
- botId
-
- Required: Yes
- Type: string
The unique identifier for the bot alias.
- localeId
-
- Required: Yes
- Type: string
The unique identifier of the locale associated with the bot alias.
TestSetDiscrepancyReportResourceTarget
Description
Contains information about the resource used for the test set discrepancy report.
Members
- botAliasTarget
-
- Type: TestSetDiscrepancyReportBotAliasTarget structure
Contains information about the bot alias used as the resource for the test set discrepancy report.
TestSetExportSpecification
Description
Contains information about the test set that is exported.
Members
- testSetId
-
- Required: Yes
- Type: string
The unique identifier of the test set.
TestSetGenerationDataSource
Description
Contains information about the data source from which the test set is generated.
Members
- conversationLogsDataSource
-
- Type: ConversationLogsDataSource structure
Contains information about the bot from which the conversation logs are sourced.
TestSetImportInputLocation
Description
Contains information about the Amazon S3 location from which the test set is imported.
Members
- s3BucketName
-
- Required: Yes
- Type: string
The name of the Amazon S3 bucket.
- s3Path
-
- Required: Yes
- Type: string
The path inside the Amazon S3 bucket pointing to the test-set CSV file.
TestSetImportResourceSpecification
Description
Contains information about the test set that is imported.
Members
- description
-
- Type: string
The description of the test set.
- importInputLocation
-
- Required: Yes
- Type: TestSetImportInputLocation structure
Contains information about the input location from where test-set should be imported.
- modality
-
- Required: Yes
- Type: string
Specifies whether the test-set being imported contains written or spoken data.
- roleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of an IAM role that has permission to access the test set.
- storageLocation
-
- Required: Yes
- Type: TestSetStorageLocation structure
Contains information about the location that Amazon Lex uses to store the test-set.
- testSetName
-
- Required: Yes
- Type: string
The name of the test set.
- testSetTags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A list of tags to add to the test set. You can only add tags when you import/generate a new test set. You can't use the
UpdateTestSet
operation to update tags. To update tags, use theTagResource
operation.
TestSetIntentDiscrepancyItem
Description
Contains information about discrepancy in an intent information between the test set and the bot.
Members
- errorMessage
-
- Required: Yes
- Type: string
The error message for a discrepancy for an intent between the test set and the bot.
- intentName
-
- Required: Yes
- Type: string
The name of the intent in the discrepancy report.
TestSetSlotDiscrepancyItem
Description
Contains information about discrepancy in a slot information between the test set and the bot.
Members
- errorMessage
-
- Required: Yes
- Type: string
The error message for a discrepancy for an intent between the test set and the bot.
- intentName
-
- Required: Yes
- Type: string
The name of the intent associated with the slot in the discrepancy report.
- slotName
-
- Required: Yes
- Type: string
The name of the slot in the discrepancy report.
TestSetSortBy
Description
Contains information about the methods by which to sort the test set.
Members
- attribute
-
- Required: Yes
- Type: string
Specifies whether to sort the test sets by name or by the time they were last updated.
- order
-
- Required: Yes
- Type: string
Specifies whether to sort in ascending or descending order.
TestSetStorageLocation
Description
Contains information about the location in which the test set is stored.
Members
- kmsKeyArn
-
- Type: string
The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service (KMS) key for encrypting the test set.
- s3BucketName
-
- Required: Yes
- Type: string
The name of the Amazon S3 bucket in which the test set is stored.
- s3Path
-
- Required: Yes
- Type: string
The path inside the Amazon S3 bucket where the test set is stored.
TestSetSummary
Description
Contains summary information about the test set.
Members
- creationDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time at which the test set was created.
- description
-
- Type: string
The description of the test set.
- lastUpdatedDateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time at which the test set was last updated.
- modality
-
- Type: string
Specifies whether the test set contains written or spoken data.
- numTurns
-
- Type: int
The number of turns in the test set.
- roleArn
-
- Type: string
The Amazon Resource Name (ARN) of an IAM role that has permission to access the test set.
- status
-
- Type: string
The status of the test set.
- storageLocation
-
- Type: TestSetStorageLocation structure
Contains information about the location at which the test set is stored.
- testSetId
-
- Type: string
The unique identifier of the test set.
- testSetName
-
- Type: string
The name of the test set.
TestSetTurnRecord
Description
Contains information about a turn in a test set.
Members
- conversationId
-
- Type: string
The unique identifier for the conversation associated with the turn.
- recordNumber
-
- Required: Yes
- Type: long (int|float)
The record number associated with the turn.
- turnNumber
-
- Type: int
The number of turns that has elapsed up to that turn.
- turnSpecification
-
- Required: Yes
- Type: TurnSpecification structure
Contains information about the agent or user turn depending upon type of turn.
TestSetTurnResult
Description
Contains information about the results of the analysis of a turn in the test set.
Members
- agent
-
- Type: AgentTurnResult structure
Contains information about the agent messages in the turn.
- user
-
- Type: UserTurnResult structure
Contains information about the user messages in the turn.
TextInputSpecification
Description
Specifies the text input specifications.
Members
- startTimeoutMs
-
- Required: Yes
- Type: int
Time for which a bot waits before re-prompting a customer for text input.
TextLogDestination
Description
Defines the Amazon CloudWatch Logs destination log group for conversation text logs.
Members
- cloudWatch
-
- Required: Yes
- Type: CloudWatchLogGroupLogDestination structure
Defines the Amazon CloudWatch Logs log group where text and metadata logs are delivered.
TextLogSetting
Description
Defines settings to enable text conversation logs.
Members
- destination
-
- Required: Yes
- Type: TextLogDestination structure
Defines the Amazon CloudWatch Logs destination log group for conversation text logs.
- enabled
-
- Required: Yes
- Type: boolean
Determines whether conversation logs should be stored for an alias.
- selectiveLoggingEnabled
-
- Type: boolean
The option to enable selective conversation log capture for text.
ThrottlingException
Description
Your request rate is too high. Reduce the frequency of requests.
Members
- message
-
- Type: string
- retryAfterSeconds
-
- Type: int
The number of seconds after which the user can invoke the API again.
TranscriptFilter
Description
The object representing the filter that Amazon Lex will use to select the appropriate transcript.
Members
- lexTranscriptFilter
-
- Type: LexTranscriptFilter structure
The object representing the filter that Amazon Lex will use to select the appropriate transcript when the transcript format is the Amazon Lex format.
TranscriptSourceSetting
Description
Indicates the setting of the location where the transcript is stored.
Members
- s3BucketTranscriptSource
-
- Type: S3BucketTranscriptSource structure
Indicates the setting of the Amazon S3 bucket where the transcript is stored.
TurnSpecification
Description
Contains information about the messages in the turn.
Members
- agentTurn
-
- Type: AgentTurnSpecification structure
Contains information about the agent messages in the turn.
- userTurn
-
- Type: UserTurnSpecification structure
Contains information about the user messages in the turn.
UserTurnInputSpecification
Description
Contains information about the user messages in the turn in the input.
Members
- requestAttributes
-
- Type: Associative array of custom strings keys (NonEmptyString) to strings
Request attributes of the user turn.
- sessionState
-
- Type: InputSessionStateSpecification structure
Contains information about the session state in the input.
- utteranceInput
-
- Required: Yes
- Type: UtteranceInputSpecification structure
The utterance input in the user turn.
UserTurnIntentOutput
Description
Contains information about the intent that is output for the turn by the test execution.
Members
- name
-
- Required: Yes
- Type: string
The name of the intent.
- slots
-
- Type: Associative array of custom strings keys (Name) to UserTurnSlotOutput structures
The slots associated with the intent.
UserTurnOutputSpecification
Description
Contains results that are output for the user turn by the test execution.
Members
- activeContexts
-
- Type: Array of ActiveContext structures
The contexts that are active in the turn.
- intent
-
- Required: Yes
- Type: UserTurnIntentOutput structure
Contains information about the intent.
- transcript
-
- Type: string
The transcript that is output for the user turn by the test execution.
UserTurnResult
Description
Contains the results for the user turn by the test execution.
Members
- actualOutput
-
- Type: UserTurnOutputSpecification structure
Contains information about the actual output for the user turn.
- conversationLevelResult
-
- Type: ConversationLevelResultDetail structure
Contains information about the results related to the conversation associated with the user turn.
- endToEndResult
-
- Type: string
Specifies whether the expected and actual outputs match or not, or if there is an error in execution.
- errorDetails
-
- Type: ExecutionErrorDetails structure
Details about an error in an execution of a test set.
- expectedOutput
-
- Required: Yes
- Type: UserTurnOutputSpecification structure
Contains information about the expected output for the user turn.
- input
-
- Required: Yes
- Type: UserTurnInputSpecification structure
Contains information about the user messages in the turn in the input.
- intentMatchResult
-
- Type: string
Specifies whether the expected and actual intents match or not.
- slotMatchResult
-
- Type: string
Specifies whether the expected and actual slots match or not.
- speechTranscriptionResult
-
- Type: string
Specifies whether the expected and actual speech transcriptions match or not, or if there is an error in execution.
UserTurnSlotOutput
Description
Contains information about a slot output by the test set execution.
Members
- subSlots
-
- Type: Associative array of custom strings keys (Name) to UserTurnSlotOutput structures
A list of items mapping the name of the subslots to information about those subslots.
- value
-
- Type: string
The value output by the slot recognition.
- values
-
- Type: Array of UserTurnSlotOutput structures
Values that are output by the slot recognition.
UserTurnSpecification
Description
Contains information about the expected and input values for the user turn.
Members
- expected
-
- Required: Yes
- Type: UserTurnOutputSpecification structure
Contains results about the expected output for the user turn.
- input
-
- Required: Yes
- Type: UserTurnInputSpecification structure
Contains information about the user messages in the turn in the input.
UtteranceAggregationDuration
Description
Provides parameters for setting the time window and duration for aggregating utterance data.
Members
- relativeAggregationDuration
-
- Required: Yes
- Type: RelativeAggregationDuration structure
The desired time window for aggregating utterances.
UtteranceAudioInputSpecification
Description
Contains information about the audio for an utterance.
Members
- audioFileS3Location
-
- Required: Yes
- Type: string
Amazon S3 file pointing to the audio.
UtteranceBotResponse
Description
An object that contains a response to the utterance from the bot.
Members
- content
-
- Type: string
The text of the response to the utterance from the bot.
- contentType
-
- Type: string
The type of the response. The following values are possible:
-
PlainText
– A plain text string. -
CustomPayload
– A response string that you can customize to include data or metadata for your application. -
SSML
– A string that includes Speech Synthesis Markup Language to customize the audio response. -
ImageResponseCard
– An image with buttons that the customer can select. See ImageResponseCard for more information.
- imageResponseCard
-
- Type: ImageResponseCard structure
A card that is shown to the user by a messaging platform. You define the contents of the card, the card is displayed by the platform.
When you use a response card, the response from the user is constrained to the text associated with a button on the card.
UtteranceDataSortBy
Description
An object specifying the measure and method by which to sort the utterance data.
Members
- name
-
- Required: Yes
- Type: string
The measure by which to sort the utterance analytics data.
-
Count
– The number of utterances. -
UtteranceTimestamp
– The date and time of the utterance.
- order
-
- Required: Yes
- Type: string
Specifies whether to sort the results in ascending or descending order.
UtteranceInputSpecification
Description
Contains information about input of an utterance.
Members
- audioInput
-
- Type: UtteranceAudioInputSpecification structure
Contains information about the audio input for an utterance.
- textInput
-
- Type: string
A text input transcription of the utterance. It is only applicable for test-sets containing text data.
UtteranceLevelTestResultItem
Description
Contains information about multiple utterances in the results of a test set execution.
Members
- conversationId
-
- Type: string
The unique identifier for the conversation associated with the result.
- recordNumber
-
- Required: Yes
- Type: long (int|float)
The record number of the result.
- turnResult
-
- Required: Yes
- Type: TestSetTurnResult structure
Contains information about the turn associated with the result.
UtteranceLevelTestResults
Description
Contains information about the utterances in the results of the test set execution.
Members
- items
-
- Required: Yes
- Type: Array of UtteranceLevelTestResultItem structures
Contains information about an utterance in the results of the test set execution.
UtteranceSpecification
Description
An object containing information about a specific utterance.
Members
- associatedIntentName
-
- Type: string
The name of the intent that the utterance is associated to.
- associatedSlotName
-
- Type: string
The name of the slot that the utterance is associated to.
- audioVoiceDurationMillis
-
- Type: long (int|float)
The duration in milliseconds of the audio associated with the utterance.
- botAliasId
-
- Type: string
The identifier of the alias of the bot that the utterance was made to.
- botResponseAudioVoiceId
-
- Type: string
The identifier for the audio of the bot response.
- botResponses
-
- Type: Array of UtteranceBotResponse structures
A list of objects containing information about the bot response to the utterance.
- botVersion
-
- Type: string
The version of the bot that the utterance was made to.
- channel
-
- Type: string
The channel that is integrated with the bot that the utterance was made to.
- conversationEndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time when the conversation in which the utterance took place ended. A conversation is defined as a unique combination of a
sessionId
and anoriginatingRequestId
. - conversationStartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time when the conversation in which the utterance took place began. A conversation is defined as a unique combination of a
sessionId
and anoriginatingRequestId
. - dialogActionType
-
- Type: string
The type of dialog action that the utterance is associated to. See the
type
field in DialogAction for more information. - inputType
-
- Type: string
The input type of the utterance. The possible values are as follows:
-
PCM format: audio data must be in little-endian byte order.
-
audio/l16; rate=16000; channels=1
-
audio/x-l16; sample-rate=16000; channel-count=1
-
audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false
-
-
Opus format
-
audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4
-
-
Text format
-
text/plain; charset=utf-8
-
- intentState
-
- Type: string
The state of the intent that the utterance is associated to.
- localeId
-
- Type: string
The locale of the bot that the utterance was made to.
- mode
-
- Type: string
The mode of the session. The possible values are as follows:
-
Speech
– The session consisted of spoken dialogue. -
Text
– The session consisted of written dialogue. -
DTMF
– The session consisted of touch-tone keypad (Dual Tone Multi-Frequency) key presses. -
MultiMode
– The session consisted of multiple modes.
- outputType
-
- Type: string
The output type of the utterance. The possible values are as follows:
-
audio/mpeg
-
audio/ogg
-
audio/pcm (16 KHz)
-
audio/
(defaults tompeg
) -
text/plain; charset=utf-8
- sessionId
-
- Type: string
The identifier of the session that the utterance was made in.
- slotsFilledInSession
-
- Type: string
The slots that have been filled in the session by the time of the utterance.
- utterance
-
- Type: string
The text of the utterance.
- utteranceRequestId
-
- Type: string
The identifier of the request associated with the utterance.
- utteranceTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time when the utterance took place.
- utteranceUnderstood
-
- Type: boolean
Specifies whether the bot understood the utterance or not.
ValidationException
Description
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
Members
- message
-
- Type: string
VoiceSettings
Description
Defines settings for using an Amazon Polly voice to communicate with a user.
Valid values include:
-
standard
-
neural
-
long-form
-
generative
Members
- engine
-
- Type: string
Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the
engine
parameter of theSynthesizeSpeech
operation in the Amazon Polly developer guide.If you do not specify a value, the default is
standard
. - voiceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Polly voice to use.
WaitAndContinueSpecification
Description
Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.
Members
- active
-
- Type: boolean
Specifies whether the bot will wait for a user to respond. When this field is false, wait and continue responses for a slot aren't used. If the
active
field isn't specified, the default is true. - continueResponse
-
- Required: Yes
- Type: ResponseSpecification structure
The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.
- stillWaitingResponse
-
- Type: StillWaitingResponseSpecification structure
A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.
- waitingResponse
-
- Required: Yes
- Type: ResponseSpecification structure
The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.