Struct aws_sdk_lexmodelsv2::Client
source · pub struct Client { /* private fields */ }Expand description
Client for Amazon Lex Model Building V2
Client for invoking operations on Amazon Lex Model Building V2. Each operation on Amazon Lex Model Building V2 is a method on this
this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_lexmodelsv2::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */Constructing a client with custom configuration
use aws_config::retry::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_lexmodelsv2::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_lexmodelsv2::Client::from_conf(config);Implementations§
source§impl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
source§impl Client
impl Client
sourcepub fn batch_create_custom_vocabulary_item(
&self
) -> BatchCreateCustomVocabularyItem
pub fn batch_create_custom_vocabulary_item(
&self
) -> BatchCreateCustomVocabularyItem
Constructs a fluent builder for the BatchCreateCustomVocabularyItem operation.
- The fluent builder is configurable:
bot_id(impl Into<String>)/set_bot_id(Option<String>):The unique identifier of the bot to batch create the custom vocabulary item for.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The bot version of the bot to batch create the custom vocabulary item for.
locale_id(impl Into<String>)/set_locale_id(Option<String>):The unique locale identifier of the bot to batch create the custom vocabulary item for.
custom_vocabulary_item_list(Vec<NewCustomVocabularyItem>)/set_custom_vocabulary_item_list(Option<Vec<NewCustomVocabularyItem>>):The custom vocabulary item list of the bot to batch create the custom vocabulary item for.
- On success, responds with
BatchCreateCustomVocabularyItemOutputwith field(s):bot_id(Option<String>):The unique identifier of the bot to batch create response for the custom vocabulary item.
bot_version(Option<String>):The bot version of the bot to batch create the custom vocabulary item response for.
locale_id(Option<String>):The unique locale identifier of the bot to batch create the custom vocabulary item response for.
errors(Option<Vec<FailedCustomVocabularyItem>>):The errors of the action to batch create the custom vocabulary item response for a bot.
resources(Option<Vec<CustomVocabularyItem>>):The resources of the action to batch create the custom vocabulary item response for a bot.
- On failure, responds with
SdkError<BatchCreateCustomVocabularyItemError>
sourcepub fn batch_delete_custom_vocabulary_item(
&self
) -> BatchDeleteCustomVocabularyItem
pub fn batch_delete_custom_vocabulary_item(
&self
) -> BatchDeleteCustomVocabularyItem
Constructs a fluent builder for the BatchDeleteCustomVocabularyItem operation.
- The fluent builder is configurable:
bot_id(impl Into<String>)/set_bot_id(Option<String>):The unique identifier of the bot to batch delete request for the custom vocabulary item.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The version of the bot to batch delete request for the custom vocabulary item.
locale_id(impl Into<String>)/set_locale_id(Option<String>):The locale identifier of the bot to batch delete request for the custom vocabulary item.
custom_vocabulary_item_list(Vec<CustomVocabularyEntryId>)/set_custom_vocabulary_item_list(Option<Vec<CustomVocabularyEntryId>>):The custom vocabulary list to batch delete request for the custom vocabulary item.
- On success, responds with
BatchDeleteCustomVocabularyItemOutputwith field(s):bot_id(Option<String>):The unique identifier of the bot to batch delete response for the custom vocabulary item.
bot_version(Option<String>):The version of the bot to batch delete response for the custom vocabulary item.
locale_id(Option<String>):The locale identifier of the bot to batch delete response for the custom vocabulary item.
errors(Option<Vec<FailedCustomVocabularyItem>>):The errors of the action to batch delete response for the custom vocabulary item.
resources(Option<Vec<CustomVocabularyItem>>):The resources of the action to batch delete response for the custom vocabulary item.
- On failure, responds with
SdkError<BatchDeleteCustomVocabularyItemError>
sourcepub fn batch_update_custom_vocabulary_item(
&self
) -> BatchUpdateCustomVocabularyItem
pub fn batch_update_custom_vocabulary_item(
&self
) -> BatchUpdateCustomVocabularyItem
Constructs a fluent builder for the BatchUpdateCustomVocabularyItem operation.
- The fluent builder is configurable:
bot_id(impl Into<String>)/set_bot_id(Option<String>):The unique identifier of the bot to the batch update request for the custom vocabulary item.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The bot version of the bot to the batch update request for the custom vocabulary item.
locale_id(impl Into<String>)/set_locale_id(Option<String>):The locale identifier of the bot to the batch update request for the custom vocabulary item.
custom_vocabulary_item_list(Vec<CustomVocabularyItem>)/set_custom_vocabulary_item_list(Option<Vec<CustomVocabularyItem>>):The custom vocabulary item list of the bot to the batch update request for the custom vocabulary item.
- On success, responds with
BatchUpdateCustomVocabularyItemOutputwith field(s):bot_id(Option<String>):The unique identifier of the bot to the batch update response for the custom vocabulary item.
bot_version(Option<String>):The bot version of the bot to the batch update response for the custom vocabulary item.
locale_id(Option<String>):The locale identifier of the bot to the batch update response for the custom vocabulary item.
errors(Option<Vec<FailedCustomVocabularyItem>>):The errors of the action to batch update response for the custom vocabulary item.
resources(Option<Vec<CustomVocabularyItem>>):The resources of the action to batch update response for the custom vocabulary item.
- On failure, responds with
SdkError<BatchUpdateCustomVocabularyItemError>
sourcepub fn build_bot_locale(&self) -> BuildBotLocale
pub fn build_bot_locale(&self) -> BuildBotLocale
Constructs a fluent builder for the BuildBotLocale operation.
- The fluent builder is configurable:
bot_id(impl Into<String>)/set_bot_id(Option<String>):The identifier of the bot to build. The identifier is returned in the response from the CreateBot operation.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The version of the bot to build. This can only be the draft version of the bot.
locale_id(impl Into<String>)/set_locale_id(Option<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.
- On success, responds with
BuildBotLocaleOutputwith field(s):bot_id(Option<String>):The identifier of the specified bot.
bot_version(Option<String>):The version of the bot that was built. This is only the draft version of the bot.
locale_id(Option<String>):The language and locale specified of where the bot can be used.
bot_locale_status(Option<BotLocaleStatus>):The bot’s build status. When the status is
ReadyExpressTestingyou 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.last_build_submitted_date_time(Option<DateTime>):A timestamp indicating the date and time that the bot was last built for this locale.
- On failure, responds with
SdkError<BuildBotLocaleError>
sourcepub fn create_bot(&self) -> CreateBot
pub fn create_bot(&self) -> CreateBot
Constructs a fluent builder for the CreateBot operation.
- The fluent builder is configurable:
bot_name(impl Into<String>)/set_bot_name(Option<String>):The name of the bot. The bot name must be unique in the account that creates the bot.
description(impl Into<String>)/set_description(Option<String>):A description of the bot. It appears in lists to help you identify a particular bot.
role_arn(impl Into<String>)/set_role_arn(Option<String>):The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.
data_privacy(DataPrivacy)/set_data_privacy(Option<DataPrivacy>):Provides information on additional privacy protections Amazon Lex should use with the bot’s data.
idle_session_ttl_in_seconds(i32)/set_idle_session_ttl_in_seconds(Option<i32>):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.
bot_tags(HashMap<String, String>)/set_bot_tags(Option<HashMap<String, String>>):A list of tags to add to the bot. You can only add tags when you create a bot. You can’t use the
UpdateBotoperation to update tags. To update tags, use theTagResourceoperation.test_bot_alias_tags(HashMap<String, String>)/set_test_bot_alias_tags(Option<HashMap<String, String>>):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
UpdateAliasoperation to update tags. To update tags on the test alias, use theTagResourceoperation.
- On success, responds with
CreateBotOutputwith field(s):bot_id(Option<String>):A unique identifier for a particular bot. You use this to identify the bot when you call other Amazon Lex API operations.
bot_name(Option<String>):The name specified for the bot.
description(Option<String>):The description specified for the bot.
role_arn(Option<String>):The IAM role specified for the bot.
data_privacy(Option<DataPrivacy>):The data privacy settings specified for the bot.
idle_session_ttl_in_seconds(Option<i32>):The session idle time specified for the bot.
bot_status(Option<BotStatus>):Shows the current status of the bot. The bot is first in the
Creatingstatus. Once the bot is read for use, it changes to theAvailablestatus. After the bot is created, you can use theDraftversion of the bot.creation_date_time(Option<DateTime>):A timestamp indicating the date and time that the bot was created.
bot_tags(Option<HashMap<String, String>>):A list of tags associated with the bot.
test_bot_alias_tags(Option<HashMap<String, String>>):A list of tags associated with the test alias for the bot.
- On failure, responds with
SdkError<CreateBotError>
sourcepub fn create_bot_alias(&self) -> CreateBotAlias
pub fn create_bot_alias(&self) -> CreateBotAlias
Constructs a fluent builder for the CreateBotAlias operation.
- The fluent builder is configurable:
bot_alias_name(impl Into<String>)/set_bot_alias_name(Option<String>):The alias to create. The name must be unique for the bot.
description(impl Into<String>)/set_description(Option<String>):A description of the alias. Use this description to help identify the alias.
bot_version(impl Into<String>)/set_bot_version(Option<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.
bot_alias_locale_settings(HashMap<String, BotAliasLocaleSettings>)/set_bot_alias_locale_settings(Option<HashMap<String, BotAliasLocaleSettings>>):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.
conversation_log_settings(ConversationLogSettings)/set_conversation_log_settings(Option<ConversationLogSettings>):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.
sentiment_analysis_settings(SentimentAnalysisSettings)/set_sentiment_analysis_settings(Option<SentimentAnalysisSettings>):Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
bot_id(impl Into<String>)/set_bot_id(Option<String>):The unique identifier of the bot that the alias applies to.
tags(HashMap<String, String>)/set_tags(Option<HashMap<String, String>>):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
UpdateBotAliasoperation to update the tags on a bot alias. To update tags, use theTagResourceoperation.
- On success, responds with
CreateBotAliasOutputwith field(s):bot_alias_id(Option<String>):The unique identifier of the bot alias.
bot_alias_name(Option<String>):The name specified for the bot alias.
description(Option<String>):The description specified for the bot alias.
bot_version(Option<String>):The version of the bot associated with this alias.
bot_alias_locale_settings(Option<HashMap<String, BotAliasLocaleSettings>>):Configuration information for a specific locale.
conversation_log_settings(Option<ConversationLogSettings>):The conversation log settings specified for the alias.
sentiment_analysis_settings(Option<SentimentAnalysisSettings>):Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
bot_alias_status(Option<BotAliasStatus>):The current status of the alias. The alias is first put into the
Creatingstate. When the alias is ready to be used, it is put into theAvailablestate. You can use theDescribeBotAliasoperation to get the current state of an alias.bot_id(Option<String>):The unique identifier of the bot that this alias applies to.
creation_date_time(Option<DateTime>):A Unix timestamp indicating the date and time that the bot alias was created.
tags(Option<HashMap<String, String>>):A list of tags associated with the bot alias.
- On failure, responds with
SdkError<CreateBotAliasError>
sourcepub fn create_bot_locale(&self) -> CreateBotLocale
pub fn create_bot_locale(&self) -> CreateBotLocale
Constructs a fluent builder for the CreateBotLocale operation.
- The fluent builder is configurable:
bot_id(impl Into<String>)/set_bot_id(Option<String>):The identifier of the bot to create the locale for.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The version of the bot to create the locale for. This can only be the draft version of the bot.
locale_id(impl Into<String>)/set_locale_id(Option<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.
description(impl Into<String>)/set_description(Option<String>):A description of the bot locale. Use this to help identify the bot locale in lists.
nlu_intent_confidence_threshold(f64)/set_nlu_intent_confidence_threshold(Option<f64>):Determines the threshold where Amazon Lex will insert the
AMAZON.FallbackIntent,AMAZON.KendraSearchIntent, or both when returning alternative intents.AMAZON.FallbackIntentandAMAZON.KendraSearchIntentare 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 theRecognizeTextoperation would be:-
AMAZON.FallbackIntent
-
IntentA
-
IntentB
-
IntentC
-
voice_settings(VoiceSettings)/set_voice_settings(Option<VoiceSettings>):The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.
- On success, responds with
CreateBotLocaleOutputwith field(s):bot_id(Option<String>):The specified bot identifier.
bot_version(Option<String>):The specified bot version.
locale_name(Option<String>):The specified locale name.
locale_id(Option<String>):The specified locale identifier.
description(Option<String>):The specified description of the bot locale.
nlu_intent_confidence_threshold(Option<f64>):The specified confidence threshold for inserting the
AMAZON.FallbackIntentandAMAZON.KendraSearchIntentintents.voice_settings(Option<VoiceSettings>):The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.
bot_locale_status(Option<BotLocaleStatus>):The status of the bot.
When the status is
Creatingthe bot locale is being configured. When the status isBuildingAmazon 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.creation_date_time(Option<DateTime>):A timestamp specifying the date and time that the bot locale was created.
- On failure, responds with
SdkError<CreateBotLocaleError>
sourcepub fn create_bot_version(&self) -> CreateBotVersion
pub fn create_bot_version(&self) -> CreateBotVersion
Constructs a fluent builder for the CreateBotVersion operation.
- The fluent builder is configurable:
bot_id(impl Into<String>)/set_bot_id(Option<String>):The identifier of the bot to create the version for.
description(impl Into<String>)/set_description(Option<String>):A description of the version. Use the description to help identify the version in lists.
bot_version_locale_specification(HashMap<String, BotVersionLocaleDetails>)/set_bot_version_locale_specification(Option<HashMap<String, BotVersionLocaleDetails>>):Specifies the locales that Amazon Lex adds to this version. You can choose the
Draftversion 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.
- On success, responds with
CreateBotVersionOutputwith field(s):bot_id(Option<String>):The bot identifier specified in the request.
description(Option<String>):The description of the version specified in the request.
bot_version(Option<String>):The version number assigned to the version.
bot_version_locale_specification(Option<HashMap<String, BotVersionLocaleDetails>>):The source versions used for each locale in the new version.
bot_status(Option<BotStatus>):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.creation_date_time(Option<DateTime>):A timestamp of the date and time that the version was created.
- On failure, responds with
SdkError<CreateBotVersionError>
sourcepub fn create_export(&self) -> CreateExport
pub fn create_export(&self) -> CreateExport
Constructs a fluent builder for the CreateExport operation.
- The fluent builder is configurable:
resource_specification(ExportResourceSpecification)/set_resource_specification(Option<ExportResourceSpecification>):Specifies the type of resource to export, either a bot or a bot locale. You can only specify one type of resource to export.
file_format(ImportExportFileFormat)/set_file_format(Option<ImportExportFileFormat>):The file format of the bot or bot locale definition files.
file_password(impl Into<String>)/set_file_password(Option<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.
- On success, responds with
CreateExportOutputwith field(s):export_id(Option<String>):An identifier for a specific request to create an export.
resource_specification(Option<ExportResourceSpecification>):A description of the type of resource that was exported, either a bot or a bot locale.
file_format(Option<ImportExportFileFormat>):The file format used for the bot or bot locale definition files.
export_status(Option<ExportStatus>):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.creation_date_time(Option<DateTime>):The date and time that the request to export a bot was created.
- On failure, responds with
SdkError<CreateExportError>
sourcepub fn create_intent(&self) -> CreateIntent
pub fn create_intent(&self) -> CreateIntent
Constructs a fluent builder for the CreateIntent operation.
- The fluent builder is configurable:
intent_name(impl Into<String>)/set_intent_name(Option<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.
description(impl Into<String>)/set_description(Option<String>):A description of the intent. Use the description to help identify the intent in lists.
parent_intent_signature(impl Into<String>)/set_parent_intent_signature(Option<String>):A unique identifier for the built-in intent to base this intent on.
sample_utterances(Vec<SampleUtterance>)/set_sample_utterances(Option<Vec<SampleUtterance>>):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..
dialog_code_hook(DialogCodeHookSettings)/set_dialog_code_hook(Option<DialogCodeHookSettings>):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,
glutenIntoleranttotrue. You might find John’s phone number and set the corresponding session attribute.fulfillment_code_hook(FulfillmentCodeHookSettings)/set_fulfillment_code_hook(Option<FulfillmentCodeHookSettings>):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.
intent_confirmation_setting(IntentConfirmationSetting)/set_intent_confirmation_setting(Option<IntentConfirmationSetting>):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.
intent_closing_setting(IntentClosingSetting)/set_intent_closing_setting(Option<IntentClosingSetting>):Sets the response that Amazon Lex sends to the user when the intent is closed.
input_contexts(Vec<InputContext>)/set_input_contexts(Option<Vec<InputContext>>):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
outputContextsproperty 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.
output_contexts(Vec<OutputContext>)/set_output_contexts(Option<Vec<OutputContext>>):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
outputContextsListproperty, 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.kendra_configuration(KendraConfiguration)/set_kendra_configuration(Option<KendraConfiguration>):Configuration information required to use the
AMAZON.KendraSearchIntentintent to connect to an Amazon Kendra index. TheAMAZON.KendraSearchIntentintent is called when Amazon Lex can’t determine another intent to invoke.bot_id(impl Into<String>)/set_bot_id(Option<String>):The identifier of the bot associated with this intent.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The identifier of the version of the bot associated with this intent.
locale_id(impl Into<String>)/set_locale_id(Option<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.
initial_response_setting(InitialResponseSetting)/set_initial_response_setting(Option<InitialResponseSetting>):Configuration settings for the response that is sent to the user at the beginning of a conversation, before eliciting slot values.
- On success, responds with
CreateIntentOutputwith field(s):intent_id(Option<String>):A unique identifier for the intent.
intent_name(Option<String>):The name specified for the intent.
description(Option<String>):The description specified for the intent.
parent_intent_signature(Option<String>):The signature of the parent intent specified for the intent.
sample_utterances(Option<Vec<SampleUtterance>>):The sample utterances specified for the intent.
dialog_code_hook(Option<DialogCodeHookSettings>):The dialog Lambda function specified for the intent.
fulfillment_code_hook(Option<FulfillmentCodeHookSettings>):The fulfillment Lambda function specified for the intent.
intent_confirmation_setting(Option<IntentConfirmationSetting>):The confirmation setting specified for the intent.
intent_closing_setting(Option<IntentClosingSetting>):The closing setting specified for the intent.
input_contexts(Option<Vec<InputContext>>):The list of input contexts specified for the intent.
output_contexts(Option<Vec<OutputContext>>):The list of output contexts specified for the intent.
kendra_configuration(Option<KendraConfiguration>):Configuration for searching a Amazon Kendra index specified for the intent.
bot_id(Option<String>):The identifier of the bot associated with the intent.
bot_version(Option<String>):The identifier of the version of the bot associated with the intent.
locale_id(Option<String>):The locale that the intent is specified to use.
creation_date_time(Option<DateTime>):A timestamp of the date and time that the intent was created.
initial_response_setting(Option<InitialResponseSetting>):Configuration settings for the response that is sent to the user at the beginning of a conversation, before eliciting slot values.
- On failure, responds with
SdkError<CreateIntentError>
sourcepub fn create_resource_policy(&self) -> CreateResourcePolicy
pub fn create_resource_policy(&self) -> CreateResourcePolicy
Constructs a fluent builder for the CreateResourcePolicy operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
policy(impl Into<String>)/set_policy(Option<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.
- On success, responds with
CreateResourcePolicyOutputwith field(s):resource_arn(Option<String>):The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy was attached to.
revision_id(Option<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.
- On failure, responds with
SdkError<CreateResourcePolicyError>
sourcepub fn create_resource_policy_statement(&self) -> CreateResourcePolicyStatement
pub fn create_resource_policy_statement(&self) -> CreateResourcePolicyStatement
Constructs a fluent builder for the CreateResourcePolicyStatement operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
statement_id(impl Into<String>)/set_statement_id(Option<String>):The name of the statement. The ID is the same as the
SidIAM property. The statement name must be unique within the policy. For more information, see IAM JSON policy elements: Sid.effect(Effect)/set_effect(Option<Effect>):Determines whether the statement allows or denies access to the resource.
principal(Vec<Principal>)/set_principal(Option<Vec<Principal>>):An IAM principal, such as an IAM users, IAM roles, or AWS services that is allowed or denied access to a resource. For more information, see AWS JSON policy elements: Principal.
action(Vec<String>)/set_action(Option<Vec<String>>):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(HashMap<String, HashMap<String, String>>)/set_condition(Option<HashMap<String, HashMap<String, String>>>):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 .
expected_revision_id(impl Into<String>)/set_expected_revision_id(Option<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.
- On success, responds with
CreateResourcePolicyStatementOutputwith field(s):resource_arn(Option<String>):The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
revision_id(Option<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.
- On failure, responds with
SdkError<CreateResourcePolicyStatementError>
sourcepub fn create_slot(&self) -> CreateSlot
pub fn create_slot(&self) -> CreateSlot
Constructs a fluent builder for the CreateSlot operation.
- The fluent builder is configurable:
slot_name(impl Into<String>)/set_slot_name(Option<String>):The name of the slot. Slot names must be unique within the bot that contains the slot.
description(impl Into<String>)/set_description(Option<String>):A description of the slot. Use this to help identify the slot in lists.
slot_type_id(impl Into<String>)/set_slot_type_id(Option<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.
value_elicitation_setting(SlotValueElicitationSetting)/set_value_elicitation_setting(Option<SlotValueElicitationSetting>):Specifies prompts that Amazon Lex sends to the user to elicit a response that provides the value for the slot.
obfuscation_setting(ObfuscationSetting)/set_obfuscation_setting(Option<ObfuscationSetting>):Determines how slot values are used in Amazon CloudWatch logs. If the value of the
obfuscationSettingparameter 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.
bot_id(impl Into<String>)/set_bot_id(Option<String>):The identifier of the bot associated with the slot.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The version of the bot associated with the slot.
locale_id(impl Into<String>)/set_locale_id(Option<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.
intent_id(impl Into<String>)/set_intent_id(Option<String>):The identifier of the intent that contains the slot.
multiple_values_setting(MultipleValuesSetting)/set_multiple_values_setting(Option<MultipleValuesSetting>):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 to
truein any other locale, Amazon Lex throws aValidationException.If the
multipleValuesSettingis not set, the default value isfalse.sub_slot_setting(SubSlotSetting)/set_sub_slot_setting(Option<SubSlotSetting>):Specifications for the constituent sub slots and the expression for the composite slot.
- On success, responds with
CreateSlotOutputwith field(s):slot_id(Option<String>):The unique identifier associated with the slot. Use this to identify the slot when you update or delete it.
slot_name(Option<String>):The name specified for the slot.
description(Option<String>):The description associated with the slot.
slot_type_id(Option<String>):The unique identifier of the slot type associated with this slot.
value_elicitation_setting(Option<SlotValueElicitationSetting>):The value elicitation settings specified for the slot.
obfuscation_setting(Option<ObfuscationSetting>):Indicates whether the slot is configured to obfuscate values in Amazon CloudWatch logs.
bot_id(Option<String>):The unique identifier of the bot associated with the slot.
bot_version(Option<String>):The version of the bot associated with the slot.
locale_id(Option<String>):The language and local specified for the slot.
intent_id(Option<String>):The unique identifier of the intent associated with the slot.
creation_date_time(Option<DateTime>):The timestamp of the date and time that the slot was created.
multiple_values_setting(Option<MultipleValuesSetting>):Indicates whether the slot returns multiple values in one response.
sub_slot_setting(Option<SubSlotSetting>):Specifications for the constituent sub slots and the expression for the composite slot.
- On failure, responds with
SdkError<CreateSlotError>
sourcepub fn create_slot_type(&self) -> CreateSlotType
pub fn create_slot_type(&self) -> CreateSlotType
Constructs a fluent builder for the CreateSlotType operation.
- The fluent builder is configurable:
slot_type_name(impl Into<String>)/set_slot_type_name(Option<String>):The name for the slot. A slot type name must be unique within the account.
description(impl Into<String>)/set_description(Option<String>):A description of the slot type. Use the description to help identify the slot type in lists.
slot_type_values(Vec<SlotTypeValue>)/set_slot_type_values(Option<Vec<SlotTypeValue>>):A list of
SlotTypeValueobjects 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.value_selection_setting(SlotValueSelectionSetting)/set_value_selection_setting(Option<SlotValueSelectionSetting>):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:
-
OriginalValue- Returns the value entered by the user, if the user value is similar to the slot value. -
TopResolution- 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
valueSelectionSettingparameter, the default isOriginalValue.-
parent_slot_type_signature(impl Into<String>)/set_parent_slot_type_signature(Option<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.AlphaNumericis supported.bot_id(impl Into<String>)/set_bot_id(Option<String>):The identifier of the bot associated with this slot type.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The identifier of the bot version associated with this slot type.
locale_id(impl Into<String>)/set_locale_id(Option<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.
external_source_setting(ExternalSourceSetting)/set_external_source_setting(Option<ExternalSourceSetting>):Sets the type of external information used to create the slot type.
composite_slot_type_setting(CompositeSlotTypeSetting)/set_composite_slot_type_setting(Option<CompositeSlotTypeSetting>):Specifications for a composite slot type.
- On success, responds with
CreateSlotTypeOutputwith field(s):slot_type_id(Option<String>):The unique identifier assigned to the slot type. Use this to identify the slot type in the
UpdateSlotTypeandDeleteSlotTypeoperations.slot_type_name(Option<String>):The name specified for the slot type.
description(Option<String>):The description specified for the slot type.
slot_type_values(Option<Vec<SlotTypeValue>>):The list of values that the slot type can assume.
value_selection_setting(Option<SlotValueSelectionSetting>):The strategy that Amazon Lex uses to select a value from the list of possible values.
parent_slot_type_signature(Option<String>):The signature of the base slot type specified for the slot type.
bot_id(Option<String>):The identifier for the bot associated with the slot type.
bot_version(Option<String>):The version of the bot associated with the slot type.
locale_id(Option<String>):The specified language and local specified for the slot type.
creation_date_time(Option<DateTime>):A timestamp of the date and time that the slot type was created.
external_source_setting(Option<ExternalSourceSetting>):The type of external information used to create the slot type.
composite_slot_type_setting(Option<CompositeSlotTypeSetting>):Specifications for a composite slot type.
- On failure, responds with
SdkError<CreateSlotTypeError>
sourcepub fn create_upload_url(&self) -> CreateUploadUrl
pub fn create_upload_url(&self) -> CreateUploadUrl
Constructs a fluent builder for the CreateUploadUrl operation.
- The fluent builder takes no input, just
sendit. - On success, responds with
CreateUploadUrlOutputwith field(s):import_id(Option<String>):An identifier for a unique import job. Use it when you call the StartImport operation.
upload_url(Option<String>):A pre-signed S3 write URL. Upload the zip archive file that contains the definition of your bot or bot locale.
- On failure, responds with
SdkError<CreateUploadUrlError>
sourcepub fn delete_bot(&self) -> DeleteBot
pub fn delete_bot(&self) -> DeleteBot
Constructs a fluent builder for the DeleteBot operation.
- The fluent builder is configurable:
bot_id(impl Into<String>)/set_bot_id(Option<String>):The identifier of the bot to delete.
skip_resource_in_use_check(bool)/set_skip_resource_in_use_check(bool):When
true, Amazon Lex doesn’t check to see if another resource, such as an alias, is using the bot before it is deleted.
- On success, responds with
DeleteBotOutputwith field(s):bot_id(Option<String>):The unique identifier of the bot that Amazon Lex is deleting.
bot_status(Option<BotStatus>):The current status of the bot. The status is
Deletingwhile the bot and its associated resources are being deleted.
- On failure, responds with
SdkError<DeleteBotError>
sourcepub fn delete_bot_alias(&self) -> DeleteBotAlias
pub fn delete_bot_alias(&self) -> DeleteBotAlias
Constructs a fluent builder for the DeleteBotAlias operation.
- The fluent builder is configurable:
bot_alias_id(impl Into<String>)/set_bot_alias_id(Option<String>):The unique identifier of the bot alias to delete.
bot_id(impl Into<String>)/set_bot_id(Option<String>):The unique identifier of the bot associated with the alias to delete.
skip_resource_in_use_check(bool)/set_skip_resource_in_use_check(bool):When this parameter is true, Amazon Lex doesn’t check to see if any other resource is using the alias before it is deleted.
- On success, responds with
DeleteBotAliasOutputwith field(s):bot_alias_id(Option<String>):The unique identifier of the bot alias to delete.
bot_id(Option<String>):The unique identifier of the bot that contains the alias to delete.
bot_alias_status(Option<BotAliasStatus>):The current status of the alias. The status is
Deletingwhile 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 theListBotAliasesoperation.
- On failure, responds with
SdkError<DeleteBotAliasError>
sourcepub fn delete_bot_locale(&self) -> DeleteBotLocale
pub fn delete_bot_locale(&self) -> DeleteBotLocale
Constructs a fluent builder for the DeleteBotLocale operation.
- The fluent builder is configurable:
bot_id(impl Into<String>)/set_bot_id(Option<String>):The unique identifier of the bot that contains the locale.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The version of the bot that contains the locale.
locale_id(impl Into<String>)/set_locale_id(Option<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.
- On success, responds with
DeleteBotLocaleOutputwith field(s):bot_id(Option<String>):The identifier of the bot that contained the deleted locale.
bot_version(Option<String>):The version of the bot that contained the deleted locale.
locale_id(Option<String>):The language and locale of the deleted locale.
bot_locale_status(Option<BotLocaleStatus>):The status of deleting the bot locale. The locale first enters the
Deletingstatus. Once the locale is deleted it no longer appears in the list of locales for the bot.
- On failure, responds with
SdkError<DeleteBotLocaleError>
sourcepub fn delete_bot_version(&self) -> DeleteBotVersion
pub fn delete_bot_version(&self) -> DeleteBotVersion
Constructs a fluent builder for the DeleteBotVersion operation.
- The fluent builder is configurable:
bot_id(impl Into<String>)/set_bot_id(Option<String>):The identifier of the bot that contains the version.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The version of the bot to delete.
skip_resource_in_use_check(bool)/set_skip_resource_in_use_check(bool):By default, the
DeleteBotVersionoperations throws aResourceInUseExceptionexception if you try to delete a bot version that has an alias pointing at it. Set theskipResourceInUseCheckparameter totrueto skip this check and remove the version even if an alias points to it.
- On success, responds with
DeleteBotVersionOutputwith field(s):bot_id(Option<String>):The identifier of the bot that is being deleted.
bot_version(Option<String>):The version of the bot that is being deleted.
bot_status(Option<BotStatus>):The current status of the bot.
- On failure, responds with
SdkError<DeleteBotVersionError>
sourcepub fn delete_custom_vocabulary(&self) -> DeleteCustomVocabulary
pub fn delete_custom_vocabulary(&self) -> DeleteCustomVocabulary
Constructs a fluent builder for the DeleteCustomVocabulary operation.
- The fluent builder is configurable:
bot_id(impl Into<String>)/set_bot_id(Option<String>):The unique identifier of the bot to remove the custom vocabulary from.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The version of the bot to remove the custom vocabulary from.
locale_id(impl Into<String>)/set_locale_id(Option<String>):The locale identifier for the locale that contains the custom vocabulary to remove.
- On success, responds with
DeleteCustomVocabularyOutputwith field(s):bot_id(Option<String>):The identifier of the bot that the custom vocabulary was removed from.
bot_version(Option<String>):The version of the bot that the custom vocabulary was removed from.
locale_id(Option<String>):The locale identifier for the locale that the custom vocabulary was removed from.
custom_vocabulary_status(Option<CustomVocabularyStatus>):The status of removing the custom vocabulary.
- On failure, responds with
SdkError<DeleteCustomVocabularyError>
sourcepub fn delete_export(&self) -> DeleteExport
pub fn delete_export(&self) -> DeleteExport
Constructs a fluent builder for the DeleteExport operation.
- The fluent builder is configurable:
export_id(impl Into<String>)/set_export_id(Option<String>):The unique identifier of the export to delete.
- On success, responds with
DeleteExportOutputwith field(s):export_id(Option<String>):The unique identifier of the deleted export.
export_status(Option<ExportStatus>):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.
- On failure, responds with
SdkError<DeleteExportError>
sourcepub fn delete_import(&self) -> DeleteImport
pub fn delete_import(&self) -> DeleteImport
Constructs a fluent builder for the DeleteImport operation.
- The fluent builder is configurable:
import_id(impl Into<String>)/set_import_id(Option<String>):The unique identifier of the import to delete.
- On success, responds with
DeleteImportOutputwith field(s):import_id(Option<String>):The unique identifier of the deleted import.
import_status(Option<ImportStatus>):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.
- On failure, responds with
SdkError<DeleteImportError>
sourcepub fn delete_intent(&self) -> DeleteIntent
pub fn delete_intent(&self) -> DeleteIntent
Constructs a fluent builder for the DeleteIntent operation.
- The fluent builder is configurable:
intent_id(impl Into<String>)/set_intent_id(Option<String>):The unique identifier of the intent to delete.
bot_id(impl Into<String>)/set_bot_id(Option<String>):The identifier of the bot associated with the intent.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The version of the bot associated with the intent.
locale_id(impl Into<String>)/set_locale_id(Option<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.
- On success, responds with
DeleteIntentOutput - On failure, responds with
SdkError<DeleteIntentError>
sourcepub fn delete_resource_policy(&self) -> DeleteResourcePolicy
pub fn delete_resource_policy(&self) -> DeleteResourcePolicy
Constructs a fluent builder for the DeleteResourcePolicy operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):The Amazon Resource Name (ARN) of the bot or bot alias that has the resource policy attached.
expected_revision_id(impl Into<String>)/set_expected_revision_id(Option<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.
- On success, responds with
DeleteResourcePolicyOutputwith field(s):resource_arn(Option<String>):The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy was deleted from.
revision_id(Option<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.
- On failure, responds with
SdkError<DeleteResourcePolicyError>
sourcepub fn delete_resource_policy_statement(&self) -> DeleteResourcePolicyStatement
pub fn delete_resource_policy_statement(&self) -> DeleteResourcePolicyStatement
Constructs a fluent builder for the DeleteResourcePolicyStatement operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
statement_id(impl Into<String>)/set_statement_id(Option<String>):The name of the statement (SID) to delete from the policy.
expected_revision_id(impl Into<String>)/set_expected_revision_id(Option<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.
- On success, responds with
DeleteResourcePolicyStatementOutputwith field(s):resource_arn(Option<String>):The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy statement was removed from.
revision_id(Option<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.
- On failure, responds with
SdkError<DeleteResourcePolicyStatementError>
sourcepub fn delete_slot(&self) -> DeleteSlot
pub fn delete_slot(&self) -> DeleteSlot
Constructs a fluent builder for the DeleteSlot operation.
- The fluent builder is configurable:
slot_id(impl Into<String>)/set_slot_id(Option<String>):The identifier of the slot to delete.
bot_id(impl Into<String>)/set_bot_id(Option<String>):The identifier of the bot associated with the slot to delete.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The version of the bot associated with the slot to delete.
locale_id(impl Into<String>)/set_locale_id(Option<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.
intent_id(impl Into<String>)/set_intent_id(Option<String>):The identifier of the intent associated with the slot.
- On success, responds with
DeleteSlotOutput - On failure, responds with
SdkError<DeleteSlotError>
sourcepub fn delete_slot_type(&self) -> DeleteSlotType
pub fn delete_slot_type(&self) -> DeleteSlotType
Constructs a fluent builder for the DeleteSlotType operation.
- The fluent builder is configurable:
slot_type_id(impl Into<String>)/set_slot_type_id(Option<String>):The identifier of the slot type to delete.
bot_id(impl Into<String>)/set_bot_id(Option<String>):The identifier of the bot associated with the slot type.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The version of the bot associated with the slot type.
locale_id(impl Into<String>)/set_locale_id(Option<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.
skip_resource_in_use_check(bool)/set_skip_resource_in_use_check(bool):By default, the
DeleteSlotTypeoperations throws aResourceInUseExceptionexception if you try to delete a slot type used by a slot. Set theskipResourceInUseCheckparameter totrueto skip this check and remove the slot type even if a slot uses it.
- On success, responds with
DeleteSlotTypeOutput - On failure, responds with
SdkError<DeleteSlotTypeError>
sourcepub fn delete_utterances(&self) -> DeleteUtterances
pub fn delete_utterances(&self) -> DeleteUtterances
Constructs a fluent builder for the DeleteUtterances operation.
- The fluent builder is configurable:
bot_id(impl Into<String>)/set_bot_id(Option<String>):The unique identifier of the bot that contains the utterances.
locale_id(impl Into<String>)/set_locale_id(Option<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.
session_id(impl Into<String>)/set_session_id(Option<String>):The unique identifier of the session with the user. The ID is returned in the response from the RecognizeText and RecognizeUtterance operations.
- On success, responds with
DeleteUtterancesOutput - On failure, responds with
SdkError<DeleteUtterancesError>
sourcepub fn describe_bot(&self) -> DescribeBot
pub fn describe_bot(&self) -> DescribeBot
Constructs a fluent builder for the DescribeBot operation.
- The fluent builder is configurable:
bot_id(impl Into<String>)/set_bot_id(Option<String>):The unique identifier of the bot to describe.
- On success, responds with
DescribeBotOutputwith field(s):bot_id(Option<String>):The unique identifier of the bot.
bot_name(Option<String>):The name of the bot.
description(Option<String>):The description of the bot.
role_arn(Option<String>):The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.
data_privacy(Option<DataPrivacy>):Settings for managing data privacy of the bot and its conversations with users.
idle_session_ttl_in_seconds(Option<i32>):The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.
bot_status(Option<BotStatus>):The current status of the bot. When the status is
Availablethe bot is ready to be used in conversations with users.creation_date_time(Option<DateTime>):A timestamp of the date and time that the bot was created.
last_updated_date_time(Option<DateTime>):A timestamp of the date and time that the bot was last updated.
- On failure, responds with
SdkError<DescribeBotError>
sourcepub fn describe_bot_alias(&self) -> DescribeBotAlias
pub fn describe_bot_alias(&self) -> DescribeBotAlias
Constructs a fluent builder for the DescribeBotAlias operation.
- The fluent builder is configurable:
bot_alias_id(impl Into<String>)/set_bot_alias_id(Option<String>):The identifier of the bot alias to describe.
bot_id(impl Into<String>)/set_bot_id(Option<String>):The identifier of the bot associated with the bot alias to describe.
- On success, responds with
DescribeBotAliasOutputwith field(s):bot_alias_id(Option<String>):The identifier of the bot alias.
bot_alias_name(Option<String>):The name of the bot alias.
description(Option<String>):The description of the bot alias.
bot_version(Option<String>):The version of the bot associated with the bot alias.
bot_alias_locale_settings(Option<HashMap<String, BotAliasLocaleSettings>>):The locale settings that are unique to the alias.
conversation_log_settings(Option<ConversationLogSettings>):Specifics of how Amazon Lex logs text and audio conversations with the bot associated with the alias.
sentiment_analysis_settings(Option<SentimentAnalysisSettings>):Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
bot_alias_history_events(Option<Vec<BotAliasHistoryEvent>>):A list of events that affect a bot alias. For example, an event is recorded when the version that the alias points to changes.
bot_alias_status(Option<BotAliasStatus>):The current status of the alias. When the alias is
Available, the alias is ready for use with your bot.bot_id(Option<String>):The identifier of the bot associated with the bot alias.
creation_date_time(Option<DateTime>):A timestamp of the date and time that the alias was created.
last_updated_date_time(Option<DateTime>):A timestamp of the date and time that the alias was last updated.
- On failure, responds with
SdkError<DescribeBotAliasError>
sourcepub fn describe_bot_locale(&self) -> DescribeBotLocale
pub fn describe_bot_locale(&self) -> DescribeBotLocale
Constructs a fluent builder for the DescribeBotLocale operation.
- The fluent builder is configurable:
bot_id(impl Into<String>)/set_bot_id(Option<String>):The identifier of the bot associated with the locale.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The identifier of the version of the bot associated with the locale.
locale_id(impl Into<String>)/set_locale_id(Option<String>):The unique identifier of the locale to describe. The string must match one of the supported locales. For more information, see Supported languages.
- On success, responds with
DescribeBotLocaleOutputwith field(s):bot_id(Option<String>):The identifier of the bot associated with the locale.
bot_version(Option<String>):The identifier of the version of the bot associated with the locale.
locale_id(Option<String>):The unique identifier of the described locale.
locale_name(Option<String>):The name of the locale.
description(Option<String>):The description of the locale.
nlu_intent_confidence_threshold(Option<f64>):The confidence threshold where Amazon Lex inserts the
AMAZON.FallbackIntentandAMAZON.KendraSearchIntentintents in the list of possible intents for an utterance.voice_settings(Option<VoiceSettings>):The Amazon Polly voice Amazon Lex uses for voice interaction with the user.
intents_count(Option<i32>):The number of intents defined for the locale.
slot_types_count(Option<i32>):The number of slot types defined for the locale.
bot_locale_status(Option<BotLocaleStatus>):The status of the bot. If the status is
Failed, the reasons for the failure are listed in thefailureReasonsfield.failure_reasons(Option<Vec<String>>):if
botLocaleStatusisFailed, Amazon Lex explains why it failed to build the bot.creation_date_time(Option<DateTime>):The date and time that the locale was created.
last_updated_date_time(Option<DateTime>):The date and time that the locale was last updated.
last_build_submitted_date_time(Option<DateTime>):The date and time that the locale was last submitted for building.
bot_locale_history_events(Option<Vec<BotLocaleHistoryEvent>>):History of changes, such as when a locale is used in an alias, that have taken place for the locale.
recommended_actions(Option<Vec<String>>):Recommended actions to take to resolve an error in the
failureReasonsfield.
- On failure, responds with
SdkError<DescribeBotLocaleError>
sourcepub fn describe_bot_recommendation(&self) -> DescribeBotRecommendation
pub fn describe_bot_recommendation(&self) -> DescribeBotRecommendation
Constructs a fluent builder for the DescribeBotRecommendation operation.
- The fluent builder is configurable:
bot_id(impl Into<String>)/set_bot_id(Option<String>):The unique identifier of the bot associated with the bot recommendation.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The version of the bot associated with the bot recommendation.
locale_id(impl Into<String>)/set_locale_id(Option<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.
bot_recommendation_id(impl Into<String>)/set_bot_recommendation_id(Option<String>):The identifier of the bot recommendation to describe.
- On success, responds with
DescribeBotRecommendationOutputwith field(s):bot_id(Option<String>):The identifier of the bot associated with the bot recommendation.
bot_version(Option<String>):The version of the bot associated with the bot recommendation.
locale_id(Option<String>):The identifier of the language and locale of the bot recommendation to describe.
bot_recommendation_status(Option<BotRecommendationStatus>):The status of the bot recommendation. If the status is Failed, then the reasons for the failure are listed in the failureReasons field.
bot_recommendation_id(Option<String>):The identifier of the bot recommendation being described.
failure_reasons(Option<Vec<String>>):If botRecommendationStatus is Failed, Amazon Lex explains why.
creation_date_time(Option<DateTime>):The date and time that the bot recommendation was created.
last_updated_date_time(Option<DateTime>):The date and time that the bot recommendation was last updated.
transcript_source_setting(Option<TranscriptSourceSetting>):The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.
encryption_setting(Option<EncryptionSetting>):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.
bot_recommendation_results(Option<BotRecommendationResults>):The object representing the URL of the bot definition, the URL of the associated transcript and a statistical summary of the bot recommendation results.
- On failure, responds with
SdkError<DescribeBotRecommendationError>
sourcepub fn describe_bot_version(&self) -> DescribeBotVersion
pub fn describe_bot_version(&self) -> DescribeBotVersion
Constructs a fluent builder for the DescribeBotVersion operation.
- The fluent builder is configurable:
bot_id(impl Into<String>)/set_bot_id(Option<String>):The identifier of the bot containing the version to return metadata for.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The version of the bot to return metadata for.
- On success, responds with
DescribeBotVersionOutputwith field(s):bot_id(Option<String>):The identifier of the bot that contains the version.
bot_name(Option<String>):The name of the bot that contains the version.
bot_version(Option<String>):The version of the bot to describe.
description(Option<String>):The description specified for the bot.
role_arn(Option<String>):The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot version.
data_privacy(Option<DataPrivacy>):Data privacy settings for the bot version.
idle_session_ttl_in_seconds(Option<i32>):The number of seconds that a session with the bot remains active before it is discarded by Amazon Lex.
bot_status(Option<BotStatus>):The current status of the bot. When the status is
Available, the bot version is ready for use.failure_reasons(Option<Vec<String>>):If the
botStatusisFailed, this contains a list of reasons that the version couldn’t be built.creation_date_time(Option<DateTime>):A timestamp of the date and time that the bot version was created.
- On failure, responds with
SdkError<DescribeBotVersionError>
sourcepub fn describe_custom_vocabulary_metadata(
&self
) -> DescribeCustomVocabularyMetadata
pub fn describe_custom_vocabulary_metadata(
&self
) -> DescribeCustomVocabularyMetadata
Constructs a fluent builder for the DescribeCustomVocabularyMetadata operation.
- The fluent builder is configurable:
bot_id(impl Into<String>)/set_bot_id(Option<String>):The unique identifier of the bot that contains the custom vocabulary.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The bot version of the bot to return metadata for.
locale_id(impl Into<String>)/set_locale_id(Option<String>):The locale to return the custom vocabulary information for. The locale must be
en_GB.
- On success, responds with
DescribeCustomVocabularyMetadataOutputwith field(s):bot_id(Option<String>):The identifier of the bot that contains the custom vocabulary.
bot_version(Option<String>):The version of the bot that contains the custom vocabulary to describe.
locale_id(Option<String>):The locale that contains the custom vocabulary to describe.
custom_vocabulary_status(Option<CustomVocabularyStatus>):The status of the custom vocabulary. If the status is
Readythe custom vocabulary is ready to use.creation_date_time(Option<DateTime>):The date and time that the custom vocabulary was created.
last_updated_date_time(Option<DateTime>):The date and time that the custom vocabulary was last updated.
- On failure, responds with
SdkError<DescribeCustomVocabularyMetadataError>
sourcepub fn describe_export(&self) -> DescribeExport
pub fn describe_export(&self) -> DescribeExport
Constructs a fluent builder for the DescribeExport operation.
- The fluent builder is configurable:
export_id(impl Into<String>)/set_export_id(Option<String>):The unique identifier of the export to describe.
- On success, responds with
DescribeExportOutputwith field(s):export_id(Option<String>):The unique identifier of the described export.
resource_specification(Option<ExportResourceSpecification>):The bot, bot ID, and optional locale ID of the exported bot or bot locale.
file_format(Option<ImportExportFileFormat>):The file format used in the files that describe the resource.
export_status(Option<ExportStatus>):The status of the export. When the status is
Completethe export archive file is available for download.failure_reasons(Option<Vec<String>>):If the
exportStatusis failed, contains one or more reasons why the export could not be completed.download_url(Option<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
DescribeExportoperation.creation_date_time(Option<DateTime>):The date and time that the export was created.
last_updated_date_time(Option<DateTime>):The last date and time that the export was updated.
- On failure, responds with
SdkError<DescribeExportError>
sourcepub fn describe_import(&self) -> DescribeImport
pub fn describe_import(&self) -> DescribeImport
Constructs a fluent builder for the DescribeImport operation.
- The fluent builder is configurable:
import_id(impl Into<String>)/set_import_id(Option<String>):The unique identifier of the import to describe.
- On success, responds with
DescribeImportOutputwith field(s):import_id(Option<String>):The unique identifier of the described import.
resource_specification(Option<ImportResourceSpecification>):The specifications of the imported bot, bot locale, or custom vocabulary.
imported_resource_id(Option<String>):The unique identifier that Amazon Lex assigned to the resource created by the import.
imported_resource_name(Option<String>):The name of the imported resource.
merge_strategy(Option<MergeStrategy>):The strategy used when there was a name conflict between the imported resource and an existing resource. When the merge strategy is
FailOnConflictexisting resources are not overwritten and the import fails.import_status(Option<ImportStatus>):The status of the import process. When the status is
Completedthe resource is imported and ready for use.failure_reasons(Option<Vec<String>>):If the
importStatusfield isFailed, this provides one or more reasons for the failure.creation_date_time(Option<DateTime>):The date and time that the import was created.
last_updated_date_time(Option<DateTime>):The date and time that the import was last updated.
- On failure, responds with
SdkError<DescribeImportError>
sourcepub fn describe_intent(&self) -> DescribeIntent
pub fn describe_intent(&self) -> DescribeIntent
Constructs a fluent builder for the DescribeIntent operation.
- The fluent builder is configurable:
intent_id(impl Into<String>)/set_intent_id(Option<String>):The identifier of the intent to describe.
bot_id(impl Into<String>)/set_bot_id(Option<String>):The identifier of the bot associated with the intent.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The version of the bot associated with the intent.
locale_id(impl Into<String>)/set_locale_id(Option<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.
- On success, responds with
DescribeIntentOutputwith field(s):intent_id(Option<String>):The unique identifier assigned to the intent when it was created.
intent_name(Option<String>):The name specified for the intent.
description(Option<String>):The description of the intent.
parent_intent_signature(Option<String>):The identifier of the built-in intent that this intent is derived from, if any.
sample_utterances(Option<Vec<SampleUtterance>>):User utterances that trigger this intent.
dialog_code_hook(Option<DialogCodeHookSettings>):The Lambda function called during each turn of a conversation with the intent.
fulfillment_code_hook(Option<FulfillmentCodeHookSettings>):The Lambda function called when the intent is complete and ready for fulfillment.
slot_priorities(Option<Vec<SlotPriority>>):The list that determines the priority that slots should be elicited from the user.
intent_confirmation_setting(Option<IntentConfirmationSetting>):Prompts that Amazon Lex sends to the user to confirm completion of an intent.
intent_closing_setting(Option<IntentClosingSetting>):The response that Amazon Lex sends to when the intent is closed.
input_contexts(Option<Vec<InputContext>>):A list of contexts that must be active for the intent to be considered for sending to the user.
output_contexts(Option<Vec<OutputContext>>):A list of contexts that are activated when the intent is fulfilled.
kendra_configuration(Option<KendraConfiguration>):Configuration information required to use the
AMAZON.KendraSearchIntentintent.bot_id(Option<String>):The identifier of the bot associated with the intent.
bot_version(Option<String>):The version of the bot associated with the intent.
locale_id(Option<String>):The language and locale specified for the intent.
creation_date_time(Option<DateTime>):A timestamp of the date and time that the intent was created.
last_updated_date_time(Option<DateTime>):A timestamp of the date and time that the intent was last updated.
initial_response_setting(Option<InitialResponseSetting>):
- On failure, responds with
SdkError<DescribeIntentError>
sourcepub fn describe_resource_policy(&self) -> DescribeResourcePolicy
pub fn describe_resource_policy(&self) -> DescribeResourcePolicy
Constructs a fluent builder for the DescribeResourcePolicy operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
- On success, responds with
DescribeResourcePolicyOutputwith field(s):resource_arn(Option<String>):The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
policy(Option<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 .
revision_id(Option<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.
- On failure, responds with
SdkError<DescribeResourcePolicyError>
sourcepub fn describe_slot(&self) -> DescribeSlot
pub fn describe_slot(&self) -> DescribeSlot
Constructs a fluent builder for the DescribeSlot operation.
- The fluent builder is configurable:
slot_id(impl Into<String>)/set_slot_id(Option<String>):The unique identifier for the slot.
bot_id(impl Into<String>)/set_bot_id(Option<String>):The identifier of the bot associated with the slot.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The version of the bot associated with the slot.
locale_id(impl Into<String>)/set_locale_id(Option<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.
intent_id(impl Into<String>)/set_intent_id(Option<String>):The identifier of the intent that contains the slot.
- On success, responds with
DescribeSlotOutputwith field(s):slot_id(Option<String>):The unique identifier generated for the slot.
slot_name(Option<String>):The name specified for the slot.
description(Option<String>):The description specified for the slot.
slot_type_id(Option<String>):The identifier of the slot type that determines the values entered into the slot.
value_elicitation_setting(Option<SlotValueElicitationSetting>):Prompts that Amazon Lex uses to elicit a value for the slot.
obfuscation_setting(Option<ObfuscationSetting>):Whether slot values are shown in Amazon CloudWatch logs. If the value is
None, the actual value of the slot is shown in logs.bot_id(Option<String>):The identifier of the bot associated with the slot.
bot_version(Option<String>):The version of the bot associated with the slot.
locale_id(Option<String>):The language and locale specified for the slot.
intent_id(Option<String>):The identifier of the intent associated with the slot.
creation_date_time(Option<DateTime>):A timestamp of the date and time that the slot was created.
last_updated_date_time(Option<DateTime>):A timestamp of the date and time that the slot was last updated.
multiple_values_setting(Option<MultipleValuesSetting>):Indicates whether the slot accepts multiple values in a single utterance.
If the
multipleValuesSettingis not set, the default value isfalse.sub_slot_setting(Option<SubSlotSetting>):Specifications for the constituent sub slots and the expression for the composite slot.
- On failure, responds with
SdkError<DescribeSlotError>
sourcepub fn describe_slot_type(&self) -> DescribeSlotType
pub fn describe_slot_type(&self) -> DescribeSlotType
Constructs a fluent builder for the DescribeSlotType operation.
- The fluent builder is configurable:
slot_type_id(impl Into<String>)/set_slot_type_id(Option<String>):The identifier of the slot type.
bot_id(impl Into<String>)/set_bot_id(Option<String>):The identifier of the bot associated with the slot type.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The version of the bot associated with the slot type.
locale_id(impl Into<String>)/set_locale_id(Option<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.
- On success, responds with
DescribeSlotTypeOutputwith field(s):slot_type_id(Option<String>):The unique identifier for the slot type.
slot_type_name(Option<String>):The name specified for the slot type.
description(Option<String>):The description specified for the slot type.
slot_type_values(Option<Vec<SlotTypeValue>>):The values that the slot type can take. Includes any synonyms for the slot type values.
value_selection_setting(Option<SlotValueSelectionSetting>):The strategy that Amazon Lex uses to choose a value from a list of possible values.
parent_slot_type_signature(Option<String>):The built in slot type used as a parent to this slot type.
bot_id(Option<String>):The identifier of the bot associated with the slot type.
bot_version(Option<String>):The version of the bot associated with the slot type.
locale_id(Option<String>):The language and locale specified for the slot type.
creation_date_time(Option<DateTime>):A timestamp of the date and time that the slot type was created.
last_updated_date_time(Option<DateTime>):A timestamp of the date and time that the slot type was last updated.
external_source_setting(Option<ExternalSourceSetting>):Provides information about the external source of the slot type’s definition.
composite_slot_type_setting(Option<CompositeSlotTypeSetting>):Specifications for a composite slot type.
- On failure, responds with
SdkError<DescribeSlotTypeError>
sourcepub fn list_aggregated_utterances(&self) -> ListAggregatedUtterances
pub fn list_aggregated_utterances(&self) -> ListAggregatedUtterances
Constructs a fluent builder for the ListAggregatedUtterances operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
bot_id(impl Into<String>)/set_bot_id(Option<String>):The unique identifier of the bot associated with this request.
bot_alias_id(impl Into<String>)/set_bot_alias_id(Option<String>):The identifier of the bot alias associated with this request. If you specify the bot alias, you can’t specify the bot version.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The identifier of the bot version associated with this request. If you specify the bot version, you can’t specify the bot alias.
locale_id(impl Into<String>)/set_locale_id(Option<String>):The identifier of the language and locale where the utterances were collected. For more information, see Supported languages.
aggregation_duration(UtteranceAggregationDuration)/set_aggregation_duration(Option<UtteranceAggregationDuration>):The time window for aggregating the utterance information. You can specify a time between one hour and two weeks.
sort_by(AggregatedUtterancesSortBy)/set_sort_by(Option<AggregatedUtterancesSortBy>):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.
filters(Vec<AggregatedUtterancesFilter>)/set_filters(Option<Vec<AggregatedUtterancesFilter>>):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.
max_results(i32)/set_max_results(Option<i32>):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
maxResultsparameter, 1,000 results are returned.next_token(impl Into<String>)/set_next_token(Option<String>):If the response from the
ListAggregatedUtterancesoperation contains more results that specified in themaxResultsparameter, a token is returned in the response. Use that token in thenextTokenparameter to return the next page of results.
- On success, responds with
ListAggregatedUtterancesOutputwith field(s):bot_id(Option<String>):The identifier of the bot that contains the utterances.
bot_alias_id(Option<String>):The identifier of the bot alias that contains the utterances. If you specified the bot version, the bot alias ID isn’t returned.
bot_version(Option<String>):The identifier of the bot version that contains the utterances. If you specified the bot alias, the bot version isn’t returned.
locale_id(Option<String>):The identifier of the language and locale that the utterances are in.
aggregation_duration(Option<UtteranceAggregationDuration>):The time period used to aggregate the utterance data.
aggregation_window_start_time(Option<DateTime>):The date and time that the aggregation window begins. Only data collected after this time is returned in the results.
aggregation_window_end_time(Option<DateTime>):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.
aggregation_last_refreshed_date_time(Option<DateTime>):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
-
aggregated_utterances_summaries(Option<Vec<AggregatedUtterancesSummary>>):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.
next_token(Option<String>):A token that indicates whether there are more results to return in a response to the
ListAggregatedUtterancesoperation. If thenextTokenfield is present, you send the contents as thenextTokenparameter of aListAggregatedUtterancesoperation request to get the next page of results.
- On failure, responds with
SdkError<ListAggregatedUtterancesError>
sourcepub fn list_bot_aliases(&self) -> ListBotAliases
pub fn list_bot_aliases(&self) -> ListBotAliases
Constructs a fluent builder for the ListBotAliases operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
bot_id(impl Into<String>)/set_bot_id(Option<String>):The identifier of the bot to list aliases for.
max_results(i32)/set_max_results(Option<i32>):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.
next_token(impl Into<String>)/set_next_token(Option<String>):If the response from the
ListBotAliasesoperation contains more results than specified in themaxResultsparameter, a token is returned in the response. Use that token in thenextTokenparameter to return the next page of results.
- On success, responds with
ListBotAliasesOutputwith field(s):bot_alias_summaries(Option<Vec<BotAliasSummary>>):Summary information for the bot aliases that meet the filter criteria specified in the request. The length of the list is specified in the
maxResultsparameter of the request. If there are more aliases available, thenextTokenfield contains a token to get the next page of results.next_token(Option<String>):A token that indicates whether there are more results to return in a response to the
ListBotAliasesoperation. If thenextTokenfield is present, you send the contents as thenextTokenparameter of aListBotAliasesoperation request to get the next page of results.bot_id(Option<String>):The identifier of the bot associated with the aliases.
- On failure, responds with
SdkError<ListBotAliasesError>
sourcepub fn list_bot_locales(&self) -> ListBotLocales
pub fn list_bot_locales(&self) -> ListBotLocales
Constructs a fluent builder for the ListBotLocales operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
bot_id(impl Into<String>)/set_bot_id(Option<String>):The identifier of the bot to list locales for.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The version of the bot to list locales for.
sort_by(BotLocaleSortBy)/set_sort_by(Option<BotLocaleSortBy>):Specifies sorting parameters for the list of locales. You can sort by locale name in ascending or descending order.
filters(Vec<BotLocaleFilter>)/set_filters(Option<Vec<BotLocaleFilter>>):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.
max_results(i32)/set_max_results(Option<i32>):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.
next_token(impl Into<String>)/set_next_token(Option<String>):If the response from the
ListBotLocalesoperation contains more results than specified in themaxResultsparameter, a token is returned in the response. Use that token as thenextTokenparameter to return the next page of results.
- On success, responds with
ListBotLocalesOutputwith field(s):bot_id(Option<String>):The identifier of the bot to list locales for.
bot_version(Option<String>):The version of the bot.
next_token(Option<String>):A token that indicates whether there are more results to return in a response to the
ListBotLocalesoperation. If thenextTokenfield is present, you send the contents as thenextTokenparameter of aListBotLocalesoperation request to get the next page of results.bot_locale_summaries(Option<Vec<BotLocaleSummary>>):Summary information for the locales that meet the filter criteria specified in the request. The length of the list is specified in the
maxResultsparameter of the request. If there are more locales available, thenextTokenfield contains a token to get the next page of results.
- On failure, responds with
SdkError<ListBotLocalesError>
sourcepub fn list_bot_recommendations(&self) -> ListBotRecommendations
pub fn list_bot_recommendations(&self) -> ListBotRecommendations
Constructs a fluent builder for the ListBotRecommendations operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
bot_id(impl Into<String>)/set_bot_id(Option<String>):The unique identifier of the bot that contains the bot recommendation list.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The version of the bot that contains the bot recommendation list.
locale_id(impl Into<String>)/set_locale_id(Option<String>):The identifier of the language and locale of the bot recommendation list.
max_results(i32)/set_max_results(Option<i32>):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.
next_token(impl Into<String>)/set_next_token(Option<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.
- On success, responds with
ListBotRecommendationsOutputwith field(s):bot_id(Option<String>):The unique identifier of the bot that contains the bot recommendation list.
bot_version(Option<String>):The version of the bot that contains the bot recommendation list.
locale_id(Option<String>):The identifier of the language and locale of the bot recommendation list.
bot_recommendation_summaries(Option<Vec<BotRecommendationSummary>>):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.
next_token(Option<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.
- On failure, responds with
SdkError<ListBotRecommendationsError>
sourcepub fn list_bots(&self) -> ListBots
pub fn list_bots(&self) -> ListBots
Constructs a fluent builder for the ListBots operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
sort_by(BotSortBy)/set_sort_by(Option<BotSortBy>):Specifies sorting parameters for the list of bots. You can specify that the list be sorted by bot name in ascending or descending order.
filters(Vec<BotFilter>)/set_filters(Option<Vec<BotFilter>>):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.
max_results(i32)/set_max_results(Option<i32>):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.
next_token(impl Into<String>)/set_next_token(Option<String>):If the response from the
ListBotsoperation contains more results than specified in themaxResultsparameter, a token is returned in the response.Use the returned token in the
nextTokenparameter of aListBotsrequest to return the next page of results. For a complete set of results, call theListBotsoperation until thenextTokenreturned in the response is null.
- On success, responds with
ListBotsOutputwith field(s):bot_summaries(Option<Vec<BotSummary>>):Summary information for the bots that meet the filter criteria specified in the request. The length of the list is specified in the
maxResultsparameter of the request. If there are more bots available, thenextTokenfield contains a token to the next page of results.next_token(Option<String>):A token that indicates whether there are more results to return in a response to the
ListBotsoperation. If thenextTokenfield is present, you send the contents as thenextTokenparameter of aListBotsoperation request to get the next page of results.
- On failure, responds with
SdkError<ListBotsError>
sourcepub fn list_bot_versions(&self) -> ListBotVersions
pub fn list_bot_versions(&self) -> ListBotVersions
Constructs a fluent builder for the ListBotVersions operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
bot_id(impl Into<String>)/set_bot_id(Option<String>):The identifier of the bot to list versions for.
sort_by(BotVersionSortBy)/set_sort_by(Option<BotVersionSortBy>):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.
max_results(i32)/set_max_results(Option<i32>):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.
next_token(impl Into<String>)/set_next_token(Option<String>):If the response to the
ListBotVersionoperation contains more results than specified in themaxResultsparameter, a token is returned in the response. Use that token in thenextTokenparameter to return the next page of results.
- On success, responds with
ListBotVersionsOutputwith field(s):bot_id(Option<String>):The identifier of the bot to list versions for.
bot_version_summaries(Option<Vec<BotVersionSummary>>):Summary information for the bot versions that meet the filter criteria specified in the request. The length of the list is specified in the
maxResultsparameter of the request. If there are more versions available, thenextTokenfield contains a token to get the next page of results.next_token(Option<String>):A token that indicates whether there are more results to return in a response to the
ListBotVersionsoperation. If thenextTokenfield is present, you send the contents as thenextTokenparameter of aListBotAliasesoperation request to get the next page of results.
- On failure, responds with
SdkError<ListBotVersionsError>
sourcepub fn list_built_in_intents(&self) -> ListBuiltInIntents
pub fn list_built_in_intents(&self) -> ListBuiltInIntents
Constructs a fluent builder for the ListBuiltInIntents operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
locale_id(impl Into<String>)/set_locale_id(Option<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.
sort_by(BuiltInIntentSortBy)/set_sort_by(Option<BuiltInIntentSortBy>):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.
max_results(i32)/set_max_results(Option<i32>):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.
next_token(impl Into<String>)/set_next_token(Option<String>):If the response from the
ListBuiltInIntentsoperation contains more results than specified in themaxResultsparameter, a token is returned in the response. Use that token in thenextTokenparameter to return the next page of results.
- On success, responds with
ListBuiltInIntentsOutputwith field(s):built_in_intent_summaries(Option<Vec<BuiltInIntentSummary>>):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
maxResultsparameter of the request. If there are more intents available, thenextTokenfield contains a token to get the next page of results.next_token(Option<String>):A token that indicates whether there are more results to return in a response to the
ListBuiltInIntentsoperation. If thenextTokenfield is present, you send the contents as thenextTokenparameter of aListBotAliasesoperation request to get the next page of results.locale_id(Option<String>):The language and locale of the intents in the list.
- On failure, responds with
SdkError<ListBuiltInIntentsError>
sourcepub fn list_built_in_slot_types(&self) -> ListBuiltInSlotTypes
pub fn list_built_in_slot_types(&self) -> ListBuiltInSlotTypes
Constructs a fluent builder for the ListBuiltInSlotTypes operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
locale_id(impl Into<String>)/set_locale_id(Option<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.
sort_by(BuiltInSlotTypeSortBy)/set_sort_by(Option<BuiltInSlotTypeSortBy>):Determines the sort order for the response from the
ListBuiltInSlotTypesoperation. You can choose to sort by the slot type signature in either ascending or descending order.max_results(i32)/set_max_results(Option<i32>):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.
next_token(impl Into<String>)/set_next_token(Option<String>):If the response from the
ListBuiltInSlotTypesoperation contains more results than specified in themaxResultsparameter, a token is returned in the response. Use that token in thenextTokenparameter to return the next page of results.
- On success, responds with
ListBuiltInSlotTypesOutputwith field(s):built_in_slot_type_summaries(Option<Vec<BuiltInSlotTypeSummary>>):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
maxResultsparameter of the request. If there are more slot types available, thenextTokenfield contains a token to get the next page of results.next_token(Option<String>):A token that indicates whether there are more results to return in a response to the
ListBuiltInSlotTypesoperation. If thenextTokenfield is present, you send the contents as thenextTokenparameter of aLIstBuiltInSlotTypesoperation request to get the next page of results.locale_id(Option<String>):The language and locale of the slot types in the list.
- On failure, responds with
SdkError<ListBuiltInSlotTypesError>
sourcepub fn list_custom_vocabulary_items(&self) -> ListCustomVocabularyItems
pub fn list_custom_vocabulary_items(&self) -> ListCustomVocabularyItems
Constructs a fluent builder for the ListCustomVocabularyItems operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
bot_id(impl Into<String>)/set_bot_id(Option<String>):The unique identifier of the bot to the list custom vocabulary request.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The bot version of the bot to the list custom vocabulary request.
locale_id(impl Into<String>)/set_locale_id(Option<String>):The locale identifier of the bot to the list custom vocabulary request.
max_results(i32)/set_max_results(Option<i32>):The maximum results to the list custom vocabulary request.
next_token(impl Into<String>)/set_next_token(Option<String>):The nextToken identifier to the list custom vocabulary request.
- On success, responds with
ListCustomVocabularyItemsOutputwith field(s):bot_id(Option<String>):The unique identifier of the bot to the list custom vocabulary response.
bot_version(Option<String>):The bot version of the bot to the list custom vocabulary response.
locale_id(Option<String>):The locale identifier of the bot to the list custom vocabulary response.
custom_vocabulary_items(Option<Vec<CustomVocabularyItem>>):The custom vocabulary items from the list custom vocabulary response.
next_token(Option<String>):The nextToken identifier to the list custom vocabulary response.
- On failure, responds with
SdkError<ListCustomVocabularyItemsError>
sourcepub fn list_exports(&self) -> ListExports
pub fn list_exports(&self) -> ListExports
Constructs a fluent builder for the ListExports operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
bot_id(impl Into<String>)/set_bot_id(Option<String>):The unique identifier that Amazon Lex assigned to the bot.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The version of the bot to list exports for.
sort_by(ExportSortBy)/set_sort_by(Option<ExportSortBy>):Determines the field that the list of exports is sorted by. You can sort by the
LastUpdatedDateTimefield in ascending or descending order.filters(Vec<ExportFilter>)/set_filters(Option<Vec<ExportFilter>>):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.
max_results(i32)/set_max_results(Option<i32>):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.
next_token(impl Into<String>)/set_next_token(Option<String>):If the response from the
ListExportsoperation contains more results that specified in themaxResultsparameter, a token is returned in the response.Use the returned token in the
nextTokenparameter of aListExportsrequest to return the next page of results. For a complete set of results, call theListExportsoperation until thenextTokenreturned in the response is null.locale_id(impl Into<String>)/set_locale_id(Option<String>):Specifies the resources that should be exported. If you don’t specify a resource type in the
filtersparameter, both bot locales and custom vocabularies are exported.
- On success, responds with
ListExportsOutputwith field(s):bot_id(Option<String>):The unique identifier assigned to the bot by Amazon Lex.
bot_version(Option<String>):The version of the bot that was exported.
export_summaries(Option<Vec<ExportSummary>>):Summary information for the exports that meet the filter criteria specified in the request. The length of the list is specified in the
maxResultsparameter. If there are more exports available, thenextTokenfield contains a token to get the next page of results.next_token(Option<String>):A token that indicates whether there are more results to return in a response to the
ListExportsoperation. If thenextTokenfield is present, you send the contents as thenextTokenparameter of aListExportsoperation request to get the next page of results.locale_id(Option<String>):The locale specified in the request.
- On failure, responds with
SdkError<ListExportsError>
sourcepub fn list_imports(&self) -> ListImports
pub fn list_imports(&self) -> ListImports
Constructs a fluent builder for the ListImports operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
bot_id(impl Into<String>)/set_bot_id(Option<String>):The unique identifier that Amazon Lex assigned to the bot.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The version of the bot to list imports for.
sort_by(ImportSortBy)/set_sort_by(Option<ImportSortBy>):Determines the field that the list of imports is sorted by. You can sort by the
LastUpdatedDateTimefield in ascending or descending order.filters(Vec<ImportFilter>)/set_filters(Option<Vec<ImportFilter>>):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.
max_results(i32)/set_max_results(Option<i32>):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.
next_token(impl Into<String>)/set_next_token(Option<String>):If the response from the
ListImportsoperation contains more results than specified in themaxResultsparameter, a token is returned in the response.Use the returned token in the
nextTokenparameter of aListImportsrequest to return the next page of results. For a complete set of results, call theListImportsoperation until thenextTokenreturned in the response is null.locale_id(impl Into<String>)/set_locale_id(Option<String>):Specifies the locale that should be present in the list. If you don’t specify a resource type in the
filtersparameter, the list contains both bot locales and custom vocabularies.
- On success, responds with
ListImportsOutputwith field(s):bot_id(Option<String>):The unique identifier assigned by Amazon Lex to the bot.
bot_version(Option<String>):The version of the bot that was imported. It will always be
DRAFT.import_summaries(Option<Vec<ImportSummary>>):Summary information for the imports that meet the filter criteria specified in the request. The length of the list is specified in the
maxResultsparameter. If there are more imports available, thenextTokenfield contains a token to get the next page of results.next_token(Option<String>):A token that indicates whether there are more results to return in a response to the
ListImportsoperation. If thenextTokenfield is present, you send the contents as thenextTokenparameter of aListImportsoperation request to get the next page of results.locale_id(Option<String>):The locale specified in the request.
- On failure, responds with
SdkError<ListImportsError>
sourcepub fn list_intents(&self) -> ListIntents
pub fn list_intents(&self) -> ListIntents
Constructs a fluent builder for the ListIntents operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
bot_id(impl Into<String>)/set_bot_id(Option<String>):The unique identifier of the bot that contains the intent.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The version of the bot that contains the intent.
locale_id(impl Into<String>)/set_locale_id(Option<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.
sort_by(IntentSortBy)/set_sort_by(Option<IntentSortBy>):Determines the sort order for the response from the
ListIntentsoperation. You can choose to sort by the intent name or last updated date in either ascending or descending order.filters(Vec<IntentFilter>)/set_filters(Option<Vec<IntentFilter>>):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.
max_results(i32)/set_max_results(Option<i32>):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.
next_token(impl Into<String>)/set_next_token(Option<String>):If the response from the
ListIntentsoperation contains more results than specified in themaxResultsparameter, a token is returned in the response.Use the returned token in the
nextTokenparameter of aListIntentsrequest to return the next page of results. For a complete set of results, call theListIntentsoperation until thenextTokenreturned in the response is null.
- On success, responds with
ListIntentsOutputwith field(s):bot_id(Option<String>):The identifier of the bot that contains the intent.
bot_version(Option<String>):The version of the bot that contains the intent.
locale_id(Option<String>):The language and locale of the intents in the list.
intent_summaries(Option<Vec<IntentSummary>>):Summary information for the intents that meet the filter criteria specified in the request. The length of the list is specified in the
maxResultsparameter of the request. If there are more intents available, thenextTokenfield contains a token to get the next page of results.next_token(Option<String>):A token that indicates whether there are more results to return in a response to the
ListIntentsoperation. If thenextTokenfield is present, you send the contents as thenextTokenparameter of aListIntentsoperation request to get the next page of results.
- On failure, responds with
SdkError<ListIntentsError>
sourcepub fn list_recommended_intents(&self) -> ListRecommendedIntents
pub fn list_recommended_intents(&self) -> ListRecommendedIntents
Constructs a fluent builder for the ListRecommendedIntents operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
bot_id(impl Into<String>)/set_bot_id(Option<String>):The unique identifier of the bot associated with the recommended intents.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The version of the bot that contains the recommended intents.
locale_id(impl Into<String>)/set_locale_id(Option<String>):The identifier of the language and locale of the recommended intents.
bot_recommendation_id(impl Into<String>)/set_bot_recommendation_id(Option<String>):The identifier of the bot recommendation that contains the recommended intents.
next_token(impl Into<String>)/set_next_token(Option<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.
max_results(i32)/set_max_results(Option<i32>):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.
- On success, responds with
ListRecommendedIntentsOutputwith field(s):bot_id(Option<String>):The unique identifier of the bot associated with the recommended intent.
bot_version(Option<String>):The version of the bot that contains the intent.
locale_id(Option<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.
bot_recommendation_id(Option<String>):The identifier of the bot recommendation that contains the recommended intent.
summary_list(Option<Vec<RecommendedIntentSummary>>):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.
next_token(Option<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.
- On failure, responds with
SdkError<ListRecommendedIntentsError>
sourcepub fn list_slots(&self) -> ListSlots
pub fn list_slots(&self) -> ListSlots
Constructs a fluent builder for the ListSlots operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
bot_id(impl Into<String>)/set_bot_id(Option<String>):The identifier of the bot that contains the slot.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The version of the bot that contains the slot.
locale_id(impl Into<String>)/set_locale_id(Option<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.
intent_id(impl Into<String>)/set_intent_id(Option<String>):The unique identifier of the intent that contains the slot.
sort_by(SlotSortBy)/set_sort_by(Option<SlotSortBy>):Determines the sort order for the response from the
ListSlotsoperation. You can choose to sort by the slot name or last updated date in either ascending or descending order.filters(Vec<SlotFilter>)/set_filters(Option<Vec<SlotFilter>>):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.
max_results(i32)/set_max_results(Option<i32>):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.
next_token(impl Into<String>)/set_next_token(Option<String>):If the response from the
ListSlotsoperation contains more results than specified in themaxResultsparameter, a token is returned in the response. Use that token in thenextTokenparameter to return the next page of results.
- On success, responds with
ListSlotsOutputwith field(s):bot_id(Option<String>):The identifier of the bot that contains the slots.
bot_version(Option<String>):The version of the bot that contains the slots.
locale_id(Option<String>):The language and locale of the slots in the list.
intent_id(Option<String>):The identifier of the intent that contains the slots.
slot_summaries(Option<Vec<SlotSummary>>):Summary information for the slots that meet the filter criteria specified in the request. The length of the list is specified in the
maxResultsparameter of the request. If there are more slots available, thenextTokenfield contains a token to get the next page of results.next_token(Option<String>):A token that indicates whether there are more results to return in a response to the
ListSlotsoperation. If thenextTokenfield is present, you send the contents as thenextTokenparameter of aListSlotsoperation request to get the next page of results.
- On failure, responds with
SdkError<ListSlotsError>
sourcepub fn list_slot_types(&self) -> ListSlotTypes
pub fn list_slot_types(&self) -> ListSlotTypes
Constructs a fluent builder for the ListSlotTypes operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
bot_id(impl Into<String>)/set_bot_id(Option<String>):The unique identifier of the bot that contains the slot types.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The version of the bot that contains the slot type.
locale_id(impl Into<String>)/set_locale_id(Option<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.
sort_by(SlotTypeSortBy)/set_sort_by(Option<SlotTypeSortBy>):Determines the sort order for the response from the
ListSlotTypesoperation. You can choose to sort by the slot type name or last updated date in either ascending or descending order.filters(Vec<SlotTypeFilter>)/set_filters(Option<Vec<SlotTypeFilter>>):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.
max_results(i32)/set_max_results(Option<i32>):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.
next_token(impl Into<String>)/set_next_token(Option<String>):If the response from the
ListSlotTypesoperation contains more results than specified in themaxResultsparameter, a token is returned in the response. Use that token in thenextTokenparameter to return the next page of results.
- On success, responds with
ListSlotTypesOutputwith field(s):bot_id(Option<String>):The identifier of the bot that contains the slot types.
bot_version(Option<String>):The version of the bot that contains the slot types.
locale_id(Option<String>):The language and local of the slot types in the list.
slot_type_summaries(Option<Vec<SlotTypeSummary>>):Summary information for the slot types that meet the filter criteria specified in the request. The length of the list is specified in the
maxResultsparameter of the request. If there are more slot types available, thenextTokenfield contains a token to get the next page of results.next_token(Option<String>):A token that indicates whether there are more results to return in a response to the
ListSlotTypesoperation. If thenextTokenfield is present, you send the contents as thenextTokenparameter of aListSlotTypesoperation request to get the next page of results.
- On failure, responds with
SdkError<ListSlotTypesError>
Constructs a fluent builder for the ListTagsForResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):The Amazon Resource Name (ARN) of the resource to get a list of tags for.
- On success, responds with
ListTagsForResourceOutputwith field(s):tags(Option<HashMap<String, String>>):The tags associated with a resource.
- On failure, responds with
SdkError<ListTagsForResourceError>
sourcepub fn search_associated_transcripts(&self) -> SearchAssociatedTranscripts
pub fn search_associated_transcripts(&self) -> SearchAssociatedTranscripts
Constructs a fluent builder for the SearchAssociatedTranscripts operation.
- The fluent builder is configurable:
bot_id(impl Into<String>)/set_bot_id(Option<String>):The unique identifier of the bot associated with the transcripts that you are searching.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The version of the bot containing the transcripts that you are searching.
locale_id(impl Into<String>)/set_locale_id(Option<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
bot_recommendation_id(impl Into<String>)/set_bot_recommendation_id(Option<String>):The unique identifier of the bot recommendation associated with the transcripts to search.
search_order(SearchOrder)/set_search_order(Option<SearchOrder>):How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.
filters(Vec<AssociatedTranscriptFilter>)/set_filters(Option<Vec<AssociatedTranscriptFilter>>):A list of filter objects.
max_results(i32)/set_max_results(Option<i32>):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.
next_index(i32)/set_next_index(Option<i32>):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.
- On success, responds with
SearchAssociatedTranscriptsOutputwith field(s):bot_id(Option<String>):The unique identifier of the bot associated with the transcripts that you are searching.
bot_version(Option<String>):The version of the bot containing the transcripts that you are searching.
locale_id(Option<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
bot_recommendation_id(Option<String>):The unique identifier of the bot recommendation associated with the transcripts to search.
next_index(Option<i32>):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.
associated_transcripts(Option<Vec<AssociatedTranscript>>):The object that contains the associated transcript that meet the criteria you specified.
total_results(Option<i32>):The total number of transcripts returned by the search.
- On failure, responds with
SdkError<SearchAssociatedTranscriptsError>
sourcepub fn start_bot_recommendation(&self) -> StartBotRecommendation
pub fn start_bot_recommendation(&self) -> StartBotRecommendation
Constructs a fluent builder for the StartBotRecommendation operation.
- The fluent builder is configurable:
bot_id(impl Into<String>)/set_bot_id(Option<String>):The unique identifier of the bot containing the bot recommendation.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The version of the bot containing the bot recommendation.
locale_id(impl Into<String>)/set_locale_id(Option<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
transcript_source_setting(TranscriptSourceSetting)/set_transcript_source_setting(Option<TranscriptSourceSetting>):The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.
encryption_setting(EncryptionSetting)/set_encryption_setting(Option<EncryptionSetting>):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.
- On success, responds with
StartBotRecommendationOutputwith field(s):bot_id(Option<String>):The unique identifier of the bot containing the bot recommendation.
bot_version(Option<String>):The version of the bot containing the bot recommendation.
locale_id(Option<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
bot_recommendation_status(Option<BotRecommendationStatus>):The status of the bot recommendation.
If the status is Failed, then the reasons for the failure are listed in the failureReasons field.
bot_recommendation_id(Option<String>):The identifier of the bot recommendation that you have created.
creation_date_time(Option<DateTime>):A timestamp of the date and time that the bot recommendation was created.
transcript_source_setting(Option<TranscriptSourceSetting>):The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.
encryption_setting(Option<EncryptionSetting>):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.
- On failure, responds with
SdkError<StartBotRecommendationError>
sourcepub fn start_import(&self) -> StartImport
pub fn start_import(&self) -> StartImport
Constructs a fluent builder for the StartImport operation.
- The fluent builder is configurable:
import_id(impl Into<String>)/set_import_id(Option<String>):The unique identifier for the import. It is included in the response from the CreateUploadUrl operation.
resource_specification(ImportResourceSpecification)/set_resource_specification(Option<ImportResourceSpecification>):Parameters for creating the bot, bot locale or custom vocabulary.
merge_strategy(MergeStrategy)/set_merge_strategy(Option<MergeStrategy>):The strategy to use when there is a name conflict between the imported resource and an existing resource. When the merge strategy is
FailOnConflictexisting resources are not overwritten and the import fails.file_password(impl Into<String>)/set_file_password(Option<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.
- On success, responds with
StartImportOutputwith field(s):import_id(Option<String>):A unique identifier for the import.
resource_specification(Option<ImportResourceSpecification>):The parameters used when importing the resource.
merge_strategy(Option<MergeStrategy>):The strategy used when there was a name conflict between the imported resource and an existing resource. When the merge strategy is
FailOnConflictexisting resources are not overwritten and the import fails.import_status(Option<ImportStatus>):The current status of the import. When the status is
Completethe bot, bot alias, or custom vocabulary is ready to use.creation_date_time(Option<DateTime>):The date and time that the import request was created.
- On failure, responds with
SdkError<StartImportError>
sourcepub fn stop_bot_recommendation(&self) -> StopBotRecommendation
pub fn stop_bot_recommendation(&self) -> StopBotRecommendation
Constructs a fluent builder for the StopBotRecommendation operation.
- The fluent builder is configurable:
bot_id(impl Into<String>)/set_bot_id(Option<String>):The unique identifier of the bot containing the bot recommendation to be stopped.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The version of the bot containing the bot recommendation.
locale_id(impl Into<String>)/set_locale_id(Option<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
bot_recommendation_id(impl Into<String>)/set_bot_recommendation_id(Option<String>):The unique identifier of the bot recommendation to be stopped.
- On success, responds with
StopBotRecommendationOutputwith field(s):bot_id(Option<String>):The unique identifier of the bot containing the bot recommendation that is being stopped.
bot_version(Option<String>):The version of the bot containing the recommendation that is being stopped.
locale_id(Option<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
bot_recommendation_status(Option<BotRecommendationStatus>):The status of the bot recommendation. If the status is Failed, then the reasons for the failure are listed in the failureReasons field.
bot_recommendation_id(Option<String>):The unique identifier of the bot recommendation that is being stopped.
- On failure, responds with
SdkError<StopBotRecommendationError>
sourcepub fn tag_resource(&self) -> TagResource
pub fn tag_resource(&self) -> TagResource
Constructs a fluent builder for the TagResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):The Amazon Resource Name (ARN) of the bot, bot alias, or bot channel to tag.
tags(HashMap<String, String>)/set_tags(Option<HashMap<String, String>>):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.
- On success, responds with
TagResourceOutput - On failure, responds with
SdkError<TagResourceError>
sourcepub fn untag_resource(&self) -> UntagResource
pub fn untag_resource(&self) -> UntagResource
Constructs a fluent builder for the UntagResource operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):The Amazon Resource Name (ARN) of the resource to remove the tags from.
tag_keys(Vec<String>)/set_tag_keys(Option<Vec<String>>):A list of tag keys to remove from the resource. If a tag key does not exist on the resource, it is ignored.
- On success, responds with
UntagResourceOutput - On failure, responds with
SdkError<UntagResourceError>
sourcepub fn update_bot(&self) -> UpdateBot
pub fn update_bot(&self) -> UpdateBot
Constructs a fluent builder for the UpdateBot operation.
- The fluent builder is configurable:
bot_id(impl Into<String>)/set_bot_id(Option<String>):The unique identifier of the bot to update. This identifier is returned by the CreateBot operation.
bot_name(impl Into<String>)/set_bot_name(Option<String>):The new name of the bot. The name must be unique in the account that creates the bot.
description(impl Into<String>)/set_description(Option<String>):A description of the bot.
role_arn(impl Into<String>)/set_role_arn(Option<String>):The Amazon Resource Name (ARN) of an IAM role that has permissions to access the bot.
data_privacy(DataPrivacy)/set_data_privacy(Option<DataPrivacy>):Provides information on additional privacy protections Amazon Lex should use with the bot’s data.
idle_session_ttl_in_seconds(i32)/set_idle_session_ttl_in_seconds(Option<i32>):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.
- On success, responds with
UpdateBotOutputwith field(s):bot_id(Option<String>):The unique identifier of the bot that was updated.
bot_name(Option<String>):The name of the bot after the update.
description(Option<String>):The description of the bot after the update.
role_arn(Option<String>):The Amazon Resource Name (ARN) of the IAM role used by the bot after the update.
data_privacy(Option<DataPrivacy>):The data privacy settings for the bot after the update.
idle_session_ttl_in_seconds(Option<i32>):The session timeout, in seconds, for the bot after the update.
bot_status(Option<BotStatus>):Shows the current status of the bot. The bot is first in the
Creatingstatus. Once the bot is read for use, it changes to theAvailablestatus. After the bot is created, you can use theDRAFTversion of the bot.creation_date_time(Option<DateTime>):A timestamp of the date and time that the bot was created.
last_updated_date_time(Option<DateTime>):A timestamp of the date and time that the bot was last updated.
- On failure, responds with
SdkError<UpdateBotError>
sourcepub fn update_bot_alias(&self) -> UpdateBotAlias
pub fn update_bot_alias(&self) -> UpdateBotAlias
Constructs a fluent builder for the UpdateBotAlias operation.
- The fluent builder is configurable:
bot_alias_id(impl Into<String>)/set_bot_alias_id(Option<String>):The unique identifier of the bot alias.
bot_alias_name(impl Into<String>)/set_bot_alias_name(Option<String>):The new name to assign to the bot alias.
description(impl Into<String>)/set_description(Option<String>):The new description to assign to the bot alias.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The new bot version to assign to the bot alias.
bot_alias_locale_settings(HashMap<String, BotAliasLocaleSettings>)/set_bot_alias_locale_settings(Option<HashMap<String, BotAliasLocaleSettings>>):The new Lambda functions to use in each locale for the bot alias.
conversation_log_settings(ConversationLogSettings)/set_conversation_log_settings(Option<ConversationLogSettings>):The new settings for storing conversation logs in Amazon CloudWatch Logs and Amazon S3 buckets.
sentiment_analysis_settings(SentimentAnalysisSettings)/set_sentiment_analysis_settings(Option<SentimentAnalysisSettings>):Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
bot_id(impl Into<String>)/set_bot_id(Option<String>):The identifier of the bot with the updated alias.
- On success, responds with
UpdateBotAliasOutputwith field(s):bot_alias_id(Option<String>):The identifier of the updated bot alias.
bot_alias_name(Option<String>):The updated name of the bot alias.
description(Option<String>):The updated description of the bot alias.
bot_version(Option<String>):The updated version of the bot that the alias points to.
bot_alias_locale_settings(Option<HashMap<String, BotAliasLocaleSettings>>):The updated Lambda functions to use in each locale for the bot alias.
conversation_log_settings(Option<ConversationLogSettings>):The updated settings for storing conversation logs in Amazon CloudWatch Logs and Amazon S3 buckets.
sentiment_analysis_settings(Option<SentimentAnalysisSettings>):Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
bot_alias_status(Option<BotAliasStatus>):The current status of the bot alias. When the status is
Availablethe alias is ready for use.bot_id(Option<String>):The identifier of the bot with the updated alias.
creation_date_time(Option<DateTime>):A timestamp of the date and time that the bot was created.
last_updated_date_time(Option<DateTime>):A timestamp of the date and time that the bot was last updated.
- On failure, responds with
SdkError<UpdateBotAliasError>
sourcepub fn update_bot_locale(&self) -> UpdateBotLocale
pub fn update_bot_locale(&self) -> UpdateBotLocale
Constructs a fluent builder for the UpdateBotLocale operation.
- The fluent builder is configurable:
bot_id(impl Into<String>)/set_bot_id(Option<String>):The unique identifier of the bot that contains the locale.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The version of the bot that contains the locale to be updated. The version can only be the
DRAFTversion.locale_id(impl Into<String>)/set_locale_id(Option<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.
description(impl Into<String>)/set_description(Option<String>):The new description of the locale.
nlu_intent_confidence_threshold(f64)/set_nlu_intent_confidence_threshold(Option<f64>):The new confidence threshold where Amazon Lex inserts the
AMAZON.FallbackIntentandAMAZON.KendraSearchIntentintents in the list of possible intents for an utterance.voice_settings(VoiceSettings)/set_voice_settings(Option<VoiceSettings>):The new Amazon Polly voice Amazon Lex should use for voice interaction with the user.
- On success, responds with
UpdateBotLocaleOutputwith field(s):bot_id(Option<String>):The identifier of the bot that contains the updated locale.
bot_version(Option<String>):The version of the bot that contains the updated locale.
locale_id(Option<String>):The language and locale of the updated bot locale.
locale_name(Option<String>):The updated locale name for the locale.
description(Option<String>):The updated description of the locale.
nlu_intent_confidence_threshold(Option<f64>):The updated confidence threshold for inserting the
AMAZON.FallbackIntentandAMAZON.KendraSearchIntentintents in the list of possible intents for an utterance.voice_settings(Option<VoiceSettings>):The updated Amazon Polly voice to use for voice interaction with the user.
bot_locale_status(Option<BotLocaleStatus>):The current status of the locale. When the bot status is
Builtthe locale is ready for use.failure_reasons(Option<Vec<String>>):If the
botLocaleStatusisFailed, thefailureReasonsfield lists the errors that occurred while building the bot.creation_date_time(Option<DateTime>):A timestamp of the date and time that the locale was created.
last_updated_date_time(Option<DateTime>):A timestamp of the date and time that the locale was last updated.
recommended_actions(Option<Vec<String>>):Recommended actions to take to resolve an error in the
failureReasonsfield.
- On failure, responds with
SdkError<UpdateBotLocaleError>
sourcepub fn update_bot_recommendation(&self) -> UpdateBotRecommendation
pub fn update_bot_recommendation(&self) -> UpdateBotRecommendation
Constructs a fluent builder for the UpdateBotRecommendation operation.
- The fluent builder is configurable:
bot_id(impl Into<String>)/set_bot_id(Option<String>):The unique identifier of the bot containing the bot recommendation to be updated.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The version of the bot containing the bot recommendation to be updated.
locale_id(impl Into<String>)/set_locale_id(Option<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
bot_recommendation_id(impl Into<String>)/set_bot_recommendation_id(Option<String>):The unique identifier of the bot recommendation to be updated.
encryption_setting(EncryptionSetting)/set_encryption_setting(Option<EncryptionSetting>):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.
- On success, responds with
UpdateBotRecommendationOutputwith field(s):bot_id(Option<String>):The unique identifier of the bot containing the bot recommendation that has been updated.
bot_version(Option<String>):The version of the bot containing the bot recommendation that has been updated.
locale_id(Option<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
bot_recommendation_status(Option<BotRecommendationStatus>):The status of the bot recommendation.
If the status is Failed, then the reasons for the failure are listed in the failureReasons field.
bot_recommendation_id(Option<String>):The unique identifier of the bot recommendation to be updated.
creation_date_time(Option<DateTime>):A timestamp of the date and time that the bot recommendation was created.
last_updated_date_time(Option<DateTime>):A timestamp of the date and time that the bot recommendation was last updated.
transcript_source_setting(Option<TranscriptSourceSetting>):The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.
encryption_setting(Option<EncryptionSetting>):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.
- On failure, responds with
SdkError<UpdateBotRecommendationError>
sourcepub fn update_export(&self) -> UpdateExport
pub fn update_export(&self) -> UpdateExport
Constructs a fluent builder for the UpdateExport operation.
- The fluent builder is configurable:
export_id(impl Into<String>)/set_export_id(Option<String>):The unique identifier Amazon Lex assigned to the export.
file_password(impl Into<String>)/set_file_password(Option<String>):The new password to use to encrypt the export zip archive.
- On success, responds with
UpdateExportOutputwith field(s):export_id(Option<String>):The unique identifier Amazon Lex assigned to the export.
resource_specification(Option<ExportResourceSpecification>):A description of the type of resource that was exported, either a bot or a bot locale.
file_format(Option<ImportExportFileFormat>):The file format used for the files that define the resource. The
TSVformat is required to export a custom vocabulary only; otherwise useLexJsonformat.export_status(Option<ExportStatus>):The status of the export. When the status is
Completedthe export archive is available for download.creation_date_time(Option<DateTime>):The date and time that the export was created.
last_updated_date_time(Option<DateTime>):The date and time that the export was last updated.
- On failure, responds with
SdkError<UpdateExportError>
sourcepub fn update_intent(&self) -> UpdateIntent
pub fn update_intent(&self) -> UpdateIntent
Constructs a fluent builder for the UpdateIntent operation.
- The fluent builder is configurable:
intent_id(impl Into<String>)/set_intent_id(Option<String>):The unique identifier of the intent to update.
intent_name(impl Into<String>)/set_intent_name(Option<String>):The new name for the intent.
description(impl Into<String>)/set_description(Option<String>):The new description of the intent.
parent_intent_signature(impl Into<String>)/set_parent_intent_signature(Option<String>):The signature of the new built-in intent to use as the parent of this intent.
sample_utterances(Vec<SampleUtterance>)/set_sample_utterances(Option<Vec<SampleUtterance>>):New utterances used to invoke the intent.
dialog_code_hook(DialogCodeHookSettings)/set_dialog_code_hook(Option<DialogCodeHookSettings>):The new Lambda function to use between each turn of the conversation with the bot.
fulfillment_code_hook(FulfillmentCodeHookSettings)/set_fulfillment_code_hook(Option<FulfillmentCodeHookSettings>):The new Lambda function to call when all of the intents required slots are provided and the intent is ready for fulfillment.
slot_priorities(Vec<SlotPriority>)/set_slot_priorities(Option<Vec<SlotPriority>>):A new list of slots and their priorities that are contained by the intent.
intent_confirmation_setting(IntentConfirmationSetting)/set_intent_confirmation_setting(Option<IntentConfirmationSetting>):New prompts that Amazon Lex sends to the user to confirm the completion of an intent.
intent_closing_setting(IntentClosingSetting)/set_intent_closing_setting(Option<IntentClosingSetting>):The new response that Amazon Lex sends the user when the intent is closed.
input_contexts(Vec<InputContext>)/set_input_contexts(Option<Vec<InputContext>>):A new list of contexts that must be active in order for Amazon Lex to consider the intent.
output_contexts(Vec<OutputContext>)/set_output_contexts(Option<Vec<OutputContext>>):A new list of contexts that Amazon Lex activates when the intent is fulfilled.
kendra_configuration(KendraConfiguration)/set_kendra_configuration(Option<KendraConfiguration>):New configuration settings for connecting to an Amazon Kendra index.
bot_id(impl Into<String>)/set_bot_id(Option<String>):The identifier of the bot that contains the intent.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The version of the bot that contains the intent. Must be
DRAFT.locale_id(impl Into<String>)/set_locale_id(Option<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.
initial_response_setting(InitialResponseSetting)/set_initial_response_setting(Option<InitialResponseSetting>):
- On success, responds with
UpdateIntentOutputwith field(s):intent_id(Option<String>):The identifier of the intent that was updated.
intent_name(Option<String>):The updated name of the intent.
description(Option<String>):The updated description of the intent.
parent_intent_signature(Option<String>):The updated built-in intent that is the parent of this intent.
sample_utterances(Option<Vec<SampleUtterance>>):The updated list of sample utterances for the intent.
dialog_code_hook(Option<DialogCodeHookSettings>):The updated Lambda function called during each turn of the conversation with the user.
fulfillment_code_hook(Option<FulfillmentCodeHookSettings>):The updated Lambda function called when the intent is ready for fulfillment.
slot_priorities(Option<Vec<SlotPriority>>):The updated list of slots and their priorities that are elicited from the user for the intent.
intent_confirmation_setting(Option<IntentConfirmationSetting>):The updated prompts that Amazon Lex sends to the user to confirm the completion of an intent.
intent_closing_setting(Option<IntentClosingSetting>):The updated response that Amazon Lex sends the user when the intent is closed.
input_contexts(Option<Vec<InputContext>>):The updated list of contexts that must be active for the intent to be considered by Amazon Lex.
output_contexts(Option<Vec<OutputContext>>):The updated list of contexts that Amazon Lex activates when the intent is fulfilled.
kendra_configuration(Option<KendraConfiguration>):The updated configuration for connecting to an Amazon Kendra index with the
AMAZON.KendraSearchIntentintent.bot_id(Option<String>):The identifier of the bot that contains the intent.
bot_version(Option<String>):The version of the bot that contains the intent. Will always be
DRAFT.locale_id(Option<String>):The updated language and locale of the intent.
creation_date_time(Option<DateTime>):A timestamp of when the intent was created.
last_updated_date_time(Option<DateTime>):A timestamp of the last time that the intent was modified.
initial_response_setting(Option<InitialResponseSetting>):
- On failure, responds with
SdkError<UpdateIntentError>
sourcepub fn update_resource_policy(&self) -> UpdateResourcePolicy
pub fn update_resource_policy(&self) -> UpdateResourcePolicy
Constructs a fluent builder for the UpdateResourcePolicy operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
policy(impl Into<String>)/set_policy(Option<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.
expected_revision_id(impl Into<String>)/set_expected_revision_id(Option<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.
- On success, responds with
UpdateResourcePolicyOutputwith field(s):resource_arn(Option<String>):The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.
revision_id(Option<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.
- On failure, responds with
SdkError<UpdateResourcePolicyError>
sourcepub fn update_slot(&self) -> UpdateSlot
pub fn update_slot(&self) -> UpdateSlot
Constructs a fluent builder for the UpdateSlot operation.
- The fluent builder is configurable:
slot_id(impl Into<String>)/set_slot_id(Option<String>):The unique identifier for the slot to update.
slot_name(impl Into<String>)/set_slot_name(Option<String>):The new name for the slot.
description(impl Into<String>)/set_description(Option<String>):The new description for the slot.
slot_type_id(impl Into<String>)/set_slot_type_id(Option<String>):The unique identifier of the new slot type to associate with this slot.
value_elicitation_setting(SlotValueElicitationSetting)/set_value_elicitation_setting(Option<SlotValueElicitationSetting>):A new set of prompts that Amazon Lex sends to the user to elicit a response the provides a value for the slot.
obfuscation_setting(ObfuscationSetting)/set_obfuscation_setting(Option<ObfuscationSetting>):New settings that determine how slot values are formatted in Amazon CloudWatch logs.
bot_id(impl Into<String>)/set_bot_id(Option<String>):The unique identifier of the bot that contains the slot.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The version of the bot that contains the slot. Must always be
DRAFT.locale_id(impl Into<String>)/set_locale_id(Option<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.
intent_id(impl Into<String>)/set_intent_id(Option<String>):The identifier of the intent that contains the slot.
multiple_values_setting(MultipleValuesSetting)/set_multiple_values_setting(Option<MultipleValuesSetting>):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
truein any other locale, Amazon Lex throws aValidationException.If the
multipleValuesSettingis not set, the default value isfalse.sub_slot_setting(SubSlotSetting)/set_sub_slot_setting(Option<SubSlotSetting>):Specifications for the constituent sub slots and the expression for the composite slot.
- On success, responds with
UpdateSlotOutputwith field(s):slot_id(Option<String>):The unique identifier of the slot that was updated.
slot_name(Option<String>):The updated name of the slot.
description(Option<String>):The updated description of the bot.
slot_type_id(Option<String>):The updated identifier of the slot type that provides values for the slot.
value_elicitation_setting(Option<SlotValueElicitationSetting>):The updated prompts that Amazon Lex sends to the user to elicit a response that provides a value for the slot.
obfuscation_setting(Option<ObfuscationSetting>):The updated setting that determines whether the slot value is obfuscated in the Amazon CloudWatch logs.
bot_id(Option<String>):The identifier of the bot that contains the slot.
bot_version(Option<String>):The identifier of the slot version that contains the slot. Will always be
DRAFT.locale_id(Option<String>):The locale that contains the slot.
intent_id(Option<String>):The intent that contains the slot.
creation_date_time(Option<DateTime>):The timestamp of the date and time that the slot was created.
last_updated_date_time(Option<DateTime>):The timestamp of the date and time that the slot was last updated.
multiple_values_setting(Option<MultipleValuesSetting>):Indicates whether the slot accepts multiple values in one response.
sub_slot_setting(Option<SubSlotSetting>):Specifications for the constituent sub slots and the expression for the composite slot.
- On failure, responds with
SdkError<UpdateSlotError>
sourcepub fn update_slot_type(&self) -> UpdateSlotType
pub fn update_slot_type(&self) -> UpdateSlotType
Constructs a fluent builder for the UpdateSlotType operation.
- The fluent builder is configurable:
slot_type_id(impl Into<String>)/set_slot_type_id(Option<String>):The unique identifier of the slot type to update.
slot_type_name(impl Into<String>)/set_slot_type_name(Option<String>):The new name of the slot type.
description(impl Into<String>)/set_description(Option<String>):The new description of the slot type.
slot_type_values(Vec<SlotTypeValue>)/set_slot_type_values(Option<Vec<SlotTypeValue>>):A new list of values and their optional synonyms that define the values that the slot type can take.
value_selection_setting(SlotValueSelectionSetting)/set_value_selection_setting(Option<SlotValueSelectionSetting>):The strategy that Amazon Lex should use when deciding on a value from the list of slot type values.
parent_slot_type_signature(impl Into<String>)/set_parent_slot_type_signature(Option<String>):The new built-in slot type that should be used as the parent of this slot type.
bot_id(impl Into<String>)/set_bot_id(Option<String>):The identifier of the bot that contains the slot type.
bot_version(impl Into<String>)/set_bot_version(Option<String>):The version of the bot that contains the slot type. Must be
DRAFT.locale_id(impl Into<String>)/set_locale_id(Option<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.
external_source_setting(ExternalSourceSetting)/set_external_source_setting(Option<ExternalSourceSetting>):Provides information about the external source of the slot type’s definition.
composite_slot_type_setting(CompositeSlotTypeSetting)/set_composite_slot_type_setting(Option<CompositeSlotTypeSetting>):Specifications for a composite slot type.
- On success, responds with
UpdateSlotTypeOutputwith field(s):slot_type_id(Option<String>):The unique identifier of the updated slot type.
slot_type_name(Option<String>):The updated name of the slot type.
description(Option<String>):The updated description of the slot type.
slot_type_values(Option<Vec<SlotTypeValue>>):The updated values that the slot type provides.
value_selection_setting(Option<SlotValueSelectionSetting>):The updated strategy that Amazon Lex uses to determine which value to select from the slot type.
parent_slot_type_signature(Option<String>):The updated signature of the built-in slot type that is the parent of this slot type.
bot_id(Option<String>):The identifier of the bot that contains the slot type.
bot_version(Option<String>):The version of the bot that contains the slot type. This is always
DRAFT.locale_id(Option<String>):The language and locale of the updated slot type.
creation_date_time(Option<DateTime>):The timestamp of the date and time that the slot type was created.
last_updated_date_time(Option<DateTime>):A timestamp of the date and time that the slot type was last updated.
external_source_setting(Option<ExternalSourceSetting>):Provides information about the external source of the slot type’s definition.
composite_slot_type_setting(Option<CompositeSlotTypeSetting>):Specifications for a composite slot type.
- On failure, responds with
SdkError<UpdateSlotTypeError>
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
Panics
- This method will panic if the
sdk_configis missing an async sleep implementation. If you experience this panic, set thesleep_implon the Config passed into this function to fix it. - This method will panic if the
sdk_configis missing an HTTP connector. If you experience this panic, set thehttp_connectoron the Config passed into this function to fix it.
sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config.
Panics
- This method will panic if the
confis missing an async sleep implementation. If you experience this panic, set thesleep_implon the Config passed into this function to fix it. - This method will panic if the
confis missing an HTTP connector. If you experience this panic, set thehttp_connectoron the Config passed into this function to fix it.